Preview Revenue Recognition Switch
GET/api/ledger/settings/revenue-recognition/preview
Read-only preview of switching revenue recognition to the fulfillment date on switch_date. Nothing is saved or posted.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Modes (mode): plan when switch_date is in the future — no orders exist after it yet, so the preview backtests the three most recent full months plus month-to-date as if the switch had happened at their start; verify when it is today or earlier — it simulates orders created from switch_date to through, and once fulfillment-date recognition is on it compares the simulated month-end balances with the ledger (reconciliation).
Sections: prerequisites (each met, warning or blocking; can_switch is false while any is blocking) · channels (how each sales channel recognises revenue: payout_settled, payout_start_after_switch, payout_unsupported, per_order_synced, per_order_not_synced) · months (per channel and month: revenue on today's basis, on the fulfillment basis, the change, month-end Deferred Revenue, and Unsettled Channel Sales split into shipped-awaiting-payout and paid-not-shipped) · open_book (orders created before the switch and not fully shipped; they keep order-date recognition and are never restated) · reconciliation (verify mode only).
Returns 422 when switch_date is missing or not a Y-m-d date.
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.