Skip to content

HouseholdYear ​

Beta

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

Views and updates household yearly deduction data.

Salaxy API v04 (beta), 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 /v04/api/household-years ​

Performs an OData query to the search index.

ParameterInTypeRequiredDescription
$searchquerystring
$filterquerystringSpecifies the logic to pull back a subset of records.
$orderbyquerystringSpecifies the values used to sort the collection of entries.
$selectquerystringThe $select system query option allows the clients to requests a limited set of properties for each entry.
$topquerynumberSpecifies the subset of entries by count.
$skipquerynumberSpecifies the count of entries to skip.
$countquerybooleanIndicates whether or not to include a total entry count.

Response: PageResultOfHouseholdYearListItem

Try it: interactive reference

POST /v04/api/household-years ​

Updates or creates a new object

Request body: HouseholdYear (required)

Response: HouseholdYear

Try it: interactive reference

GET /v04/api/household-years/{id} ​

Gets a single object based on identier

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: HouseholdYear

Try it: interactive reference

DELETE /v04/api/household-years/{id} ​

Deletes an object from the storage

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v04/api/household-years/new ​

Factory method that creates a new object

Response: HouseholdYear

Try it: interactive reference

POST /v04/api/household-years/{id}/processingStatus/{processingStatus} ​

Requests an update for the processing status of the household year deduction..

ParameterInTypeRequiredDescription
idpathstringyesId of the year to update.
processingStatuspathHouseholdYearProcessingStatusyesThe requested processing status for the deduction.

Response: HouseholdYear

Try it: interactive reference

GET /v04/api/household-years/{id}/processingStatus/{processingStatus} ​

Requests an update for the processing status of the household year deduction..

ParameterInTypeRequiredDescription
idpathstringyesId of the year to update.
processingStatuspathHouseholdYearProcessingStatusyesThe requested processing status for the deduction.

Response: HouseholdYear

Try it: interactive reference

POST /v04/api/household-years/{id}/pdfs ​

Returns pdf files for the given household year

ParameterInTypeRequiredDescription
idpathstringyesId of the year.
signaturequerystringSigning statement.

Response: object[]

Try it: interactive reference

GET /v04/api/household-years/{id}/pdfs ​

Returns pdf files for the given household year

ParameterInTypeRequiredDescription
idpathstringyesId of the year.
signaturequerystringSigning statement.

Response: object[]

Try it: interactive reference

GET /v04/api/household-years/calculations ​

Gets all paid calculations for the given year.

ParameterInTypeRequiredDescription
yearqueryintegerYear or null. If null, the current year is used.

Response: Calculation[]

Try it: interactive reference

POST /v04/api/household-years/calculations ​

Updates the household data in the calculation.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.