Conventions

Requests and responsesCopy Anchor Link

• JSON in, JSON out: send Content-Type: application/json with a body.
• A single record comes as {"data": {…}}, a list as {"data": […], "meta": {…}}. The key figures (GET /api/v1/reports/key-figures) are the one exception: they are the response itself.
• IDs are strings with a prefix that names the kind: cli_… for a client, inv_… for an invoice.

PagingCopy Anchor Link

Lists take page (from 1) and page_size and answer with:

{ "meta": { "page": 2, "page_size": 50, "total": 121, "total_pages": 3 } }

Request pages until page reaches total_pages.

Amounts and datesCopy Anchor Link

• Money is an exact decimal string, never a float: "1234.50". Send amounts the same way. Currencies are ISO 4217 codes ("CHF").
• Dates are YYYY-MM-DD in the workspace's time zone; timestamps are RFC 3339 in UTC.

VersioningCopy Anchor Link

The API lives under /api/v1. Within v1, changes are only additive: new operations, new optional fields and new fields in responses. Ignore fields you do not know rather than failing on them.