Skip to main content

Get Account Rules Import Template

GET 
/api/product-account-rules/import-template

Download a CSV template to start an import from: one row per top-level product category, active, including sub-categories, with the account columns left blank.

Required scope: accounting:read

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

Authentication: Requires Bearer token with the accounting:read scope.

Response: text/csv file download named account-rules-template.csv.

CSV columns (in order): name, position, is_active, channel_accounts_take_priority, category, include_subcategories, category_scope, brand, default_supplier, product_type, tag, sku_prefix, sales_account, cogs_account, inventory_account, in_transit_account, accrued_purchases_account, discount_account.

  • category, brand, default_supplier, product_type, tag, sku_prefix — names (or product type values), several separated by |.
  • is_active, channel_accounts_take_priority, include_subcategories — 1 or 0.
  • category_scope — primary (match the product's primary category; the default when blank) or any (match any of its categories).
  • Account columns — the nominal code number (e.g. 4010) or "number name" (e.g. 4010 Sales - Binding Machines); blank leaves that account type unset.

Request​

Responses​

OK

Response Headers
    Content-Type