Accounting

List the master VAT catalog used by Klara Accounting.

This operation remains available until <b>2027-08-14</b> and is removed after that date. Use <code>GET /core/v1/accounting/master-vats</code> instead.<br/><br/>Returns the global master VAT catalog — the table of supported VAT rates with their validity ranges and translated labels. The downstream handler is a dispatcher driven by the query string: when <code>code</code> is non-blank only rows whose <code>vatCode</code> matches one of the semicolon-separated codes are returned (and when combined with <code>current-period=true</code>, only the ones valid today); otherwise when <code>default-vat=true</code> only the company-default rows are returned; otherwise the full catalog is returned, ordered by rate ascending, optionally paginated via <code>offset</code> / <code>limit</code>. Pagination is honoured only on the full-catalog branch — it is silently ignored when <code>code</code> or <code>default-vat</code> is set. The endpoint is a pure read and idempotent. Requires a bearer token whose principal carries the <code>ACCOUNTING_GET_MASTER_VAT</code> permission.

get/core/latest/accounting/master-vats

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/core/latest/accounting/master-vats
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Query parameters

codestring
Example:1;3;4

Semicolon-separated list of <code>vatCode</code>s to filter on. When set, switches the response to the by-code branch and ignores <code>default-vat</code>.

current-periodboolean

When combined with <code>code</code>, restricts the result to master VAT rows whose validity range covers today. Defaults to <code>false</code>.

default-vatboolean

When <code>true</code>, restricts the result to the company-default master VAT rows. Defaults to <code>false</code>. Ignored when <code>code</code> is set.

includeHiddenVatCaseboolean

When <code>true</code>, the response also includes hidden VAT-case ids that are not directly mapped to a master VAT row. Defaults to <code>false</code>.

limitinteger
Example:50

Maximum number of results to return. Only honoured on the full-catalog branch.

offsetinteger

Zero-based index of the first result. Only honoured on the full-catalog branch (when neither <code>code</code> nor <code>default-vat</code> is set).

Response

Array of master VAT rows matching the filters.

idinteger

Internal id of the master VAT row.

vatCodestring

Short numeric VAT code as configured in the Klara accounting plan.

ratenumber

VAT rate as a percentage value (8.10 means 8.10 %).

validFromstring date

Inclusive start date of the validity range (ISO yyyy-MM-dd). May be null when open-ended.

validTostring date

Inclusive end date of the validity range (ISO yyyy-MM-dd). May be null when open-ended.

defaultVatboolean

True when the row is one of the company-default VAT entries.

referenceVatCaseIdstring

Optional reference to a hidden VAT case id not directly mapped to a master VAT.

createDatestring date-time

Timestamp when the row was created (ISO yyyy-MM-dd'T'HH:mm:ss).

updateDatestring date-time

Timestamp of the last update (ISO yyyy-MM-dd'T'HH:mm:ss).

Example response

[
  {
    "id": 12,
    "vatCode": "1",
    "rate": 8.1,
    "validFrom": "2024-01-01",
    "validTo": "2030-12-31",
    "defaultVat": true,
    "masterVatMulties": [
      {
        "id": 101,
        "language": "de",
        "description": "Normalsatz 8.1 %"
      }
    ],
    "referenceVatCaseId": "VC-7",
    "createDate": "2024-01-01T08:00:00",
    "updateDate": "2024-06-15T14:30:00"
  }
]

Changes

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