Payroll Leaves API

Employee leaves track absences such as sick leave, parental leave, care days, and other types of leave. The API enforces Norwegian labor law constraints, including limits on self-certified sick leave (egenmelding).

API Endpoints

List Employee Leaves

GET /payroll/leaves

Retrieve a paginated list of employee leaves with filtering options.

Query Parameters

When filtering by year, the API returns all leaves that overlap the specified calendar year — leaves where the start date is before the end of the year and the end date is either null (ongoing) or on/after January 1 of that year.

Response

{
  "data": [
    {
      "id": 1,
      "business_partner_id": 56,
      "client_account_id": 7,
      "contract_id": 12,
      "leave_type": "SICK_SELF_CERTIFIED",
      "start_date": "2024-03-18",
      "end_date": "2024-03-20",
      "leave_percentage": "100.00",
      "source_reference": null,
      "status": "COMPLETED",
      "note": "Influenza",
      "created_by_id": 7,
      "created_at": "2024-03-18T08:30:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "per_page": 100,
    "records": 1
  }
}

Results are sorted by start_date descending (newest first).

Get Employee Leave

GET /payroll/leaves/{id}

Retrieve a single employee leave by ID.

Path Parameters

Query Parameters

Create Employee Leave

POST /payroll/leaves

Creates a new employee leave record.

Request Body

Example Request

{
  "client_account_id": 7,
  "business_partner_id": 56,
  "leave_type": "PARENTAL",
  "start_date": "2024-04-01",
  "end_date": "2024-06-30",
  "contract_id": 12,
  "leave_percentage": "50.00",
  "note": "Paternity leave, 50% schedule"
}

Response

Returns the created leave with status 201 Created.

Update Employee Leave

PUT /payroll/leaves/{id}

Updates an existing employee leave. Only provided fields are updated.

Path Parameters

Request Body

Same fields as create, except client_account_id and business_partner_id which cannot be changed after creation.

Response

Returns the updated leave.

Cancel Employee Leave

DELETE /payroll/leaves/{id}

Cancels an employee leave. This is a soft delete — the record remains in the database with status set to CANCELLED.

Path Parameters

Response

Returns the cancelled leave with status set to CANCELLED.

Attributes

Leave Types

Status Values

Self-Certified Sick Leave Rules

Norwegian labor law imposes specific limits on self-certified sick leave (egenmelding). The API enforces these automatically:

• Maximum duration: 3 calendar days per episode. If end_date is provided, it must be at most 3 days after start_date.
• Maximum frequency: 4 episodes per calendar year. The API counts all ACTIVE and COMPLETED self-certified leaves in the same calendar year.

Attempting to exceed these limits returns a 400 Bad Request error.

Relationships

The following related objects can be included using the with parameter:

• business_partner - The employee associated with the leave

Validation Rules

• business_partner_id is required
• client_account_id is required
• leave_type must be a valid leave type value
• start_date is required
• end_date must be on or after start_date (if provided)
• leave_percentage must be between 1 and 100 (if provided)
• status must be a valid status value (if provided)
• Self-certified sick leave has additional duration and frequency limits (see above)

Error Responses

Related Resources

• Payroll Contracts
• Payroll Runs
• Payroll Tax Cards
• Business Partners