GET
List cheques (company)
Company space Accounting module For: Accountant, Manager · Permission: cheques.list Conditions
  • The organization’s plan must include the accounting module; otherwise the call is refused before anything else.
  • Only cheques your company currently holds are listed; a cheque handed over to the organization or bounced back is listed by the book that currently holds it.
  • Dates must be valid and to / received_to must not be before from / received_from; max_amount must be at least min_amount when min_amount is sent.
  • Sort is limited to received_at, amount and created_at; per_page is 1 to 100 (default 25).
Part of Handle cheques.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
received_at,
amount,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
financial_status
enum<string> | null

Only cheques in this status: received, in_collection, settled, unpaid or returned.

Available options:
received,
in_collection,
settled,
unpaid,
returned
source_type
string | null

Only cheques whose originating payment has this source type (for example order_payment or customer_credit_payment). Maximum 100 characters.

Maximum string length: 100
source_id
string | null

Only the cheque whose originating payment has this source identifier. Maximum 100 characters.

Maximum string length: 100
customer_id
string | null

Only cheques received from this customer (27-character KSUID).

Required string length: 27
received_from
string<date-time> | null

Only cheques received on or after this date (ISO 8601), compared with the date the payment was received.

received_to
string<date-time> | null

Only cheques received on or before this date (ISO 8601). Must not be before received_from.

from
string<date-time> | null

Only cheques created on or after this date (ISO 8601), compared with the creation date of the cheque record.

to
string<date-time> | null

Only cheques created on or before this date (ISO 8601). Must not be before from.

min_amount
integer | null

Only cheques whose amount is at least this value, an integer in minor units of the company currency (divide by 10 to the power currency_exponent).

Required range: x >= 0
max_amount
integer | null

Only cheques whose amount is at most this value, in minor units of the company currency. Must be at least min_amount when both are sent.

Required range: x >= 0
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, company_id, organization_id, customer, customer_id, identity, financial_status, status, recovery_status, accounting_owner, physical_holder, version, source_type, source_id, amount, currency_code, currency_exponent, original_amount, original_currency_code, original_currency_exponent, reference, received_at, accounting_status, settlement_id, cheque_transfer_id, order.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: operations.

Response

Resource.

data
ChequeResource · object[]
required

Items of this page.

meta
object
required

Pagination details.