FAfactorialhr
Compensations > Cycle

Reads a single Cycle

Changed on

Retrieves compensation cycles

get/api/2026-10-01/resources/compensations/cycles/{id}

Request

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

Path parameters

idstring required

Compensation cycle ids

Response

OK

idstring required

Unique identifier of the compensation cycle

company_idstring required

ID of the company that owns the cycle

recurrencestring required

How often the cycle recurs (e.g. monthly)

first_paymentstring

Date of the first payment in the cycle

currencystring

ISO 4217 currency code the cycle pays in

countrystring

ISO country code the cycle applies to

closure_dayinteger

Day of the period on which the cycle's runs close

alerts_dayinteger

Day of the period on which alerts for the cycle are dispatched

archived_atstring

Timestamp of archival (null if active)

created_atstring

Timestamp when the cycle record was created

updated_atstring

Timestamp when the cycle record was last updated

Example response

{
  "id": "1",
  "company_id": "1",
  "recurrence": "monthly",
  "first_payment": "2026-01-01",
  "currency": "EUR",
  "country": "es",
  "closure_day": 25,
  "alerts_day": 20,
  "created_at": "2026-01-01T08:00:00.000+00:00",
  "updated_at": "2026-01-01T08:00:00.000+00:00"
}

Changes