---
title: "Get the order-numbering configuration for a document type."
method: GET
path: "/core/v1/order-numbering-configurations"
tags: ["Finance"]
---

# Get the order-numbering configuration for a document type.

`GET /core/v1/order-numbering-configurations`

## Request

- Base URL: `https://api.klara.ch`
- URL: `https://api.klara.ch/core/v1/order-numbering-configurations`
- Auth: one of:
  - API key in header `X-API-KEY`
  - HTTP bearer

Returns the numbering strategy configured for the given <code>order-type</code> of the company resolved from the bearer JWT. Use this before creating a document to decide how to supply the document number in <code>POST /core/v1/invoices</code>: <code>STANDARD</code> — server auto-assigns; <code>MANUAL</code> — set <code>invoiceCode</code> yourself; <code>CUSTOMISED</code> — set <code>invoiceCode</code> to a value matching the returned <code>format</code> pattern. If no configuration has been saved by the company administrator, a default <code>STANDARD</code> configuration is returned. The caller must hold the <code>FINANCE</code> permission on the target company. This operation is idempotent and read-only.

## Query parameters

- `order-type` 'OFFER' | 'CONFIRMATION' | 'DELIVERY_NOTE' | 'INVOICE' | 'CREDIT_NOTE' | 'FRIENDLY_REMINDER' | 'FIRST_REMINDER' | 'SECOND_REMINDER' | 'PAYSLIP' | 'RECURRING_INVOICE_TEMPLATE': Order-management document type. Used as the discriminator on <code>OrderDocument.orderType</code>.

## Response `200`

Numbering configuration for the requested document type.

- OrderNumberingConfiguration
  - `orderType` 'OFFER' | 'CONFIRMATION' | 'DELIVERY_NOTE' | 'INVOICE' | 'CREDIT_NOTE' | 'FRIENDLY_REMINDER' | 'FIRST_REMINDER' | 'SECOND_REMINDER' | 'PAYSLIP' | 'RECURRING_INVOICE_TEMPLATE': Order-document type this configuration applies to.
  - `orderNumberingType` 'STANDARD' | 'MANUAL' | 'CUSTOMISED': Strategy used to assign document numbers. <code>STANDARD</code>: server auto-increments from <code>startingNumber</code>; <code>MANUAL</code>: caller must supply a number in <code>POST /invoices</code>; <code>CUSTOMISED</code>: caller must supply a code matching <code>format</code>.
  - `startingNumber` integer: The first number in the auto-increment sequence (relevant for STANDARD). Null when not configured.
  - `increment` integer: Step size between successive auto-incremented numbers (relevant for STANDARD). Null when not configured.
  - `format` string: Alphanumeric format pattern for CUSTOMISED numbering (e.g. <code>INV-{YYYY}-{SEQ}</code>). Null when not configured.

## Other responses

- `400`: Data invalid<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.
- `401`: No Authorization header found or invalid token<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.
- `403`: The current user is not allowed to access this company data<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.
- `429`: API rate limit exceeded<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.
- `500`: Something went wrong on our side while processing the request. Please kindly contact our support.<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.

---

[API](https://skmtc.dev/klara/apis/klara-public-api.md) · [All operations](https://skmtc.dev/klara/apis/klara-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/klara/apis/klara-public-api/revisions/490b1a879fc2?raw)