List payrolls for your tenant
Retrieves all payrolls associated with your tenant.
query Parameters
filterThe OData filter expression (with support for attribute fields)
orderByThe OData order-by expression (with support for attribute fields)
resultThe query result type: items, count or items with count (default: result items)
The query result type
selectThe OData field selection expression
skipThe number of items in the queried collection that are to be skipped
statusThe object status (default: all status)
The object status
topThe number of items in the queried collection
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List payrolls for your tenant › Responses
OK
idUnique identifier
namePayroll name
divisionIdstatusThe object status
Get available cases for a payroll
Retrieves the list of cases available for the specified payroll, filtered by case type and user.
path Parameters
payrollIdThe payroll identifier
query Parameters
userIdThe user identifier
caseTypeThe case type (Global, National, Company, Employee)
The case type
employeeIdThe employee identifier (required for Employee case type)
caseNamesFilter by specific case names
clusterSetNameThe cluster set name
cultureThe culture for localization
evaluationDateThe evaluation date
hiddenInclude hidden cases
regulationDateThe regulation date
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get available cases for a payroll › Responses
OK
caseTypeThe case type
nameidstatusThe object status
createdupdateddescriptionhiddenclustersGet payroll cases
Retrieves cases for the specified payroll with optional filtering.
path Parameters
payrollIdThe payroll identifier
query Parameters
caseNamesFilter by specific case names
caseTypeThe case type
The case type
clusterSetNameThe cluster set name
evaluationDateThe evaluation date
overrideTypeOverride type for derivable object
Override type for derivable object
regulationDateThe regulation date
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get payroll cases › Responses
OK
caseTypeThe case type
nameidstatusThe object status
createdupdateddescriptionhiddenclustersAdd a payroll case (inject simulation variables)
Creates a new case change for the specified payroll using a simplified, flat payload structure. The gateway transforms the friendly format into the backend structure automatically. Use domain sections (identite, remuneration, frais, pas, prevoyanceMutuelle) with camelCase field names.
path Parameters
payrollIdThe payroll identifier
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Add a payroll case (inject simulation variables) › Request Body
userIdThe user identifier
employeeIdThe employee identifier
divisionIdThe division identifier
forecastThe forecast identifier
reasonReason for the case change
startShared start date for all case values (applied to every field)
Identity information case
Remuneration case
Expenses case
Withholding tax case (Prelevement A la Source)
Insurance and mutual fund case
Add a payroll case (inject simulation variables) › Responses
Created
idThe case change identifier
userIdemployeeIddivisionIdforecastreasonstartShared start date (present if all values have the same start)
statusThe object status
createdupdatedIdentity information case
Remuneration case
Expenses case
Withholding tax case (Prelevement A la Source)
Insurance and mutual fund case