Skip to content

Invoice ​

Beta

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

Invoices in Salaxy contect are the payments that should be made to pay the net salary and side costs. The service is for querying invoices and notifying them as unread/paid/read/canceled from 3rd party system.

Salaxy API v04 (beta), Finland only. 23 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/invoices ​

Returns list of invoices for the current owner.

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

Try it: interactive reference

GET /v04/api/invoices/{id} ​

Gets a single invoice. based on identier.

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object

Response: Invoice

Try it: interactive reference

DELETE /v04/api/invoices/{id} ​

Deletes an object from the storage

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v04/api/invoices/{id}/content ​

Downloads the pdf file for the invoice.

ParameterInTypeRequiredDescription
idpathstringyesThe id of the invoice.
inlinequerybooleanIf true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.

Response: OK

Try it: interactive reference

POST /v04/api/invoices/content ​

Downloads the pdf file for the invoice.

ParameterInTypeRequiredDescription
inlinequerybooleanIf true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.

Request body: Invoice (required)

Response: OK

Try it: interactive reference

GET /v04/api/invoices/sepa ​

Downloads the sepa file for the posted ids.

ParameterInTypeRequiredDescription
idsquerystring[]Ids of the invoices for the sepa payment.
payerIbanNumberquerystringPayer iban number.
payerBicquerystringPayer BIC.
bankPartyIdquerystringPayer bank party id. Depends on the bank.
inlinequerybooleanIf true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.
versionquerystringISO 20022 version, pain.001.001.02 (default) or pain.001.001.03

Response: OK

Try it: interactive reference

POST /v04/api/invoices/sepa ​

Downloads the sepa file for the posted invoices.

ParameterInTypeRequiredDescription
payerIbanNumberquerystringPayer iban number.
payerBicquerystringPayer BIC.
bankPartyIdquerystringPayer bank party id. Depends on the bank.
inlinequerybooleanIf true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.
versionquerystringISO 20022 version, pain.001.001.02 (default) or pain.001.001.03

Request body: Invoice[] (required)

Response: OK

Try it: interactive reference

GET /v04/api/invoices/{id}/finvoice ​

Downloads the finvoice file for the invoice.

ParameterInTypeRequiredDescription
idpathstringyesThe id of the invoice.
inlinequerybooleanIf true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.

Response: OK

Try it: interactive reference

POST /v04/api/invoices/finvoice ​

Downloads the finvoice file for the invoice.

ParameterInTypeRequiredDescription
inlinequerybooleanIf true, returns the content as inline (disposition). If false, the content is returned as an attachment.

Request body: Invoice (required)

Response: OK

Try it: interactive reference

POST /v04/api/invoices/create/{channel} ​

Saves the calculation in its current state and creates invoices to pay a salary calculation. Note that if the calculation is already read-only, it will NOT be saved => Will be fetched from storage.

ParameterInTypeRequiredDescription
channelpathPaymentChannelyesPayment channel to use.
excludePeriodicInvoicesquerybooleanIf true, creates and returns calculation specific invoices immediately and creates periodic invoices in the background. The default option is false, all invoices are created immediately.

Request body: Calculation (required)

Response: Invoice[]

Try it: interactive reference

POST /v04/api/invoices/create/{channel}/tax ​

Creates/updates a tax invoice for the period. If there is already a read-only tax invoice in the period, throws an error.

ParameterInTypeRequiredDescription
channelpathPaymentChannelyesPayment channel to use.
monthquerystringMonth for the tax invoice.

Response: Invoice

Try it: interactive reference

POST /v04/api/invoices/create/{channel}/union ​

Creates/updates a union invoice for the period. If there is already a read-only union invoice in the period, throws an error.

ParameterInTypeRequiredDescription
channelpathPaymentChannelyesPayment channel to use.
monthquerystringMonth for the union invoice.

Response: Invoice[]

Try it: interactive reference

POST /v04/api/invoices/create-by-id/{channel} ​

Creates invoices to pay a salary calculation(s) that have already been stored in the database.

ParameterInTypeRequiredDescription
channelpathPaymentChannelyesPayment channel to use.
excludePeriodicInvoicesquerybooleanIf true, creates and returns calculation specific invoices immediately and creates periodic invoices in the background. The default option is false, all invoices are created immediately.

Request body: string[] (required)

Response: Invoice[]

Try it: interactive reference

POST /v04/api/invoices/create-for-payroll/{channel}/{payrollId} ​

Creates invoices to pay a Payroll object that has already been stored in the database.

ParameterInTypeRequiredDescription
channelpathPaymentChannelyesPayment channel to use.
payrollIdpathstringyesIdentifier for the Payroll object.
excludePeriodicInvoicesquerybooleanIf true, creates and returns calculation specific invoices immediately and creates periodic invoices in the background. The default option is false, all invoices are created immediately.

Response: Invoice[]

Try it: interactive reference

POST /v04/api/invoices/preview-and-created/{channel} ​

Previews invoices to pay a salary calculation(s) and fetches the ones that have already been created. Used for payment dialog preview: Does not yet save the invoices and does not do any other storage saves.

ParameterInTypeRequiredDescription
channelpathPaymentChannelyesChannel to which the invoices are generated.
excludePeriodicInvoicesquerybooleanIf true, does not return periodic invoices. Only calculation specific invoices are returned.

Request body: CalculationCollection (required)

Response: InvoicePreview[]

Try it: interactive reference

POST /v04/api/invoices/{id}/status/{status} ​

Requests an update for the status of an invoice.

ParameterInTypeRequiredDescription
idpathstringyesId of the invoice to update.
statuspathInvoiceStatusyesThe requested status for the invoice.

Response: Invoice

Try it: interactive reference

GET /v04/api/invoices/{id}/status/{status} ​

Requests an update for the status of an invoice.

ParameterInTypeRequiredDescription
idpathstringyesId of the invoice to update.
statuspathInvoiceStatusyesThe requested status for the invoice.

Response: Invoice

Try it: interactive reference

POST /v04/api/invoices/{id}/einvoice ​

Sends the invoice as einvoice.

ParameterInTypeRequiredDescription
idpathstringyesInvoice id for which the einvoice should be generated and sent.
receiverquerystringReceiver address (eivoice)
intermediatorquerystringIntermediator address (einvoice)

Response: object

Try it: interactive reference

GET /v04/api/invoices/psd/accounts ​

List current PSD accounts for the given bank.

ParameterInTypeRequiredDescription
bankqueryBankSelected bank.

Response: Account[]

Try it: interactive reference

POST /v04/api/invoices/create/{channel}/{id} ​

ParameterInTypeRequiredDescription
channelpathPaymentChannelyes
idpathstringyes

Response: Invoice[]

Try it: interactive reference

POST /v04/api/invoices/preview-for-payroll/{channel}/{payrollId} ​

ParameterInTypeRequiredDescription
channelpathPaymentChannelyes
payrollIdpathstringyes

Response: Invoice[]

Try it: interactive reference

POST /v04/api/invoices/preview/{channel} ​

ParameterInTypeRequiredDescription
channelpathPaymentChannelyes

Request body: Calculation (required)

Response: Invoice[]

Try it: interactive reference

POST /v04/api/invoices/preview-by-id/{channel} ​

ParameterInTypeRequiredDescription
channelpathPaymentChannelyes

Request body: string[] (required)

Response: Invoice[]

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.