Invoice

idstring

numberstringnullable

statusstring

amountDueCentsinteger

amountPaidCentsinteger

currencystring

periodStartstring<date-time>nullable

periodEndstring<date-time>nullable

hostedUrlstringnullable

pdfUrlstringnullable

paidAtstring<date-time>nullable

nfse objectnullable

The Brazilian service invoice issued for this charge, or null. It only appears once the note has been issued: an emission in progress or one that failed is our problem, not news for whoever paid.

idstring

numberstringnullable

seriestringnullable

issuedAtstring<date-time>nullable

linkstringnullable

The city hall's public page for the note.

hasPdfboolean

hasXmlboolean

Invoice

{
  "id": "string",
  "number": "string",
  "status": "string",
  "amountDueCents": 0,
  "amountPaidCents": 0,
  "currency": "string",
  "periodStart": "2024-07-29T15:51:28.071Z",
  "periodEnd": "2024-07-29T15:51:28.071Z",
  "hostedUrl": "string",
  "pdfUrl": "string",
  "paidAt": "2024-07-29T15:51:28.071Z",
  "nfse": {
    "id": "string",
    "number": "string",
    "serie": "string",
    "issuedAt": "2024-07-29T15:51:28.071Z",
    "link": "string",
    "hasPdf": true,
    "hasXml": true
  }
}