---
title: "Lister les variables de paie"
description: "Liste paginée des variables de paie de l’entreprise, toutes origines confondues (saisie, import, feuilles de temps, astreintes, intéressement, page Primes), du mois de paie le plus récent au plus ancien.\n\nLes variables récurrentes (abonnements annuels de transport, primes et avantages récurrents) n’y figurent pas : lisez-les avec `GET /public/v1/recurring-variables`."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.puncto.fr/llms.txt
> Use this file to discover all available pages before exploring further.

Path: API Puncto › Variables de paie

`GET /public/v1/payroll-variables`

Liste paginée des variables de paie de l’entreprise, toutes origines confondues (saisie, import, feuilles de temps, astreintes, intéressement, page Primes), du mois de paie le plus récent au plus ancien.

Les variables récurrentes (abonnements annuels de transport, primes et avantages récurrents) n’y figurent pas : lisez-les avec `GET /public/v1/recurring-variables`.

## Authentication

- `bearerAuth`, http, header `Authorization`

## Query parameters

- `page` (`listPayrollVariables.query.page`; integer, optional) — Numéro de page, à partir de 1.
  - min 1; default `1`
- `perPage` (`listPayrollVariables.query.perPage`; integer, optional) — Nombre d’éléments par page, 200 au plus.
  - min 1; max 200; default `50`
- `year` (`listPayrollVariables.query.year`; integer, optional) — Année du mois de paie.
  - min 2000; max 2100; example `2026`
- `month` (`listPayrollVariables.query.month`; integer, optional) — Mois de paie, de 1 (janvier) à 12.
  - min 1; max 12; example `10`
- `type[]` (`listPayrollVariables.query.type[]`; array<string>, optional) — Types de variable à garder. Répétez le paramètre pour en passer plusieurs.
- `status[]` (`listPayrollVariables.query.status[]`; array<string>, optional) — Statuts à garder. Répétez le paramètre pour en passer plusieurs.
- `contractId` (`listPayrollVariables.query.contractId`; string, optional) — Identifiant Puncto du contrat.
  - example `"cont_01JB7Q6ZC8V3K9N2M4R5T7W8XY"`
- `collaboratorId` (`listPayrollVariables.query.collaboratorId`; string, optional) — Identifiant Puncto du collaborateur. Ne pas combiner avec `collaboratorForeignErpId`.
  - example `"coll_01JB7Q6ZC8V3K9N2M4R5T7W8XY"`
- `collaboratorForeignErpId` (`listPayrollVariables.query.collaboratorForeignErpId`; string, optional) — Identifiant du collaborateur dans votre système (`foreignErpId`). Ne pas combiner avec `collaboratorId`.
  - example `"salarie-123"`
- `foreignErpId` (`listPayrollVariables.query.foreignErpId`; string, optional) — Identifiant de la variable dans votre système.
  - example `"prime-2026-10-salarie-123"`

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.puncto.fr/public/v1/payroll-variables \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.puncto.fr/public/v1/payroll-variables';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.puncto.fr/public/v1/payroll-variables"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Page de variables de paie

#### Example

```json
{
  "data": [
    {
      "payrollVariableId": "pvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY",
      "foreignErpId": "string",
      "contractId": "cont_01JB7Q6ZC8V3K9N2M4R5T7W8XY",
      "collaboratorId": "coll_01JB7Q6ZC8V3K9N2M4R5T7W8XY",
      "collaboratorForeignErpId": "string",
      "year": 0,
      "month": 0,
      "status": "PENDING",
      "data": {
        "type": "PRIME",
        "name": "string",
        "amount": 0,
        "base": 0,
        "primeType": "HOLIDAY_BONUS",
        "isAbsenceSensitive": true,
        "attachmentPeriod": {
          "startDate": "2019-08-24",
          "endDate": "2019-08-24"
        }
      },
      "proofFiles": [
        {
          "documentId": "cfil_01JB7Q6ZC8V3K9N2M4R5T7W8XY",
          "displayFileName": "string",
          "fileType": "PAYSLIP",
          "mimeType": "image/jpeg",
          "createdAt": "2019-08-24T14:15:22Z"
        }
      ],
      "businessMealParticipantContractIds": [
        "cont_01JB7Q6ZC8V3K9N2M4R5T7W8XY"
      ],
      "origin": "ENTRY",
      "isLocked": true,
      "lockState": {
        "state": "OPEN"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "perPage": 0,
    "currentPage": 0,
    "firstPage": 0,
    "lastPage": 0
  }
}
```

- `data` (`listPayrollVariables.response.200.data`; array<object>, required)
  - `payrollVariableId` (`listPayrollVariables.response.200.data.payrollVariableId`; string, required) — Identifiant Puncto de la variable de paie
  - `foreignErpId` (`listPayrollVariables.response.200.data.foreignErpId`; string | null, required) — Identifiant de la variable dans votre système, null si elle n'en a pas
  - `contractId` (`listPayrollVariables.response.200.data.contractId`; string, required) — Contrat qui porte la variable
  - `collaboratorId` (`listPayrollVariables.response.200.data.collaboratorId`; string, required) — Collaborateur titulaire du contrat
  - `collaboratorForeignErpId` (`listPayrollVariables.response.200.data.collaboratorForeignErpId`; string | null, required) — Identifiant du collaborateur dans votre système, null s'il n'a pas été renseigné
  - `year` (`listPayrollVariables.response.200.data.year`; number, required) — Année du mois de paie
  - `month` (`listPayrollVariables.response.200.data.month`; number, required) — Mois de paie, de 1 (janvier) à 12
  - `status` (`listPayrollVariables.response.200.data.status`; string, required) — Seules les variables `VALIDATED` entrent dans le bulletin
    - one of `"PENDING"`, `"VALIDATED"`, `"REJECTED"`
  - `data` (`listPayrollVariables.response.200.data.data`; any of, required) — Contenu de la variable
    - any of: `PublicApiPayrollVariablePrimeData`, `PublicApiPayrollVariableSalaryDeductionData`, `PublicApiPayrollVariableInKindBenefitData`, `PublicApiPayrollVariableOvertimeData`, `PublicApiPayrollVariableMonthlyOvertimeData`, `PublicApiPayrollVariableRemoteWorkDayData`, `PublicApiPayrollVariableMealAllowanceAdjustmentData`, `PublicApiPayrollVariableMealVoucherAdjustmentData`, `PublicApiPayrollVariableSalaryAdvanceData`, `PublicApiPayrollVariableProfitSharingData`, `PublicApiPayrollVariableHolidayVoucherData`, `PublicApiPayrollVariablePrevoyanceIjData`, `PublicApiPayrollVariableOnCallData`, `PublicApiPayrollVariableExpenseNoteData`, `PublicApiPayrollVariablePersonalTransportData`, `PublicApiPayrollVariableOtherTaxFreeIndemnityData`
  - `proofFiles` (`listPayrollVariables.response.200.data.proofFiles`; array<object>, required) — Justificatifs, dans leur ordre d'ajout
    - `documentId` (`listPayrollVariables.response.200.data.proofFiles.documentId`; string, required) — Identifiant Puncto du document
    - `displayFileName` (`listPayrollVariables.response.200.data.proofFiles.displayFileName`; string, required) — Nom du document affiché dans Puncto
    - `fileType` (`listPayrollVariables.response.200.data.proofFiles.fileType`; string, required) — Type de document
      - one of `"PAYSLIP"`, `"PAYSLIP_ARCHIVED"`, `"DSN_MONTHLY"`, `"DSN_WORK_STOPPAGE"`, `"DSN_WORK_STOPPAGE_RESUMPTION"`, `"DSN_FCTU"`, `"DSN_SADV"`, `"CRM"`, `"EXPENSE_BILL"`, `"MEAL_VOUCHER_EXPORT"`, `"SEPA_PAYROLL"`, `"SEPA_SDTC"`, `"ABSENCE_PROOF"`, `"DPAE"`, `"DPAE_RETURN"`, `"ACCOUNTING_PAYROLL_OD"`, `"ACCOUNTING_PAYROLL_DSN_RECAP"`, `"ACCOUNTING_CONTRIBUTIONS_DETAIL"`, `"ACCOUNTING_CONTRIBUTIONS_RECAP"`, `"ACCOUNTING_PAYBOOK"`, `"ACCOUNTING_PAYROLL_LOG"`, `"ACCOUNTING_REST_RECAP"`, `"IDENTITY"`, `"VITALE"`, `"RIB"`, `"CONTRACT"`, `"INTERNSHIP_AGREEMENT"`, `"INTERNSHIP_CERTIFICATE"`, `"INTERNSHIP_CERTIFICATE_SIGNED"`, `"WORK_CERTIFICATE"`, `"WORK_CERTIFICATE_SIGNED"`, `"FINAL_SETTLEMENT_RECEIPT"`, `"FINAL_SETTLEMENT_RECEIPT_SIGNED"`, `"PROFIT_SHARING_STATEMENT"`, `"ON_CALL_STATEMENT"`, `"PROFIT_SHARING_AGREEMENT_RECEIPT"`, `"BILLING_INVOICE"`, `"COMPANY_SETUP_CHECKLIST"`, `"FCTU_AER"`, `"EXPORT"`, `"ABSENCE_BATCH"`, `"VARIABLE_BATCH"`, `"OC_FICHE"`, `"BPIJ"`, `"SIGNATURE_AUDIT_TRAIL"`, `"OTHER"`
    - `mimeType` (`listPayrollVariables.response.200.data.proofFiles.mimeType`; any of, required) — Type MIME du fichier
      - any of: `ImageMimeType`, `OtherMimeType`
    - `createdAt` (`listPayrollVariables.response.200.data.proofFiles.createdAt`; string, required) — Date d'enregistrement du document dans Puncto
      - format `date-time`
  - `businessMealParticipantContractIds` (`listPayrollVariables.response.200.data.businessMealParticipantContractIds`; array<string>, required) — Note de frais de repas d'affaires : contrats des participants, dont les titres restaurant du mois sont réduits dès l'enregistrement de la note, quel que soit son statut
  - `origin` (`listPayrollVariables.response.200.data.origin`; string, required) — Parcours de Puncto qui a créé la variable : - `ENTRY` : saisie dans Puncto ou importée par l'API ; aussi les indemnités générées par la clôture d'un contrat (celles du mois du solde de tout compte se modifient depuis la clôture) et le report d'un net négatif, généré à la clôture du mois sur le mois suivant (retenue `LAST_MONTH_NEGATIVE_PAY_ADVANCE`) ; - `VARIABLE_BATCH` : import d'un fichier de variables dans Puncto, modifiable comme une saisie ; - `TIMESHEET` : heures supplémentaires payées d'une feuille de temps validée, modifiables seulement depuis la feuille ; - `ON_CALL_PERIOD` : période d'astreinte, modifiable par l'import des périodes d'astreinte ; - `PROFIT_SHARING` : versement d'intéressement, modifiable seulement depuis ce versement ; - `HOLIDAY_BONUS`, `HOLIDAY_VOUCHER_ATTRIBUTION` : prime de vacances ou chèques-vacances de la page Primes, modifiables seulement depuis cette page ; - `VALUE_SHARING_BONUS` : versement de prime de partage de la valeur (PPV) de la page Primes ; comme dans l'application, la variable peut changer de statut ou être supprimée ; - `PREVOYANCE_IJ_SLIP` : part d'un bordereau de paiement prévoyance, modifiable seulement depuis ce bordereau.
    - one of `"ENTRY"`, `"VARIABLE_BATCH"`, `"TIMESHEET"`, `"ON_CALL_PERIOD"`, `"PROFIT_SHARING"`, `"HOLIDAY_BONUS"`, `"HOLIDAY_VOUCHER_ATTRIBUTION"`, `"VALUE_SHARING_BONUS"`, `"PREVOYANCE_IJ_SLIP"`
  - `isLocked` (`listPayrollVariables.response.200.data.isLocked`; boolean, required) — Plus aucune modification n'est possible : le mois de paie est clôturé et aucune paie ouverte ne peut porter la régularisation (`lockState.state` vaut `BLOCKED`)
  - `lockState` (`listPayrollVariables.response.200.data.lockState`; any of, required) — Effet d'une modification de la variable : sur la paie du mois, ou en saisie tardive régularisée par une paie ultérieure
    - any of: `object`, `object`, `object`
  - `createdAt` (`listPayrollVariables.response.200.data.createdAt`; string, required) — Date de création de la variable
    - format `date-time`
  - `updatedAt` (`listPayrollVariables.response.200.data.updatedAt`; string, required) — Date de dernière modification de la variable
    - format `date-time`
- `meta` (`listPayrollVariables.response.200.meta`; object, required)
  - `total` (`listPayrollVariables.response.200.meta.total`; integer, required) — Nombre total d’éléments.
  - `page` (`listPayrollVariables.response.200.meta.page`; integer, required) — Page renvoyée.
  - `perPage` (`listPayrollVariables.response.200.meta.perPage`; integer, required)
  - `currentPage` (`listPayrollVariables.response.200.meta.currentPage`; integer, required)
  - `firstPage` (`listPayrollVariables.response.200.meta.firstPage`; integer, required)
  - `lastPage` (`listPayrollVariables.response.200.meta.lastPage`; integer, required)

### 401

Clé d’API absente, invalide ou révoquée

#### Example

```json
{
  "error": "Les endpoints de l’API publique sont réservés aux comptes application."
}
```

- `error` (`listPayrollVariables.response.401.error`; string, required) — Message lisible, en français.
- `errorCode` (`listPayrollVariables.response.401.errorCode`; string, optional) — Code stable, sur certaines erreurs.

### 403

Opération hors de l’accès de la clé d’API

#### Example

```json
{
  "error": "Opération interdite"
}
```

- `error` (`listPayrollVariables.response.403.error`; string, required) — Message lisible, en français.
- `errorCode` (`listPayrollVariables.response.403.errorCode`; string, optional) — Code stable, sur certaines erreurs.

### 404

Collaborateur du filtre introuvable

#### Example

```json
{
  "error": "Collaborateur non trouvé"
}
```

- `error` (`listPayrollVariables.response.404.error`; string, required) — Message lisible, en français.
- `errorCode` (`listPayrollVariables.response.404.errorCode`; string, optional) — Code stable, sur certaines erreurs.

### 422

Paramètres invalides

#### Example

```json
{
  "errors": [
    {
      "message": "Le champ statut de l’absence doit être une valeur autorisée",
      "rule": "enum",
      "field": "status"
    }
  ]
}
```

- `errors` (`listPayrollVariables.response.422.errors`; array<object>, required)
  - `message` (`listPayrollVariables.response.422.errors.message`; string, required)
  - `rule` (`listPayrollVariables.response.422.errors.rule`; string, required) — Règle de validation en échec.
  - `field` (`listPayrollVariables.response.422.errors.field`; string, required) — Chemin du champ, par exemple `absences.0.type`.


Source: https://docs.puncto.fr/reference/payroll-variables/list/index.md
