POST
Cancel a cheque transfer
Organization space Accounting module Cannot be undone For: Accountant · Permission: cheque_transfers.reverse 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 book in the path must be the organization’s own book; a company’s book is refused.
  • The caller must have been granted access to the book in the path.
  • The caller needs access to the company’s book as well.
  • Only a transfer in status transferred can be cancelled; repeating the call on an already reversed transfer returns it unchanged.
  • Refused when a later step (deposit, settlement and so on) was recorded on the cheque after the transfer.
  • accounting_date, when sent, must not be before the day of the transfer.
  • When the original transfer entries sit in a closed period, the reversal is dated on the first day of the next open period; the date used must fall in an open period of each book.
  • The original transfer entries must still be found and not already reversed or refunded.
What else happens
  • Posts reversing entries in the company book and in the organization book, and marks the two original entries reversed. Bank statement matches on them are released; a match on a reconciled statement refuses the call.
  • Sets the transfer to reversed with the time and actor, and stores the two reversal entry identifiers.
  • Marks the payment source as reversed.
  • When the transfer is linked to a cheque step, restores the cheque to its state before the transfer (owner and physical holder back to the company), marks the transferred step reversed, records a reversed step and increments the cheque version.
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

chequeTransfer
string
required

Identifier of the accounting book in the path (the organization's own book). The OpenAPI path names it chequeTransfer by mistake.

cheque_transfer
string
required

Identifier of the cheque transfer to cancel (27-character KSUID).

Query Parameters

response
enum<string>
default:none

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

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, organization_id, company_id, status, source_type, source_id, original_amount, currency_code, currency_exponent, company_amount, company_currency_code, company_currency_exponent, organization_amount, organization_currency_code, organization_currency_exponent, external_reference, transferred_at, transferred_by, transferred_by_type, organization_settled_at, organization_settled_by, organization_settled_by_type, reversed_at, reversed_by, reversed_by_type, company_journal_entry_id, organization_journal_entry_id, company_reversal_journal_entry_id, organization_reversal_journal_entry_id, created_at, updated_at.

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: .

Body

application/json
accounting_date
string<date-time> | null

Optional date (ISO 8601) of the reversing entries. Must not be before the day of the transfer. Default: the date of the original entries, moved to the first day of the next open period when that period is closed.

Response

Resource (only with response=resource).

id

Identifier of the cheque transfer (27-character KSUID).

organization_id

Identifier of the organization the record belongs to.

company_id

Identifier of the company the record belongs to.

status

transferred when the transfer is active, reversed after the organization cancelled it.

source_type

Type of the transferred payment, for example order_payment or customer_credit_payment.

source_id

Identifier of the transferred payment (27-character KSUID).

original_amount
integer

Amount of the cheque as tendered, in minor units of currency_code.

currency_code

ISO 4217 code of the currency the cheque was paid in.

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.

company_amount
integer

Amount in the company's currency, in minor units of company_currency_code.

company_currency_code

ISO 4217 code of the company's currency.

company_currency_exponent
integer

Number of decimal places of the company's currency; divide company_amount by 10 to this power.

organization_amount
integer

Amount in the organization's currency, in minor units of organization_currency_code.

organization_currency_code

ISO 4217 code of the organization's currency.

organization_currency_exponent
integer

Number of decimal places of the organization's currency; divide organization_amount by 10 to this power.

external_reference

Free reference given at transfer time, for example a handover slip number.

transferred_at

Date and time of the handover (ISO 8601), as sent by the company. Also the accounting date of the transfer entries.

transferred_by

Identifier of the member profile or agent account who made the transfer; null when no actor could be identified.

transferred_by_type

Kind of actor named in transferred_by (its type alias); null when unknown.

organization_settled_at

Not set by any current action; always null.

organization_settled_by

Not set by any current action; always null.

organization_settled_by_type

Not set by any current action; always null.

reversed_at

Date and time the organization cancelled the transfer (ISO 8601); null while it is active.

reversed_by

Identifier of the member profile or agent account who cancelled the transfer; null while active.

reversed_by_type

Kind of actor named in reversed_by; null while active.

company_journal_entry_id

Identifier of the entry posted in the company's book when the cheque was handed over.

organization_journal_entry_id

Identifier of the entry posted in the organization's book when the cheque was handed over.

company_reversal_journal_entry_id

Identifier of the reversing entry in the company's book; null while the transfer is active.

organization_reversal_journal_entry_id

Identifier of the reversing entry in the organization's book; null while the transfer is active.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).