Start Payment Posting
POST/api/ledger/payment-posting/start
Starts (or moves) payment posting as a background job: records the start date, posts one internal true-up dated on the start date that brings A/R and A/P to the provider's balances, then posts every payment and payout deposit dated on or after it. History before the start date is never re-posted and nothing is written inside a locked period. Returns the tracked job id to follow progress.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token. Requires the accounting settings permission.
Returns 422 when any preview blocker applies or no offset account is given.
Request body:
start_date(string, required,Y-m-d) — the first local day whose payments post. Must be after the locked period and on or after the accounting start date.offset_nominal_code_id(integer, optional for preview, required to start) — the account that absorbs the A/R and A/P true-up (usually Opening Balance Equity).accounts_receivable_provider/accounts_payable_provider(number, optional, send both or neither) — the provider's A/R and A/P balances at the end of the day beforestart_date, debit-positive (A/P negative). Omit both to read them from the captured provider trial balance.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.