FAfactorialhr
Compensations > Concept

Reads all Concepts

Changed on

Retrieves compensation concepts (custom and default)

get/api/2026-10-01/resources/compensations/concepts

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/compensations/concepts
  • 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

Query parameters

ids[]string[]

Filter by concept ids

[
  "1"
]
categories[]string[]

Return only the concepts in these categories: earnings_fixed_salary, earnings_variable, earnings_benefits_in_kind, earnings_others, deductions, company_contribution or summarized_values.

[
  "earnings_fixed_salary",
  "deductions"
]
with_active_statusboolean

When true, returns only active concepts

Example:true
enabledboolean

When true, returns active concepts only; when false, only inactive

Example:true
defaultboolean

Set to true to return only the concepts Factorial ships by default, leaving out the ones the company created itself. Passing false has no effect.

Response

OK

Example response

{
  "data": [
    {
      "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