Skip to content

Settlements

Settlement history

settlements:read

Returns completed payouts to your organisation, newest first. collections covers recovered debt; invoicing covers customer payments collected through invoice service. Amounts are integer øre. This is history only: it does not predict the next payout date, and line-level specifications remain available in the portal.

ParameterInTypeRequiredDescription
limitqueryintegerNoPage size, 1-200 (default 50)
cursorquerystringNoOpaque cursor from meta.nextCursor
Request exampleNo request body
curl https://api.rieckflow.com/v1/settlements \
-H "Authorization: Bearer $RIECK_API_KEY"
200 Paginated collection and invoicing payouts, newest first.application/json
Response fields 9
FieldTypeDescription
data[].iduuidStable settlement id.
data[].typecollections | invoicingOrigin of the payout.
data[].payoutOereintegerNet amount paid out to you.
data[].feeOereintegerRieck fee deducted from the payout.
data[].vatOereinteger | nullVAT on the fee for collection settlements; null for invoicing.
data[].vatOffsetOereintegerVAT offset against the collected amount.
data[].lineCountintegerNumber of lines included in the settlement.
data[].settledAtdate-timeUTC settlement timestamp.
meta.nextCursor`stringnull`
Possible errors 5
HTTPCodeMeaning
400invalid_cursorThe cursor is malformed, expired or belongs to another list shape.
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
429rate_limitedThe organisation’s rate budget is exhausted.