Skip to main content

Apply Ecommerce Standard Chart

POST 

/api/ledger/setup/ecommerce-standard/apply

Apply the preview rows you selected. Only adds: creates missing accounts, fills empty roles and empty payout mappings. Nothing already set is remapped, renamed or deleted, and nothing dated in a locked period is written. Requires the accounting.manage_settings permission.

Required scope: accounting:write

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

The preview is re-run first. If any selected row is no longer offered (for example the role was mapped since the preview), the whole request is refused with 422 and nothing is applied.

Body:

  • rows (required, array, min 1) — the selected rows.
  • rows.*.id (required, string, distinct) — a row id from the preview.
  • rows.*.create_in_provider (optional, boolean, default false) — also create this account in the connected Xero / QuickBooks Online organisation and link it. Only for rows with provider_create_available.
  • rows.*.use_existing_id (optional, integer, nullable) — use one of the row's possible_matches instead of creating the account.

Payout mapping fills take effect from effective_from; earlier payouts keep their accounts. A payout row whose account was neither existing nor added is skipped and listed in skipped. A provider failure leaves the account in SKU.io, unlinked, and is listed in provider_failed.

Request​

Responses​

OK

Response Headers
    Content-Type