Accounting

Resolve a master VAT catalog row by its numeric id.

Loads a single master VAT row from Klara's global master VAT catalog, identified by its numeric primary-key <code>masterVatId</code>. The catalog is global Klara reference data — the same row is returned for every tenant, so there are no tenant or company path parameters. 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/v1/accounting/master-vats/{masterVatId}

Request

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

Path parameters

masterVatIdinteger required
Example:12

Numeric primary-key id of the master VAT row to resolve. Obtain it from <code>GET /core/v1/accounting/master-vats</code> or <code>GET /core/v1/accounting/master-vats/current</code>.

Response

The master VAT row matching <code>masterVatId</code>, including its rate, VAT code and validity range.

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.