Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Compensations > Concept

Reads a single Concept

Reads a single Concept

get/api/2026-07-01/resources/compensations/concepts/{id}

Path parameters

idstring required

The ids of the concepts

Response

OK

idstring required

The identifier of the concept

category'earnings_fixed_salary' | 'earnings_variable' | 'earnings_benefits_in_kind' | 'earnings_others' | 'deductions' | 'company_contribution' | 'summarized_values'

The category of the concept

company_idstring required

The company identifier of the concept

defaultboolean required

Whether the concept is a default or a custom concept

descriptionstring required

The description of the concept

labelstring required

The label of the concept

namestring required

The name of the concept

translated_namestring required

The translated name of the concept if it is a default concept.

unit_namestring

The name of the unit of the concept

unit_type'distance' | 'money' | 'time' | 'unit'

The type of the unit of the concept

Example response

{
  "id": "1",
  "category": "earnings_fixed_salary",
  "company_id": "1",
  "description": "Fixed Comission",
  "label": "Fixed comission",
  "name": "fixed_comission",
  "translated_name": "Fixed comission",
  "unit_name": "EUR",
  "unit_type": "money"
}