Lister les champs définissables de la paie

GET

/api/payroll/user-fields

Retourne la configuration des 8 champs définissables de la paie : libellé, format (heures, jours, montant, date…) et portée. Un champ scope: employee se saisit sur l'employé (user_fields de PATCH /employees/by-id/{id}) ; un champ scope: function se saisit sur chaque fonction de l'employé, et son cumul, recalculé par Acomba, est en lecture seule. Un champ de format date se saisit avec date, les autres avec value (-99999.99 à 99999.99). L'interface d'Acomba ne configure que les 3 premiers champs, et sa case « Fonction » les rend tous les 3 cumulatifs.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/payroll/user-fields' \
--header 'x-api-key: <api-key>'

Response Example

{
    "fields": [
        {
            "configured": true,
            "format": "days",
            "index": 1,
            "label": "Jours de congé par an",
            "scope": "employee"
        },
        {
            "configured": true,
            "format": "hours",
            "index": 2,
            "label": "Heures de formation",
            "scope": "function"
        },
        {
            "configured": true,
            "format": "date",
            "index": 3,
            "label": "Date d'embauche syndicale",
            "scope": "employee"
        },
        {
            "configured": false,
            "index": 4,
            "scope": "employee"
        }
    ],
    "metadata": {
        "properties": [
            "CPA_UserFields_*"
        ],
        "scopes": {
            "employee": "PATCH /employees/by-id/{id} (user_fields)",
            "function": "PATCH /employees/by-id/{id}/functions/by-id/{function_cp} (user_fields)"
        },
        "sdk_interface": "ControlPayroll"
    }
}

Modified at 2026-10-10 14:01:59

Lister les tables de valeurs de la paie

Lister les périodes de paie