FAfactorialhr
Compensations > Concept

Updates a Concept

Changed on

Updates an existing concept. For default concepts, only the enabled flag may be changed. The unit type can't be changed once the concept is created; send the current one or leave it out.

put/api/2026-10-01/resources/compensations/concepts/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/compensations/concepts/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: payroll
    • or API key in header x-api-key

Path parameters

idstring required

The identifier of the concept to update

Request body

idstring required

The identifier of the concept to update

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

Concept category (custom concepts only)

descriptionstring

Concept description (custom concepts only)

labelstring

Display label (custom concepts only)

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

Unit type (custom concepts only). It can't be changed once the concept is created, so a different value is rejected

labor_costboolean

Marks the concept as labor cost (custom concepts only)

enabledboolean

Activates / deactivates the concept (default and custom concepts)

Example request

{
  "id": "1",
  "category": "earnings_fixed_salary",
  "description": "Fixed Comission",
  "label": "Fixed comission",
  "unit_type": "money",
  "enabled": true
}

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 accounting category of the concept (e.g. earnings_fixed_salary, deductions)

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'

What the concept's amount is measured in (e.g. money, a quantity of units)

enabledboolean required

Whether the concept is enabled for the company

created_atstring

Timestamp when the concept was created

updated_atstring

Timestamp when the concept was last updated

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",
  "enabled": true,
  "created_at": "2026-01-01T08:00:00.000+00:00",
  "updated_at": "2026-01-01T08:00:00.000+00:00"
}

Changes