---
title: "Consulter une période d’astreinte"
---

> 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 › Astreintes

`GET /public/v1/on-call-periods/{onCallPeriodId}`

## Authentication

- `bearerAuth`, http, header `Authorization`

## Path parameters

- `onCallPeriodId` (`getOnCallPeriod.path.onCallPeriodId`; string, required) — Identifiant Puncto de la période (`payrollVariableId`), ou son `foreignErpId` avec `matchingBy=BY_FOREIGN_ERP_ID`.
  - example `"pvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY"`

## Query parameters

- `matchingBy` (`getOnCallPeriod.query.matchingBy`; string, optional) — Clé de correspondance de `onCallPeriodId`. Par défaut, l’identifiant Puncto.
  - one of `"BY_PUNCTO_ID"`, `"BY_FOREIGN_ERP_ID"`

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.puncto.fr/public/v1/on-call-periods/pvar_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/on-call-periods/pvar_01JB7Q6ZC8V3K9N2M4R5T7W8XY"

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

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

print(response.text)
```

## Responses

### 200

Période d’astreinte

#### Example

```json
{
  "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"
}
```

- `payrollVariableId` (`getOnCallPeriod.response.200.payrollVariableId`; string, required) — Identifiant Puncto de la variable de paie
- `foreignErpId` (`getOnCallPeriod.response.200.foreignErpId`; string | null, required) — Identifiant de la variable dans votre système, null si elle n'en a pas
- `contractId` (`getOnCallPeriod.response.200.contractId`; string, required) — Contrat qui porte la variable
- `collaboratorId` (`getOnCallPeriod.response.200.collaboratorId`; string, required) — Collaborateur titulaire du contrat
- `collaboratorForeignErpId` (`getOnCallPeriod.response.200.collaboratorForeignErpId`; string | null, required) — Identifiant du collaborateur dans votre système, null s'il n'a pas été renseigné
- `year` (`getOnCallPeriod.response.200.year`; number, required) — Année du mois de paie
- `month` (`getOnCallPeriod.response.200.month`; number, required) — Mois de paie, de 1 (janvier) à 12
- `status` (`getOnCallPeriod.response.200.status`; string, required) — Seules les variables `VALIDATED` entrent dans le bulletin
  - one of `"PENDING"`, `"VALIDATED"`, `"REJECTED"`
- `data` (`getOnCallPeriod.response.200.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` (`getOnCallPeriod.response.200.proofFiles`; array<object>, required) — Justificatifs, dans leur ordre d'ajout
  - `documentId` (`getOnCallPeriod.response.200.proofFiles.documentId`; string, required) — Identifiant Puncto du document
  - `displayFileName` (`getOnCallPeriod.response.200.proofFiles.displayFileName`; string, required) — Nom du document affiché dans Puncto
  - `fileType` (`getOnCallPeriod.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` (`getOnCallPeriod.response.200.proofFiles.mimeType`; any of, required) — Type MIME du fichier
    - any of: `ImageMimeType`, `OtherMimeType`
  - `createdAt` (`getOnCallPeriod.response.200.proofFiles.createdAt`; string, required) — Date d'enregistrement du document dans Puncto
    - format `date-time`
- `businessMealParticipantContractIds` (`getOnCallPeriod.response.200.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` (`getOnCallPeriod.response.200.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` (`getOnCallPeriod.response.200.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` (`getOnCallPeriod.response.200.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` (`getOnCallPeriod.response.200.createdAt`; string, required) — Date de création de la variable
  - format `date-time`
- `updatedAt` (`getOnCallPeriod.response.200.updatedAt`; string, required) — Date de dernière modification de la variable
  - 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` (`getOnCallPeriod.response.401.error`; string, required) — Message lisible, en français.
- `errorCode` (`getOnCallPeriod.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` (`getOnCallPeriod.response.403.error`; string, required) — Message lisible, en français.
- `errorCode` (`getOnCallPeriod.response.403.errorCode`; string, optional) — Code stable, sur certaines erreurs.

### 404

Période introuvable

#### Example

```json
{
  "error": "Période d’astreinte non trouvée"
}
```

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


Source: https://docs.puncto.fr/reference/on-call-periods/retrieve/index.md
