Skip to main content
GET
/
api
/
v1
/
invoices
List invoices
curl --request GET \
  --url https://integrations.polinate.ai/api/v1/invoices \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>'
{
  "items": [],
  "total": 0,
  "page": 1,
  "pageSize": 20
}

Headers

​
X-Business-Id
string
required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

​
X-API-Key
string
required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

Query Parameters

​
page
integer
Required range: x > 0
Example:

1

​
limit
integer
Required range: x > 0
Example:

20

​
createdSince
string<date-time>
Example:

"2024-01-01T00:00:00Z"

​
hasArtefact
boolean

Filter by presence of invoiceArtefact property (use propertyPath for more control)

Example:

true

​
status
enum<string>
Available options:
DELETED,
DRAFT,
AUTHORISED,
PARTIALLY_PAID,
PAID,
OVERPAID,
OVERDUE,
VOIDED,
DEFAULTED,
CREDITED,
REFUNDED
Example:

"PAID"

​
propertyPath
string

Dot-notation path to filter by JSONB property

Example:

"xero.invoiceId"

​
propertyValue
string

Value to match exactly for the property path (mutually exclusive with propertyExists)

Example:

"12345"

​
propertyExists
boolean

Boolean to check existence (true) or non-existence (false) of the property path (mutually exclusive with propertyValue)

Example:

false

Response

OK

​
items
object[]
required
​
total
number
required
​
page
number
required
​
pageSize
number
required