Skip to main content

Preview Payment Posting Start

POST 

/api/ledger/payment-posting/preview

Shows what starting payment posting on a date would do, without changing anything: A/R and A/P per the ledger and per the provider at the end of the previous day, the true-up between them, how many payments and posted payouts would post, and any blockers (locked date, unmapped payment types, missing provider balances) or warnings.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token. Requires the accounting settings permission.

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 before start_date, debit-positive (A/P negative). Omit both to read them from the captured provider trial balance.

Request​

Responses​

OK

Response Headers
    Content-Type