Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Payroll > FamilySituation

Creates a Family situation

Create a family situation.

post/api/2026-07-01/resources/payroll/family_situations

Request body

employee_idstring required

Employee id.

civil_status'single' | 'cohabitating' | 'divorced' | 'married' | 'civil_partnership' | 'separated' | 'widow' | 'not_applicable' | 'unknown'

Civil status of the employee.

number_of_dependantsinteger

Number of dependants of the employee.

Example request

{
  "employee_id": "10",
  "civil_status": "married",
  "number_of_dependants": 3
}

Response

CREATED

idstring required

ID of the family situation.

employee_idstring required

Employee id of the family situation.

civil_status'single' | 'cohabitating' | 'divorced' | 'married' | 'unknown' | 'civil_partnership' | 'separated' | 'widow' | 'not_applicable'

Civil status of the employee.

number_of_dependantsinteger

Number of dependants of the employee.

Example response

{
  "id": "1",
  "employee_id": "5",
  "civil_status": "married",
  "number_of_dependants": 2
}