Skip to content

API conventions

Every primary entity uses a typed prefix and a numeric tail:

Prefix Entity
IP. Instance provider (tenant)
C. Client
D. Debtor
I. Invoice
P. Payment
SP. Service provider
BL. Business loan
CB. Collection batch (collection case)

The prefix is the uppercase initials of the entity name, followed by a numeric sequence (for example C.100100). This list is not exhaustive - many secondary entities have their own prefixes.

IDs are opaque strings - do not parse them in your code.

Request and response bodies use camelCase. The database columns are snake_case; the API marshalling layer translates.

Date-time fields are ISO 8601 without a trailing Z or offset (for example 2026-06-06T11:22:33). They are expressed in the platform’s configured timezone, not UTC - Europe/Stockholm by default, and resolved per locale for localized tenants. Treat them as local to the tenant; confirm the exact timezone with your Quiddly contact if it matters for your integration. Date-only fields use YYYY-MM-DD.

  • amount: decimal string, never a float ("1250.00", not 1250.0).
  • currency: ISO 4217 (SEK, EUR, …).

See Idempotency and errors.