GET
List cheque transfers (organization)
Organization space Accounting module For: Accountant · Permission: cheque_transfers.list 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.
  • From the organization’s own book all transfers received are returned, and company_id can narrow them; from a company’s book only that company’s transfers are returned and company_id is ignored.
  • Sort is limited to transferred_at and created_at.
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

book
string
required

Identifier of the accounting book: the organization itself or one of its companies (27-character KSUID).

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:
transferred_at,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

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

Only transfers in this status: transferred (active) or reversed.

Available options:
transferred,
reversed
company_id
string | null

Only transfers made by this company. Honored only in the organization's own book; in a company's book the list is always that company's.

Required string length: 27
source_type
string | null

Only transfers of payments whose source has this type. Maximum 100 characters.

Maximum string length: 100
source_id
string | null

Only the transfer of the payment with this source identifier (27-character KSUID).

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

Only transfers made on or after this date (ISO 8601); the whole day counts.

to
string<date-time> | null

Only transfers made on or before this date (ISO 8601); the whole day counts. Must not be before from.

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

Response

Resource.

data
ChequeTransferResource · object[]
required

Items of this page.

meta
object
required

Pagination details.