Accounting

Get or recompute the VAT clearing report of a company for a given period.

Returns the VAT clearing report of the caller's company for the requested calendar <code>year</code> and reporting <code>quarter</code> (quarter, semester or yearly). When <code>recalculate=true</code> the report is recomputed from the current bookings and the stored <code>CALCULATED</code> snapshot is rewritten before being returned; this is why the operation uses <code>POST</code> rather than <code>GET</code>. When <code>recalculate=false</code> the latest <code>CALCULATED</code> snapshot is returned as-is, or — if only a <code>SEALED</code> snapshot exists — that one. The caller must hold the <code>ACCOUNTING</code> permission on the targeted company.

post/core/v1/vat-clearing-reports/{year}/{quarter}

Request

Base URL: https://api.klara.ch
URL: https://api.klara.ch/core/v1/vat-clearing-reports/{year}/{quarter}
Auth: one of:
- API key in header X-API-KEY
- HTTP bearer

Path parameters

quarter'Q1' | 'Q2' | 'Q3' | 'Q4' | 'S1' | 'S2' | 'YEAR_NET_TAX_RATE' | 'YEAR_EFFECTIVE' required

Reporting period of a VAT clearing report.

Example:Q1

Reporting period within the year. Allowed values: Q1, Q2, Q3, Q4, S1, S2, YEAR_NET_TAX_RATE, YEAR_EFFECTIVE.

yearinteger required

Example:2024

Calendar year of the reporting period.

Query parameters

recalculateboolean

If true, recompute the report from current bookings and overwrite the stored CALCULATED snapshot before returning. Defaults to false.

Headers

Accept-Languagestring

Example:de-CH

Preferred language for localized labels in the response. Examples: de-CH, de, fr-CH, it-CH, en.

Response

The VAT clearing report.

idinteger

Internal id of the report.

status'CALCULATED' | 'SEALED'

Current status of the report.

yearinteger

Calendar year of the reporting period.

period'Q1' | 'Q2' | 'Q3' | 'Q4' | 'S1' | 'S2' | 'YEAR_NET_TAX_RATE' | 'YEAR_EFFECTIVE'

Reporting period within the year.

correctionCountinteger

Number of booking corrections detected versus the sealed snapshot.

formerVatRateReleaseDatestring date

Release date of the former VAT rates that still apply to a part of the period.

newVatRatesReleasedboolean

Whether new VAT rates have been released and apply to part of the period.

periodFromstring date

Start date of the reporting period.

periodTostring date

End date of the reporting period.

Example response

{
  "id": 987,
  "codeBoxes": [
    {
      "id": 1234,
      "code": "302",
      "value": 12345.67,
      "description": "Steuerbarer Umsatz",
      "editableDescription": true,
      "rate": 8.1
    }
  ],
  "status": "CALCULATED",
  "year": 2024,
  "period": "Q1",
  "formerVatRateReleaseDate": "2023-12-31T00:00:00Z",
  "periodFrom": "2024-01-01T00:00:00Z",
  "periodTo": "2024-03-31T00:00:00Z"
}

Changes

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