Skip to main content

Set Channel Sending

PUT 

/api/ledger/settings/channel-sync/:integrationInstance/sending

Sets how one sales channel sends each class of its documents to the accounting system automatically: its per-order invoices, its credits, and its payout or settlement documents (Amazon settlements, Shopify / eBay payouts, Walmart settlements).

Required scope: accounting:write

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

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

Body (every field optional; a field left out keeps its current setting):

  • invoices (string): follow (the account-wide Sync by Transaction Type switch and its start date decide, the default), always (sent whatever the account-wide switch says) or never (not sent automatically; Sync Now still sends one).
  • credits (string): same values, for the channel's sales credits.
  • settlements (string): same values, for the channel's payout or settlement documents. Only for channels that have them (Amazon, Shopify, eBay, Walmart); 422 otherwise.
  • send_from_today (boolean, default true): when a class newly becomes always, send automatically only documents dated from today, so older documents the account-wide switch held back are not all released at once (they can still be sent one at a time). false sends everything not yet sent. A class that is already always keeps its date.
  • send_from (string, YYYY-MM-DD, optional): the day every class set to always in this request sends from, instead of today or its existing date (e.g. 2026-01-01 to send a channel's documents from the first open day). Must be after the books' lock date; 422 otherwise.

always never crosses a hard stop: the accounting system's conversion date, a per-payout channel's paid orders (booked by the payout), another app booking the channel, a paused connection, or batching rules. never beats always.

The channel's unsynced documents are re-evaluated in the background. Returns the channel's refreshed explanation (same shape as Get Channel Sync Explanation), whose settings.sending shows each class's mode and from date. 404 when the channel does not exist; 422 for an unknown mode, settlements on a channel without them, or an instance that is not a sales channel.

Go-live readiness: readiness_overrides (array, optional) passes over failing blocking checks, each as {"check_key": "...", "reason": "..."} with a reason of at least 10 characters. Overriding needs the accounting.period.override permission (403 without it). The reason and the check's figures are kept on record.

Moving settlements from never to follow or always checks that channel's payout codes and returns 422 with a readiness error when codes have no account and no fallback.

Request​

Responses​

OK

Response Headers
    Content-Type