invoiceResponse

apiVersionapiVersion (string)required

Example: 1.0

data objectrequired

Base64-encoded ZIP archive containing one invoice PDF and, when invoice detail rows are available, both JSON and CSV detail files for the same BAN and date.

banban (string)required

Customer billing account number. Often numeric, but not constrained to five digits.

Possible values: non-empty and <= 255 characters

Examples:

Example 1

Example: 34566

Example 2

Example: 1-TrazDemo

invoiceDatestring<date>required

fileNamestringrequired

Name of the ZIP archive.

contentTypestringrequired

Constant value: application/zip

files object[]required

Manifest of files included in the ZIP archive. The invoice PDF is always present. When invoice detail is available, the JSON and CSV detail files are both included.

Possible values: >= 1

Array [

fileNamestringrequired

File name inside the ZIP archive.

contentTypestringrequired

Possible values: [application/pdf, application/json, text/csv]

artifactTypestringrequired

Possible values: [invoicePdf, invoiceDetailJson, invoiceDetailCsv]

]

fileContentstring<byte>required

Base64-encoded ZIP archive.

invoiceResponse

{
  "apiVersion": "1.0",
  "data": {
    "ban": "34566",
    "invoiceDate": "2024-07-29",
    "fileName": "string",
    "contentType": "application/zip",
    "files": [
      {
        "fileName": "string",
        "contentType": "application/pdf",
        "artifactType": "invoicePdf"
      }
    ],
    "fileContent": "string"
  }
}