Nectar Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

Event Types

connection

document

accounts

array[]

company

object

Skeleton serializer for externally available fields of a Company object.

3 Items

country

string

Optional

Country of the utility company.

AF - Af
AL - Al
DZ - Dz
AS - As
AD - Ad
AO - Ao
AI - Ai
AQ - Aq
AG - Ag
AR - Ar
AM - Am
AW - Aw
AU - Au
AT - At
AZ - Az
BS - Bs
BH - Bh
BD - Bd
BB - Bb
BY - By
BE - Be
BZ - Bz
BJ - Bj
BM - Bm
BT - Bt
BO - Bo
BQ - Bq
BA - Ba
BW - Bw
BV - Bv
BR - Br
IO - Io
BN - Bn
BG - Bg
BF - Bf
BI - Bi
KH - Kh
CM - Cm
CA - Ca
CV - Cv
KY - Ky
CF - Cf
TD - Td
CL - Cl
CN - Cn
CX - Cx
CC - Cc
CO - Co
KM - Km
CG - Cg
CD - Cd
CK - Ck
CR - Cr
HR - Hr
CU - Cu
CW - Cw
CY - Cy
CZ - Cz
CI - Ci
DK - Dk
DJ - Dj
DM - Dm
DO - Do
EC - Ec
EG - Eg
SV - Sv
GQ - Gq
ER - Er
EE - Ee
ET - Et
FK - Fk
FO - Fo
FJ - Fj
FI - Fi
FR - Fr
GF - Gf
PF - Pf
TF - Tf
GA - Ga
GM - Gm
GE - Ge
DE - De
GH - Gh
GI - Gi
GR - Gr
GL - Gl
GD - Gd
GP - Gp
GU - Gu
GT - Gt
GG - Gg
GN - Gn
GW - Gw
GY - Gy
HT - Ht
HM - Hm
VA - Va
HN - Hn
HK - Hk
HU - Hu
IS - Is
IN - In
ID - Id
IR - Ir
IQ - Iq
IE - Ie
IM - Im
IL - Il
IT - It
JM - Jm
JP - Jp
JE - Je
JO - Jo
KZ - Kz
KE - Ke
KI - Ki
KP - Kp
KR - Kr
KW - Kw
KG - Kg
LA - La
LV - Lv
LB - Lb
LS - Ls
LR - Lr
LY - Ly
LI - Li
LT - Lt
LU - Lu
MO - Mo
MK - Mk
MG - Mg
MW - Mw
MY - My
MV - Mv
ML - Ml
MT - Mt
MH - Mh
MQ - Mq
MR - Mr
MU - Mu
YT - Yt
MX - Mx
FM - Fm
MD - Md
MC - Mc
MN - Mn
ME - Me
MS - Ms
MA - Ma
MZ - Mz
MM - Mm
NA - Na
NR - Nr
NP - Np
NL - Nl
NC - Nc
NZ - Nz
NI - Ni
NE - Ne
NG - Ng
NU - Nu
NF - Nf
MP - Mp
NO - No
OM - Om
PK - Pk
PW - Pw
PS - Ps
PA - Pa
PG - Pg
PY - Py
PE - Pe
PH - Ph
PN - Pn
PL - Pl
PT - Pt
PR - Pr
QA - Qa
RO - Ro
RU - Ru
RW - Rw
RE - Re
BL - Bl
SH - Sh
KN - Kn
LC - Lc
MF - Mf
PM - Pm
VC - Vc
WS - Ws
SM - Sm
ST - St
SA - Sa
SN - Sn
RS - Rs
SC - Sc
SL - Sl
SG - Sg
SX - Sx
SK - Sk
SI - Si
SB - Sb
SO - So
ZA - Za
GS - Gs
SS - Ss
ES - Es
LK - Lk
SD - Sd
SR - Sr
SJ - Sj
SZ - Sz
SE - Se
CH - Ch
SY - Sy
TW - Tw
TJ - Tj
TZ - Tz
TH - Th
TL - Tl
TG - Tg
TK - Tk
TO - To
TT - Tt
TN - Tn
TR - Tr
TM - Tm
TC - Tc
TV - Tv
UG - Ug
UA - Ua
AE - Ae
GB - Gb
US - Us
UM - Um
UY - Uy
UZ - Uz
VU - Vu
VE - Ve
VN - Vn
VG - Vg
VI - Vi
WF - Wf
EH - Eh
YE - Ye
ZM - Zm
ZW - Zw
AX - Ax

created

string

(date-time)

Timestamp when the utility account connection was created.

datasource

object

serializes external fields of Datasource.

1 Items

emails

array[]

Optional

List of email addresses the bill will be sent from for the EMAIL workflow type.

eventType

string

Type of event.

id

string

(uuid)

Unique identifier for the utility account connection.

status

string

Optional

Current status of the workflow, from list of pre-defined fields. Used to indicate if credentials are connected, incorrect, pending, requires mfa, etc.

MFA_TOKEN_EXPIRED - Mfa Token Expired
PASSWORD_INCORRECT - Password Incorrect
CONNECTED - Connected
PENDING - Pending
NEW_PASSWORD_NEEDED - New Password Needed
WEBSITE_DOWN - Website Down
PDF_DOWNLOAD_DOWN - Pdf Download Down

updated

string

(date-time)

Optional

Timestamp when the utility account connection was last updated.

url

string

Optional

URL of the utility company's login website.

Example

JSON

{
  "accounts": [
    {
      "accountNumber": "string",
      "datasourceTypes": [
        "string"
      ],
      "endDate": "2025-05-10",
      "isTracked": true,
      "startDate": "2025-05-10"
    }
  ],
  "company": {
    "externalId": "string",
    "id": "347b367d-ae6e-42cb-b998-3e7fb9ec6d58",
    "name": "string"
  },
  "country": "string",
  "created": "2025-05-10T00:41:17.398683402",
  "datasource": {
    "name": "string"
  },
  "emails": [
    "email"
  ],
  "eventType": "string",
  "id": "a7685b41-39c2-4fd1-aceb-f99198ffeaf5",
  "status": "string",
  "updated": "2025-05-10T00:41:17.398693003",
  "url": "string"
}

accounts

array[]

Optional

List of accounts associated with the connection.

company

object

Optional

Company associated with the connection.

country

string

Optional

Country of the utility company.

AF - Af
AL - Al
DZ - Dz
AS - As
AD - Ad
AO - Ao
AI - Ai
AQ - Aq
AG - Ag
AR - Ar
AM - Am
AW - Aw
AU - Au
AT - At
AZ - Az
BS - Bs
BH - Bh
BD - Bd
BB - Bb
BY - By
BE - Be
BZ - Bz
BJ - Bj
BM - Bm
BT - Bt
BO - Bo
BQ - Bq
BA - Ba
BW - Bw
BV - Bv
BR - Br
IO - Io
BN - Bn
BG - Bg
BF - Bf
BI - Bi
KH - Kh
CM - Cm
CA - Ca
CV - Cv
KY - Ky
CF - Cf
TD - Td
CL - Cl
CN - Cn
CX - Cx
CC - Cc
CO - Co
KM - Km
CG - Cg
CD - Cd
CK - Ck
CR - Cr
HR - Hr
CU - Cu
CW - Cw
CY - Cy
CZ - Cz
CI - Ci
DK - Dk
DJ - Dj
DM - Dm
DO - Do
EC - Ec
EG - Eg
SV - Sv
GQ - Gq
ER - Er
EE - Ee
ET - Et
FK - Fk
FO - Fo
FJ - Fj
FI - Fi
FR - Fr
GF - Gf
PF - Pf
TF - Tf
GA - Ga
GM - Gm
GE - Ge
DE - De
GH - Gh
GI - Gi
GR - Gr
GL - Gl
GD - Gd
GP - Gp
GU - Gu
GT - Gt
GG - Gg
GN - Gn
GW - Gw
GY - Gy
HT - Ht
HM - Hm
VA - Va
HN - Hn
HK - Hk
HU - Hu
IS - Is
IN - In
ID - Id
IR - Ir
IQ - Iq
IE - Ie
IM - Im
IL - Il
IT - It
JM - Jm
JP - Jp
JE - Je
JO - Jo
KZ - Kz
KE - Ke
KI - Ki
KP - Kp
KR - Kr
KW - Kw
KG - Kg
LA - La
LV - Lv
LB - Lb
LS - Ls
LR - Lr
LY - Ly
LI - Li
LT - Lt
LU - Lu
MO - Mo
MK - Mk
MG - Mg
MW - Mw
MY - My
MV - Mv
ML - Ml
MT - Mt
MH - Mh
MQ - Mq
MR - Mr
MU - Mu
YT - Yt
MX - Mx
FM - Fm
MD - Md
MC - Mc
MN - Mn
ME - Me
MS - Ms
MA - Ma
MZ - Mz
MM - Mm
NA - Na
NR - Nr
NP - Np
NL - Nl
NC - Nc
NZ - Nz
NI - Ni
NE - Ne
NG - Ng
NU - Nu
NF - Nf
MP - Mp
NO - No
OM - Om
PK - Pk
PW - Pw
PS - Ps
PA - Pa
PG - Pg
PY - Py
PE - Pe
PH - Ph
PN - Pn
PL - Pl
PT - Pt
PR - Pr
QA - Qa
RO - Ro
RU - Ru
RW - Rw
RE - Re
BL - Bl
SH - Sh
KN - Kn
LC - Lc
MF - Mf
PM - Pm
VC - Vc
WS - Ws
SM - Sm
ST - St
SA - Sa
SN - Sn
RS - Rs
SC - Sc
SL - Sl
SG - Sg
SX - Sx
SK - Sk
SI - Si
SB - Sb
SO - So
ZA - Za
GS - Gs
SS - Ss
ES - Es
LK - Lk
SD - Sd
SR - Sr
SJ - Sj
SZ - Sz
SE - Se
CH - Ch
SY - Sy
TW - Tw
TJ - Tj
TZ - Tz
TH - Th
TL - Tl
TG - Tg
TK - Tk
TO - To
TT - Tt
TN - Tn
TR - Tr
TM - Tm
TC - Tc
TV - Tv
UG - Ug
UA - Ua
AE - Ae
GB - Gb
US - Us
UM - Um
UY - Uy
UZ - Uz
VU - Vu
VE - Ve
VN - Vn
VG - Vg
VI - Vi
WF - Wf
EH - Eh
YE - Ye
ZM - Zm
ZW - Zw
AX - Ax

created

string

(date-time)

Timestamp when the utility account connection was created.

dataCollectionStartDate

string

(date)

Optional

Date when data collection for the workflow begins. This is the date from which Nectar will pull historical data. This field overrides the site and company level dataCollectionStartDate fields.

datasource

object

Optional

Datasource / utility provider associated with the connection.

eventType

string

Type of event.

id

string

(uuid)

Unique identifier for the utility account connection.

initialDatasourceTypes

array[]

Optional

Initial datasource types associated with this workflow. Initial datasource types are used to filter the workflows when the number of datasource types associated via accounts is 0.

initialSites

array[]

Optional

Initial sites associated with this connection. Initial sites are often useful to manually associate sites with the connection before the connection is validated or onboarded.

multiplyByOccupancy

boolean

Optional

Flag to indicate if data should be multiplied by occupancy.

status

string

Status of the connection.

updated

string

(date-time)

Optional

Timestamp when the utility account connection was last updated.

url

string

Optional

URL of the utility company's login website.

username

string

Optional

Username for the integration workflow.

workflowOwnerEmail

string

(email)

Optional

Utility login / data owner email address. This person will receive notifications if data is missing or if the utility data connection is misconfigured.

Example

JSON

{
  "accounts": [
    {
      "accountNumber": "string",
      "dataCollectionStartDate": "2025-12-05",
      "datasourceTypes": [
        "string"
      ],
      "id": "b20b4386-0b63-47af-86ca-b061f2a4b46f",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-12-05",
      "meters": [
        "cbbd6daa-8563-409f-9846-5cee3a4441a0"
      ]
    }
  ],
  "country": "string",
  "created": "2025-12-05T22:07:09.433371181",
  "dataCollectionStartDate": "2025-12-05",
  "eventType": "string",
  "id": "a5bba8d4-f3e1-4815-abde-23f50e39513b",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "575fa8ce-621c-4f70-94e8-766d22975cd6"
  ],
  "multiplyByOccupancy": true,
  "status": "string",
  "updated": "2025-12-05T22:07:09.433384481",
  "url": "string",
  "username": "string",
  "workflowOwnerEmail": "email"
}

accounts

array[]

company

object

Skeleton serializer for externally available fields of a Company object.

3 Items

country

string

Optional

Country of the utility company.

AF - Af
AL - Al
DZ - Dz
AS - As
AD - Ad
AO - Ao
AI - Ai
AQ - Aq
AG - Ag
AR - Ar
AM - Am
AW - Aw
AU - Au
AT - At
AZ - Az
BS - Bs
BH - Bh
BD - Bd
BB - Bb
BY - By
BE - Be
BZ - Bz
BJ - Bj
BM - Bm
BT - Bt
BO - Bo
BQ - Bq
BA - Ba
BW - Bw
BV - Bv
BR - Br
IO - Io
BN - Bn
BG - Bg
BF - Bf
BI - Bi
KH - Kh
CM - Cm
CA - Ca
CV - Cv
KY - Ky
CF - Cf
TD - Td
CL - Cl
CN - Cn
CX - Cx
CC - Cc
CO - Co
KM - Km
CG - Cg
CD - Cd
CK - Ck
CR - Cr
HR - Hr
CU - Cu
CW - Cw
CY - Cy
CZ - Cz
CI - Ci
DK - Dk
DJ - Dj
DM - Dm
DO - Do
EC - Ec
EG - Eg
SV - Sv
GQ - Gq
ER - Er
EE - Ee
ET - Et
FK - Fk
FO - Fo
FJ - Fj
FI - Fi
FR - Fr
GF - Gf
PF - Pf
TF - Tf
GA - Ga
GM - Gm
GE - Ge
DE - De
GH - Gh
GI - Gi
GR - Gr
GL - Gl
GD - Gd
GP - Gp
GU - Gu
GT - Gt
GG - Gg
GN - Gn
GW - Gw
GY - Gy
HT - Ht
HM - Hm
VA - Va
HN - Hn
HK - Hk
HU - Hu
IS - Is
IN - In
ID - Id
IR - Ir
IQ - Iq
IE - Ie
IM - Im
IL - Il
IT - It
JM - Jm
JP - Jp
JE - Je
JO - Jo
KZ - Kz
KE - Ke
KI - Ki
KP - Kp
KR - Kr
KW - Kw
KG - Kg
LA - La
LV - Lv
LB - Lb
LS - Ls
LR - Lr
LY - Ly
LI - Li
LT - Lt
LU - Lu
MO - Mo
MK - Mk
MG - Mg
MW - Mw
MY - My
MV - Mv
ML - Ml
MT - Mt
MH - Mh
MQ - Mq
MR - Mr
MU - Mu
YT - Yt
MX - Mx
FM - Fm
MD - Md
MC - Mc
MN - Mn
ME - Me
MS - Ms
MA - Ma
MZ - Mz
MM - Mm
NA - Na
NR - Nr
NP - Np
NL - Nl
NC - Nc
NZ - Nz
NI - Ni
NE - Ne
NG - Ng
NU - Nu
NF - Nf
MP - Mp
NO - No
OM - Om
PK - Pk
PW - Pw
PS - Ps
PA - Pa
PG - Pg
PY - Py
PE - Pe
PH - Ph
PN - Pn
PL - Pl
PT - Pt
PR - Pr
QA - Qa
RO - Ro
RU - Ru
RW - Rw
RE - Re
BL - Bl
SH - Sh
KN - Kn
LC - Lc
MF - Mf
PM - Pm
VC - Vc
WS - Ws
SM - Sm
ST - St
SA - Sa
SN - Sn
RS - Rs
SC - Sc
SL - Sl
SG - Sg
SX - Sx
SK - Sk
SI - Si
SB - Sb
SO - So
ZA - Za
GS - Gs
SS - Ss
ES - Es
LK - Lk
SD - Sd
SR - Sr
SJ - Sj
SZ - Sz
SE - Se
CH - Ch
SY - Sy
TW - Tw
TJ - Tj
TZ - Tz
TH - Th
TL - Tl
TG - Tg
TK - Tk
TO - To
TT - Tt
TN - Tn
TR - Tr
TM - Tm
TC - Tc
TV - Tv
UG - Ug
UA - Ua
AE - Ae
GB - Gb
US - Us
UM - Um
UY - Uy
UZ - Uz
VU - Vu
VE - Ve
VN - Vn
VG - Vg
VI - Vi
WF - Wf
EH - Eh
YE - Ye
ZM - Zm
ZW - Zw
AX - Ax

created

string

(date-time)

Timestamp when the utility account connection was created.

datasource

object

serializes external fields of Datasource.

1 Items

emails

array[]

Optional

List of email addresses the bill will be sent from for the EMAIL workflow type.

eventType

string

Type of event.

id

string

(uuid)

Unique identifier for the utility account connection.

old

object

Object with the old values of the connection. Same format as parent object.

protectedChanges

array[]

Tracks if there are any changes to any secure connection details.Array that may contain any of the following fields: username, password, securityQuestions.

status

string

Optional

Current status of the workflow, from list of pre-defined fields. Used to indicate if credentials are connected, incorrect, pending, requires mfa, etc.

MFA_TOKEN_EXPIRED - Mfa Token Expired
PASSWORD_INCORRECT - Password Incorrect
CONNECTED - Connected
PENDING - Pending
NEW_PASSWORD_NEEDED - New Password Needed
WEBSITE_DOWN - Website Down
PDF_DOWNLOAD_DOWN - Pdf Download Down

updated

string

(date-time)

Optional

Timestamp when the utility account connection was last updated.

url

string

Optional

URL of the utility company's login website.

Example

JSON

{
  "accounts": [
    {
      "accountNumber": "string",
      "datasourceTypes": [
        "string"
      ],
      "endDate": "2025-05-10",
      "isTracked": true,
      "startDate": "2025-05-10"
    }
  ],
  "company": {
    "externalId": "string",
    "id": "b492a1a8-4a95-4fd1-a80e-74acf4ca006d",
    "name": "string"
  },
  "country": "string",
  "created": "2025-05-10T00:41:17.399085912",
  "datasource": {
    "name": "string"
  },
  "emails": [
    "email"
  ],
  "eventType": "string",
  "id": "b0b935f9-cf91-4da7-b0b3-86d665532608",
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-05-10T00:41:17.399093962",
  "url": "string"
}

accounts

array[]

Optional

List of accounts associated with the connection.

company

object

Optional

Company associated with the connection.

country

string

Optional

Country of the utility company.

AF - Af
AL - Al
DZ - Dz
AS - As
AD - Ad
AO - Ao
AI - Ai
AQ - Aq
AG - Ag
AR - Ar
AM - Am
AW - Aw
AU - Au
AT - At
AZ - Az
BS - Bs
BH - Bh
BD - Bd
BB - Bb
BY - By
BE - Be
BZ - Bz
BJ - Bj
BM - Bm
BT - Bt
BO - Bo
BQ - Bq
BA - Ba
BW - Bw
BV - Bv
BR - Br
IO - Io
BN - Bn
BG - Bg
BF - Bf
BI - Bi
KH - Kh
CM - Cm
CA - Ca
CV - Cv
KY - Ky
CF - Cf
TD - Td
CL - Cl
CN - Cn
CX - Cx
CC - Cc
CO - Co
KM - Km
CG - Cg
CD - Cd
CK - Ck
CR - Cr
HR - Hr
CU - Cu
CW - Cw
CY - Cy
CZ - Cz
CI - Ci
DK - Dk
DJ - Dj
DM - Dm
DO - Do
EC - Ec
EG - Eg
SV - Sv
GQ - Gq
ER - Er
EE - Ee
ET - Et
FK - Fk
FO - Fo
FJ - Fj
FI - Fi
FR - Fr
GF - Gf
PF - Pf
TF - Tf
GA - Ga
GM - Gm
GE - Ge
DE - De
GH - Gh
GI - Gi
GR - Gr
GL - Gl
GD - Gd
GP - Gp
GU - Gu
GT - Gt
GG - Gg
GN - Gn
GW - Gw
GY - Gy
HT - Ht
HM - Hm
VA - Va
HN - Hn
HK - Hk
HU - Hu
IS - Is
IN - In
ID - Id
IR - Ir
IQ - Iq
IE - Ie
IM - Im
IL - Il
IT - It
JM - Jm
JP - Jp
JE - Je
JO - Jo
KZ - Kz
KE - Ke
KI - Ki
KP - Kp
KR - Kr
KW - Kw
KG - Kg
LA - La
LV - Lv
LB - Lb
LS - Ls
LR - Lr
LY - Ly
LI - Li
LT - Lt
LU - Lu
MO - Mo
MK - Mk
MG - Mg
MW - Mw
MY - My
MV - Mv
ML - Ml
MT - Mt
MH - Mh
MQ - Mq
MR - Mr
MU - Mu
YT - Yt
MX - Mx
FM - Fm
MD - Md
MC - Mc
MN - Mn
ME - Me
MS - Ms
MA - Ma
MZ - Mz
MM - Mm
NA - Na
NR - Nr
NP - Np
NL - Nl
NC - Nc
NZ - Nz
NI - Ni
NE - Ne
NG - Ng
NU - Nu
NF - Nf
MP - Mp
NO - No
OM - Om
PK - Pk
PW - Pw
PS - Ps
PA - Pa
PG - Pg
PY - Py
PE - Pe
PH - Ph
PN - Pn
PL - Pl
PT - Pt
PR - Pr
QA - Qa
RO - Ro
RU - Ru
RW - Rw
RE - Re
BL - Bl
SH - Sh
KN - Kn
LC - Lc
MF - Mf
PM - Pm
VC - Vc
WS - Ws
SM - Sm
ST - St
SA - Sa
SN - Sn
RS - Rs
SC - Sc
SL - Sl
SG - Sg
SX - Sx
SK - Sk
SI - Si
SB - Sb
SO - So
ZA - Za
GS - Gs
SS - Ss
ES - Es
LK - Lk
SD - Sd
SR - Sr
SJ - Sj
SZ - Sz
SE - Se
CH - Ch
SY - Sy
TW - Tw
TJ - Tj
TZ - Tz
TH - Th
TL - Tl
TG - Tg
TK - Tk
TO - To
TT - Tt
TN - Tn
TR - Tr
TM - Tm
TC - Tc
TV - Tv
UG - Ug
UA - Ua
AE - Ae
GB - Gb
US - Us
UM - Um
UY - Uy
UZ - Uz
VU - Vu
VE - Ve
VN - Vn
VG - Vg
VI - Vi
WF - Wf
EH - Eh
YE - Ye
ZM - Zm
ZW - Zw
AX - Ax

created

string

(date-time)

Timestamp when the utility account connection was created.

dataCollectionStartDate

string

(date)

Optional

Date when data collection for the workflow begins. This is the date from which Nectar will pull historical data. This field overrides the site and company level dataCollectionStartDate fields.

datasource

object

Optional

Datasource / utility provider associated with the connection.

eventType

string

Type of event.

id

string

(uuid)

Unique identifier for the utility account connection.

initialDatasourceTypes

array[]

Optional

Initial datasource types associated with this workflow. Initial datasource types are used to filter the workflows when the number of datasource types associated via accounts is 0.

initialSites

array[]

Optional

Initial sites associated with this connection. Initial sites are often useful to manually associate sites with the connection before the connection is validated or onboarded.

multiplyByOccupancy

boolean

Optional

Flag to indicate if data should be multiplied by occupancy.

old

object

Object with the old values of the connection. Same format as parent object.

protectedChanges

array[]

Tracks if there are any changes to any secure connection details.Array that may contain any of the following fields: username, password, securityQuestions.

status

string

Status of the connection.

updated

string

(date-time)

Optional

Timestamp when the utility account connection was last updated.

url

string

Optional

URL of the utility company's login website.

username

string

Optional

Username for the integration workflow.

workflowOwnerEmail

string

(email)

Optional

Utility login / data owner email address. This person will receive notifications if data is missing or if the utility data connection is misconfigured.

Example

JSON

{
  "accounts": [
    {
      "accountNumber": "string",
      "dataCollectionStartDate": "2025-12-05",
      "datasourceTypes": [
        "string"
      ],
      "id": "20054789-af05-45f0-b9b2-939ad68f43c9",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-12-05",
      "meters": [
        "0787161d-f47c-48b2-aaf4-57319ad159d3"
      ]
    }
  ],
  "country": "string",
  "created": "2025-12-05T22:07:09.434975745",
  "dataCollectionStartDate": "2025-12-05",
  "eventType": "string",
  "id": "4dcdc98b-b801-49af-b692-faed9c64752b",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "fd6eafae-1351-4982-bc1f-baee71b207e4"
  ],
  "multiplyByOccupancy": true,
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-12-05T22:07:09.435011910",
  "url": "string",
  "username": "string",
  "workflowOwnerEmail": "email"
}

accounts

array[]

company

object

Skeleton serializer for externally available fields of a Company object.

3 Items

country

string

Optional

Country of the utility company.

AF - Af
AL - Al
DZ - Dz
AS - As
AD - Ad
AO - Ao
AI - Ai
AQ - Aq
AG - Ag
AR - Ar
AM - Am
AW - Aw
AU - Au
AT - At
AZ - Az
BS - Bs
BH - Bh
BD - Bd
BB - Bb
BY - By
BE - Be
BZ - Bz
BJ - Bj
BM - Bm
BT - Bt
BO - Bo
BQ - Bq
BA - Ba
BW - Bw
BV - Bv
BR - Br
IO - Io
BN - Bn
BG - Bg
BF - Bf
BI - Bi
KH - Kh
CM - Cm
CA - Ca
CV - Cv
KY - Ky
CF - Cf
TD - Td
CL - Cl
CN - Cn
CX - Cx
CC - Cc
CO - Co
KM - Km
CG - Cg
CD - Cd
CK - Ck
CR - Cr
HR - Hr
CU - Cu
CW - Cw
CY - Cy
CZ - Cz
CI - Ci
DK - Dk
DJ - Dj
DM - Dm
DO - Do
EC - Ec
EG - Eg
SV - Sv
GQ - Gq
ER - Er
EE - Ee
ET - Et
FK - Fk
FO - Fo
FJ - Fj
FI - Fi
FR - Fr
GF - Gf
PF - Pf
TF - Tf
GA - Ga
GM - Gm
GE - Ge
DE - De
GH - Gh
GI - Gi
GR - Gr
GL - Gl
GD - Gd
GP - Gp
GU - Gu
GT - Gt
GG - Gg
GN - Gn
GW - Gw
GY - Gy
HT - Ht
HM - Hm
VA - Va
HN - Hn
HK - Hk
HU - Hu
IS - Is
IN - In
ID - Id
IR - Ir
IQ - Iq
IE - Ie
IM - Im
IL - Il
IT - It
JM - Jm
JP - Jp
JE - Je
JO - Jo
KZ - Kz
KE - Ke
KI - Ki
KP - Kp
KR - Kr
KW - Kw
KG - Kg
LA - La
LV - Lv
LB - Lb
LS - Ls
LR - Lr
LY - Ly
LI - Li
LT - Lt
LU - Lu
MO - Mo
MK - Mk
MG - Mg
MW - Mw
MY - My
MV - Mv
ML - Ml
MT - Mt
MH - Mh
MQ - Mq
MR - Mr
MU - Mu
YT - Yt
MX - Mx
FM - Fm
MD - Md
MC - Mc
MN - Mn
ME - Me
MS - Ms
MA - Ma
MZ - Mz
MM - Mm
NA - Na
NR - Nr
NP - Np
NL - Nl
NC - Nc
NZ - Nz
NI - Ni
NE - Ne
NG - Ng
NU - Nu
NF - Nf
MP - Mp
NO - No
OM - Om
PK - Pk
PW - Pw
PS - Ps
PA - Pa
PG - Pg
PY - Py
PE - Pe
PH - Ph
PN - Pn
PL - Pl
PT - Pt
PR - Pr
QA - Qa
RO - Ro
RU - Ru
RW - Rw
RE - Re
BL - Bl
SH - Sh
KN - Kn
LC - Lc
MF - Mf
PM - Pm
VC - Vc
WS - Ws
SM - Sm
ST - St
SA - Sa
SN - Sn
RS - Rs
SC - Sc
SL - Sl
SG - Sg
SX - Sx
SK - Sk
SI - Si
SB - Sb
SO - So
ZA - Za
GS - Gs
SS - Ss
ES - Es
LK - Lk
SD - Sd
SR - Sr
SJ - Sj
SZ - Sz
SE - Se
CH - Ch
SY - Sy
TW - Tw
TJ - Tj
TZ - Tz
TH - Th
TL - Tl
TG - Tg
TK - Tk
TO - To
TT - Tt
TN - Tn
TR - Tr
TM - Tm
TC - Tc
TV - Tv
UG - Ug
UA - Ua
AE - Ae
GB - Gb
US - Us
UM - Um
UY - Uy
UZ - Uz
VU - Vu
VE - Ve
VN - Vn
VG - Vg
VI - Vi
WF - Wf
EH - Eh
YE - Ye
ZM - Zm
ZW - Zw
AX - Ax

created

string

(date-time)

Timestamp when the utility account connection was created.

datasource

object

serializes external fields of Datasource.

1 Items

emails

array[]

Optional

List of email addresses the bill will be sent from for the EMAIL workflow type.

eventType

string

Type of event.

id

string

(uuid)

Unique identifier for the utility account connection.

old

object

Object with the old values of the connection. Same format as parent object.

protectedChanges

array[]

Tracks if there are any changes to any secure connection details.Array that may contain any of the following fields: username, password, securityQuestions.

status

string

Optional

Current status of the workflow, from list of pre-defined fields. Used to indicate if credentials are connected, incorrect, pending, requires mfa, etc.

MFA_TOKEN_EXPIRED - Mfa Token Expired
PASSWORD_INCORRECT - Password Incorrect
CONNECTED - Connected
PENDING - Pending
NEW_PASSWORD_NEEDED - New Password Needed
WEBSITE_DOWN - Website Down
PDF_DOWNLOAD_DOWN - Pdf Download Down

updated

string

(date-time)

Optional

Timestamp when the utility account connection was last updated.

url

string

Optional

URL of the utility company's login website.

Example

JSON

{
  "accounts": [
    {
      "accountNumber": "string",
      "datasourceTypes": [
        "string"
      ],
      "endDate": "2025-05-10",
      "isTracked": true,
      "startDate": "2025-05-10"
    }
  ],
  "company": {
    "externalId": "string",
    "id": "c559fcfe-3b78-47a1-acfb-55a2880518fa",
    "name": "string"
  },
  "country": "string",
  "created": "2025-05-10T00:41:17.399683496",
  "datasource": {
    "name": "string"
  },
  "emails": [
    "email"
  ],
  "eventType": "string",
  "id": "73ca7bb7-5f5c-48c2-ac24-db17cc09f221",
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-05-10T00:41:17.399690926",
  "url": "string"
}

accounts

array[]

Optional

List of accounts associated with the connection.

company

object

Optional

Company associated with the connection.

country

string

Optional

Country of the utility company.

AF - Af
AL - Al
DZ - Dz
AS - As
AD - Ad
AO - Ao
AI - Ai
AQ - Aq
AG - Ag
AR - Ar
AM - Am
AW - Aw
AU - Au
AT - At
AZ - Az
BS - Bs
BH - Bh
BD - Bd
BB - Bb
BY - By
BE - Be
BZ - Bz
BJ - Bj
BM - Bm
BT - Bt
BO - Bo
BQ - Bq
BA - Ba
BW - Bw
BV - Bv
BR - Br
IO - Io
BN - Bn
BG - Bg
BF - Bf
BI - Bi
KH - Kh
CM - Cm
CA - Ca
CV - Cv
KY - Ky
CF - Cf
TD - Td
CL - Cl
CN - Cn
CX - Cx
CC - Cc
CO - Co
KM - Km
CG - Cg
CD - Cd
CK - Ck
CR - Cr
HR - Hr
CU - Cu
CW - Cw
CY - Cy
CZ - Cz
CI - Ci
DK - Dk
DJ - Dj
DM - Dm
DO - Do
EC - Ec
EG - Eg
SV - Sv
GQ - Gq
ER - Er
EE - Ee
ET - Et
FK - Fk
FO - Fo
FJ - Fj
FI - Fi
FR - Fr
GF - Gf
PF - Pf
TF - Tf
GA - Ga
GM - Gm
GE - Ge
DE - De
GH - Gh
GI - Gi
GR - Gr
GL - Gl
GD - Gd
GP - Gp
GU - Gu
GT - Gt
GG - Gg
GN - Gn
GW - Gw
GY - Gy
HT - Ht
HM - Hm
VA - Va
HN - Hn
HK - Hk
HU - Hu
IS - Is
IN - In
ID - Id
IR - Ir
IQ - Iq
IE - Ie
IM - Im
IL - Il
IT - It
JM - Jm
JP - Jp
JE - Je
JO - Jo
KZ - Kz
KE - Ke
KI - Ki
KP - Kp
KR - Kr
KW - Kw
KG - Kg
LA - La
LV - Lv
LB - Lb
LS - Ls
LR - Lr
LY - Ly
LI - Li
LT - Lt
LU - Lu
MO - Mo
MK - Mk
MG - Mg
MW - Mw
MY - My
MV - Mv
ML - Ml
MT - Mt
MH - Mh
MQ - Mq
MR - Mr
MU - Mu
YT - Yt
MX - Mx
FM - Fm
MD - Md
MC - Mc
MN - Mn
ME - Me
MS - Ms
MA - Ma
MZ - Mz
MM - Mm
NA - Na
NR - Nr
NP - Np
NL - Nl
NC - Nc
NZ - Nz
NI - Ni
NE - Ne
NG - Ng
NU - Nu
NF - Nf
MP - Mp
NO - No
OM - Om
PK - Pk
PW - Pw
PS - Ps
PA - Pa
PG - Pg
PY - Py
PE - Pe
PH - Ph
PN - Pn
PL - Pl
PT - Pt
PR - Pr
QA - Qa
RO - Ro
RU - Ru
RW - Rw
RE - Re
BL - Bl
SH - Sh
KN - Kn
LC - Lc
MF - Mf
PM - Pm
VC - Vc
WS - Ws
SM - Sm
ST - St
SA - Sa
SN - Sn
RS - Rs
SC - Sc
SL - Sl
SG - Sg
SX - Sx
SK - Sk
SI - Si
SB - Sb
SO - So
ZA - Za
GS - Gs
SS - Ss
ES - Es
LK - Lk
SD - Sd
SR - Sr
SJ - Sj
SZ - Sz
SE - Se
CH - Ch
SY - Sy
TW - Tw
TJ - Tj
TZ - Tz
TH - Th
TL - Tl
TG - Tg
TK - Tk
TO - To
TT - Tt
TN - Tn
TR - Tr
TM - Tm
TC - Tc
TV - Tv
UG - Ug
UA - Ua
AE - Ae
GB - Gb
US - Us
UM - Um
UY - Uy
UZ - Uz
VU - Vu
VE - Ve
VN - Vn
VG - Vg
VI - Vi
WF - Wf
EH - Eh
YE - Ye
ZM - Zm
ZW - Zw
AX - Ax

created

string

(date-time)

Timestamp when the utility account connection was created.

dataCollectionStartDate

string

(date)

Optional

Date when data collection for the workflow begins. This is the date from which Nectar will pull historical data. This field overrides the site and company level dataCollectionStartDate fields.

datasource

object

Optional

Datasource / utility provider associated with the connection.

eventType

string

Type of event.

id

string

(uuid)

Unique identifier for the utility account connection.

initialDatasourceTypes

array[]

Optional

Initial datasource types associated with this workflow. Initial datasource types are used to filter the workflows when the number of datasource types associated via accounts is 0.

initialSites

array[]

Optional

Initial sites associated with this connection. Initial sites are often useful to manually associate sites with the connection before the connection is validated or onboarded.

multiplyByOccupancy

boolean

Optional

Flag to indicate if data should be multiplied by occupancy.

old

object

Object with the old values of the connection. Same format as parent object.

protectedChanges

array[]

Tracks if there are any changes to any secure connection details.Array that may contain any of the following fields: username, password, securityQuestions.

status

string

Status of the connection.

updated

string

(date-time)

Optional

Timestamp when the utility account connection was last updated.

url

string

Optional

URL of the utility company's login website.

username

string

Optional

Username for the integration workflow.

workflowOwnerEmail

string

(email)

Optional

Utility login / data owner email address. This person will receive notifications if data is missing or if the utility data connection is misconfigured.

Example

JSON

{
  "accounts": [
    {
      "accountNumber": "string",
      "dataCollectionStartDate": "2025-12-05",
      "datasourceTypes": [
        "string"
      ],
      "id": "435f9080-11b2-41c7-abe9-f54d3a21cfb0",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-12-05",
      "meters": [
        "fb9e71b2-17b5-4290-8c1d-903cb92a2b80"
      ]
    }
  ],
  "country": "string",
  "created": "2025-12-05T22:07:09.438731900",
  "dataCollectionStartDate": "2025-12-05",
  "eventType": "string",
  "id": "3e3a8dbf-5bec-4a11-9491-8907a7975551",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "24dc4a57-a2f3-4f59-ac20-b863634ec109"
  ],
  "multiplyByOccupancy": true,
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-12-05T22:07:09.438774820",
  "url": "string",
  "username": "string",
  "workflowOwnerEmail": "email"
}

afterPreviousCharges

string

(decimal)

Optional

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.

afterPreviousCredits

string

(decimal)

Optional

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.

afterPreviousTotalPayment

string

(decimal)

Optional

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.

auditTrailUrl

string

URL to view the audit trail of the document on Nectar's platform. Includes side-by-side view of Nectar's parsed data vs. the original raw document and the edit history.

chargesUnits

string

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

company

object

Skeleton serializer for externally available fields of a Company object.

3 Items

created

string

(date-time)

Timestamp when the document was created.

credits

string

(decimal)

Optional

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

currentCharges

string

(decimal)

Optional

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

currentOpenBalance

string

(decimal)

Optional

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

documentDate

string

(date)

Date of the document associated with the usage data.

dueDate

string

(date)

Optional

Due date from the bill.

electricityDeliveryCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity delivery/distribution charges

electricityDemandCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity demand charges

electricitySupplyCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity supply charges

eventType

string

Type of event.

gasDeliveryCharges

string

(decimal)

Optional

[GAS] Total gas delivery/distribution charges

gasSupplyCharges

string

(decimal)

Optional

[GAS] Total gas supply charges

id

string

(uuid)

Unique identifier for the document.

interestCharges

string

(decimal)

Optional

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

invoiceId

string

Optional

Invoice ID from the bill.

isFlagged

boolean

Optional

Indicates if the document is flagged.

lineItems

array[]

meterSiteUsageData

array[]

notes

string

Optional

Additional notes related to the document.

previousCloseBalance

string

(decimal)

Optional

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

processedDate

string

(date-time)

Date when the document was processed in the system.

revisedDocumentId

string

ID of the document that revises this one.

sourceType

string

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

supersededDocumentIds

array[]

List of IDs of the documents that this document revises.

taxCharges

string

(decimal)

Optional

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.

totalCharges

string

(decimal)

Optional

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.

url

string

Presigned URL for accessing the document stored in S3. URL expires in 1 day.

utilityCompany

string

Name of the utility company providing the service.

Example

JSON

{
  "afterPreviousCharges": "decimal",
  "afterPreviousCredits": "decimal",
  "afterPreviousTotalPayment": "decimal",
  "auditTrailUrl": "string",
  "chargesUnits": "string",
  "company": {
    "externalId": "string",
    "id": "4ee0cb09-f4ce-4fa9-8722-d102afc161fa",
    "name": "string"
  },
  "created": "2025-05-10T00:41:17.399982233",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "documentDate": "2025-05-10",
  "dueDate": "2025-05-10",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "eventType": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "9673acab-8c19-4ff0-9c75-1029079263f8",
  "interestCharges": "decimal",
  "invoiceId": "string",
  "isFlagged": true,
  "lineItems": [
    {
      "accountIds": [
        "string"
      ],
      "billingPeriod": "string",
      "chargeType": "string",
      "description": "string",
      "electricityChargeType": "string",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "string",
      "gasChargeType": "string",
      "meterIds": [
        "string"
      ],
      "multipliers": [
        "decimal"
      ],
      "quantity": "decimal",
      "quantityUnits": "string",
      "rate": "decimal",
      "totalCharge": "decimal"
    }
  ],
  "meterSiteUsageData": [
    {
      "accountId": "string",
      "accountIsTracked": true,
      "additionalFields": {},
      "auditTrailUrl": "string",
      "billedDemand": "decimal",
      "created": "2025-05-10T00:41:17.400026715",
      "currentReading": "decimal",
      "customContainerName": "string",
      "customContainerSize": "decimal",
      "customContainerUnits": "string",
      "customContainerUsage": "decimal",
      "datasourceType": "string",
      "daysInRange": 42,
      "documentDate": "2025-05-10",
      "documentId": "ee1fbd0a-7bc4-474c-b986-7384ea9138a7",
      "documentNotes": "string",
      "documentSourceType": "string",
      "endDate": "2025-05-10",
      "exclusion": true,
      "icp": "string",
      "id": "7c3a7372-8ec4-4a52-aeea-fb4bf1fad811",
      "identifiers": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "isEstimated": true,
      "isFlagged": true,
      "isImplied": true,
      "meterId": "string",
      "podId": "string",
      "previousReading": "decimal",
      "processedDate": "2025-05-10T00:41:17.400049665",
      "shopNumber": "string",
      "siteAddress": "string",
      "siteExternalId": "string",
      "siteId": "0e0fa7dc-aa3f-4394-a05f-db22e113db83",
      "siteName": "string",
      "startDate": "2025-05-10",
      "submeterId": "string",
      "supplierName": "string",
      "tariff": "string",
      "totalDocumentCharges": "decimal",
      "totalDocumentChargesUnits": "string",
      "updated": "2025-05-10T00:41:17.400063215",
      "usage": "string",
      "usageUnits": "string",
      "utilityCompany": "string"
    }
  ],
  "notes": "string",
  "previousCloseBalance": "decimal",
  "processedDate": "2025-05-10T00:41:17.400079966",
  "revisedDocumentId": "string",
  "sourceType": "string",
  "supersededDocumentIds": [
    "string"
  ],
  "taxCharges": "decimal",
  "totalCharges": "decimal",
  "url": "string",
  "utilityCompany": "string"
}

afterPreviousCharges

string

(decimal)

Optional

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.

afterPreviousCredits

string

(decimal)

Optional

afterPreviousTotalPayment

string

(decimal)

Optional

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.

auditTrailUrl

string

URL to view the audit trail of the document on Nectar's platform. Includes side-by-side view of Nectar's parsed data vs. the original raw document and the edit history.

billDate

string

(date)

Date of the bill.

chargesUnits

string

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

company

string

(uuid)

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

created

string

(date-time)

Timestamp when the document was created.

credits

string

(decimal)

Optional

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

currentCharges

string

(decimal)

Optional

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

currentOpenBalance

string

(decimal)

Optional

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

dueDate

string

(date)

Optional

Due date from the bill.

electricityDeliveryCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity delivery/distribution charges

electricityDemandCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity demand charges

electricitySupplyCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity supply charges

email

string

(email)

Optional

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 admin@nectarclimate.com if document was scraped by Nectar.

eventType

string

Type of event.

fileName

string

Optional

Original name of the file uploaded or downloaded.

flaggedStatus

string

Status of the flagged document.

gasDeliveryCharges

string

(decimal)

Optional

[GAS] Total gas delivery/distribution charges

gasSupplyCharges

string

(decimal)

Optional

[GAS] Total gas supply charges

id

string

(uuid)

Unique identifier for the document.

interestCharges

string

(decimal)

Optional

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

invoiceId

string

Optional

Invoice ID from the bill.

isFlagged

boolean

Optional

Indicates if the document is flagged.

jobId

string

Optional

The ID of the job that processed the document.

lineItems

array[]

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

notes

string

Optional

Additional notes related to the document.

previousCloseBalance

string

(decimal)

Optional

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

revisedDocumentId

string

ID of the document that revises this one.

sourceType

string

Optional

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

status

string

Custom status name assigned to the document by the company, if set.

supersededDocumentIds

array[]

List of IDs of the documents that this document revises.

taxCharges

string

(decimal)

Optional

totalCharges

string

(decimal)

Optional

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.

updated

string

(date-time)

Optional

Timestamp when the document was last updated.

url

string

Presigned URL for accessing the document stored in S3. URL expires in 1 day.

usageData

array[]

List of usage data entries associated with this document.

utilityCompany

string

Name of the utility company providing the service.

Example

JSON

{
  "afterPreviousCharges": "decimal",
  "afterPreviousCredits": "decimal",
  "afterPreviousTotalPayment": "decimal",
  "auditTrailUrl": "string",
  "billDate": "2025-12-05",
  "chargesUnits": "string",
  "company": "d1e5bfbe-bcac-4670-9bb6-0275190c5c3c",
  "created": "2025-12-05T22:07:09.439236244",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "dueDate": "2025-12-05",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "email": "email",
  "eventType": "string",
  "fileName": "string",
  "flaggedStatus": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "b16ef6e2-7c64-4ad5-8664-e64ac4241026",
  "interestCharges": "decimal",
  "invoiceId": "string",
  "isFlagged": true,
  "jobId": "string",
  "lineItems": [
    {
      "accountIds": [
        "string"
      ],
      "description": "string",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "string",
      "multipliers": [
        "decimal"
      ],
      "quantity": "decimal",
      "quantityUnits": "string",
      "rate": "decimal",
      "totalCharge": "decimal"
    }
  ],
  "notes": "string",
  "previousCloseBalance": "decimal",
  "revisedDocumentId": "string",
  "sourceType": "string",
  "status": "string",
  "supersededDocumentIds": [
    "string"
  ],
  "taxCharges": "decimal",
  "totalCharges": "decimal",
  "updated": "2025-12-05T22:07:09.439295154",
  "url": "string",
  "usageData": [
    {
      "additionalFields": {},
      "billedDemand": "decimal",
      "country": "string",
      "created": "2025-12-05T22:07:09.439432026",
      "currentReading": "decimal",
      "endDate": "2025-12-05",
      "exclusion": true,
      "fractionRenewable": "decimal",
      "id": "cd84d4c7-7665-4e54-85c7-bea5856ea331",
      "identifiers": [
        {
          "name": "string",
          "rawName": "string",
          "value": "string"
        }
      ],
      "isEstimated": true,
      "isImplied": true,
      "meter": "string",
      "meterAddress": "string",
      "meterIsTracked": true,
      "multiplier": "decimal",
      "multiplier2": "decimal",
      "multiplier2Description": "string",
      "multiplierDescription": "string",
      "netMeteringGeneratedKwh": "decimal",
      "netMeteringGridExportKwh": "decimal",
      "netMeteringGridImportKwh": "decimal",
      "previousReading": "decimal",
      "serviceAddress": "string",
      "startDate": "2025-12-05",
      "supplierName": "string",
      "tariff": "string",
      "updated": "2025-12-05T22:07:09.439470724",
      "usage": "string",
      "utilityName": "string",
      "wasteDescription": "string",
      "wasteStream": "string",
      "wasteType": "string"
    }
  ],
  "utilityCompany": "string"
}

afterPreviousCharges

string

(decimal)

Optional

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.

afterPreviousCredits

string

(decimal)

Optional

afterPreviousTotalPayment

string

(decimal)

Optional

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.

auditTrailUrl

string

URL to view the audit trail of the document on Nectar's platform. Includes side-by-side view of Nectar's parsed data vs. the original raw document and the edit history.

chargesUnits

string

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

company

object

Skeleton serializer for externally available fields of a Company object.

3 Items

created

string

(date-time)

Timestamp when the document was created.

credits

string

(decimal)

Optional

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

currentCharges

string

(decimal)

Optional

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

currentOpenBalance

string

(decimal)

Optional

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

documentDate

string

(date)

Date of the document associated with the usage data.

dueDate

string

(date)

Optional

Due date from the bill.

electricityDeliveryCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity delivery/distribution charges

electricityDemandCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity demand charges

electricitySupplyCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity supply charges

eventType

string

Type of event.

gasDeliveryCharges

string

(decimal)

Optional

[GAS] Total gas delivery/distribution charges

gasSupplyCharges

string

(decimal)

Optional

[GAS] Total gas supply charges

id

string

(uuid)

Unique identifier for the document.

interestCharges

string

(decimal)

Optional

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

invoiceId

string

Optional

Invoice ID from the bill.

isFlagged

boolean

Optional

Indicates if the document is flagged.

lineItems

array[]

meterSiteUsageData

array[]

notes

string

Optional

Additional notes related to the document.

old

object

Object with the old values of the document. Same format as parent object.

previousCloseBalance

string

(decimal)

Optional

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

processedDate

string

(date-time)

Date when the document was processed in the system.

revisedDocumentId

string

ID of the document that revises this one.

sourceType

string

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

supersededDocumentIds

array[]

List of IDs of the documents that this document revises.

taxCharges

string

(decimal)

Optional

totalCharges

string

(decimal)

Optional

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.

url

string

Presigned URL for accessing the document stored in S3. URL expires in 1 day.

utilityCompany

string

Name of the utility company providing the service.

Example

JSON

{
  "afterPreviousCharges": "decimal",
  "afterPreviousCredits": "decimal",
  "afterPreviousTotalPayment": "decimal",
  "auditTrailUrl": "string",
  "chargesUnits": "string",
  "company": {
    "externalId": "string",
    "id": "e9a82440-66e9-486a-90f7-4054e53ef793",
    "name": "string"
  },
  "created": "2025-05-10T00:41:17.402149345",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "documentDate": "2025-05-10",
  "dueDate": "2025-05-10",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "eventType": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "d730cd17-75a7-4ff4-8af0-850461749301",
  "interestCharges": "decimal",
  "invoiceId": "string",
  "isFlagged": true,
  "lineItems": [
    {
      "accountIds": [
        "string"
      ],
      "billingPeriod": "string",
      "chargeType": "string",
      "description": "string",
      "electricityChargeType": "string",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "string",
      "gasChargeType": "string",
      "meterIds": [
        "string"
      ],
      "multipliers": [
        "decimal"
      ],
      "quantity": "decimal",
      "quantityUnits": "string",
      "rate": "decimal",
      "totalCharge": "decimal"
    }
  ],
  "meterSiteUsageData": [
    {
      "accountId": "string",
      "accountIsTracked": true,
      "additionalFields": {},
      "auditTrailUrl": "string",
      "billedDemand": "decimal",
      "created": "2025-05-10T00:41:17.402195166",
      "currentReading": "decimal",
      "customContainerName": "string",
      "customContainerSize": "decimal",
      "customContainerUnits": "string",
      "customContainerUsage": "decimal",
      "datasourceType": "string",
      "daysInRange": 42,
      "documentDate": "2025-05-10",
      "documentId": "3ca0b273-3de6-480d-b751-109218be3584",
      "documentNotes": "string",
      "documentSourceType": "string",
      "endDate": "2025-05-10",
      "exclusion": true,
      "icp": "string",
      "id": "b6091ede-7e9e-422e-9335-277c98d94c4f",
      "identifiers": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "isEstimated": true,
      "isFlagged": true,
      "isImplied": true,
      "meterId": "string",
      "podId": "string",
      "previousReading": "decimal",
      "processedDate": "2025-05-10T00:41:17.402217447",
      "shopNumber": "string",
      "siteAddress": "string",
      "siteExternalId": "string",
      "siteId": "8be64e22-8b82-484b-97b5-6ae04778874d",
      "siteName": "string",
      "startDate": "2025-05-10",
      "submeterId": "string",
      "supplierName": "string",
      "tariff": "string",
      "totalDocumentCharges": "decimal",
      "totalDocumentChargesUnits": "string",
      "updated": "2025-05-10T00:41:17.402230587",
      "usage": "string",
      "usageUnits": "string",
      "utilityCompany": "string"
    }
  ],
  "notes": "string",
  "previousCloseBalance": "decimal",
  "processedDate": "2025-05-10T00:41:17.402248308",
  "revisedDocumentId": "string",
  "sourceType": "string",
  "supersededDocumentIds": [
    "string"
  ],
  "taxCharges": "decimal",
  "totalCharges": "decimal",
  "url": "string",
  "utilityCompany": "string"
}

afterPreviousCharges

string

(decimal)

Optional

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.

afterPreviousCredits

string

(decimal)

Optional

afterPreviousTotalPayment

string

(decimal)

Optional

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.

auditTrailUrl

string

URL to view the audit trail of the document on Nectar's platform. Includes side-by-side view of Nectar's parsed data vs. the original raw document and the edit history.

billDate

string

(date)

Date of the bill.

chargesUnits

string

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

company

string

(uuid)

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

created

string

(date-time)

Timestamp when the document was created.

credits

string

(decimal)

Optional

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

currentCharges

string

(decimal)

Optional

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

currentOpenBalance

string

(decimal)

Optional

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

dueDate

string

(date)

Optional

Due date from the bill.

electricityDeliveryCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity delivery/distribution charges

electricityDemandCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity demand charges

electricitySupplyCharges

string

(decimal)

Optional

[ELECTRICITY] Total electricity supply charges

email

string

(email)

Optional

eventType

string

Type of event.

fileName

string

Optional

Original name of the file uploaded or downloaded.

flaggedStatus

string

Status of the flagged document.

gasDeliveryCharges

string

(decimal)

Optional

[GAS] Total gas delivery/distribution charges

gasSupplyCharges

string

(decimal)

Optional

[GAS] Total gas supply charges

id

string

(uuid)

Unique identifier for the document.

interestCharges

string

(decimal)

Optional

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

invoiceId

string

Optional

Invoice ID from the bill.

isFlagged

boolean

Optional

Indicates if the document is flagged.

jobId

string

Optional

The ID of the job that processed the document.

lineItems

array[]

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

notes

string

Optional

Additional notes related to the document.

old

object

Object with the old values of the document. Same format as parent object.

previousCloseBalance

string

(decimal)

Optional

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

revisedDocumentId

string

ID of the document that revises this one.

sourceType

string

Optional

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

status

string

Custom status name assigned to the document by the company, if set.

supersededDocumentIds

array[]

List of IDs of the documents that this document revises.

taxCharges

string

(decimal)

Optional

totalCharges

string

(decimal)

Optional

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.

updated

string

(date-time)

Optional

Timestamp when the document was last updated.

url

string

Presigned URL for accessing the document stored in S3. URL expires in 1 day.

usageData

array[]

List of usage data entries associated with this document.

utilityCompany

string

Name of the utility company providing the service.

Example

JSON

{
  "afterPreviousCharges": "decimal",
  "afterPreviousCredits": "decimal",
  "afterPreviousTotalPayment": "decimal",
  "auditTrailUrl": "string",
  "billDate": "2025-12-05",
  "chargesUnits": "string",
  "company": "0d483b9f-b3ba-46b5-a7fb-d2d965f5fba4",
  "created": "2025-12-05T22:07:09.443980458",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "dueDate": "2025-12-05",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "email": "email",
  "eventType": "string",
  "fileName": "string",
  "flaggedStatus": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "eb0148d8-3c7e-4c63-b68c-560fef59ea66",
  "interestCharges": "decimal",
  "invoiceId": "string",
  "isFlagged": true,
  "jobId": "string",
  "lineItems": [
    {
      "accountIds": [
        "string"
      ],
      "description": "string",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "string",
      "multipliers": [
        "decimal"
      ],
      "quantity": "decimal",
      "quantityUnits": "string",
      "rate": "decimal",
      "totalCharge": "decimal"
    }
  ],
  "notes": "string",
  "previousCloseBalance": "decimal",
  "revisedDocumentId": "string",
  "sourceType": "string",
  "status": "string",
  "supersededDocumentIds": [
    "string"
  ],
  "taxCharges": "decimal",
  "totalCharges": "decimal",
  "updated": "2025-12-05T22:07:09.444109687",
  "url": "string",
  "usageData": [
    {
      "additionalFields": {},
      "billedDemand": "decimal",
      "country": "string",
      "created": "2025-12-05T22:07:09.444202435",
      "currentReading": "decimal",
      "endDate": "2025-12-05",
      "exclusion": true,
      "fractionRenewable": "decimal",
      "id": "57889868-a1ea-45c2-9090-936d643180e0",
      "identifiers": [
        {
          "name": "string",
          "rawName": "string",
          "value": "string"
        }
      ],
      "isEstimated": true,
      "isImplied": true,
      "meter": "string",
      "meterAddress": "string",
      "meterIsTracked": true,
      "multiplier": "decimal",
      "multiplier2": "decimal",
      "multiplier2Description": "string",
      "multiplierDescription": "string",
      "netMeteringGeneratedKwh": "decimal",
      "netMeteringGridExportKwh": "decimal",
      "netMeteringGridImportKwh": "decimal",
      "previousReading": "decimal",
      "serviceAddress": "string",
      "startDate": "2025-12-05",
      "supplierName": "string",
      "tariff": "string",
      "updated": "2025-12-05T22:07:09.444242688",
      "usage": "string",
      "utilityName": "string",
      "wasteDescription": "string",
      "wasteStream": "string",
      "wasteType": "string"
    }
  ],
  "utilityCompany": "string"
}

Nectar Webhook Event Types

Event Types

connection.created

accounts

company

country

created

datasource

emails

eventType

id

status

updated

url

connection.created.v2

accounts

company

country

created

dataCollectionStartDate

datasource

eventType

id

initialDatasourceTypes

initialSites

multiplyByOccupancy

status

updated

url

username

workflowOwnerEmail

connection.updated

accounts

company

country

created

datasource

emails

eventType

id

old

protectedChanges

status

updated

url

connection.updated.v2

accounts

company

country

created

dataCollectionStartDate

datasource

eventType

id

initialDatasourceTypes

initialSites

multiplyByOccupancy

old

protectedChanges

status

updated

url

username

workflowOwnerEmail

connection.validated

accounts

company

country

created

datasource

emails

eventType

id

old

protectedChanges

status

updated

url

connection.validated.v2

accounts