Receivables

GET /receivables

Request

Base URL
https://api.kolek.com.br (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer

business_idstring

Filter receivables by business ID.

client_idstring

Filter receivables by client ID.

pageinteger

The page number for pagination. Both page and limit parameters must be provided to enable pagination. The minimum value for page is 1.

limitinteger

The number of items per page for pagination. Both limit and page parameters must be provided to enable pagination. The minimum value for limit is 1.

order_bystring

Field name to order the results by, e.g., "issued_date". Defaults to descending "issued_date" if not provided.

sort_order'asc' | 'desc'

Sort order, can be either "asc" for ascending or "desc" for descending. Defaults to "desc" if not provided.

status'Paid' | 'Cancelled' | 'Ongoing' | 'On_hold' | 'Bad_Debt'

Filter by status. Valid values are defined by the account_receivables_status enum.

with_businessboolean

Boolean flag to include business details associated with this invoice. Valid values are "true" or "false".

with_clientboolean

Boolean flag to include client details associated with this invoice. Valid values are "true" or "false".

with_bankslipboolean

Boolean flag to include all bankslip details associated with this invoice. Valid values are "true" or "false".

with_nfseboolean

Boolean flag to include all NFSe details associated with this invoice. Valid values are "true" or "false".

with_partial_paymentsboolean

Boolean flag to include all the partial payment associated for this invoice. Valid values are "true" or "false".

nfse_statusstring

Filter receivables by NFSe status.

nfse_withoutboolean

Boolean flag to exclude receivables that have NFSe associated. Valid values are "true" or "false".

Successfully retrieved the list of receivables based on the specified criteria.

No recorded changes to this operation across all 1 revision of this API.