GET
View a cheque of a book (organization)
Organization space Accounting module For: Accountant · Permission: cheques.retrieve Conditions
  • The organization’s plan must include the accounting module; otherwise the call is refused before anything else.
  • This action is available only in the organization space.
  • The caller must have been granted access to the book in the path.
  • The cheque must be held by the book in the path.
  • The step history is returned only with ?include=operations.
Part of Handle cheques.

Authorizations

Authorization
string
header
required

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

Path Parameters

cheque
string
required

Identifier of the cheque (27-character KSUID).

Query Parameters

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.

id

Identifier of the cheque (27-character KSUID).

source_type

Type of the payment this cheque came from, for example order_payment (a sale) or customer_credit_payment (a payment on a customer's debt).

source_id

Identifier of that originating payment (27-character KSUID).

company_id

Identifier of the company the record belongs to.

organization_id

Identifier of the organization the record belongs to.

customer
object

The customer who gave the cheque, as an object with the customer's id and name (name as recorded on the payment).

customer_id

Identifier of the customer who gave the cheque (27-character KSUID).

order
object

The order the cheque paid, as an object with id and number; both are null when the cheque is not linked to an order.

amount
integer

Cheque amount in minor units of currency_code (divide by 10 to the power currency_exponent). It is the amount in the company's functional currency.

currency_code

ISO 4217 code of the currency of amount.

currency_exponent
integer

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.

original_amount
integer

Amount as tendered, in minor units of original_currency_code.

original_currency_code

ISO 4217 code of the currency the customer paid in.

original_currency_exponent
integer

Number of decimal places of the original currency; divide original_amount by 10 to this power.

reference

Reference recorded on the originating payment.

received_at

Date and time the payment was received (ISO 8601).

accounting_status

Status of the payment source for accounting. It starts as not_initiated, follows the cheque's financial status after each step (received, in_collection, settled, unpaid, returned), becomes resolved or written_off after recovery, and shows transferred or reversed for the older cheque-transfer flow.

settlement_id

Identifier of the settlement that moved this payment into a money account, when one exists.

cheque_transfer_id

Identifier of the older cheque transfer made for this payment, when one exists.

identity
object

What is written on the cheque, as an object: series, number, issuing_bank_name, issuing_bank_code, drawer_name, drawer_account_reference, issue_date and due_date (dates as YYYY-MM-DD), beneficiary_name. Each is null when unknown.

financial_status

Where the cheque is in its life: received (held, not yet deposited), in_collection (deposited at the bank), settled (the bank paid it), unpaid (the bank refused it), returned (given back to the customer).

status

Same value as financial_status.

recovery_status

Follow-up of an unpaid or returned cheque: open (the debt is still to be recovered), resolved (a replacement payment was recorded), written_off (the debt was written off). Null while no recovery applies.

accounting_owner
object

Book that currently holds the cheque, as an object: type (company or organization) and id.

physical_holder
object

Who physically holds the paper cheque, as an object: type (company, organization, bank, customer or none) and id (null for bank and none).

version
integer

Counter increased by one at each change of the cheque; use it to detect that the cheque moved.

operations
array

Step history of the cheque in time order (deposit, settlement, rejection and so on, with reversals). Present only when requested with ?include=operations.