GET api/clients/invoices?clientId={clientId}&xeroOrganisationId={xeroOrganisationId}&page={page}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

string

None.

xeroOrganisationId

globally unique identifier

None.

page

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

InvoicePageDTO
NameDescriptionTypeAdditional information
Items

Collection of InvoiceDTO

None.

NextPage

InvoiceContinuationDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "Id": "sample string 1",
      "XeroOrganisationId": "2c72567b-40cc-4856-b987-105c4aceacb9",
      "Reference": "sample string 2",
      "Number": "sample string 3",
      "Amount": 4.0,
      "Status": 1,
      "DueDate": "2026-10-08T22:28:37.2684443Z",
      "InvoicedDate": "2026-10-08T22:28:37.2684443Z"
    },
    {
      "Id": "sample string 1",
      "XeroOrganisationId": "2c72567b-40cc-4856-b987-105c4aceacb9",
      "Reference": "sample string 2",
      "Number": "sample string 3",
      "Amount": 4.0,
      "Status": 1,
      "DueDate": "2026-10-08T22:28:37.2684443Z",
      "InvoicedDate": "2026-10-08T22:28:37.2684443Z"
    }
  ],
  "NextPage": {
    "XeroOrganisationId": "a9d4db3b-8d40-46cd-a334-82a6f9690c18",
    "Page": 2
  }
}