🔒 List supplier invoices V3

get

https://{xentralId}.xentral.biz/api/v3/supplierInvoices

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: supplierInvoice:read.

Paginated list of supplier invoices (liabilities). Cancelled invoices are part of the list; filter them in or out with documentStatus or the isCancelled flag. Invoices belonging to a project the authenticated user cannot access are not listed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn, isNull, isNotNull

supplier.id: equals, notEquals, in, notIn, isNull, isNotNull

documentNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

supplierInvoiceNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

documentStatus: equals, notEquals, in, notIn

project.id: equals, notEquals, in, notIn, isNull, isNotNull

salesOrder.id: equals, notEquals, in, notIn, isNull, isNotNull

costCenter: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

date: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

receiptDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

dueDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

isPaymentApprovalMissing: equals, notEquals

isGoodsCheckMissing: equals, notEquals

isInvoiceCheckMissing: equals, notEquals

isAccountAssignmentMissing: equals, notEquals

isPaymentMissing: equals, notEquals

isPaid: equals, notEquals

isCancelled: equals, notEquals

isDocumentMissing: equals, notEquals

hasDateAndReceiptDateInDifferentMonths: equals, notEquals

filter

sort

array

Sort via id, -id, documentNumber, -documentNumber, date, -date, receiptDate, -receiptDate, dueDate, -dueDate, amountGross, -amountGross, createdAt and -createdAt. Default sort is id

sort

include

array of strings

include

Allowed:

perPage

integer

≥ 0

Number of items per page. Default: 15, Max: 100. A larger value is reduced to the maximum; omitting it or sending 0 selects the default.

page

integer

≥ 0

Page number. Only used with simple and table pagination. Omitting it or sending 0 selects the first page.

cursor

string

The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter

Headers

x-pagination

string

enum

Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.

Allowed:

Responses

401

Unauthorized

403

Forbidden

200Paginated list of supplier invoices (liabilities). Cancelled invoices are part of the list; filter them in or out with documentStatus or the isCancelled flag. Invoices belonging to a project the authenticated user cannot access are not listed.

429Too Many Requests