PUT /v1/accounts

Upsert Accounts

Create or update chart accounts for one end-customer. This is the canonical Kontoplan amendment path.

Requires API key Idempotent OpenAPI v1

Authentication

Use a HelvCore API key in the Authorization header. Keys are server-side secrets and must not be exposed to browser JavaScript.

GETHeader

Authorization: Bearer hc_...

Parameters

Idempotency-Keystringrequiredheader

Documented field.

Request body

Send JSON using the documented schema. Unknown or unsafe fields fail with structured validation errors where the endpoint owns validation.

end_customer_idstringrequiredbody

Documented field.

valid_fromstringoptionalbody

Effective date for the returned mapping view. Account rows themselves are current-state records.

source_referencestringoptionalbody

Optional source provenance, e.g. audited closing Kontoplan reference.

accountsarrayrequiredbody

Documented field.

Returns

Returns a documented JSON response on success and the standard HelvCore error envelope on failure.

202Successful response.

defaultStructured error response.

401invalid_auth - missing, expired, or invalid Bearer key

Stable error codes

api_key_disabledDocumented HelvCore error code for this operation.

api_key_expiredDocumented HelvCore error code for this operation.

idempotency_key_conflictDocumented HelvCore error code for this operation.

invalid_authDocumented HelvCore error code for this operation.

invalid_requestDocumented HelvCore error code for this operation.

missing_idempotency_keyDocumented HelvCore error code for this operation.

validation_failedDocumented HelvCore error code for this operation.

curl -X PUT https://api.helvcore.ch/v1/accounts \ -H "Authorization: Bearer $HELVCORE_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "accounts": [ { "account_class": "string", "account_code": "string", "account_name": "string", "account_type": "asset", "account_id": "string", "currency": "CHF", "status": "active" } ], "end_customer_id": "00000000-0000-4000-8000-000000000000", "source_reference": "string", "valid_from": "2026-03-31" }'

{ "accounts": [ { "account_class": "string", "account_code": "string", "account_name": "string", "account_type": "asset", "account_id": "string", "currency": "CHF", "status": "active" } ], "end_customer_id": "00000000-0000-4000-8000-000000000000", "source_reference": "string", "valid_from": "2026-03-31" }