Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Invoices

Get a list of invoices

Retrieve a paged collection of invoices. At least one filter (invoiceId, jobId, jobGroupId, contactId, reference, or createdAtFrom/createdAtTo) is required. (required scope finance:read)

get/v1/finance/invoices

Query parameters

sortBy'createdAt'

Represents the fields that can be used to sort invoices.<p>Possible values:</p><ul><li><b>createdAt</b>: The date and time when the invoice was created</li></ul>

Example:createdAt

The field to sort items in the page by

direction'ascending' | 'descending'

Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>

Example:ascending

The direction to apply the sort

idinteger[]

Only return invoices where id matches the value(s) provided (Max items: 50)

jobIdinteger[]

Only return invoices where jobId matches the value(s) provided (Max items: 50)

jobGroupIdinteger[]

Only return invoices where jobGroupId matches the value(s) provided (Max items: 50)

contactIdinteger[]

Only return invoices where contactId matches the value(s) provided (Max items: 50)

referencestring[]

Only return invoices where reference matches the value(s) provided (Max items: 50)

createdAtFromstring date-time

Only return invoices created at or after this date (inclusive)

createdAtTostring date-time

Only return invoices created at or before this date (inclusive)

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 12345,
      "jobId": 54321,
      "jobGroupId": 67890,
      "contractId": 101112,
      "createdAt": "2022-11-29T16:50:16.0000000+00:00",
      "dueAt": "2022-12-29T16:50:16.0000000+00:00",
      "reference": "InvoiceNote101",
      "currencyCode": "EUR",
      "deliverySiteContactId": 56789,
      "nominalCodeId": 45678,
      "bankAccountId": 34567,
      "departmentCodeId": 23456,
      "clientNotes": "Please pay within 30 days",
      "internalNotes": "Follow up in two weeks",
      "sentAt": "2024-01-15T10:30:00.0000000+00:00",
      "cancelledAt": "2024-02-20T14:45:00.0000000+00:00",
      "paidAt": "2024-01-30T09:15:00.0000000+00:00",
      "acceptedAt": "2024-01-20T11:00:00.0000000+00:00",
      "cost": 850.5,
      "totalExclTax": 1000,
      "totalInclTax": 1200,
      "totalPaid": 1200,
      "paymentLink": "{bookingSiteBaseUrl}/pay/{invoiceUid}/{invoiceId}/{customerId}",
      "customFields": [
        {
          "definitionId": 5514123,
          "value": "Purple",
          "definition": {
            "caption": "Favourite colour",
            "type": "boolean",
            "listOptions": [
              "Red",
              "Blue",
              "Green",
              "Purple"
            ],
            "isRequired": true,
            "isEditable": true,
            "default": "10"
          },
          "systemListValueMetadata": {
            "label": "John Doe",
            "entityType": "resource"
          }
        }
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}