List retained per-account cycle outcomes, optionally by status (pending, complete, failed)

GET/accounts/cycles/periods/{period}/accounts

Path parameters

periodstringRequired

Query parameters

limitintegerOptional

Page size

Default 10. Maximum 100.

starting_afterstringOptional

The id of the last item seen; returns the page after it

ending_beforestringOptional

The id of the first item seen; returns the page before it

Returns

200 OK

dataarray of objectsRequired

9 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

attemptsintegerOptional

Cycle passes that reached this account, including reconciliations

error_codestringOptional

Failed: the problem code of the last attempt

error_detailstringOptional

Failed: what the operator has to fix before reconciling

periodstringRequired

reportobject or nullOptional

CycleReport is the evidence a statement cycle leaves behind.

19 child attributes

accountsintegerRequired

actorstringRequired

analysis_accountsintegerRequired

Business accounts analysed

earnings_credit_amountintegerRequired

Earnings credit applied against their fees

execution_datestring · dateRequired

A business date, YYYY-MM-DD

failed_accountsintegerRequired

Accounts whose last pass failed; reconcile them one by one

fees_postedintegerRequired

fees_skippedintegerRequired

fees_waivedintegerRequired

foreign_currency_interest_amountsobjectOptional

ForeignInterest is the interest paid on accounts held in currencies other than USD, by currency in that currency's own minor units; interest_amount and withheld_amount are USD.

interest_accountsintegerRequired

Accounts paid interest in the period

interest_amountintegerRequired

pending_accountsintegerRequired

periodstringRequired

replayedbooleanRequired

statementsintegerRequired

statusstringRequired

total_accountsintegerRequired

withheld_amountintegerRequired

Backup withholding taken

source_sha256stringOptional

statement_idstringOptional

statusstringRequired

Pending, complete or failed

has_morebooleanRequired

Whether another page follows

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503