Accounting

List Klara master accounting business-case templates.

Returns the global catalog of business-case templates — the manual-journal categories that drive the booking form (operating expenses, salary payments, asset purchases, …). The catalog is global Klara reference data: the same list is returned for every tenant, so there are no tenant or company path parameters. The <code>Accept-Language</code> header selects which translation of the human-readable <code>display</code> label is returned; if absent or unsupported the German translation is used as a fallback and the full per-language <code>i18n</code> / <code>keywordI18ns</code> maps are returned for client-side rendering. Optional <code>sort-field</code> (comma-separated column names) / <code>offset</code> / <code>limit</code> query parameters are forwarded to the downstream catalog for ordering and pagination. The endpoint is a pure read — idempotent, no side effects. Requires a bearer token whose principal carries the <code>ACCOUNTING_GET_BUSINESS_CASE_TEMPLATE</code> permission.

get/core/v1/accounting/business-case-templates

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/core/v1/accounting/business-case-templates
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Query parameters

limitinteger
Example:50

Maximum number of templates to return. When omitted, the downstream service returns the full catalog.

offsetinteger

Zero-based index of the first template to return. When omitted, the response starts at the first row.

orderColumnsstring[]

Renamed to <code>sort-field</code>. This name is accepted until <b>2027-09-01</b>; when both are sent, <code>sort-field</code> wins. After that date, a request sending <code>orderColumns</code> without <code>sort-field</code> is rejected with <b>400</b>.<br/><br/><strong>Deprecated</strong> — use <code>sort-field</code> instead, which takes the columns as one comma-separated value rather than as a repeated parameter. Names of columns to order the result by, ascending. Repeat this query parameter for multi-column ordering.

sort-fieldstring
Example:group,code

Comma-separated list of columns to order the result by, ascending (e.g. <code>?sort-field=group,code</code>). This catalog orders ascending only, so it publishes no <code>sort-direction</code>.

Headers

Accept-Languagestring
Example:de-CH

IETF language tag used to resolve the localized <code>display</code> label of each template. Examples: <code>de-CH</code>, <code>fr-CH</code>, <code>it-CH</code>, <code>en</code>. Falls back to the German translation when no translation exists for the requested language.

Response

Business-case templates matching the supplied ordering and pagination.

idinteger

Internal id of the template in the Klara catalogue.

codestring

Stable catalogue code of the template.

displaystring

Label of the template, already translated for the request's Accept-Language.

i18nobject

All translations of the label, keyed by IETF language tag.

keywordI18nsobject

All translations of the search keywords, keyed by IETF language tag.

groupstring

Catalogue group the template belongs to.

Example response

[
  {
    "id": 101,
    "code": "OFFICE_SUPPLIES",
    "display": "Bürobedarf",
    "i18n": {
      "de": "Bürobedarf",
      "fr": "Fournitures de bureau"
    },
    "keywordI18ns": {
      "de": "Büro Material",
      "fr": "Fournitures"
    },
    "group": "Operating expenses"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.