List all bills

bills

GET

/api/v1/bills

Retrieve details of multiple bills. A due-date range (fromDueDate + toDueDate) is required. Additional filters (status, type, cashflowType, counterpartyReference) are optional.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Header Parameters

x-region*

Mandatory routing header to direct the request to the appropriate regional products

Type

string

Required

Valid values

"EU""IN""US""UK"

Query Parameters

status

Filter by bill status. OPEN — bill pending payment; CLOF — closed offline; VOID — voided; PAID — payment received from debtor (system-set by the payment engine, cannot be set via PATCH); POST — bill posted to ledger after reconciliation (follows PAID); PROCESSING — payment in flight (system-set). Typical settled flow: OPEN → PROCESSING → PAID → POST.

Type

string

Valid values

"OPEN""CLOF""VOID""PAID""POST""PROCESSING"

Example"OPEN"

type

Filter by bill type. INV for Invoice, CRM for Credit Memo.

Type

string

Valid values

"INV""CRM"

Example"INV"

cashflowType

Filter by cashflow classification. AR for Account Receivable, AP for Account Payable.

Type

string

Valid values

"AR""AP"

Example"AR"

counterpartyReference

Filter by unique identifier of the counterparty.

Type

string

Example"160591"

Max Length

90

fromDueDate*

Start of due-date range filter. ISO 8601 date format (YYYY-MM-DD). Example: 2023-11-01.

Type

string

Required

Example"2023-11-01"

Format

"date"

Pattern

"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"

toDueDate*

End of due-date range filter. ISO 8601 date format (YYYY-MM-DD). Example: 2023-11-30.

Type

string

Required

Example"2023-11-30"

Format

"date"

Pattern

"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"

page

The page number.

Type

integer

Example1

Minimum

1

Default

1

limit

The page size, indicating the number of entries returned per page.

Type

integer

Example100

Minimum

1

Default

100

Responses

List of bills.

Content-Type

application/json

object

object

Required

This is the page number.

Minimum0

The page size, indicating the number of entries returned per page.

Minimum0

true if there are more pages available beyond this one.

object[]

Required

object

Required

object[]

Min Items1