Sign in
Bills

Get all bills

Returns all bills, optionally filtered by customers, identifiers and other filters. Note this operation uses Pagination.

post/api/connector/v1/bills/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

BillIdsstring[] nullable

Unique identifiers of the Bills. Required if no other filter is provided.

CustomerIdsstring[] nullable

Unique identifiers of the Customers.

State'Open' | 'Closed'

Whether the bill is Open or Closed.

Open

Closed

Type'Receipt' | 'Invoice'

After a bill is closed, the Bill Type is set to Receipt or Invoice. Receipt indicates that the bill has been fully paid and the balance is zero. Invoice indicates that the bill has not yet been fully paid but an invoice has been issued. Prior to closing, Bill Type should not be used.

Receipt (Default; the bill has been paid in full; only applicable after the bill is closed.)

Invoice (Bill has not been paid in full but an invoice has been issued to request payment.)

CorrectionStateBillCorrectionStateEnum[] nullable

Whether to return regular bills, corrective bills, or both. If BillIds are specified, defaults to both, otherwise defaults to Bill.

Response

OK

Cursorstring uuid nullable

Unique identifier of the last and hence oldest bill returned. This can be used in Limitation in a subsequent request to fetch the next batch of older bills.

Changes

No recorded changes to this endpoint across all 10 revisions of this API.