---
title: "Consulter une variable récurrente"
description: "Renvoie une variable récurrente, désignée par son identifiant Puncto ou par son `foreignErpId`."
---

> 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 récurrentes

`GET /public/v1/recurring-variables/{recurringVariableId}`

Renvoie une variable récurrente, désignée par son identifiant Puncto ou par son `foreignErpId`.

## Authentication

- `bearerAuth`, http, header `Authorization`

## Path parameters

- `recurringVariableId` (`getRecurringVariable.path.recurringVariableId`; string, required) — Identifiant Puncto de la variable récurrente, ou son `foreignErpId` avec `matchingBy=BY_FOREIGN_ERP_ID`.
  - example `"rvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY"`

## Query parameters

- `matchingBy` (`getRecurringVariable.query.matchingBy`; string, optional) — Ce que désigne `{recurringVariableId}`. - `BY_PUNCTO_ID` : `{recurringVariableId}` est l’identifiant Puncto (par défaut) - `BY_FOREIGN_ERP_ID` : `{recurringVariableId}` est le `foreignErpId` de la variable récurrente
  - one of `"BY_PUNCTO_ID"`, `"BY_FOREIGN_ERP_ID"`

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.puncto.fr/public/v1/recurring-variables/rvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY';
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/recurring-variables/rvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY"

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

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

print(response.text)
```

## Responses

### 200

Variable récurrente

#### Example

```json
{
  "recurringVariableId": "rvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY",
  "foreignErpId": "string",
  "contractId": "cont_01JB7Q6ZC8V3K9N2M4R5T7W8XY",
  "collaboratorId": "coll_01JB7Q6ZC8V3K9N2M4R5T7W8XY",
  "collaboratorForeignErpId": "string",
  "data": {
    "type": "PRIME",
    "name": "string",
    "amount": 0,
    "primeType": "HOLIDAY_BONUS",
    "isAbsenceSensitive": true
  },
  "frequency": "MONTHLY",
  "status": "PENDING",
  "startYear": 0,
  "startMonth": 0,
  "endYear": 0,
  "endMonth": 0,
  "lockedThrough": {
    "year": 0,
    "month": 0
  },
  "proofFiles": [
    {
      "documentId": "cfil_01JB7Q6ZC8V3K9N2M4R5T7W8XY",
      "displayFileName": "string",
      "fileType": "PAYSLIP",
      "mimeType": "image/jpeg",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
```

- `recurringVariableId` (`getRecurringVariable.response.200.recurringVariableId`; string, required) — Identifiant Puncto de la variable récurrente
- `foreignErpId` (`getRecurringVariable.response.200.foreignErpId`; string | null, required) — Identifiant de la variable récurrente dans votre système, null si elle n'a pas été importée
- `contractId` (`getRecurringVariable.response.200.contractId`; string, required) — Contrat qui verse la variable
- `collaboratorId` (`getRecurringVariable.response.200.collaboratorId`; string, required) — Collaborateur titulaire du contrat
- `collaboratorForeignErpId` (`getRecurringVariable.response.200.collaboratorForeignErpId`; string | null, required) — Identifiant du collaborateur dans votre système, null s'il n'a pas été renseigné
- `data` (`getRecurringVariable.response.200.data`; any of, required) — Ce que la variable verse chaque mois
  - any of: `PublicApiRecurringPrimeData`, `PublicApiRecurringInKindBenefitData`, `PublicApiAnnualPublicTransportData`
- `frequency` (`getRecurringVariable.response.200.frequency`; string, required) — Périodicité des versements
- `status` (`getRecurringVariable.response.200.status`; string, required) — Seule une variable validée (`VALIDATED`) est versée ; une variable en attente (`PENDING`) attend un administrateur
  - one of `"PENDING"`, `"VALIDATED"`, `"REJECTED"`
- `startYear` (`getRecurringVariable.response.200.startYear`; number, required) — Année du premier mois de versement
- `startMonth` (`getRecurringVariable.response.200.startMonth`; number, required) — Premier mois de versement, de 1 à 12
- `endYear` (`getRecurringVariable.response.200.endYear`; number | null, required) — Année du dernier mois de versement, null tant que la variable court sans fin
- `endMonth` (`getRecurringVariable.response.200.endMonth`; number | null, required) — Dernier mois de versement inclus, de 1 à 12, null tant que la variable court sans fin
- `lockedThrough` (`getRecurringVariable.response.200.lockedThrough`; any of, required) — Dernier mois de la période déjà verrouillé (paie clôturée ou bulletin validé), null si aucun ou si la variable n'est pas validée. Une variable verrouillée ne se supprime plus et ne se modifie plus : seul son dernier mois de versement peut encore être fixé, après ce mois
  - any of: `PublicApiYearMonth`, `null`
- `proofFiles` (`getRecurringVariable.response.200.proofFiles`; array<object>, required) — Justificatifs joints dans Puncto
  - `documentId` (`getRecurringVariable.response.200.proofFiles.documentId`; string, required) — Identifiant Puncto du document
  - `displayFileName` (`getRecurringVariable.response.200.proofFiles.displayFileName`; string, required) — Nom du document affiché dans Puncto
  - `fileType` (`getRecurringVariable.response.200.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` (`getRecurringVariable.response.200.proofFiles.mimeType`; any of, required) — Type MIME du fichier
    - any of: `ImageMimeType`, `OtherMimeType`
  - `createdAt` (`getRecurringVariable.response.200.proofFiles.createdAt`; string, required) — Date d'enregistrement du document dans Puncto
    - format `date-time`
- `createdAt` (`getRecurringVariable.response.200.createdAt`; string, required) — Date de création dans Puncto
  - format `date-time`
- `updatedAt` (`getRecurringVariable.response.200.updatedAt`; string, required) — Date de dernière modification dans Puncto
  - format `date-time`

### 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` (`getRecurringVariable.response.401.error`; string, required) — Message lisible, en français.
- `errorCode` (`getRecurringVariable.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` (`getRecurringVariable.response.403.error`; string, required) — Message lisible, en français.
- `errorCode` (`getRecurringVariable.response.403.errorCode`; string, optional) — Code stable, sur certaines erreurs.

### 404

Variable récurrente introuvable dans l’entreprise

#### Example

```json
{
  "error": "Variable récurrente non trouvée"
}
```

- `error` (`getRecurringVariable.response.404.error`; string, required) — Message lisible, en français.
- `errorCode` (`getRecurringVariable.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` (`getRecurringVariable.response.422.errors`; array<object>, required)
  - `message` (`getRecurringVariable.response.422.errors.message`; string, required)
  - `rule` (`getRecurringVariable.response.422.errors.rule`; string, required) — Règle de validation en échec.
  - `field` (`getRecurringVariable.response.422.errors.field`; string, required) — Chemin du champ, par exemple `absences.0.type`.


Source: https://docs.puncto.fr/reference/recurring-variables/retrieve/index.md
