Reference

Case Fields Reference

Copy page

This reference documents all available case fields for payroll calculations. Fields are organized by domain sections for clarity when submitting case values.

Field Structure

When adding case values via POST /payrolls/{payrollId}/cases, use the following structure:

Code
 
{
  "userId": 7,
  "employeeId": 2,
  "divisionId": 3,
  "forecast": "optional-forecast-id",
  "start": "2025-01-01T00:00:00Z",
  "identite": { ... },
  "remuneration": { ... },
  "frais": { ... },
  "pas": { ... },
  "prevoyanceMutuelle": { ... }
}

Domain Sections

identite (Identity)

Employee identification information.

Field	Type	Description	Example
nom	string	Last name	"Dupont"
prenom	string	First name	"Jean"

Example:

Code
 
"identite": {
  "nom": "Dupont",
  "prenom": "Jean"
}

remuneration (Compensation)

Salary and hours worked.

Field	Type	Description	Example
heuresTravaillees	number	Hours worked in the period	151.67
tauxHoraire	number	Hourly rate in euros	12.50

Example:

Code
 
"remuneration": {
  "heuresTravaillees": 151.67,
  "tauxHoraire": 12.50
}

frais (Expenses & Allowances)

Meal allowances, mileage, and adjustments.

Field	Type	Description	Example
nombreRepas	number	Number of meal allowances	15
montantRepas	number	Amount per meal in euros	9.50
indemniteKilometrique	number	Mileage allowance in euros	250.00
regularisation	number	Net salary adjustment (+/-)	50.00

Example:

Code
 
"frais": {
  "nombreRepas": 15,
  "montantRepas": 9.50,
  "indemniteKilometrique": 250.00,
  "regularisation": 50.00
}

pas (Withholding Tax)

French withholding tax (Prélèvement À la Source).

Field	Type	Description	Example
tauxPAS	number	Withholding tax rate (0-1)	0.05

Example:

Code
 
"pas": {
  "tauxPAS": 0.05
}

prevoyanceMutuelle (Benefits)

Health insurance and social security contributions.

Field	Type	Description	Example
mutuelleObligatoire	number	Mandatory health insurance (€)	24.75
mutuelleFacultative	number	Optional health insurance (€)	49.50
tauxPrevoyance	number	Social security rate (0-1)	0.0089

Example:

Code
 
"prevoyanceMutuelle": {
  "mutuelleObligatoire": 24.75,
  "mutuelleFacultative": 49.50,
  "tauxPrevoyance": 0.0089
}

Complete Example

POST /payrolls/{payrollId}/cases
 
{
  "userId": 7,
  "employeeId": 2,
  "divisionId": 3,
  "forecast": "preview-jan2025-emp2",
  "start": "2025-01-01T00:00:00Z",
  "identite": {
    "nom": "Dupont",
    "prenom": "Jean"
  },
  "remuneration": {
    "heuresTravaillees": 151.67,
    "tauxHoraire": 12.50
  },
  "frais": {
    "nombreRepas": 15,
    "montantRepas": 9.50,
    "indemniteKilometrique": 250,
    "regularisation": 50.00
  },
  "pas": {
    "tauxPAS": 0.05
  },
  "prevoyanceMutuelle": {
    "mutuelleObligatoire": 24.75,
    "mutuelleFacultative": 49.50,
    "tauxPrevoyance": 0.0089
  }
}

Quick Reference Table

Section	Field	Type	Required	Description
identite	nom	string	No	Last name
identite	prenom	string	No	First name
remuneration	heuresTravaillees	number	Yes	Hours worked
remuneration	tauxHoraire	number	Yes	Hourly rate
frais	nombreRepas	number	No	Meal count
frais	montantRepas	number	No	Meal amount
frais	indemniteKilometrique	number	No	Mileage
frais	regularisation	number	No	Adjustment
pas	tauxPAS	number	No	Tax rate
prevoyanceMutuelle	mutuelleObligatoire	number	No	Mandatory insurance
prevoyanceMutuelle	mutuelleFacultative	number	No	Optional insurance
prevoyanceMutuelle	tauxPrevoyance	number	No	Prevoyance rate

Output: Wage Type Results

After running a payrun, you receive calculated wage types:

Wage Type	Name	Description
100	SalaireBase	Base salary
600	IndemniteRepas	Meal allowance
620	IndemniteKilometrique	Mileage allowance
650	Regularisation	Salary adjustment
910	TotalCotisationsSalariales	Employee contributions
920	TotalCotisationsPatronales	Employer contributions
930	TotalAllegements	Tax credits
950	NetImposable	Taxable net income
980	TotalIndemnites	Total allowances
990	NetAPayer	Net pay

Next Steps

• Quickstart - Complete workflow example
• Real vs Forecast Mode - Execution modes
• API Reference - All endpoints