# Reports

Methods for Reporting: Initiating custom report creation, listing created reports (including preview, pdf and HTML) as well as creating demo reports with test data.

Salaxy API v03, **Finland only**. 32 operations. Interactive version: [REST API reference](https://code.salaxy.com/reference/rest-api.md). Machine-readable: [OpenAPI document](https://code.salaxy.com/openapi/salaxy-03.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 /v03/api/reports/type/{type}`

**Gets all the generated reports of specific type for this user.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `type` | path | ReportType | yes |  |

Response: `Report[]`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/type/{type})

## `GET /v03/api/reports/type/{type}/{id}`

**Gets a single report by type and id for this user.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `type` | path | ReportType | yes | Report type. |
| `id` | path | string | yes | Report id. |
| `wait` | query | boolean |  | Optional flag to indicate, whether to wait for the report to be generated. |

Response: `Report[]`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/type/{type}/{id})

## `GET /v03/api/reports/assure/{type}`

**Assures that the report (pdf) exists for given calculations (ids).**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `type` | path | ReportType | yes | Calculation report type. |
| `ids` | query | string[] |  | Ids for calculations. |
| `language` | query | Language |  | Language for the report. |

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/assure/{type})

## `POST /v03/api/reports/assure/{type}`

**Assures that the report (pdf) exists for given calculations.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `type` | path | ReportType | yes | Calculation report type. |
| `language` | query | Language |  | Language for the report. |

Request body: `ReportingCalculation[]` (required)

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/POST/v03/api/reports/assure/{type})

## `GET /v03/api/reports/assure-pdf/{type}`

**Assures that the report (pdf) exists for given calculations (ids).**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `type` | path | ReportType | yes | Calculation report type. |
| `ids` | query | string[] |  | Ids for calculations. |
| `language` | query | Language |  | Language for the report. |
| `disposition` | query | string |  | Optional content disposition parameter (inline or attachment), if the response should be returned as file. |

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/assure-pdf/{type})

## `POST /v03/api/reports/assure-pdf/{type}`

**Assures that the report (pdf) exists for given calculations.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `type` | path | ReportType | yes | Calculation report type. |
| `language` | query | Language |  | Language for the report. |
| `disposition` | query | string |  | Optional content disposition parameter (inline or attachment), if the response should be returned as file. |
| `watermark` | query | string |  | Optional watermark text for the report. Value "default" will show the default language versioned watermark. |

Request body: `ReportingCalculation[]` (required)

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/POST/v03/api/reports/assure-pdf/{type})

## `POST /v03/api/reports/pdf/{type}`

**Gets PDF reporst for the specified calculations.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `type` | path | ReportType | yes | The report type. |
| `language` | query | Language |  | The language for the report. |
| `disposition` | query | string |  | Optional content disposition parameter (inline or attachment), if the response should be returned as file. |
| `watermark` | query | string |  | Optional watermark text for the report. Value "default" will show the default language versioned watermark. |

Request body: `ReportingCalculationCollection` (required)

Response: The generated PDF report.

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/POST/v03/api/reports/pdf/{type})

## `GET /v03/api/reports/accounting/{refDate}`

**Gets the monthly / yearly accounting data.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `target` | query | string |  | Accounting target: contains default ruleset for creating accounting entries. |
| `periodType` | query | PeriodType |  | Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month. |
| `endDate` | query | string |  | End date for the period. Required only for the custom period. |
| `periodDateKind` | query | PeriodDateKind |  | Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date. |
| `minStatus` | query | CalculationStatus |  | Minimum status level for the calculations: draft-paymentStarted-paymentSucceeded. The default level is paymentSucceeded. |
| `createdFrom` | query | string |  | Minimum creation date for the calculation included in the report. |

Response: `AccountingData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/accounting/{refDate})

## `GET /v03/api/reports/accounting/{id}`

**Gets the accounting data from the saved report id.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | Saved accounting data file id. |
| `target` | query | string |  | Accounting target: contains default ruleset for creating accounting entries. |

Response: `AccountingData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/accounting/{id})

## `GET /v03/api/reports/accounting`

**Gets the accounting data based on given set of calculations.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `calculationIds` | query | string[] |  | Calculations that are the bases for the report. |
| `target` | query | string |  | Accounting target: contains default ruleset for creating accounting entries. |

Response: `AccountingData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/accounting)

## `POST /v03/api/reports/accounting`

**Gets the accounting data based on given set of calculations.
This method can be accessed anonymously for testing / development purposes.
In this case, last valid calculation employer is set as employer avatar, but other employer information is not filled in.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `target` | query | string |  | Accounting target: contains default ruleset for creating accounting entries. |

Request body: `ReportingCalculation[]` (required)

Response: `AccountingData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/POST/v03/api/reports/accounting)

## `GET /v03/api/reports/accounting/{refDate}/holiday-pay-debt`

**Gets the accounting data for the holiday pay debt.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Last month to include in the report. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `target` | query | string |  | Accounting target: contains default ruleset for creating accounting entries. |
| `employmentIds` | query | string[] |  | Employment relations for which to get the holiday debt. If not given, all employment relations are incluced. |
| `fromHolidayYear` | query | integer |  | Return debt only starting from the given year. |

Response: `AccountingData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/accounting/{refDate}/holiday-pay-debt)

## `POST /v03/api/reports/accounting/{refDate}/close`

**Closes the accounting period (month).**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Date for the period. The first date of the month. |
| `option` | query | AccountingPeriodClosingOption |  | Option for closing the period. Currently only default -option supporte. |

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/POST/v03/api/reports/accounting/{refDate}/close)

## `GET /v03/api/reports/validate/payCertificate/{id}`

**Validates the request for pay certificate.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | Worker ID. |
| `calculationIds` | query | string[] |  | IDs of the calculations selected for the period. |

Response: `ApiValidation`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/validate/payCertificate/{id})

## `GET /v03/api/reports/validate/pay-certificate/{id}`

**Validates the request for pay certificate.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | Worker ID. |
| `calculationIds` | query | string[] |  | IDs of the calculations selected for the period. |

Response: `ApiValidation`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/validate/pay-certificate/{id})

## `GET /v03/api/reports/calculation/{refDate}`

**Returns the raw data for the calculation based reports.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `periodType` | query | PeriodType |  | Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month. |
| `endDate` | query | string |  | End date for the period. Required only for the custom period. |
| `periodDateKind` | query | PeriodDateKind |  | Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date. |
| `workers` | query | string[] |  | List of workers (by official id) to include in the report. |

Response: `CalculationReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/calculation/{refDate})

## `GET /v03/api/reports/calculation`

**Returns the raw data for cumulative reports calculated from given set of calculations.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `calculationIds` | query | string[] |  | Calculations that are the bases for the report. |

Response: `CalculationReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/calculation)

## `POST /v03/api/reports/table/{type}`

**Returns tabular report data (rows + column metadata) for AG Grid.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `type` | path | TableReportType | yes | Report type. |

Request body: `TableReportQuery` (required)

Response: `TableReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/POST/v03/api/reports/table/{type})

## `GET /v03/api/reports/accountingRow/{refDate}`

**Returns the raw data for the accounting row reports.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `periodType` | query | PeriodType |  | Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month. |
| `endDate` | query | string |  | End date for the period. Required only for the custom period. |
| `periodDateKind` | query | PeriodDateKind |  | Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date. |
| `workers` | query | string[] |  | List of workers (by official id) to include in the report. |
| `createdFrom` | query | string |  | Minimum creation date for the calculation included in the report. |

Response: `AccountingRowReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/accountingRow/{refDate})

## `GET /v03/api/reports/accounting-row/{refDate}`

**Returns the raw data for the accounting row reports.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `periodType` | query | PeriodType |  | Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month. |
| `endDate` | query | string |  | End date for the period. Required only for the custom period. |
| `periodDateKind` | query | PeriodDateKind |  | Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date. |
| `workers` | query | string[] |  | List of workers (by official id) to include in the report. |
| `createdFrom` | query | string |  | Minimum creation date for the calculation included in the report. |

Response: `AccountingRowReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/accounting-row/{refDate})

## `GET /v03/api/reports/accountingRow`

**Returns the raw data for row reports calculated from given set of calculations.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `calculationIds` | query | string[] |  | Calculations that are the bases for the report. |

Response: `AccountingRowReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/accountingRow)

## `GET /v03/api/reports/accounting-row`

**Returns the raw data for row reports calculated from given set of calculations.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `calculationIds` | query | string[] |  | Calculations that are the bases for the report. |

Response: `AccountingRowReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/accounting-row)

## `GET /v03/api/reports/holiday-pay-debt/{refDate}`

**Returns the holiday pay debt data report based on given employments.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Last month to include in the report. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `employmentIds` | query | string[] |  | Employment relations for which to get the holiday debt. If not given, all employment relations are incluced. |

Response: `AccountingHolidayPayDebtReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/holiday-pay-debt/{refDate})

## `GET /v03/api/reports/summary/{refDate}`

**Returns the raw data for the summary reports.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `periodType` | query | PeriodType |  | Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month. |
| `endDate` | query | string |  | End date for the period. Required only for the custom period. |
| `periodDateKind` | query | PeriodDateKind |  | Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date. |
| `workers` | query | string[] |  | List of workers (by official id) to include in the report. |

Response: `SummaryReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/summary/{refDate})

## `GET /v03/api/reports/summary`

**Returns the raw data for the summary reports.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `calculationIds` | query | string[] |  | Calculations that are the bases for the report. |

Response: `SummaryReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/summary)

## `GET /v03/api/reports/summary/{refDate}/{workerId}/{employerId}`

**Returns the raw data for the worker summary reports.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `workerId` | path | string | yes | Worker id or keyword "self" to get the WorkerCopies for the current account instead. Please note that ID can be social security number or workers technical id. |
| `employerId` | path | string | yes | Employer id. If null, first employer report will be returned. |
| `periodType` | query | PeriodType |  | Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month. |
| `endDate` | query | string |  | End date for the period. Required only for the custom period. |
| `periodDateKind` | query | PeriodDateKind |  | Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is Salary date. |

Response: `WorkerSummaryReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/summary/{refDate}/{workerId}/{employerId})

## `GET /v03/api/reports/cumulative-calculation/{id}`

**Returns the calculation with cumulative data.
Please note that the cumulative data is calculated from several calculations preceding the the calculation.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | The calculation for which the cumulative report is created for. |

Response: `CumulativeCalculation`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/cumulative-calculation/{id})

## `GET /v03/api/reports/pay-stats/{employmentId}`

**Returns the calculated pay statistics for the given employment relation.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `employmentId` | path | string | yes | The employment relation for which to calculate the statistics values. |

Response: `PayStatsCalculationReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/pay-stats/{employmentId})

## `GET /v03/api/reports/pay-stats-calc/{employmentId}`

**Returns the calculated pay statistics for the given employment relation.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `employmentId` | path | string | yes | The employment relation for which to calculate the statistics values. |

Response: `PayStatsCalculationReportData`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/pay-stats-calc/{employmentId})

## `GET /v03/api/reports/data/accounting/{tableType}/{refDate}`

**Gets the monthly / yearly accounting data.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `refDate` | path | string | yes | Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned. |
| `tableType` | path | AccountingReportTableType | yes | Accounting report table type. |
| `periodType` | query | PeriodType |  | Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month. |
| `endDate` | query | string |  | End date for the period. Required only for the custom period. |
| `minStatus` | query | CalculationStatus |  | Minimum status level for the calculations: draft-paymentStarted-paymentSucceeded. The default level is paymentSucceeded. |
| `createdFrom` | query | string |  | Minimum creation date for the calculation included in the report. |

Response: `AccountingReportTable`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/data/accounting/{tableType}/{refDate})

## `GET /v03/api/reports/data/accounting/{tableType}`

**Gets the accounting report based on given set of calculations.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `calculationIds` | query | string[] |  | Calculations that are the bases for the report. |
| `tableType` | path | AccountingReportTableType | yes | Accounting report table type. |

Response: `AccountingReportTable`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/GET/v03/api/reports/data/accounting/{tableType})

## `POST /v03/api/reports/data/accounting/{tableType}`

**Gets the accounting report based on given set of calculations.
This method can be accessed anonymously for testing / development purposes.
In this case, last valid calculation employer is set as employer avatar, but other employer information is not filled in.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `tableType` | path | AccountingReportTableType | yes | Accounting report table type. |

Request body: `ReportingCalculation[]` (required)

Response: `AccountingReportTable`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/reports/POST/v03/api/reports/data/accounting/{tableType})
