Skip to main content
GET
Retrieve all financial movements (payments, refunds, reimbursements, ...)

Path Parameters

consumer_id
string<uuid>
required

Query Parameters

cursor
string | null
page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100
date_from
string<date> | null

Retrieve financial movements cleared on or after this date.

date_to
string<date> | null

Retrieve financial movements cleared on or before this date.

export_status
enum<string> | null

Retrieve only financial movements with this export status, e.g. to_export to fetch exactly the ones still to be synced to the target accounting system. Shared across every payable-like entity of this vertical (payables, financial movements, ...): whether it still needs to be synced to the target accounting system.

Available options:
unknown,
not_ready,
to_export,
exported

Response

Successful Response

items
FinancialMovementItem · object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1