Skip to main content

Preview Ecommerce Standard Chart

GET 

/api/ledger/setup/ecommerce-standard/preview

Read-only preview of what applying SKU.io's ecommerce standard chart of accounts would ADD to this tenant: missing accounts, empty role mappings and empty marketplace payout mappings. Nothing already set is ever proposed for change. Writes nothing. Requires the accounting.index permission.

Required scope: accounting:read

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

Matching: a standard account counts as present when one of its roles is already mapped, or an active account has the same name and type (already_set, existing holds it). Weaker name overlaps are listed in possible_matches and never chosen for you. A standard code already taken moves to the next free code.

Row fields:

  • id — send it back to the apply endpoint.
  • kind — add_account, use_existing (fills empty roles with an account you already have), already_set (informational) or fill_payout_mapping.
  • effect — none, inert (the role is only read once its feature is on) or changes_postings (entries that fall back elsewhere today post here from effective_from).
  • default_include — the recommended selection. Goods Received Not Invoiced is never pre-selected.
  • provider_create_available — the account can also be created in the connected Xero / QuickBooks Online organisation.
  • requires_account — for payout rows, the standard account they post to (must exist or be added in the same apply).

effective_from is today, or the day after the accounting lock date when that is later.

Request​

Responses​

OK

Response Headers
    Content-Type