Skip to main content
WEBHOOK
document.updated.v2
{
  "billDate": "2023-12-25",
  "chargesUnits": "USD",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "usageData": [
    {
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "updated": "2023-11-07T05:31:56Z",
      "isEstimated": true,
      "isImplied": true,
      "currentReading": "<string>",
      "previousReading": "<string>",
      "multiplier": "<string>",
      "multiplierDescription": "<string>",
      "multiplier2": "<string>",
      "multiplier2Description": "<string>",
      "fractionRenewable": "<string>",
      "netMeteringGeneratedKwh": "<string>",
      "netMeteringGridImportKwh": "<string>",
      "netMeteringGridExportKwh": "<string>",
      "exclusion": true,
      "tariff": "<string>",
      "billedDemand": "<string>",
      "supplierName": "<string>",
      "utilityName": "<string>",
      "country": "<string>"
    }
  ],
  "lineItems": [
    {
      "rate": "<string>",
      "totalCharge": "<string>",
      "description": "<string>",
      "quantity": "<string>",
      "quantityUnits": "<string>",
      "multipliers": [
        "<string>"
      ],
      "accountIds": [
        "<string>"
      ],
      "chargeType": "TAX",
      "electricityChargeType": "SUPPLY",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "<string>",
      "gasChargeType": "SUPPLY",
      "billingPeriod": "CURRENT"
    }
  ],
  "updated": "2023-11-07T05:31:56Z",
  "fileName": "<string>",
  "email": "[email protected]",
  "jobId": "<string>",
  "notes": "<string>",
  "dueDate": "2023-12-25",
  "totalCharges": "<string>",
  "sourceType": "INVOICE",
  "isFlagged": true,
  "invoiceId": "<string>",
  "previousCloseBalance": "<string>",
  "afterPreviousTotalPayment": "<string>",
  "afterPreviousCharges": "<string>",
  "afterPreviousCredits": "<string>",
  "currentOpenBalance": "<string>",
  "currentCharges": "<string>",
  "credits": "<string>",
  "taxCharges": "<string>",
  "interestCharges": "<string>",
  "electricitySupplyCharges": "<string>",
  "electricityDeliveryCharges": "<string>",
  "electricityDemandCharges": "<string>",
  "gasSupplyCharges": "<string>",
  "gasDeliveryCharges": "<string>"
}

Body

application/json

Serializer for all fields of WorkflowResult, including signed S3 URL generation for webhooks.

Uses all the fields in the helper create serializer with an additional field documenting the original object.

​
billDate
string<date>
required

Date of the bill.

​
chargesUnits
enum<string>
required

Currency unit for the charges and balances.

  • USD - Usd
  • EUR - Eur
  • AED - Aed
  • AFN - Afn
  • ALL - All
  • AMD - Amd
  • ANG - Ang
  • AOA - Aoa
  • ARS - Ars
  • AUD - Aud
  • AWG - Awg
  • AZN - Azn
  • BAM - Bam
  • BBD - Bbd
  • BDT - Bdt
  • BGN - Bgn
  • BHD - Bhd
  • BIF - Bif
  • BMD - Bmd
  • BND - Bnd
  • BOB - Bob
  • BOV - Bov
  • BRL - Brl
  • BSD - Bsd
  • BTN - Btn
  • BWP - Bwp
  • BYN - Byn
  • BZD - Bzd
  • CAD - Cad
  • CDF - Cdf
  • CHE - Che
  • CHF - Chf
  • CHW - Chw
  • CLF - Clf
  • CLP - Clp
  • CNY - Cny
  • COP - Cop
  • COU - Cou
  • CRC - Crc
  • CUC - Cuc
  • CUP - Cup
  • CVE - Cve
  • CZK - Czk
  • DJF - Djf
  • DKK - Dkk
  • DOP - Dop
  • DZD - Dzd
  • EGP - Egp
  • ERN - Ern
  • ETB - Etb
  • FJD - Fjd
  • FKP - Fkp
  • GBP - Gbp
  • GEL - Gel
  • GHS - Ghs
  • GIP - Gip
  • GMD - Gmd
  • GNF - Gnf
  • GTQ - Gtq
  • GYD - Gyd
  • HKD - Hkd
  • HNL - Hnl
  • HRK - Hrk
  • HTG - Htg
  • HUF - Huf
  • IDR - Idr
  • ILS - Ils
  • INR - Inr
  • IQD - Iqd
  • IRR - Irr
  • ISK - Isk
  • JMD - Jmd
  • JOD - Jod
  • JPY - Jpy
  • KES - Kes
  • KGS - Kgs
  • KHR - Khr
  • KMF - Kmf
  • KPW - Kpw
  • KRW - Krw
  • KWD - Kwd
  • KYD - Kyd
  • KZT - Kzt
  • LAK - Lak
  • LBP - Lbp
  • LKR - Lkr
  • LRD - Lrd
  • LSL - Lsl
  • LYD - Lyd
  • MAD - Mad
  • MDL - Mdl
  • MGA - Mga
  • MKD - Mkd
  • MMK - Mmk
  • MNT - Mnt
  • MOP - Mop
  • MRU - Mru
  • MUR - Mur
  • MVR - Mvr
  • MWK - Mwk
  • MXN - Mxn
  • MXV - Mxv
  • MYR - Myr
  • MZN - Mzn
  • NAD - Nad
  • NGN - Ngn
  • NIO - Nio
  • NOK - Nok
  • NPR - Npr
  • NZD - Nzd
  • OMR - Omr
  • PAB - Pab
  • PEN - Pen
  • PGK - Pgk
  • PHP - Php
  • PKR - Pkr
  • PLN - Pln
  • PYG - Pyg
  • QAR - Qar
  • RON - Ron
  • RSD - Rsd
  • RUB - Rub
  • RWF - Rwf
  • SAR - Sar
  • SBD - Sbd
  • SCR - Scr
  • SDG - Sdg
  • SEK - Sek
  • SGD - Sgd
  • SHP - Shp
  • SLE - Sle
  • SLL - Sll
  • SOS - Sos
  • SRD - Srd
  • SSP - Ssp
  • STN - Stn
  • SVC - Svc
  • SYP - Syp
  • SZL - Szl
  • THB - Thb
  • TJS - Tjs
  • TMT - Tmt
  • TND - Tnd
  • TOP - Top
  • TRY - Try
  • TTD - Ttd
  • TWD - Twd
  • TZS - Tzs
  • UAH - Uah
  • UGX - Ugx
  • USN - Usn
  • UYI - Uyi
  • UYU - Uyu
  • UZS - Uzs
  • VED - Ved
  • VEF - Vef
  • VND - Vnd
  • VUV - Vuv
  • WST - Wst
  • XAF - Xaf
  • XCD - Xcd
  • XOF - Xof
  • XPF - Xpf
  • XSU - Xsu
  • YER - Yer
  • ZAR - Zar
  • ZMW - Zmw
  • ZWL - Zwl
Available options:
USD,
EUR,
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BOV,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLF,
CLP,
CNY,
COP,
COU,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MXV,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USN,
UYI,
UYU,
UZS,
VED,
VEF,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
XSU,
YER,
ZAR,
ZMW,
ZWL
​
company
string<uuid>
required

Reference to the associated company. Deleting the company will soft delete the document.

​
usageData
object[]
required

List of usage data entries associated with this document.

​
lineItems
object[]
required

List of individual line items from the document, such as charges, fees, and taxes.

​
updated
string<date-time>

Timestamp when the document was last updated.

​
fileName
string | null

Original name of the file uploaded or downloaded.

​
email
string<email> | null

Email of the user who uploaded or created the document. If uploaded programmatically, this will be the email associated with the API key. Email will show [email protected] if document was scraped by Nectar.

​
jobId
string | null

The ID of the job that processed the document.

​
notes
string | null

Additional notes related to the document.

​
dueDate
string<date> | null

Due date from the bill.

​
totalCharges
string<decimal>

The total charges from the current bill including any overdue charges and penalties. This is often also known as the current closing balance = total due.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
sourceType
enum<string>

Source of the data for this workflow result. Defaults to INVOICE for a regularly billed invoice. Can also be more granular SMART_METER data or MANUAL for manually entered data.

  • INVOICE - Invoice
  • SMART_METER - Smart Meter
  • MANUAL - Manual
Available options:
INVOICE,
SMART_METER,
MANUAL
​
isFlagged
boolean

Indicates if the document is flagged.

​
invoiceId
string | null

Invoice ID from the bill.

​
previousCloseBalance
string<decimal> | null

Last bill's total due. Positive number indicates amount owed. For irregular bills or bills without balances, this quantity defaults to 0.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
afterPreviousTotalPayment
string<decimal> | null

Payments made between last bill invoice date and this bill invoice date. Should always be 0 or negative. For irregular bills or bills without payments, this quantity defaults to 0.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
afterPreviousCharges
string<decimal> | null

Charges between previous close and current open, e.g. interest charges. Positive number indicates amount owed. For irregular bills or bills without charges, this quantity defaults to 0.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
afterPreviousCredits
string<decimal> | null

Credits (besides payments) applied before open balance. Should always be <= 0. For irregular bills or bills without credits, this quantity defaults to 0. Credits are always recorded as negative values.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
currentOpenBalance
string<decimal>

Opening balance on this bill, equal to previousCloseBalance + afterPreviousTotalPayment + afterPreviousCharges + afterPreviousCredits.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
currentCharges
string<decimal> | null

Sum of new charges at meter and bill level, excluding tax. Positive number indicates amount owed.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
credits
string<decimal> | null

Sum of credited charges at meter and bill level. Should always be <= 0.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
taxCharges
string<decimal> | null

Sum of tax charges at meter and bill level. This includes various types of taxes such as VAT (Value Added Tax), GST (Goods and Services Tax), and other applicable taxes. VAT is common in many countries, while GST is typically used in countries like Australia and New Zealand. Other forms of sales or consumption taxes may also be included here.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
interestCharges
string<decimal>

Late or interest payment charges (already included in either afterPreviousCharges or currentCharges).

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
electricitySupplyCharges
string<decimal> | null

[ELECTRICITY] Total electricity supply charges

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
electricityDeliveryCharges
string<decimal> | null

[ELECTRICITY] Total electricity delivery/distribution charges

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
electricityDemandCharges
string<decimal> | null

[ELECTRICITY] Total electricity demand charges

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
gasSupplyCharges
string<decimal> | null

[GAS] Total gas supply charges

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
gasDeliveryCharges
string<decimal> | null

[GAS] Total gas delivery/distribution charges

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

Response

200

No response body