Run the monthly fee, withholding and statement cycle for a period

POST/accounts/cycles

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

limitintegerOptional

operatorstringOptional

periodstringRequired

Returns

200 OK

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

Errors

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

400401403404409412413422424429500503