API Docs / Schemas / InvoiceSummaryResponse

InvoiceSummaryResponse

Summary response model for listing invoices (without line items).

Properties

Name Type Description
code*string

The unique code identifier for the invoice.

The unique code identifier for the invoice.

invoiceNumber*string

The customer-facing invoice number.

The customer-facing invoice number.

statusenum

Defines the status of a billing invoice.

Draft Issued PaymentPending Paid PaymentFailed Cancelled

Defines the status of a billing invoice.

Draft Issued PaymentPending Paid PaymentFailed Cancelled

totalAmountnumber

The total amount of the invoice (subtotal + VAT) in pounds.

The total amount of the invoice (subtotal + VAT) in pounds.

dueDatestring

The date when payment is due.

The date when payment is due.

pdfBlobUrlstring

Time-limited URL for downloading the invoice PDF. Null if PDF has not been generated.

Time-limited URL for downloading the invoice PDF. Null if PDF has not been generated.

createdDatestring

The date and time when the invoice was created.

The date and time when the invoice was created.

JSON Example

{
  "code": "string",
  "invoiceNumber": "string",
  "status": "Draft",
  "totalAmount": 0,
  "dueDate": "2024-01-01"
}

Contained in Schemas