---
title: "Modifier une variable récurrente"
description: "Change le statut ou le dernier mois de versement d’une variable récurrente, un seul par requête. Les brouillons des mois concernés sont recalculés. Renvoyer les valeurs actuelles ne change rien.\n\nLe contenu (`data`, `frequency`, `startYear`, `startMonth`) ne se modifie pas : fixez le dernier mois de versement ou supprimez la variable, puis créez-en une nouvelle.\n\n- **Statut** : seule une variable `VALIDATED` est versée. Une variable déjà versée par un mois verrouillé (paie clôturée ou bulletin validé) reste validée. Une variable ne se valide que sur des mois ouverts : un abonnement annuel accepté tard ne rembourse que les mois encore ouverts.\n- **Dernier mois de versement** : pas avant le premier mois, pas au-delà du douzième mois d’un abonnement annuel, et sans ajouter ni retirer de versement à un mois verrouillé. Une fois qu’un mois verrouillé a versé la variable, c’est la seule modification possible."
---

> 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

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

Change le statut ou le dernier mois de versement d’une variable récurrente, un seul par requête. Les brouillons des mois concernés sont recalculés. Renvoyer les valeurs actuelles ne change rien.

Le contenu (`data`, `frequency`, `startYear`, `startMonth`) ne se modifie pas : fixez le dernier mois de versement ou supprimez la variable, puis créez-en une nouvelle.

- **Statut** : seule une variable `VALIDATED` est versée. Une variable déjà versée par un mois verrouillé (paie clôturée ou bulletin validé) reste validée. Une variable ne se valide que sur des mois ouverts : un abonnement annuel accepté tard ne rembourse que les mois encore ouverts.
- **Dernier mois de versement** : pas avant le premier mois, pas au-delà du douzième mois d’un abonnement annuel, et sans ajouter ni retirer de versement à un mois verrouillé. Une fois qu’un mois verrouillé a versé la variable, c’est la seule modification possible.

## Authentication

- `bearerAuth`, http, header `Authorization`

## Path parameters

- `recurringVariableId` (`updateRecurringVariable.path.recurringVariableId`; string, required) — Identifiant Puncto de la variable récurrente. Depuis votre `foreignErpId`, retrouvez-le avec `GET /public/v1/recurring-variables/{recurringVariableId}?matchingBy=BY_FOREIGN_ERP_ID`.
  - example `"rvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY"`

## Request body

_Required._

- `status` (`updateRecurringVariable.status`; string, optional) — - `PENDING` : En attente - `VALIDATED` : Accepté - `REJECTED` : Refusé
  - one of `"PENDING"`, `"VALIDATED"`, `"REJECTED"`
- `endYear` (`updateRecurringVariable.endYear`; integer, optional) — Année du dernier mois de versement, avec `endMonth`.
  - min 2000; max 2100; example `2027`
- `endMonth` (`updateRecurringVariable.endMonth`; integer, optional) — Dernier mois de versement inclus, avec `endYear`.
  - min 1; max 12; example `1`

## Example request

```json
{
  "endYear": 2027,
  "endMonth": 6
}
```

## Code samples

### cURL

```bash
curl --request PUT \
  --url https://api.puncto.fr/public/v1/recurring-variables/rvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endYear": 2027,
  "endMonth": 6
}
'
```

### TypeScript

```typescript
const url = 'https://api.puncto.fr/public/v1/recurring-variables/rvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({endYear: 2027, endMonth: 6})
};

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"

payload = {
    "endYear": 2027,
    "endMonth": 6
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Variable récurrente modifiée

#### 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` (`updateRecurringVariable.response.200.recurringVariableId`; string, required) — Identifiant Puncto de la variable récurrente
- `foreignErpId` (`updateRecurringVariable.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` (`updateRecurringVariable.response.200.contractId`; string, required) — Contrat qui verse la variable
- `collaboratorId` (`updateRecurringVariable.response.200.collaboratorId`; string, required) — Collaborateur titulaire du contrat
- `collaboratorForeignErpId` (`updateRecurringVariable.response.200.collaboratorForeignErpId`; string | null, required) — Identifiant du collaborateur dans votre système, null s'il n'a pas été renseigné
- `data` (`updateRecurringVariable.response.200.data`; any of, required) — Ce que la variable verse chaque mois
  - any of: `PublicApiRecurringPrimeData`, `PublicApiRecurringInKindBenefitData`, `PublicApiAnnualPublicTransportData`
- `frequency` (`updateRecurringVariable.response.200.frequency`; string, required) — Périodicité des versements
- `status` (`updateRecurringVariable.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` (`updateRecurringVariable.response.200.startYear`; number, required) — Année du premier mois de versement
- `startMonth` (`updateRecurringVariable.response.200.startMonth`; number, required) — Premier mois de versement, de 1 à 12
- `endYear` (`updateRecurringVariable.response.200.endYear`; number | null, required) — Année du dernier mois de versement, null tant que la variable court sans fin
- `endMonth` (`updateRecurringVariable.response.200.endMonth`; number | null, required) — Dernier mois de versement inclus, de 1 à 12, null tant que la variable court sans fin
- `lockedThrough` (`updateRecurringVariable.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` (`updateRecurringVariable.response.200.proofFiles`; array<object>, required) — Justificatifs joints dans Puncto
  - `documentId` (`updateRecurringVariable.response.200.proofFiles.documentId`; string, required) — Identifiant Puncto du document
  - `displayFileName` (`updateRecurringVariable.response.200.proofFiles.displayFileName`; string, required) — Nom du document affiché dans Puncto
  - `fileType` (`updateRecurringVariable.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` (`updateRecurringVariable.response.200.proofFiles.mimeType`; any of, required) — Type MIME du fichier
    - any of: `ImageMimeType`, `OtherMimeType`
  - `createdAt` (`updateRecurringVariable.response.200.proofFiles.createdAt`; string, required) — Date d'enregistrement du document dans Puncto
    - format `date-time`
- `createdAt` (`updateRecurringVariable.response.200.createdAt`; string, required) — Date de création dans Puncto
  - format `date-time`
- `updatedAt` (`updateRecurringVariable.response.200.updatedAt`; string, required) — Date de dernière modification dans Puncto
  - format `date-time`

### 400

Modification refusée : contenu envoyé, statut et dernier mois ensemble, variable déjà versée par un mois verrouillé, ou dernier mois invalide (avant le premier, au-delà du douzième d’un abonnement annuel, sur un mois verrouillé)

#### Example

```json
{
  "error": "Ce dernier mois de versement changerait un mois déjà clôturé : choisissez un mois après le dernier mois clôturé."
}
```

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

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


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