GET
List settlements (organization)
Organization space Accounting module For: Accountant · Permission: settlements.list Conditions
  • The accounting module must be active for the organization.
  • The caller must have been granted access to the book in the URL.
  • The book in the URL must be a company book; the organization’s own book or a client book is refused.
  • Only settlements of that company are listed.
  • to must not be before from.
Part of Card and payment settlements.

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 company book whose settlements are listed.

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

asc for ascending order, desc for descending order.

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

Keeps only settlements in this status: initiated, settled, cancelled or reversed.

Available options:
initiated,
settled,
cancelled,
reversed
payment_method
enum<string> | null

Keeps only settlements of this payment method: cash, credit_card, bank_transfer, mobile_money, cheque or other.

Available options:
cash,
credit_card,
bank_transfer,
mobile_money,
cheque,
other
money_account_id
string | null

Keeps only settlements paid into this money account (27-character KSUID string).

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

Keeps settlements initiated on or after this date (ISO 8601); the whole day is included.

to
string<date-time> | null

Keeps settlements initiated on or before this date (ISO 8601); the whole day is included. 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, company_id, source_type, source_id, direction, payment_method, creation_mode, status, money_account_id, payment_route_account_id, register_payment_method_id, original_amount, original_currency_code, original_currency_exponent, company_functional_amount, company_currency_code, company_currency_exponent, organization_functional_amount, organization_currency_code, organization_currency_exponent, conversion_snapshot, external_reference, initiated_at, settled_at, reversed_at, reversed_by, reversed_by_type, 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
SettlementResource · object[]
required

Items of this page.

meta
object
required

Pagination details.