Skip to navigation
APIChart of Accounts

Replace the export map

Replaces one export system’s whole account map and makes that system the workspace’s active one. system is a lowercase name of at most 32 characters, such as ledger_one; entries names each account once, at most 1,000 in all, and an account left out leaves the map. Answers the map as saved, and 409 when another save of it is under way. Every mapping read then answers stale: true until that mapping has been prepared again with the new codes, and extraction.mapped announces each one. Requires a plan that includes spreads; other plans get a 403.

Requires the chart_of_accounts:write scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Headers

Idempotency-KeystringOptional<=255 characters

Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See Idempotency.

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-07-19. Omit to get the latest. See Versioning.

Request

This endpoint expects an object.
systemstringRequired

The export system's name: a lowercase letter followed by up to 31 lowercase letters, digits, underscores or hyphens, such as ledger_one.

entrieslist of objectsRequired
The map's entries, at most 1,000, each naming an account the map names once. An account left out leaves the system's map.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
Idempotency-Replayboolean

Set to true when the response is replayed from the idempotency cache for a request that re-presented an Idempotency-Key it had already used. Absent on the original (winner) response. A replay repeats the original status and body. When the original could not be stored (an unhandled server fault, or a body over the 1 MiB replay cap) the replay is an error envelope that says so; the operation is never re-run under the same key.

SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-07-19.

RateLimit-Limitinteger

Request budget of the endpoint's rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
entrieslist of objects
One entry per mapped account, in order of account id. Empty until an export map is saved.
systemstring or nullOptional
The export system the map belongs to, the workspace's active one. Null until an export map is saved.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error