Sign in

v1

latestOpenAPI 3.1.02026-08-0670151364.9 KB
Invoices

Create an invoice

post/invoices

Request body

invoiceNostring

The unique number of the invoice. Acts as an idempotency key. Will be generated if not provided.

descriptionstring

A short description or summary of the invoice.

amountnumber

The invoice amount.

dueDatestring date-time

The due date for the invoice payment.

issueDatestring date-time

The date the invoice is issued.

itemsTaxType'EXCLUSIVE' | 'INCLUSIVE' | 'NONE'

How tax is applied to line items from the invoice

officeIdstring uuid

The unique identifier of the office associated with this invoice.

Example request

{
  "invoiceNo": "INV-12345",
  "customer": {
    "id": "80349480-490b-4234-92e7-fad697e3d446"
  },
  "description": "Monthly subscription fee for January",
  "dueDate": "2025-12-15T23:59:59.000Z",
  "issueDate": "2025-12-15T23:59:59.000Z",
  "items": [
    {
      "taxRateId": "d4f1c2b3-4a5b-678c-9d0e-f1a2b3c4d5e6",
      "productId": "d4f1c2b3-4a5b-678c-9d0e-f1a2b3c4d5e6"
    }
  ],
  "paymentRequests": [
    {
      "amount": 100,
      "payByDate": "2025-03-25T11:36:55.243Z"
    }
  ],
  "officeId": "80349480-490b-4234-92e7-fad697e3d446"
}

Response

The request was successful and the invoice was created.

idstring

The internal id of the invoice

invoiceNostring

The number of the invoice. Can be empty when creating the invoice without an invoice number,but it will be automatically generated when the invoice is pushed to an accounting software. Once set, serves as a unique value that can be used as an idempotency key.

descriptionstring

Short description of the invoice

totalAmountstring

The invoice total amount. Includes tax amount, amount paid or reduced with credit notes)

taxAmountstring

The invoice tax amount.

dueAmountstring

The invoice amount due (remaining to be paid).

creditNotesAmountstring

The total amount that is credited.

dueDatestring date-time

The due date of the invoice

issueDatestring date-time

The issue date date of the invoice

creationTimestring date-time

The date the invoice was created

lastUpdatedTimestring date-time

The date the invoice was last updated

paidTimestring date-time

The date the invoice was paid

status'DRAFT' | 'UNPAID' | 'OVERDUE' | 'SCHEDULED' | 'SUBMITTED' | 'PAID' | 'VOID' | 'SETTLED'

The invoice status

statusReasonCode'MISSING_PAYER_CONTACT_DETAILS' | 'PENDING_ACTIVATION' | 'PENDING_DD_MANDATE' | 'PENDING_DD_CAPABILITY' | 'MARKED_AS_PAID' | 'WORKFLOW_COMPLETED' | 'NOTIFICATION_DELIVERY_FAILED' | 'BULK_PRUNE' | 'STALE_DRAFT_CLEANUP' | 'OTHER' | 'DIRECT_DEBIT_MANDATE_BANK_ACCOUNT_CHANGED'

The reason as predefined code why the invoice is in a certain status

statusReasonstring

Custom details on why the invoice is in a certain status

invoiceSource'FILE_UPLOAD' | 'MANUAL' | 'PR' | 'EXTERNAL' | 'SCHEDULE' | 'PLATFORM'

The source of the invoice

itemsTaxType'EXCLUSIVE' | 'INCLUSIVE' | 'NONE'

How tax is applied to line items from the invoice

fileSource'NONE' | 'FILE_UPLOAD' | 'EXTERNAL' | 'ADFIN' | 'PENDING_ADFIN'

The file source of invoice

creditControlStatus'AT_RISK' | 'EXPECTED' | 'CONFIRMED'

The credit control status of the invoice

workflowType'AUTO_COLLECT' | 'ON_DEMAND' | 'NONE'

The workflow type of the invoice