HRIS API

Employees

Companies

Departments

Payrolls

Employee Payrolls

Employee Schedules

Time Off Requests

SD Worx BE SME OpenPayroll API for Belgian SME payroll master data: employers, contracts and person details.

connection

oauth_credentials

SD Worx (BE SME Payroll)

Runs on api.acc.sdworx.com with token host auth.acc.sdworx.com. SD Worx BeIntegration provisions a test employer on request; its Client ID and certificate are separate from production.

Runs on api.sdworx.com with token host auth.sdworx.com and requires the production Client ID issued for your registered certificate. ⚠️ Acceptance credentials cannot be used against production.

SD Worx OpenPayroll API developer portal (login required)

Organization

People

edge-case

An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.

Company number

The date and time when the object was created.

Created at (timestamp)

Created by

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

UNKNOWN_CURRENCY

When custom mappings are configured on the resource, the result is included here.

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

The date and time when the object was last updated.

Updated at (timestamp)

Updated by

Birth Date

Company ID

Company name

compensation

Country code according to ISO 3166-1 alpha-2.

Country Code

medium

Deceased Date

Flag to indicate if the object is deleted.

Deleted

The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.

Department

Unique identifier of the department ID this employee belongs to.

Department ID

Name of the department this employee belongs to.

Department Name

Description

Indicate the employee's dietary preference.

Dietary preference

Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee.

Direct reports

The name used to display the employee, often a combination of their first and last names.

Display name

The division the person is currently in. Usually a collection of departments or teams or regions.

Division

Unique identifier of the division this employee belongs to.

Division ID

The third-party API ID of original entity

An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.

Employee number

An End Date is the date that the employee ended working at the company

Employee end date

Employment sub type

The type of employment relationship the employee has with the organization.

Employment type

A Start Date is the date that the employee started working at the company

Employee start date

The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.

Employment status

First name

Food allergies

The gender represents the gender identity of a person.

Gender

The initials of the person, usually derived from their first, middle, and last names.

Initials

critical

language code according to ISO 639-1. For the United States - EN

Last name

Email address

The name of the manager, often a combination of their first and last names.

Manager name

Marital status

Middle name

The nationality of the person, represented as a two-letter country code according to ISO 3166-1 alpha-2.

Nationality

Person

Photo URL

The name the employee prefers to be addressed by, which may be different from their legal name.

Preferred name

The date that the employee ended their probation period at the company.

Probation end date

The date that the employee started their probation period at the company.

Probation start date

Probation period

Pronouns

Record URL

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

Row version

A formal salutation for the person. For example, 'Mr', 'Mrs'

A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.

Social Security Number

When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.

Source

Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).

Source ID

Tax Code

Tax ID

The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.

Timezone

Job title

Indicates if the employee works from a remote location.

Remote

`id` is the SD Worx employer file number (for example `1AB1234`), an alphanumeric payroll-file code. Only
`legal_name`, `display_name` and `status` are available; addresses, phone numbers, emails, websites,
`currency`, `company_number` and timestamps are not. `status` is `active` while the payroll file has no end
date and `inactive` once it has one.

The list contains every employer (payroll file) the integration's registered client may access, and it is
returned in full on every call; `limit` and `cursor` page through that list. An employee connection reads
one employer at a time: the `employer_file_number` connection setting picks one of these records.


`id` is the SD Worx employer file number (for example `1AB1234`). Only `legal_name`, `display_name` and
`status` are available; `status` is `active` while the payroll file has no end date and `inactive` once it
has one. An unknown employer file number returns a 404.


Listing employees requires the `employer_file_number` connection setting: it selects the SD Worx payroll file
(employer) whose employees are returned. The available employers are the records of the `companies` resource.

Only employees with an active contract are returned, so terminated employees never appear; `employment_status`
is `terminated` only for a contract whose leaving date has already passed. `department`, `manager`, `team`,
`bank_accounts` and `photo_url` are not available.

Employees cannot be filtered or sorted: any `filter[...]` or `sort[...]` parameter is rejected with a 400.
`limit` and `cursor` work. Every page assembles person and contract details from several vendor calls, so
a list call takes a few seconds. Listing without the `employer_file_number` setting returns a 400 that
names the setting; an employer the connection cannot access returns a 404.

If one of the detail calls fails, the request still succeeds with a 200 and the fields that call
provides (for example `gender`, `birthday`, `jobs`, `compensations` or the employment dates) are absent.
Treat their absence as unavailable for this request, not as empty at the source. One record is returned
per person; when a person holds several concurrent contracts with the employer, the details of the first
contract are used.

`id` is the SD Worx person id and `employee_number` the payroll employee number. `title`, `jobs`,
`employment_start_date`, `employment_end_date`, `employment_role.type` and `compensations` come from the
contract valid on the day of the request; wages are returned in EUR per hour, month or (as `other`) per day.
`jobs` is empty when the contract has no job description in SD Worx.

`gender` is derived from SD Worx's gender code table (male, female, or `not_specified` for unknown and not
disclosed). `preferred_language` and `languages` are normalised to ISO 639-1 codes (`nl`, `fr`, `de`, `en`),
`nationalities` are ISO 3166-1 alpha-2 codes and `marital_status` carries the SD Worx marital-status code
(for example `02` for married). Belgian addresses split the house number and the box number:
`addresses[].line1` holds the street and house number and `addresses[].line2` holds the box number.


`id` is the SD Worx person id. Reading an employee requires the `employer_file_number` connection setting
(a 400 names it when missing); `employee_number`, `company_id`, `title`, `jobs`, `compensations`,
`employment_start_date`, `employment_end_date` and `employment_role` come from the person's active
contract for that employer, valid on the day of the request, and are absent when the person has none.
The record is assembled from several vendor calls: if one fails the request still succeeds with a 200
and that call's fields are absent, so treat absence as unavailable for this request. `jobs` is empty
when the contract has no job description.

`department`, `manager`, `team`, `bank_accounts`, `photo_url` and `updated_at` are not available.

`gender` is derived from SD Worx's gender code table (male, female, or `not_specified` for unknown and not
disclosed); `preferred_language` and `languages` are ISO 639-1 codes, `nationalities` ISO 3166-1 alpha-2
codes and `marital_status` the SD Worx marital-status code (for example `02` for married).
`addresses[].line1` holds the street and house number and `addresses[].line2` holds the Belgian box number.


Task	You (Customer)	Your Consumer	Apideck
Generate the certificate and register it with SD Worx BeIntegration to obtain a Client ID	—	✓	—
Select the Server URL (acceptance or production) in Apideck	✓	—	—
Enter the Client ID and private key when connecting	—	✓	—
Confirm that the integration may access the employer's payroll file	—	✓ (if required)	—
Select the employer (payroll file) when connecting	—	✓	—
Mint and refresh access tokens, poll for changes (virtual webhooks)	—	—	✓
Notify SD Worx before the certificate expires and register the renewed one	—	✓	—

SD Worx (BE SME Payroll)

At a Glance

Responsibility matrix

Environments

🚨Important to Know About SD Worx (BE SME Payroll)