Appearance
HouseholdYear
Views and updates household yearly deduction data.
Salaxy API v03, Finland only. 11 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.
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.
GET /v03/api/household-years
Performs an OData query to the search index.
| 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
POST /v03/api/household-years
Updates or creates a new object
Request body: HouseholdYear (required)
Response: HouseholdYear
Try it: interactive reference
GET /v03/api/household-years/{id}
Gets a single object based on identier
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Unique identifier for the object. |
Response: HouseholdYear
Try it: interactive reference
DELETE /v03/api/household-years/{id}
Deletes an object from the storage
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Unique identifier for the object. |
Response: string
Try it: interactive reference
GET /v03/api/household-years/new
Factory method that creates a new object
Response: HouseholdYear
Try it: interactive reference
POST /v03/api/household-years/{id}/processingStatus/{processingStatus}
Requests an update for the processing status of the household year deduction..
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the year to update. |
processingStatus | path | HouseholdYearProcessingStatus | yes | The requested processing status for the deduction. |
Response: HouseholdYear
Try it: interactive reference
GET /v03/api/household-years/{id}/processingStatus/{processingStatus}
Requests an update for the processing status of the household year deduction..
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the year to update. |
processingStatus | path | HouseholdYearProcessingStatus | yes | The requested processing status for the deduction. |
Response: HouseholdYear
Try it: interactive reference
POST /v03/api/household-years/{id}/pdfs
Returns pdf files for the given household year
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the year. |
signature | query | string | Signing statement. |
Response: object[]
Try it: interactive reference
GET /v03/api/household-years/{id}/pdfs
Returns pdf files for the given household year
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the year. |
signature | query | string | Signing statement. |
Response: object[]
Try it: interactive reference
GET /v03/api/household-years/calculations
Gets all paid calculations for the given year.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
year | query | integer | Year or null. If null, the current year is used. |
Response: Calculation[]
Try it: interactive reference
POST /v03/api/household-years/calculations
Updates the household data in the calculation.
Request body: Calculation (required)
Response: Calculation
Try it: interactive reference

