# Pro

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

Methods for PRO users (accountants, integrated services), for fetching data accross multiple accounts and impersonating as different authorized acccounts: Fetching the token and session.

Salaxy API v04 (beta), **Finland only**. 26 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/pro/session`

**Returns the current account from the session.**

Response: Current account from session.

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

## `GET /v04/api/pro/accounts`

**Lists all accounts on behalf of which this account has been authorized to act.**

Response: Accounts that this account can act on behalf of.

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

## `GET /v04/api/pro/authorizingAccounts`

**Lists all accounts on behalf of which this account has been authorized to act.**

Response: Accounts that this account can act on behalf of.

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

## `POST /v04/api/pro/accounts/{accountId}/partner`

**Set the current account as primary partner for the account.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `accountId` | path | string | yes | Account id of the account. |
| `serviceModelId` | query | string |  | Selected service model. |

Response: Updated account with the partner set.

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/pro/POST/v04/api/pro/accounts/{accountId}/partner)

## `DELETE /v04/api/pro/accounts/{accountId}/partner`

**Remove the current primary partner (current account) from the account.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `accountId` | path | string | yes |  |

Response: Updated account with the partner set.

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/pro/DELETE/v04/api/pro/accounts/{accountId}/partner)

## `GET /v04/api/pro/credentials`

**Lists all credentials for this partner account.**

Response: Credentials for the partner account.

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

## `GET /v04/api/pro/accounts/{accountId}/token`

**Returns a new JWT token for the given account.
The requesting user must have access to the account: for IAM logins, the account must also be allowed in IAM,
except a pending connection (authorized the current account, no primary partner yet) that the accountant may take as a customer.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `accountId` | path | string | yes |  |

Response: JWT token.

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/pro/GET/v04/api/pro/accounts/{accountId}/token)

## `POST /v04/api/pro/clearIAMCache`

**Clears the IAM cache (allowed companies) of the current organization (the account the user is logged in as)
for all its users on all backend nodes, e.g. after the organization's companies have been changed in IAM.**

Response: True if cleared; false if the current user is not an IAM user.

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

## `GET /v04/api/pro/workbench`

**The Pro work list (Hoidettavat): the customers and each customer's tasks with due dates, computed from the search index.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `accountId` | query | string |  | One customer's account id (the customer's own page); every customer when empty. |

Response: `WorkbenchResult`

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

## `GET /v04/api/pro/payrolls`

**Returns list of payrolls for the current partner.**

| 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: `PageResultOfPayrollListItem`

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

## `GET /v04/api/pro/messages`

**Returns list of message threads for the current partner.**

| 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: `PageResultOfMessageListItem`

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

## `GET /v04/api/pro/calculations/editable`

**Returns list of editable calculations for the current partner.**

| 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/pro/GET/v04/api/pro/calculations/editable)

## `GET /v04/api/pro/calculations/readonly`

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

| 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/pro/GET/v04/api/pro/calculations/readonly)

## `GET /v04/api/pro/workers`

**Returns worker list items for the current partner.
Please not that data.isTerminated reflects the status of the employment relation as of today and is not part of filtering or sorting.
Instead filtering by data.isTerminated results to filtering on any isTerminated flag regardless of start/end days.
If you wish to filter data.isTerminated, use data.startDate and data.endDate taking into consideration that they may also be null.**

| 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: `PageResultOfWorkerListItem`

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

## `GET /v04/api/pro/invoices`

**Returns invoices list items for the current partner.**

| 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: `PageResultOfInvoiceListItem`

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

## `GET /v04/api/pro/files`

**Returns report list items for the current partner.**

| 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: `PageResultOfFileListItem`

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

## `GET /v04/api/pro/taxcards`

**Returns list of taxcards for the current partner.**

| 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: `PageResultOfTaxcardListItem`

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

## `GET /v04/api/pro/records`

**Returns list of records for the current partner.**

| 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: `PageResultOfRecordListItem`

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

## `GET /v04/api/pro/ir-epr`

**Returns list of Earnings Payment Reports (EPR / Palkkatietoilmoitus)
for Incomes Registry (tulorekisteri).**

| 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: `PageResultOfEarningsPaymentListItem`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/pro/GET/v04/api/pro/ir-epr)

## `GET /v04/api/pro/ir-psr`

**Returns list of Payer Summary Reports (PSR / Erillisilmoitus)
for Incomes Registry (tulorekisteri).**

| 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: `PageResultOfPayerSummaryListItem`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/pro/GET/v04/api/pro/ir-psr)

## `GET /v04/api/pro/household-years`

**Returns household yearly list items for the current partner.**

| 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: `PageResultOfHouseholdYearListItem`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/pro/GET/v04/api/pro/household-years)

## `GET /v04/api/pro/settings`

**Returns settings list items for the current partner.**

| 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: `PageResultOfAccountSettingsListItem`

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

## `GET /v04/api/pro/customers`

**Returns list of customers for the current partner.**

| 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: `PageResultOfPersonListItem`

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

## `GET /v04/api/pro/customers/{refDate}`

**Lists customers which paid calculations in the given period.**

| 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. |

Response: `PageResultOfPersonListItem`

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

## `GET /v04/api/pro/payment-messages`

**Payment messages (maksuaineisto) of the customers from the search index, newest first unless ordered. The customers are
the same as in the invoice list. Act on a message with the company endpoints (v03/api/payment-messages) and the
customer's token: they read the table, which the index follows about a second later.**

| 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: `PageResultOfPaymentMessageListItem`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/pro/GET/v04/api/pro/payment-messages)

## `GET /v04/api/pro/payment-messages/counts`

**Counts of the payment messages per status and per channel, over the same filter and search as the list. Leave the
status filter out to count every status group.**

| 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: `PaymentMessageCounts`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/pro/GET/v04/api/pro/payment-messages/counts)
