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 Uncollected

Defines the status of a billing invoice.

Draft Issued PaymentPending Paid PaymentFailed Cancelled Uncollected

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.

invoiceDatestring

The invoice date (UTC): when it was issued, or an imported invoice's own date. Null on a draft.

The invoice date (UTC): when it was issued, or an imported invoice's own date. Null on a draft.

createdDatestring

When Account Hub created the record (a draft opens when its first line arrives).

When Account Hub created the record (a draft opens when its first line arrives).

accountingInvoiceAccountingLinkResponse
sourceApplicationCodestring

The application that raised an imported invoice, which Account Hub only records; null for
Account Hub's own invoices.

The application that raised an imported invoice, which Account Hub only records; null for
Account Hub's own invoices.

JSON Example

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

Contained in Schemas