# CalcCorrection

**Beta:**
Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.

Endpoints for correcting readonly and paid calculations.

Salaxy API v04 (beta), **Finland only**. 6 operations. Interactive version: [REST API reference](https://code.salaxy.com/reference/rest-api-v04.md). Machine-readable: [OpenAPI document](https://code.salaxy.com/openapi/salaxy-04.json).

**The reference wins:**
These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see [Errors](https://code.salaxy.com/reference/errors.md).

## `GET /v04/api/calculations/correction`

**Returns list of readonly calculations for the current employer.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `$search` | query | string |  |  |
| `$filter` | query | string |  | Specifies the logic to pull back a subset of records. |
| `$orderby` | query | string |  | Specifies the values used to sort the collection of entries. |
| `$select` | query | string |  | The $select system query option allows the clients to requests a limited set of properties for each entry. |
| `$top` | query | number |  | Specifies the subset of entries by count. |
| `$skip` | query | number |  | Specifies the count of entries to skip. |
| `$count` | query | boolean |  | Indicates whether or not to include a total entry count. |

Response: `PageResultOfCalculationListItem`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/calccorrection/GET/v04/api/calculations/correction)

## `POST /v04/api/calculations/correction`

**Commits the pending changes to the calculation**

Request body: `CalculationCorrection` (required)

Response: `CalculationCorrection`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/calccorrection/POST/v04/api/calculations/correction)

## `GET /v04/api/calculations/correction/{id}`

**Gets a single calculation for correction based on identier**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | Unique identifier for the calculation. |

Response: `CalculationCorrection`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/calccorrection/GET/v04/api/calculations/correction/{id})

## `POST /v04/api/calculations/correction/refresh/{refresh}`

**Refreshes the calculation. Does not save the calculation.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refresh` | path | CalculationRefresh | yes | Refreshable logical part of the calculation. |

Request body: `CalculationCorrection` (required)

Response: `CalculationCorrection`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/calccorrection/POST/v04/api/calculations/correction/refresh/{refresh})

## `GET /v04/api/calculations/correction/{id}/document-flow`

**Returns document flow for the given calculation.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | Id of the calculation |

Response: `DocumentFlowItem`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/calccorrection/GET/v04/api/calculations/correction/{id}/document-flow)

## `GET /v04/api/calculations/correction/snapshot/categories`

**Lists all distinct categories for snapshots.**

Response: `string[]`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/calccorrection/GET/v04/api/calculations/correction/snapshot/categories)
