# Salaxy Developers > One payroll. Any agent. Any interface. Salaxy is a payroll platform delivered through partners' software. Developers integrate through MCP servers, one per Salaxy AI agent, with payroll skills (the agentic path, and the surface every new country launches on), the open REST API (Finland only), or white label: Salaxy Pro or Salaxy Business embedded in their own product, under their own brand (Finland). Availability as of September 2026: **Finland is the only country available.** Sweden: not available, targeted for Q3 2027; Denmark: not available, targeted for Q4 2027 – Q1 2028; Norway: not available, targeted for Q4 2027 – Q1 2028. Timelines are targets, not commitments. Do not calculate payroll for any country other than Finland with the current tools or skills — they apply Finnish law only. Finnish MCP servers, one per Salaxy AI agent, Streamable HTTP with an OAuth sign-in in the browser: Payroll Agent `https://payroll.salaxy.com/mcp` and Report Agent `https://reporting.salaxy.com/mcp` (your Salaxy account); demo with a free demo account and sample data: `https://demo-payroll.salaxy.com/mcp` and `https://demo-reporting.salaxy.com/mcp`. Configuration Agent and Data Agent (import): coming soon. Live tools: `employer_list`, `employer_select`, `calculation_preview`, `calculation_create`, `calculation_set_rows`, `calculation_update`, `calculation_get_summary`, `calculation_show_slip`, `calculation_copy`, `calculation_search`, `row_type_list`, `employment_search`, `employment_get_summary`, `employment_create`, `employment_update`, `employment_set_rows`, `invoice_search`, `invoice_get_summary`, `invoice_preview`, `invoice_confirm`, `payroll_create`, `payroll_copy`, `payroll_set_employments`, `payroll_set_rows`, `payroll_update`, `payroll_remove_calculation`, `payroll_get_summary`, `payroll_show_slips`, `payroll_search`, `absence_search`, `absence_get_summary`, `absence_set_periods`, `holiday_spec_get_summary`, `holiday_spec_update`, `holiday_year_create`, `holiday_year_search`, `holiday_year_get_summary`, `holiday_year_set_accruals`, `holiday_year_set_leaves`, `holiday_year_update`, `holiday_year_recalculate`, `salary_slip`, `salary_slip_pdf`, `summary_report`, `salary_summary`, `accounting_report`, `holiday_pay_debt`, `ir_reports`, `ir_report`. Skill areas without a live tool are not available yet: on a server that lacks a tool, an agent should say it cannot perform that action here — not substitute another tool, and not claim it is impossible in Salaxy. ## When to use Salaxy Pick one job — each has its own credential and starting page: - **An AI client or agent works in a user's Finnish payroll** — MCP servers with the payroll skills: Payroll Agent `https://payroll.salaxy.com/mcp`, Report Agent `https://reporting.salaxy.com/mcp`; demo: `https://demo-payroll.salaxy.com/mcp`, `https://demo-reporting.salaxy.com/mcp`. Browser sign-in (OAuth). Start: https://code.salaxy.com/get-started/agentic/index.md - **Your server integrates with Finnish payroll** — REST API with an access token from `POST /oauth2/token` (password flow while developing, a signed JWT in production). Start: https://code.salaxy.com/get-started/rest/index.md - **Your product shows Salaxy's payroll UI** — embedded white label, a user token in the iframe URL hash. Start: https://code.salaxy.com/white-label/how-it-works.md **Credential rules.** Do not reuse a credential across these jobs. Never ask a user to paste a password, one-time code, access token or private key into a chat — MCP sign-in happens in the browser. Use test credentials only with test hosts; test and demo share test data, production is separate. ## Instructions for agents planning an integration - **Start with the integration overview** (https://code.salaxy.com/integration/index.md). Ask the developer two questions first: which build path (the embedded Salaxy UI — Salaxy Business for companies, Salaxy Pro for accounting firms — or their own UI on the REST API; paths can be combined), and partner or company. Then take the topics in the order listed, and ask the "Which fits you?" question of each topic. - **Build on v03**, the current API version. Do not use a beta version for production code. - **Follow the API rules** in every REST call: errors (https://code.salaxy.com/reference/errors.md), queries and paging (https://code.salaxy.com/reference/queries.md), retries and idempotency (https://code.salaxy.com/reference/idempotency.md), events and polling (https://code.salaxy.com/reference/polling.md). - **When a fact is not on this site, say so** and list it as a question for Salaxy. Do not guess Salaxy behaviour from other payroll APIs. Every page below is Markdown. The human-readable page is at the same URL without `.md` (`index.md` → the folder URL). If a guide and the generated reference disagree about a field, follow the reference. ## About Salaxy - [What Salaxy offers](https://code.salaxy.com/about/index.md): Salaxy is a payroll platform delivered through partners' software. Three ways to integrate — MCP and skills, the REST API, and white label. - [Availability](https://code.salaxy.com/about/availability.md): What is live today — by country and surface, and by skill area and MCP tool. Dates are targets. - [Core concepts](https://code.salaxy.com/about/concepts.md): The objects every Salaxy integration deals with — account, worker, employment, calculation, payroll, invoice — and how they relate. Shared by MCP and REST. - [MCP or REST?](https://code.salaxy.com/about/mcp-or-rest.md): How to choose between the Salaxy MCP servers with payroll skills and the REST API. - [For agents](https://code.salaxy.com/for-agents.md): Instructions for AI agents and coding assistants reading this site — where the machine-readable sources are, and what is and is not available. ## Get started — agentic path (MCP and skills) - [Choose your path](https://code.salaxy.com/get-started/index.md): Three ways to start building with Salaxy — the agentic path with MCP and skills, the REST API for Finland, or embedded white label for Finland. - [Connect a client](https://code.salaxy.com/get-started/agentic/index.md): Connect Claude, ChatGPT, Codex, VS Code, Cursor or your own agent to the Salaxy MCP servers for Finland — Payroll Agent and Report Agent, demo or production. - [Your first calculation](https://code.salaxy.com/get-started/agentic/first-calculation.md): Ask for a Finnish salary calculation in plain language through the Salaxy Payroll Agent, and read what comes back. - [Add the skills](https://code.salaxy.com/get-started/agentic/skills.md): Give your agent the Salaxy payroll skills — the domain knowledge that turns MCP tool calls into correct Finnish payroll. - [Build your own agent](https://code.salaxy.com/get-started/agentic/build-your-agent.md): Embed the Salaxy payroll skills in your own product's agent — system prompt, integration context, guardrails and verification. ## Get started — REST API (Finland) - [REST API — getting started](https://code.salaxy.com/get-started/rest/index.md): Getting started with the Salaxy REST API for Finnish payroll — a six-step guide from a test account to a paid salary. - [Environments](https://code.salaxy.com/get-started/environments.md): Salaxy's test, demo and production environments — REST API and white label embed hosts, which to use when, and the MCP servers. - [1. Create an account](https://code.salaxy.com/get-started/rest/create-account.md): Create a Salaxy test company account for developing a REST API integration — step 1 of the REST guide. - [2. Authenticate](https://code.salaxy.com/get-started/rest/authenticate.md): Get an access token for the Salaxy REST API — password flow while developing, impersonation in production. Step 2 of the REST guide. - [3. Create employees](https://code.salaxy.com/get-started/rest/create-employees.md): Create an employment relationship — the record that carries a worker's payroll terms — with POST /v03/api/employments. Step 3 of the REST guide. - [4. Create a payroll](https://code.salaxy.com/get-started/rest/create-payroll.md): Create a payroll, build a salary calculation from an employment and add it to the payroll — step 4 of the REST guide. - [5. Set for payment](https://code.salaxy.com/get-started/rest/set-for-payment.md): Commit a payroll for payment — Salaxy validates it, generates the invoices and the payment starts. Step 5 of the REST guide. - [6. Track the payment status](https://code.salaxy.com/get-started/rest/track-status.md): Poll salary calculations and payrolls until the payment outcome is final — which endpoints, which statuses, and a polling pattern. Step 6 of the REST guide. ## Help - [Get a test account](https://code.salaxy.com/get-started/test-account.md): What credential you need to try Salaxy in the test environment, how to get it and how fast, for the agentic, REST API, embedded white label and partner integration paths. - [Developer FAQ](https://code.salaxy.com/get-started/faq.md): Short answers to the questions integrators ask most about test accounts, tokens, environments, versions, errors and retries, each with a link to the page that holds the details. - [Support](https://code.salaxy.com/get-started/support.md): Where to ask about the Salaxy APIs and MCP server, what to request from Salaxy, and what to include when you report a problem. ## Integration topics (in reading order) - [Integration overview](https://code.salaxy.com/integration/index.md): How a Salaxy integration fits together — choose a build path (the embedded Salaxy UI — Salaxy Business and Salaxy Pro — or your own UI on the REST API), then work through the integration topics in order, from one-time setup to reporting. - [Integration in a day with a coding agent](https://code.salaxy.com/integration/with-a-coding-agent.md): Point Claude Code or another coding agent at code.salaxy.com, answer its questions, and plan and build a Salaxy integration against the test environment in a day. - [Partner and technical accounts](https://code.salaxy.com/integration/partner-account.md): The accounts a partner integration starts from — the partner account, its technical accounts and the digital certificate that signs your sign-in. Who sets up what, in test and in production. - [Account structure](https://code.salaxy.com/integration/account-structure.md): How your customers are arranged under your technical account — two tiers (partner to customer company), three tiers (partner to accounting firm to customer company) or a mix — and how to choose. - [Contract options](https://code.salaxy.com/integration/contract-options.md): Who has an agreement with Salaxy in each account structure — the partner's power of attorney, the accounting firm's own authorisation, and the two ways a customer company authorises Salaxy to act for it. - [Service models](https://code.salaxy.com/integration/service-models.md): A service model fixes the payment channel, accounting models and other settings for every customer company under a partner or accounting firm. Salaxy provisions it; you decide who gets which. - [Payment channels and SEPA payment files](https://code.salaxy.com/integration/payment-channels.md): How salaries get paid in a Salaxy integration - a payment channel is the route from the payroll to the bank. Compare the options, see how a channel is provisioned and how to fetch SEPA payment files. - [Accounting models](https://code.salaxy.com/integration/accounting-models.md): An accounting model is the chart of accounts and the posting rules that turn a payroll into accounting rows. Salaxy provisions it and attaches it to customer companies through a service model. - [Customer account creation](https://code.salaxy.com/integration/customer-accounts.md): Create a customer company account in Salaxy, or find the existing one, with one call from the Business ID. What the response flags mean, what blocks payment, and what to do next. - [Company settings](https://code.salaxy.com/integration/company-settings.md): Read and write a customer company's settings over the REST API - company information, employer payment account, pension and insurance contracts - with the GET, change, POST round trip that keeps Salaxy's own settings safe. - [Accounting firm account creation](https://code.salaxy.com/integration/accounting-firm-accounts.md): Create an accounting firm account under your technical account, then thread customer companies under it with proxyPartner, so the firm sees its own customer book in Salaxy Pro. - [Pro API (accounting firm tier)](https://code.salaxy.com/integration/pro-api.md): The Pro API (/v01/api/pro/...) is the endpoint family for accounting firms — one cross-tenant view over every customer account an accounting firm, or a partner acting as one, may run payroll for. - [Employees and employments](https://code.salaxy.com/integration/employments.md): How Salaxy models an employee (worker plus employment), the employment lifecycle (create, update, end), and how to keep employments in sync with your own HR or time-tracking data. - [Tax cards](https://code.salaxy.com/integration/tax-cards.md): How Salaxy gets the withholding tax percentage for an employee. Use the automatic tax card from the Tax Administration, or set a manual card through the REST API. - [Dimensions (cost centres)](https://code.salaxy.com/integration/dimensions.md): How to push cost-accounting dimensions such as cost centres and projects into Salaxy, and how to tag calculations and rows with them so accounting data carries your own coding. - [Worktime import](https://code.salaxy.com/integration/worktime-import.md): How a worktime or time-tracking system sends hours and pay rows into Salaxy payrolls, through the REST API import endpoints now and the Data Agent (MCP) when it opens. - [Payroll lifecycle and statuses](https://code.salaxy.com/integration/payroll-lifecycle.md): How a payroll, its salary calculations and the invoices they produce move through their statuses — from creation to payment to closure. Shared by the REST API and the MCP path. - [Salary calculations](https://code.salaxy.com/integration/calculations.md): How a salary calculation is built from rows, calculated by Salaxy, validated and read back — totals, worker and employer sides, validation, and retroactive salary. - [Custom payroll logic](https://code.salaxy.com/integration/payroll-logic.md): Change how Salaxy calculates salaries for one customer with small JavaScript scripts - row type formulas, scripts that run before the calculation, and scripts for holiday accruals, holiday pay and pay statistics. - [Row type scripts](https://code.salaxy.com/integration/row-type-scripts.md): Set the price, count, message, data or other values of every row of one row type with a JavaScript formula - for built-in and custom row types. - [Before-calculation scripts](https://code.salaxy.com/integration/before-calc-scripts.md): Add, remove or change the rows of a salary calculation with a JavaScript script that runs before Salaxy calculates it. - [After-calculation scripts](https://code.salaxy.com/integration/after-calc-scripts.md): Calculate holiday accruals, holiday pay and pay statistics with your own JavaScript rules, from the calculations of an employment. - [Invoices and payments](https://code.salaxy.com/integration/invoices-and-payments.md): The production loop for paying salaries — fetch the unread invoices from your payment channel, pay them, and report each one back to Salaxy as read, paid or cancelled. - [Accounting data](https://code.salaxy.com/integration/accounting-data.md): How to fetch the bookkeeping entries of paid salaries as one JSON object - by month, from a saved monthly report, by calculation or by invoice - and how the accounting target decides the accounts. - [Holiday pay debt](https://code.salaxy.com/integration/holiday-pay-debt.md): How to fetch the accrued holiday pay liability (lomapalkkavelka) of a customer company - computed on request from its own endpoints, never part of other accounting data, and never pushed. - [Monthly cycle](https://code.salaxy.com/integration/monthly-cycle.md): The outputs Salaxy produces for every employer between day 4 and day 10 of each month - accounting reports, Incomes Register summary and tax invoices - and what your integration can rely on. - [Incomes Register filing](https://code.salaxy.com/integration/incomes-register.md): Salaxy files every paid salary and the monthly employer summary to the Finnish Incomes Register for the customer company. There is nothing to build, but you should know the timing, the late-filing risk and the test behaviour. - [Salary slips and e-payslips](https://code.salaxy.com/integration/salary-slips.md): How a worker gets the salary slip — as a PDF you fetch through the REST API, or as an electronic payslip (verkkopalkka) that Salaxy delivers to the worker's online bank when the salary is paid. - [Messages and notifications](https://code.salaxy.com/integration/messages-and-notifications.md): How messages between a company and its payroll provider work in Salaxy — the message-thread REST API and the Messages view in the embedded UI — and the notification a worker gets after the salary is paid. - [Go-live checklist](https://code.salaxy.com/integration/go-live.md): What must be true before your Salaxy integration runs in production — production accounts and certificate, provisioned channel and models, switched hosts, a smoke test, and a named customer care and escalation path. ## API rules — REST API (Finland) - [Errors](https://code.salaxy.com/reference/errors.md): How the Salaxy REST API reports failures — one JSON error shape, a few HTTP statuses, no stable error codes. Branch on the status, not the message. - [Queries and paging](https://code.salaxy.com/reference/queries.md): OData-style queries on Salaxy REST list endpoints — $filter, $search, $orderby, and paging with nextPageLink. Avoid $top. - [Query field reference](https://code.salaxy.com/reference/query-fields.md): The fields of Salaxy REST list items (ApiListItem and AccountInIndex) and whether each one can be filtered, searched or sorted in an OData-style query. - [Retries and idempotency](https://code.salaxy.com/reference/idempotency.md): How to make retried requests safe with the Salaxy REST API — no general idempotency key; use your own ids and look before you create. - [Events and polling](https://code.salaxy.com/reference/polling.md): The Salaxy REST API has no webhooks or push notifications today — poll the read endpoints. What to poll, and how often. - [Limits, logging and correlation](https://code.salaxy.com/reference/limits.md): What limits the Salaxy REST API states today (page size, token lifetime, no published rate limit), what to log on your side, and what to give Salaxy for a server-side log lookup. - [Versions and changes](https://code.salaxy.com/reference/versions.md): Which Salaxy REST API version to build on, how v04 differs from v03, how to move one area at a time, and what changed in the v03 reference recently. - [Test endpoints and test data](https://code.salaxy.com/reference/test-endpoints.md): What the Salaxy test environment is for, which endpoints are meant for test only, how to create and delete test accounts, and how to set test data such as tax card lookups. - [Wage types (row types)](https://code.salaxy.com/reference/wage-types.md): Every salary calculation row type you can send to the Salaxy REST API, grouped into families, with its code, an English name and what it is for. - [Yearly numbers](https://code.salaxy.com/reference/yearly-numbers.md): How to read the figures that change every year, such as contribution percentages, tax-free allowances and public holidays, from one anonymous Salaxy API endpoint instead of keeping your own copy. ## Problem types (the `type` URIs of v04 problem details errors) - [Problem types](https://code.salaxy.com/problems/index.md): Problem types are the stable error identifiers in problem details responses (RFC 9457). Each one links to a page that describes it. - [Problem type: not-found](https://code.salaxy.com/problems/not-found.md): 404 Not Found. The resource does not exist, for example an unknown payment channel key or a company with no config. - [Problem type: channel-not-available](https://code.salaxy.com/problems/channel-not-available.md): 409 Conflict. The payment channel is no longer available to the company, but a config is still stored. It can only be read or deleted. - [Problem type: concurrent-change](https://code.salaxy.com/problems/concurrent-change.md): 409 Conflict. Concurrent changes to the company settings kept the write from saving after three tries. Nothing was saved. - [Problem type: precondition-failed](https://code.salaxy.com/problems/precondition-failed.md): 412 Precondition Failed. The If-Match or If-None-Match header of the request does not hold, usually because the config changed after you read it. - [Problem type: unsupported-media-type](https://code.salaxy.com/problems/unsupported-media-type.md): 415 Unsupported Media Type. The request body has the wrong content type: PATCH needs application/merge-patch+json and PUT needs application/json. - [Problem type: validation-failed](https://code.salaxy.com/problems/validation-failed.md): 422 Unprocessable Entity. The request body is not valid. The errors field lists the messages per field. - [Problem type: internal-error](https://code.salaxy.com/problems/internal-error.md): 500 Internal Server Error. An unexpected error in Salaxy. The response tells nothing about the cause. ## Countries - [Countries](https://code.salaxy.com/countries/index.md): Salaxy is a multi-country payroll platform. Finland is live; Sweden is coming in Q3 2027; Denmark and Norway are planned for Q4 2027 – Q1 2028. - [Finland](https://code.salaxy.com/countries/finland.md): Salaxy in Finland — MCP and skills, REST API and white label, all live. Endpoints, skill set and Finland-specific references. - [Sweden](https://code.salaxy.com/countries/sweden.md): Salaxy in Sweden — not available yet. MCP and skills support targeted for Q3 2027. The REST API will not be offered in Sweden. - [Denmark](https://code.salaxy.com/countries/denmark.md): Salaxy in Denmark — not available yet. MCP and skills support targeted for Q4 2027 – Q1 2028. The REST API will not be offered in Denmark. - [Norway](https://code.salaxy.com/countries/norway.md): Salaxy in Norway — not available yet. MCP and skills support targeted for Q4 2027 – Q1 2028. The REST API will not be offered in Norway. ## Reference - [MCP reference](https://code.salaxy.com/reference/mcp.md): The Salaxy MCP servers — Payroll Agent and Report Agent, demo and production — and every tool they expose. Generated at build time. - [Skills reference](https://code.salaxy.com/reference/skills.md): The Salaxy payroll skill tree — what each area covers, which MCP tools it uses and how much of it the evals verify. - [Verified coverage](https://code.salaxy.com/reference/verified.md): What an agent has actually been verified to do with the Salaxy skills and MCP tools — every eval case, by skill area. - [REST API reference (Finland)](https://code.salaxy.com/reference/rest-api.md): Interactive reference for the Salaxy REST API v03 (Finland), rendered with Scalar from the OpenAPI document. - [REST API reference v04 (beta)](https://code.salaxy.com/reference/rest-api-v04.md): Interactive reference for the Salaxy REST API v04 (beta, Finland), rendered with Scalar from the OpenAPI document. ## Get started — embedded white label (Finland) - [Embedded white label: quick start](https://code.salaxy.com/get-started/white-label/index.md): Embed the Salaxy payroll UI in your application with an iframe and built-in navigation, in about five minutes. Finland. ## Embedded white label (Finland) - [Embedded white label](https://code.salaxy.com/white-label/index.md): Embedded white label payroll under your own brand, in two products — Salaxy Business for one company's payroll, Salaxy Pro for many. Salaxy AI agents built in. Finland. - [How embedded white label works](https://code.salaxy.com/white-label/how-it-works.md): The technical picture of a Salaxy embedded white label integration — what runs where, how sign-in works, what the partner builds and what Salaxy provides, and how a white label project goes. - [Navigation](https://code.salaxy.com/white-label/navigation.md): Two ways to navigate the embedded Salaxy payroll UI — Salaxy's built-in horizontal menu, or your own menu driving the iframe through the URL hash. - [URL parameters and sizing](https://code.salaxy.com/white-label/url-parameters.md): The embed URL of Salaxy's embedded white label — base URL, language, design and the first-load access token — and how to size the iframe. - [Designs](https://code.salaxy.com/white-label/designs.md): Make the embedded Salaxy payroll UI look like your product — the design (formerly skin), built on Bootstrap 5 and implemented by Salaxy, and the skin URL parameter. - [Events from the embedded white label](https://code.salaxy.com/white-label/events.md): The messages the embedded Salaxy payroll UI posts to your page with postMessage — session success and failure — and how to listen safely. ## Trust — security & authentication (REST complete; MCP being written) - [Security & authentication](https://code.salaxy.com/security/index.md): How Salaxy authenticates people, partners and agents, and what an agent is allowed to do — shared by the MCP and REST paths. - [MCP authentication](https://code.salaxy.com/security/mcp-authentication.md): Signing in to Salaxy's MCP servers — a user's own AI client with browser sign-in, or a partner's embedded agent — and choosing the employer to act for. - [REST authentication](https://code.salaxy.com/security/rest-authentication.md): How to get an access token for the Salaxy REST API (Finland) — which flow fits which integration, and how tokens work. - [Password flow](https://code.salaxy.com/security/password.md): Get a Salaxy REST API access token with a username and password — for development and testing only. - [Impersonation flow for SSO](https://code.salaxy.com/security/impersonation.md): Single sign-on to the Salaxy REST API — your server signs a JWT with its certificate and exchanges it for an access token for a customer account that has authorised you. - [Federation flow for banks](https://code.salaxy.com/security/federation.md): Federation for banks and payment providers — a trusted partner with strong authentication creates or signs in to Salaxy accounts for its users with a signed OpenID Connect message. - [Partner-initiated account creation](https://code.salaxy.com/security/account-creation.md): Make sure a company account exists in Salaxy before onboarding — POST /v03/api/partner/company creates a stub from the trade register or returns the existing account. - [Permissions and human approval](https://code.salaxy.com/security/permissions.md): What an agent may do on its own, what always needs a person's confirmation, and how user levels limit both. - [Token handling for agents](https://code.salaxy.com/security/tokens.md): Keeping credentials out of prompts, skills and logs when an agent works with Salaxy. ## Trust — privacy & AI compliance (being written) - [Privacy & AI compliance](https://code.salaxy.com/privacy/index.md): Data protection and AI regulation for payroll through agents — who is responsible for what when an agent works with Salaxy. - [GDPR roles and the DPA](https://code.salaxy.com/privacy/gdpr.md): Controller and processor in Salaxy payroll, and the data processing agreement. - [Personal data in agent conversations](https://code.salaxy.com/privacy/personal-data.md): What payroll data reaches a language model when an agent calls Salaxy's tools, and how to keep it to a minimum. - [Choosing a model provider](https://code.salaxy.com/privacy/model-providers.md): Which language-model set-ups suit live payroll data. - [Retention and logging](https://code.salaxy.com/privacy/retention.md): What is stored, where, and for how long. - [EU AI Act](https://code.salaxy.com/privacy/ai-act.md): How the EU AI Act relates to payroll through agents. - [Guidance for partner and third-party agents](https://code.salaxy.com/privacy/partner-agents.md): What Salaxy covers and what an agent's operator must cover when its own agent connects to Salaxy. - [Legal documents](https://code.salaxy.com/privacy/legal.md): The binding Salaxy legal documents, published at salaxy.com/privacy. ## REST API reference by tag (generated from the OpenAPI document) - [REST API by tag](https://code.salaxy.com/reference/rest/index.md): The Salaxy REST API (Finland), 38 groups of operations as static pages — generated from the OpenAPI document. - [Absences — REST API](https://code.salaxy.com/reference/rest/absences.md): Absences Controller provides CRUD functionality as well as additional methods for Absences objects - [Account — REST API](https://code.salaxy.com/reference/rest/account.md): Read and update access to Palkkaus-account: Person or Company accounts that are currently in use as well as Worker Accounts that are created under this account. - [AccountingTarget — REST API](https://code.salaxy.com/reference/rest/accountingtarget.md): Views and updates accounting targets: integrated systems, CoA and rulesets that map the calculations to the CoA (Chart of Accounts). - [AccountReset — REST API](https://code.salaxy.com/reference/rest/accountreset.md): Controller for resetting account data for testing purposes. - [ApiCrudUtility — REST API](https://code.salaxy.com/reference/rest/apicrudutility.md): Various utility endpoints for all API CRUD objects. - [BeneficialOwners — REST API](https://code.salaxy.com/reference/rest/beneficialowners.md): Views and updates beneficial owners and other beneficiaries of the company. - [Calculations — REST API](https://code.salaxy.com/reference/rest/calculations.md): Salary Calculations CRUD functionality as well as additional helper methods. - [Calculator — REST API](https://code.salaxy.com/reference/rest/calculator.md): Anonymous methods for calculating salary previews and testing without committing data to database. - [Dataset — REST API](https://code.salaxy.com/reference/rest/dataset.md): Lists and edits datasets: Dataset models some arbitrary data that is stored in storage. - [Employment — REST API](https://code.salaxy.com/reference/rest/employment.md): Employment relations between employers and workers. This is the primary method for Employers to manage their workers. - [File — REST API](https://code.salaxy.com/reference/rest/file.md): User-specific files and other files related functionality: Image processing, preview etc. - [HolidayYears — REST API](https://code.salaxy.com/reference/rest/holidayyears.md): Holiday Years Controller provides CRUD functionality as well as additional methods for Holiday Year objects - [HouseholdYear — REST API](https://code.salaxy.com/reference/rest/householdyear.md): Views and updates household yearly deduction data. - [Import — REST API](https://code.salaxy.com/reference/rest/import.md): Controller for mass imports. - [InsuranceServices — REST API](https://code.salaxy.com/reference/rest/insuranceservices.md): API connecting to insurance partner services. - [Invoice — REST API](https://code.salaxy.com/reference/rest/invoice.md): 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. - [MessageThread — REST API](https://code.salaxy.com/reference/rest/messagethread.md): CRUD functionality as well as additional methods for Message threads. Messages thread groups together a set of related messages and/or attachments. - [OnboardingApi — REST API](https://code.salaxy.com/reference/rest/onboardingapi.md): Functionality for Onboarding: The process where the user becomes a user of Salaxy service and an account is created for him / her / the company. - [Partner — REST API](https://code.salaxy.com/reference/rest/partner.md): Methods restricted to Authroized partners. NOTE: With production data, these methods require Approved Partner status! - [PaymentChannel — REST API](https://code.salaxy.com/reference/rest/paymentchannel.md): Payment channels are methods that hanlde salary payments: Paytrail / Palkkaus.fi Customer funds account handling, Finvoice, Accounting software, Banks Web Services etc. This controller is for those channels to fetch Invoices and other data as well as to update payment feedback back to Palkkaus.fi. T - [PaymentMessage — REST API](https://code.salaxy.com/reference/rest/paymentmessage.md): Payment messages (maksuaineisto) of the current company: create from invoices, list, download, mark sent, resend, mark paid and cancel. Every call is scoped to the account of the token. The channel's settings decide the actions: GET settings/{channel} returns them. Payment channels use the payment-c - [Payroll — REST API](https://code.salaxy.com/reference/rest/payroll.md): Payroll Controller provides CRUD functionality as well as additional methods for Payroll objects - [Record — REST API](https://code.salaxy.com/reference/rest/record.md): Views and updates account and employment records. - [ReferenceObject — REST API](https://code.salaxy.com/reference/rest/referenceobject.md): Reference object controller. For testing and development purposes only. This controller is a typical CRUD controller for business objects. The implementation is based on the current development conventions. The reference objects have no meaning or use outside development or testing environments, and - [Reports — REST API](https://code.salaxy.com/reference/rest/reports.md): Methods for Reporting: Initiating custom report creation, listing created reports (including preview, pdf and HTML) as well as creating demo reports with test data. - [RowUsecases — REST API](https://code.salaxy.com/reference/rest/rowusecases.md): Strongly typed and stand-alone test methods for the calculation rows usecases. - [ServiceModel — REST API](https://code.salaxy.com/reference/rest/servicemodel.md): Views and updates partner service models. Service models customize the user interface, workflows, texts and other functionality for customer groups of partners. - [Session — REST API](https://code.salaxy.com/reference/rest/session.md): Login, logoff and information about the current session. - [Settings — REST API](https://code.salaxy.com/reference/rest/settings.md): View and update settings for the service. - [TaskDefinition — REST API](https://code.salaxy.com/reference/rest/taskdefinition.md): Views and updates the definitions of the scheduled or adhoc tasks that can perform automated actions. - [TaskRun — REST API](https://code.salaxy.com/reference/rest/taskrun.md): Views and updates the runs of the scheduled or adhoc tasks that can perform automated actions. - [Taxcards — REST API](https://code.salaxy.com/reference/rest/taxcards.md): Year 2019 version for taxcards. This API will be replaced by the new 2020 version in January 2020. The new version is labeled as V03 (3.0-rc in before release) and old V02. - [Template — REST API](https://code.salaxy.com/reference/rest/template.md): Views and updates templates for business object creation. - [Test — REST API](https://code.salaxy.com/reference/rest/test.md): Test methods for various purposes. - [TestData — REST API](https://code.salaxy.com/reference/rest/testdata.md): Methods for modifying test data. Only available in test environment. - [Usecases — REST API](https://code.salaxy.com/reference/rest/usecases.md): Views and updates usecases. Usecases are a way to define custom functionality and data for partner pusposes. - [Version — REST API](https://code.salaxy.com/reference/rest/version.md): Functionality to list and get versions from version history for api objects. - [Workflow — REST API](https://code.salaxy.com/reference/rest/workflow.md): Functionality to add and change workflow events for all the API objects that support workflows. ## REST API v04 (beta) reference by tag (generated from the OpenAPI document) - [REST API v04 by tag](https://code.salaxy.com/reference/rest/v04/index.md): The Salaxy REST API (Finland), 49 groups of operations as static pages — generated from the OpenAPI document. - [Absences — REST API v04](https://code.salaxy.com/reference/rest/v04/absences.md): Absences Controller provides CRUD functionality as well as additional methods for Absences objects - [Account — REST API v04](https://code.salaxy.com/reference/rest/v04/account.md): Read and update access to Palkkaus-account: Person or Company accounts that are currently in use as well as Worker Accounts that are created under this account. - [AccountingTarget — REST API v04](https://code.salaxy.com/reference/rest/v04/accountingtarget.md): Views and updates accounting targets: integrated systems, CoA and rulesets that map the calculations to the CoA (Chart of Accounts). - [AccountReset — REST API v04](https://code.salaxy.com/reference/rest/v04/accountreset.md): Controller for resetting account data for testing purposes. - [ApiCrudUtility — REST API v04](https://code.salaxy.com/reference/rest/v04/apicrudutility.md): Various utility endpoints for all API CRUD objects. - [BeneficialOwners — REST API v04](https://code.salaxy.com/reference/rest/v04/beneficialowners.md): Views and updates beneficial owners and other beneficiaries of the company. - [CalcCorrection — REST API v04](https://code.salaxy.com/reference/rest/v04/calccorrection.md): Endpoints for correcting readonly and paid calculations. - [Calculations — REST API v04](https://code.salaxy.com/reference/rest/v04/calculations.md): Salary Calculations CRUD functionality as well as additional helper methods. - [Calculator — REST API v04](https://code.salaxy.com/reference/rest/v04/calculator.md): Anonymous methods for calculating salary previews and testing without committing data to database. - [CompanyAuthorizationLink — REST API v04](https://code.salaxy.com/reference/rest/v04/companyauthorizationlink.md): PARTNERS: Creates the links that send a company representative to the authorization flow. The partner account is read from the credentials of the caller, not from the request, so the end user's address bar carries nothing that would change who is being authorized. Test environments additionally have - [Dataset — REST API v04](https://code.salaxy.com/reference/rest/v04/dataset.md): Lists and edits datasets: Dataset models some arbitrary data that is stored in storage. - [Employment — REST API v04](https://code.salaxy.com/reference/rest/v04/employment.md): Employment relations between employers and workers. This is the primary method for Employers to manage their workers. - [File — REST API v04](https://code.salaxy.com/reference/rest/v04/file.md): User-specific files and other files related functionality: Image processing, preview etc. - [HolidayYears — REST API v04](https://code.salaxy.com/reference/rest/v04/holidayyears.md): Holiday Years Controller provides CRUD functionality as well as additional methods for Holiday Year objects - [HouseholdYear — REST API v04](https://code.salaxy.com/reference/rest/v04/householdyear.md): Views and updates household yearly deduction data. - [Import — REST API v04](https://code.salaxy.com/reference/rest/v04/import.md): Controller for mass imports. - [ImportPlan — REST API v04](https://code.salaxy.com/reference/rest/v04/importplan.md): CRUD for data funnel import plans: named, re-runnable bindings of a schema and a transformation. - [ImportRun — REST API v04](https://code.salaxy.com/reference/rest/v04/importrun.md): CRUD for data funnel import runs: executions that post a target dataset to Salaxy. Execution itself is not part of this API. - [InsuranceServices — REST API v04](https://code.salaxy.com/reference/rest/v04/insuranceservices.md): API connecting to insurance partner services. - [Invoice — REST API v04](https://code.salaxy.com/reference/rest/v04/invoice.md): 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. - [MessageThread — REST API v04](https://code.salaxy.com/reference/rest/v04/messagethread.md): CRUD functionality as well as additional methods for Message threads. Messages thread groups together a set of related messages and/or attachments. - [OnboardingApi — REST API v04](https://code.salaxy.com/reference/rest/v04/onboardingapi.md): Functionality for Onboarding: The process where the user becomes a user of Salaxy service and an account is created for him / her / the company. - [Orders — REST API v04](https://code.salaxy.com/reference/rest/v04/orders.md): Orders operations of the Salaxy REST API - [Overview — REST API v04](https://code.salaxy.com/reference/rest/v04/overview.md): Mainly read-only methods over all objects owned by the current account. - [Partner — REST API v04](https://code.salaxy.com/reference/rest/v04/partner.md): Methods restricted to Authroized partners. NOTE: With production data, these methods require Approved Partner status! - [PaymentChannel — REST API v04](https://code.salaxy.com/reference/rest/v04/paymentchannel.md): Payment channels are methods that hanlde salary payments: Paytrail / Palkkaus.fi Customer funds account handling, Finvoice, Accounting software, Banks Web Services etc. This controller is for those channels to fetch Invoices and other data as well as to update payment feedback back to Palkkaus.fi. T - [PaymentChannelConfig — REST API v04](https://code.salaxy.com/reference/rest/v04/paymentchannelconfig.md): The payment channel config of the current company: its own values that a payment channel needs to pay for it, such as the ID the provider gave the company and the account the provider debits. At most one per channel, in the company settings (payments.channelConfigs[]) like settings/dimensions, and n - [PaymentMessage — REST API v04](https://code.salaxy.com/reference/rest/v04/paymentmessage.md): Payment messages (maksuaineisto) of the current company: create from invoices, list, download, mark sent, resend, mark paid and cancel. Every call is scoped to the account of the token. The channel's settings decide the actions: GET settings/{channel} returns them. Payment channels use the payment-c - [Payroll — REST API v04](https://code.salaxy.com/reference/rest/v04/payroll.md): Payroll Controller provides CRUD functionality as well as additional methods for Payroll objects - [Pro — REST API v04](https://code.salaxy.com/reference/rest/v04/pro.md): Methods for PRO users (accountants, integrated services), for fetching data accross multiple accounts and impersonating as different authorized acccounts: Fetching the token and session. - [Record — REST API v04](https://code.salaxy.com/reference/rest/v04/record.md): Views and updates account and employment records. - [ReferenceObject — REST API v04](https://code.salaxy.com/reference/rest/v04/referenceobject.md): Reference object controller. For testing and development purposes only. This controller is a typical CRUD controller for business objects. The implementation is based on the current development conventions. The reference objects have no meaning or use outside development or testing environments, and - [Reports — REST API v04](https://code.salaxy.com/reference/rest/v04/reports.md): Methods for Reporting: Initiating custom report creation, listing created reports (including preview, pdf and HTML) as well as creating demo reports with test data. - [RowUsecases — REST API v04](https://code.salaxy.com/reference/rest/v04/rowusecases.md): Strongly typed and stand-alone test methods for the calculation rows usecases. - [ServiceModel — REST API v04](https://code.salaxy.com/reference/rest/v04/servicemodel.md): Views and updates partner service models. Service models customize the user interface, workflows, texts and other functionality for customer groups of partners. - [Session — REST API v04](https://code.salaxy.com/reference/rest/v04/session.md): Login, logoff and information about the current session. - [Settings — REST API v04](https://code.salaxy.com/reference/rest/v04/settings.md): View and update settings for the service. - [SourceDataset — REST API v04](https://code.salaxy.com/reference/rest/v04/sourcedataset.md): CRUD for data funnel source datasets: uploaded sources normalised to flat JSON rows. - [TargetDataset — REST API v04](https://code.salaxy.com/reference/rest/v04/targetdataset.md): CRUD for data funnel target datasets: materialised flat target rows of a transformation. - [TaskDefinition — REST API v04](https://code.salaxy.com/reference/rest/v04/taskdefinition.md): Views and updates the definitions of the scheduled or adhoc tasks that can perform automated actions. - [TaskRun — REST API v04](https://code.salaxy.com/reference/rest/v04/taskrun.md): Views and updates the runs of the scheduled or adhoc tasks that can perform automated actions. - [Taxcards — REST API v04](https://code.salaxy.com/reference/rest/v04/taxcards.md): Year 2019 version for taxcards. This API will be replaced by the new 2020 version in January 2020. The new version is labeled as V03 (3.0-rc in before release) and old V02. - [Template — REST API v04](https://code.salaxy.com/reference/rest/v04/template.md): Views and updates templates for business object creation. - [Test — REST API v04](https://code.salaxy.com/reference/rest/v04/test.md): Test methods for various purposes. - [TestData — REST API v04](https://code.salaxy.com/reference/rest/v04/testdata.md): Methods for modifying test data. Only available in test environment. - [Transformation — REST API v04](https://code.salaxy.com/reference/rest/v04/transformation.md): CRUD for data funnel transformations: JSONata expressions mapping flat source rows to flat target rows. - [Usecases — REST API v04](https://code.salaxy.com/reference/rest/v04/usecases.md): Views and updates usecases. Usecases are a way to define custom functionality and data for partner pusposes. - [Version — REST API v04](https://code.salaxy.com/reference/rest/v04/version.md): Functionality to list and get versions from version history for api objects. - [Workflow — REST API v04](https://code.salaxy.com/reference/rest/v04/workflow.md): Functionality to add and change workflow events for all the API objects that support workflows. ## Machine-readable - [OpenAPI v03](https://code.salaxy.com/openapi/salaxy-03.json): Salaxy API v03, OpenAPI 3.1 — **the REST API documentation** (Finland only). Read this rather than the rendered reference page. This is the current version. - [OpenAPI v04](https://code.salaxy.com/openapi/salaxy-04.json): Salaxy API v04, OpenAPI 3.1 — **the REST API documentation** (Finland only). Read this rather than the rendered reference page. This version is **beta**: it may change and is not used in production yet; build on v03. - MCP servers (sign-in required): call `tools/list` after signing in for the live tool definitions. The MCP reference page above lists every server and its tools. - [Full site in one file](https://code.salaxy.com/llms-full.txt) ## Optional - [Skills repository](https://github.com/salaxy-payroll/salaxy-ai-for-payroll): the Finnish payroll skill tree and eval suite (opens publicly soon). - [Current developer site](https://code.salaxy.com): REST API guides not yet moved here, the logic-script editor and the embedded demo.