Silae API

https://silae-api.document360.io/docs
Admin
Silae API provides REST and SWS APIs for integrating with Silae payroll management system, enabling...
Tokens:116,911
Snippets:489
Trust Score:9.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### API REST Getting Started

Source: https://silae-api.document360.io/docs/premi%C3%A8re-connexion-au-portail-api

Steps to get started with Silae REST APIs using the obtained Client ID, Client Secret, and Subscription Key.

```APIDOC
## API REST Getting Started

### Description
This section outlines the initial steps for utilizing the Silae REST APIs, including authentication and authorization.

### Method
N/A (Conceptual Steps)

### Endpoint
N/A (Conceptual Steps)

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Steps:
1. **Authentication**: Use the obtained **Client ID** and **Client Secret** to authenticate and obtain an `access_token` using the 'Token Creation Prod' API function.
2. **Authorization**: Use the copied **API Access Configuration Key** (Subscription Key) to gain access rights to the designated payroll data.
```

--------------------------------

### GET /AnalyseProductionPaieEffectifs

Source: https://silae-api.document360.io/docs/release-note-1

Retrieves the average workforce size over a given period.

```APIDOC
## GET /AnalyseProductionPaieEffectifs

### Description
Retrieves the average workforce size over a given period.

### Method
GET

### Endpoint
/AnalyseProductionPaieEffectifs

### Parameters
#### Query Parameters
- **startDate** (string) - Required - The start date of the period.
- **endDate** (string) - Required - The end date of the period.

### Request Example
GET /AnalyseProductionPaieEffectifs?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD

### Response
#### Success Response (200)
- **averageWorkforce** (number) - The average workforce size.

#### Response Example
{
  "averageWorkforce": 150.5
}
```

--------------------------------

### GET /LectureAxesAnalytiques

Source: https://silae-api.document360.io/docs/release-note-1

Retrieves analytical axes, now supporting up to 15 axes.

```APIDOC
## GET /LectureAxesAnalytiques

### Description
Retrieves analytical axes, now supporting up to 15 axes.

### Method
GET

### Endpoint
/LectureAxesAnalytiques

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter criteria for the axes.

### Request Example
GET /LectureAxesAnalytiques?filter=department

### Response
#### Success Response (200)
- **analyticalAxes** (array) - An array of analytical axis objects.

#### Response Example
{
  "analyticalAxes": [
    {
      "id": "AXIS001",
      "name": "Department"
    }
  ]
}
```

--------------------------------

### GET /AnalyseProductionPaieEffectifsAsynchrone

Source: https://silae-api.document360.io/docs/release-note-1

Initiates an asynchronous request to retrieve the average workforce size over a given period.

```APIDOC
## GET /AnalyseProductionPaieEffectifsAsynchrone

### Description
Initiates an asynchronous request to retrieve the average workforce size over a given period.

### Method
GET

### Endpoint
/AnalyseProductionPaieEffectifsAsynchrone

### Parameters
#### Query Parameters
- **startDate** (string) - Required - The start date of the period.
- **endDate** (string) - Required - The end date of the period.

### Request Example
GET /AnalyseProductionPaieEffectifsAsynchrone?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD

### Response
#### Success Response (200)
- **requestId** (string) - The ID of the asynchronous request.

#### Response Example
{
  "requestId": "REQ12345"
}
```

--------------------------------

### GET /ListeSalarieEmplois

Source: https://silae-api.document360.io/docs/release-note-1

Retrieves employee employment data. Includes new error handling for non-existent or duplicate employee IDs.

```APIDOC
## GET /ListeSalarieEmplois

### Description
Retrieves employee employment data. Includes new error handling for non-existent or duplicate employee IDs.

### Method
GET

### Endpoint
/ListeSalarieEmplois

### Parameters
#### Query Parameters
- **matriculeSalarie** (string) - Required - The employee's registration number.

### Request Example
GET /ListeSalarieEmplois?matriculeSalarie=123456

### Response
#### Success Response (200)
- **employmentData** (array) - An array of employee employment data objects.

#### Error Response (400)
- **error** (string) - Description of the error.
  - 'Aucun salarié ne correspond au matricule' if the employee ID does not exist.
  - 'Plusieurs salariés correspondent au matricule' if multiple employees share the same ID.

#### Response Example (Success)
{
  "employmentData": [
    {
      "employeeId": "EMP123",
      "position": "Developer"
    }
  ]
}

#### Response Example (Error - Not Found)
{
  "error": "Aucun
```

--------------------------------

### GET /EditionSoldeDeReposAsynchrone

Source: https://silae-api.document360.io/docs/release-note-1

Initiates an asynchronous request to generate a leave balance edition, with an option to select the analytical axis for distribution.

```APIDOC
## GET /EditionSoldeDeReposAsynchrone

### Description
Initiates an asynchronous request to generate a leave balance edition, with an option to select the analytical axis for distribution.

### Method
GET

### Endpoint
/EditionSoldeDeReposAsynchrone

### Parameters
#### Query Parameters
- **employeeId** (string) - Required - The ID of the employee.
- **analyticalAxisId** (string) - Optional - The ID of the analytical axis to use for distribution.
- **editionType** (integer) - Optional - Type of edition: 1 for Classic, 2 for CP Days, 3 for Detailed (default).

### Request Example
GET /EditionSoldeDeReposAsynchrone?employeeId=EMP123&analyticalAxisId=AXIS001&editionType=1

### Response
#### Success Response (200)
- **requestId** (string) - The ID of the asynchronous request.

#### Response Example
{
  "requestId": "REQ67890"
}
```

--------------------------------

### Get StatutAnalyseProductionPaieUtilisateursV2Asynchrone - Response Example

Source: https://silae-api.document360.io/docs/statutanalyseproductionpaieutilisateursv2asynchrone

Example JSON response body for the StatutAnalyseProductionPaieUtilisateursV2Asynchrone function. It includes task status, progress, execution duration, error messages, and detailed production statistics per user and dossier.

```json
{
  "statistiques": [
    {
      "numeroDossier": "string",
      "codeAgence": "string",
      "statistiquesProductionUtilisateurs": [
        {
          "identifiantUtilisateur": "string",
          "periode": "2020-10-14T21:46:24",
          "nbBulletins": 0,
          "nbEntrees": 0,
          "nbSorties": 0
        },
        {
          "identifiantUtilisateur": "string",
          "periode": "2020-10-14T21:46:24",
          "nbBulletins": 0,
          "nbEntrees": 0,
          "nbSorties": 0
        }
      ]
    },
    {
      "numeroDossier": "string",
      "codeAgence": "string",
      "statistiquesProductionUtilisateurs": [
        {
          "identifiantUtilisateur": "string",
          "periode": "2020-10-14T21:46:24",
          "nbBulletins": 0,
          "nbEntrees": 0,
          "nbSorties": 0
        },
        {
          "identifiantUtilisateur": "string",
          "periode": "2020-10-14T21:46:24",
          "nbBulletins": 0,
          "nbEntrees": 0,
          "nbSorties": 0
        }
      ]
    }
  ],
  "statut": "string",
  "messageErreur": "string",
  "progression": 10.5,
  "dureeExecution": "string"
}
```

--------------------------------

### Test Environment Setup

Source: https://silae-api.document360.io/docs/editeur-portail-api-deja-op%C3%A9rationnel

Steps to set up and use the Silae Paie REST API test environment, including importing payroll data.

```APIDOC
## Test Environment Setup

### Description
This section details the optional steps for setting up and using the Silae Paie REST API test environment, particularly if the API connector has not been previously validated.

### Access
Follow the password initialization procedure from the received message to gain access to the test environment.

### Preparation and Usage
1. **Request Payroll Dossiers**: Obtain the relevant Silae payroll dossiers from the client that will be used for testing.
2. **Access Test Environment**: Use the specific URL provided in the "Access to your Silae collaborator space" email to access the Silae Paie domain.
3. **Import Payroll Dossiers**: Import the client's payroll dossiers into the test environment using the password provided in the email.
   - Refer to the Silae Paie Knowledge Base for "Export / Import payroll dossiers on the software" for detailed instructions.
```

--------------------------------

### AnalyseProductionPaieUtilisateursV2Asynchrone API Endpoint and Request/Response

Source: https://silae-api.document360.io/docs/analyseproductionpaieutilisateursv2asynchrone

This snippet shows the REST API endpoint, HTTP verb, and example JSON payloads for the AnalyseProductionPaieUtilisateursV2Asynchrone function. It highlights the asynchronous nature, returning a task GUID.

```json
POST /v1/AnalyseProduction/AnalyseProductionPaieUtilisateursV2Asynchrone
{
  "requeteAnalyseProduction": {
    "periodeDebut": "2020-10-14T21:46:24",
    "periodeFin": "2020-10-14T21:46:24",
    "numeroDossier": "string",
    "codeAgence": "string"
  }
}

{
  "guidTache": "string"
}
```

--------------------------------

### Configuring API Access

Source: https://silae-api.document360.io/docs/premi%C3%A8re-connexion-au-portail-api

Guide to configuring API access within the production environment, including selecting API accounts and user permissions.

```APIDOC
## Configuring API Access

### Description
Configure API access settings in the production environment, linking your activated API account and defining access permissions for Silae users.

### Method
N/A (UI Interaction)

### Endpoint
N/A (UI Interaction)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
- **API Configuration Label** (string) - A user-defined label for the API configuration.

#### Response Example
N/A

### Steps:
1. Access the production environment.
2. Navigate to 'Paramétrage Paie' > 'bouton Options' > 'Configuration API'.
3. Select the activated Production API account from the list.
4. Designate a Silae user with the necessary API access rights.
5. Choose the type of access to payroll files:
    * Access to all domain payroll files.
    * Access to specific payroll files by selecting them.
6. Enter a desired label for the API configuration.
7. Save the API configuration. Be mindful of the implications for billing based on selected payroll files.
```

--------------------------------

### API Configuration Management

Source: https://silae-api.document360.io/docs/configuration-api

This section details how to configure API access for My Silae. It covers the necessary prerequisites, the main components of an API configuration, and how to manage these configurations through the Silae Paie application.

```APIDOC
## Introduction

To utilize the My Silae APIs, it is mandatory to have access authorizations to interact with payroll data. This requires setting up an API configuration to grant API access to the relevant payroll files.

### Prerequisites

#### Access to API Configuration Function
Users must be authorized to access the **API Configuration** function to manage API configurations. This requires the 'configure' permission, typically assigned from the collaborator administration, and should be granted to accounts with access to all payroll files in the domain.

#### Principal Components of an API Configuration

To define an API configuration, the following are needed:

*   An **active API account** on the portal (refer to API Account Management).
*   A **Silae user** corresponding to a Collaborator or Contact record, possessing the necessary rights to execute REST API functions.
    *   _Example:_ A Silae user lacking the right to modify an Employee record will receive an error if the API account attempts such an action.
    *   _Example:_ A Silae user without access to a payroll file cannot execute any API functions.

_Refer to:_ My Silae Paie Knowledge Base: Create and manage a collaborator, Client access rights, Define client contact access rights.

## API Configuration Management

The **Payroll Setup > Options > API Configuration** function provides access to the list of API access configurations. It allows for:

*   Displaying all granted API configurations within the domain.
*   Consulting and modifying (creating) the parameters of a selected API configuration.
*   Consulting and modifying (creating) the list of active payroll files for a chosen API configuration.

### Composition of an API Configuration

The **Create an API Configuration** action (right-hand menu) allows for defining an API configuration.

### API Configuration Parameters

| Field                 | Description                                                                                                                                      |
| :-------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------- |
| **API Account**       | The API account for which access is granted. Select from the proposed list. If the expected API account is not listed, it has not been activated on the API portal. |
| **Silae User**        | The Silae user to whom the API access is linked.                                                                                                  |
| **Access Type**       | Defines the scope of the API configuration:
    *   **Access to all domain files**: All files, including those added later, will be selected.
    *   **Access to one or more files**: A selection of payroll files from the domain list can be made. |
| **Label**             | A free text field for annotating the API configuration.                                                                                          |
| **Unique API Access Configuration ID** | An ID to identify the API access configuration (assigned upon saving a new configuration).                                                  |

### Access Type by API Model

The **Access Type** must be selected based on the API model (Model 1A, 1B, 2) associated with the account. The standard configuration is:

| API Model             | Example API Account Name      | Access Type                         |
| :-------------------- | :---------------------------- | :---------------------------------- |
| Model 1A              | SILAE-PARTENAIRE - 1A         | Access to all domain files or Access to one or more files |
| Model 1B              | SILAE-PARTENAIRE - 1B         | Access to one or more files         |
| Model 2               | SILAE-PARTENAIRE - CLIENT RS1 | Access to one or more files         |
| Model 2               | SILAE-PARTENAIRE - CLIENT RS2 | Access to one or more files         |

### Payroll File Selection

Payroll file selection is active based on the chosen access type:

| Access Type                     | Description          |
| :------------------------------ | :------------------- |
| Access to all domain files      | No action required   |
| Access to one or more files     | The button enables selection |

```

--------------------------------

### AnalyseProductionPaieBulletinsOriginauxAsynchrone API Endpoint and Request/Response

Source: https://silae-api.document360.io/docs/analyseproductionpaiebulletinsoriginauxasynchrone

This snippet shows the REST API endpoint, the HTTP POST method, and example JSON structures for the request and response of the AnalyseProductionPaieBulletinsOriginauxAsynchrone function. The request includes analysis criteria, and the response provides a task GUID for asynchronous processing.

```http
POST /v1/AnalyseProduction/AnalyseProductionPaieBulletinsOriginauxAsynchrone
```

```json
{
  "requeteAnalyseProduction": {
    "typePeriode": 0,
    "periodeDebut": "2020-10-14T21:46:24",
    "periodeFin": "2020-10-14T21:46:24",
    "numeroDossier": "string",
    "codeAgence": "string"
  }
}
```

```json
{
  "guidTache": "string"
}
```

--------------------------------

### GET /StatutAnalyseProductionPaieEffectifsAsynchrone

Source: https://silae-api.document360.io/docs/release-note-1

Retrieves the status of an asynchronous request to get the average workforce size.

```APIDOC
## GET /StatutAnalyseProductionPaieEffectifsAsynchrone

### Description
Retrieves the status of an asynchronous request to get the average workforce size.

### Method
GET

### Endpoint
/StatutAnalyseProductionPaieEffectifsAsynchrone

### Parameters
#### Query Parameters
- **requestId** (string) - Required - The ID of the asynchronous request.

### Request Example
GET /StatutAnalyseProductionPaieEffectifsAsynchrone?requestId=REQ12345

### Response
#### Success Response (200)
- **status** (string) - The status of the request (e.g., 'processing', 'completed', 'failed').
- **result** (object) - The result of the analysis if completed.

#### Response Example
{
  "status": "completed",
  "result": {
    "averageWorkforce": 150.5
  }
}
```

--------------------------------

### POST /CreationCompteCollaborateurDepuisModele

Source: https://silae-api.document360.io/docs/release-note-1

Creates a collaborator account from a template, ensuring compliance with rights proposed from the MySilae interface.

```APIDOC
## POST /CreationCompteCollaborateurDepuisModele

### Description
Creates a collaborator account from a template, ensuring compliance with rights proposed from the MySilae interface.

### Method
POST

### Endpoint
/CreationCompteCollaborateurDepuisModele

### Parameters
#### Request Body
- **templateId** (string) - Required - The ID of the template to use.
- **collaboratorData** (object) - Required - Data for the new collaborator account.
  - **name** (string) - Required - The collaborator's name.

### Request Example
{
  "templateId": "TEMPLATE001",
  "collaboratorData": {
    "name": "Peter Jones"
  }
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the collaborator account was created.

#### Response Example
{
  "message": "Collaborator account created successfully from template."
}
```

--------------------------------

### Generating API Access Configuration Key (Subscription Key)

Source: https://silae-api.document360.io/docs/premi%C3%A8re-connexion-au-portail-api

Instructions for generating the main or secondary API access configuration key (Subscription Key) required for accessing payroll data.

```APIDOC
## Generating API Access Configuration Key (Subscription Key)

### Description
Generate the Subscription Key, which is used to grant access to designated payroll data via the REST API. There is no difference between the main and secondary keys.

### Method
N/A (UI Interaction)

### Endpoint
N/A (UI Interaction)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
- **Subscription Key** (string) - The key required for accessing payroll data.

#### Response Example
N/A

### Steps:
1. Access 'Mes Comptes' on the API portal homepage.
2. Select the 'Modifier' option for the relevant API account.
3. Navigate to the '_Configuration d'accès API_' tab.
4. Locate the previously defined API configuration.
5. Click the button associated with the API configuration to:
    * Activate the API access configuration.
    * Generate the main or secondary **Subscription Key**. Keep this key confidential.
```

--------------------------------

### Silae API: Get Original Payslip Count (POST)

Source: https://silae-api.document360.io/docs/analyseproductionpaiebulletinsoriginaux

This code snippet demonstrates how to use the POST HTTP verb to call the AnalyseProductionPaieBulletinsOriginaux API endpoint. It requires a structured request body containing analysis criteria such as pay period type, start and end dates, and optional dossier number or agency code. The response contains statistics on original payslip production per dossier and pay period.

```json
{
  "requeteAnalyseProduction": {
    "typePeriode": 0,
    "periodeDebut": "2020-10-14T21:46:24",
    "periodeFin": "2020-10-14T21:46:24",
    "numeroDossier": "string",
    "codeAgence": "string"
  }
}
```

```json
{
  "statistiques": [
    {
      "numeroDossier": "string",
      "codeAgence": "string",
      "statistiquesProduction": [
        {
          "periodePaie": "2020-10-14",
          "nbBulletinsOriginaux": 0
        },
        {
          "periodePaie": "2020-10-14",
          "nbBulletinsOriginaux": 0
        }
      ]
    },
    {
      "numeroDossier": "string",
      "codeAgence": "string",
      "statistiquesProduction": [
        {
          "periodePaie": "2020-10-14",
          "nbBulletinsOriginaux": 0
        },
        {
          "periodePaie": "2020-10-14",
          "nbBulletinsOriginaux": 0
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /v1/AnalyseProduction/StatutAnalyseProductionPaieUtilisateursV2Asynchrone

Source: https://silae-api.document360.io/docs/statutanalyseproductionpaieutilisateursv2asynchrone

Retrieves the result of the AnalyseProductionPaieUtilisateursV2Asynchrone call to get production analysis status for users.

```APIDOC
## GET /v1/AnalyseProduction/StatutAnalyseProductionPaieUtilisateursV2Asynchrone

### Description
This function retrieves the result of the AnalyseProductionPaieUtilisateursV2Asynchrone call to obtain the calculation task status and associated production statistics.

### Method
GET

### Endpoint
/v1/AnalyseProduction/StatutAnalyseProductionPaieUtilisateursV2Asynchrone

### Parameters
#### Query Parameters
- **guidTache** (string) - Required - Task identifier for the calculation used in the StatutAnalyseProductionPaieUtilisateursV2Asynchrone function to obtain the result.

### Request Example
(No request body for GET request, parameters are passed via query string)

### Response
#### Success Response (200)
- **statistiques** (StatistiquesUtilisateursV2[]) - List of structured elements containing production information for each concerned file.
- **statut** (string) - Status of the task (e.g., ETAT_TERMINEE, ETAT_ERREUR, ETAT_ENCOURS).
- **messageErreur** (string) - Error report if the task failed.
- **progression** (number(double)) - Estimated percentage of task completion.
- **dureeExecution** (string) - If the task is completed, contains the overall processing time.

#### Response Example
```json
{
  "statistiques": [
    {
      "numeroDossier": "string",
      "codeAgence": "string",
      "statistiquesProductionUtilisateurs": [
        {
          "identifiantUtilisateur": "string",
          "periode": "2020-10-14T21:46:24",
          "nbBulletins": 0,
          "nbEntrees": 0,
          "nbSorties": 0
        }
      ]
    }
  ],
  "statut": "ETAT_TERMINEE",
  "messageErreur": null,
  "progression": 100.0,
  "dureeExecution": "00:05:12"
}
```

### Error Handling
(Specific error codes and messages would typically be detailed here, but are not fully provided in the source text.)
```

--------------------------------

### POST /CreationCompteCollaborateur

Source: https://silae-api.document360.io/docs/release-note-1

Creates a collaborator account, ensuring compliance with rights proposed from the MySilae interface.

```APIDOC
## POST /CreationCompteCollaborateur

### Description
Creates a collaborator account, ensuring compliance with rights proposed from the MySilae interface.

### Method
POST

### Endpoint
/CreationCompteCollaborateur

### Parameters
#### Request Body
- **collaboratorData** (object) - Required - Data for the new collaborator account.
  - **name** (string) - Required - The collaborator's name.
  - **rights** (array) - Required - The collaborator's rights.

### Request Example
{
  "collaboratorData": {
    "name": "Jane Smith",
    "rights": ["read"]
  }
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the collaborator account was created.

#### Response Example
{
  "message": "Collaborator account created successfully."
}
```

--------------------------------

### GET /v1/AnalyseProduction/StatutAnalyseProductionPaieAsynchrone

Source: https://silae-api.document360.io/docs/statutanalyseproductionpaieasynchrone

This function retrieves the result of the AnalyseProductionPaieAsynchrone call. It is used to get the status and statistics of an asynchronous payroll production analysis task.

```APIDOC
## GET /v1/AnalyseProduction/StatutAnalyseProductionPaieAsynchrone

### Description
This function retrieves the result of the AnalyseProductionPaieAsynchrone call. It allows you to check the status and gather production statistics for a given payroll analysis task.

### Method
GET

### Endpoint
/v1/AnalyseProduction/StatutAnalyseProductionPaieAsynchrone

### Parameters
#### Query Parameters
- **guidTache** (string) - Required - Identifier of the calculation task obtained as a result of calling AnalyseProductionPaieAsynchrone.

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **statistiques** (StatistiquesV2[]) - List of structured elements containing production information for each concerned dossier.
- **statut** (string) - Status of the task. Possible values are:
    - ETAT_TERMINEE: Task completed normally.
    - ETAT_ERREUR: Task encountered an error.
    - ETAT_ENCOURS: Task is still in progress (another status request can be made).
- **messageErreur** (string) - Error report if the task failed.
- **progression** (number(double)) - Estimated percentage of task completion.
- **dureeExecution** (string) - If the task is completed, contains the total processing time.

### Detailed Response Structures
#### StatistiquesV2
- **numeroDossier** (string) - Dossier number concerned by the request.
- **codeAgence** (string) - Agency code of the concerned agency.
- **statistiquesProduction** (StatistiquesProductionV2[]) - List of structured elements containing production information.
- **statistiquesDADS** (StatistiquesDADS[]) - Structured element containing DADS related information.

#### StatistiquesProductionV2
- **nbBulletinsCoffresForts** (integer(int32)) - Number of payslips in the safe, including those for e-document.
- **nbBulletinsCoffresFortsEditique** (integer(int32)) - Number of payslips in the safe, e-document only.
- **nbDocsSortieCoffresForts** (integer(int32)) - Number of exit documents in the safe.
- **periode** (string(date-time)) - Payroll period to which the data reported via other parameters of this structured element corresponds.
- **nbBulletinsOriginaux** (integer(int32)) - Number of original payslips calculated (status Controlled or Edited).
- **nbBulletinsOriginauxACalculer** (integer(int32)) - Number of payslips not calculated (status Error).
- **nbEntrees** (integer(int32)) - Number of employee entries during the period.
- **nbSorties** (integer(int32)) - Number of employee exits during the period.
- **nbDeclarations** (integer(int32)) - Number of declarations calculated during the period.
- **nbDUE** (integer(int32)) - Number of DUE generated during the period.
- **nbAttestationsPoleEmploi** (integer(int32)) - Number of Pôle Emploi attestations generated during the period.
- **nbIJSS** (integer(int32)) - Number of IJSS during the period.

#### StatistiquesDADS
- **annee** (integer(int32)) - DADS year.
- **nbSalaries** (integer(int32)) - Number of employees.
- **effectif3112** (integer(int32)) - Headcount as of 31/12.

#### Response Example
```json
{
  "statistiques": [
    {
      "numeroDossier": "001",
      "codeAgence": "AG01",
      "statistiquesProduction": [
        {
          "nbBulletinsCoffresForts": 10,
          "nbBulletinsCoffresFortsEditique": 5,
          "nbDocsSortieCoffresForts": 2,
          "periode": "2023-10-01T00:00:00Z",
          "nbBulletinsOriginaux": 8,
          "nbBulletinsOriginauxACalculer": 2,
          "nbEntrees": 1,
          "nbSorties": 0,
          "nbDeclarations": 1,
          "nbDUE": 1,
          "nbAttestationsPoleEmploi": 1,
          "nbIJSS": 0
        }
      ],
      "statistiquesDADS": [
        {
          "annee": 2022,
          "nbSalaries": 15,
          "effectif3112": 15
        }
      ]
    }
  ],
  "statut": "ETAT_TERMINEE",
  "messageErreur": null,
  "progression": 100.0,
  "dureeExecution": "PT1M30S"
}
```
```

--------------------------------

### API REST Access - Production Environment

Source: https://silae-api.document360.io/docs/portail-api-d%C3%A9j%C3%A0-op%C3%A9rationnel-1

Once REST API developments have been tested and validated in the test environment, this section covers establishing a connection to the production environment.

```APIDOC
## API REST Access - Production Environment

### Description
This section details the process of connecting to the production environment for the Silae Paie REST API after successful testing and validation in the test environment.

### Accessing Production:

*   The connection to the production environment can be established once your REST API developments have been thoroughly tested and validated.
*   The specific access methods and credentials for the production environment are assumed to be configured similarly to the test environment, using the obtained Client ID, Client Secret, and Subscription Key, but directed towards the production API endpoints.
```

--------------------------------

### Get ListeModulesMySilae Endpoint

Source: https://silae-api.document360.io/docs/listemodulesmysilae

This snippet defines the GET endpoint for retrieving MySilae module information for payroll folders. It accepts an optional 'codeAgence' parameter for filtering and returns a list of dossiers with their active modules and statuses.

```http
GET /v1/AnalyseProduction/ListeModulesMySilae
```

--------------------------------

### Understanding PeriodeDebut/PeriodeFin vs. DateDebut/DateFin Parameters

Source: https://silae-api.document360.io/docs/faq-utilisation-des-fonction-api

This section clarifies the difference between date range parameters, explaining how `PeriodeDebut` and `PeriodeFin` consider only month and year, while `DateDebut` and `DateFin` are strict date comparisons.

```APIDOC
## Date Parameter Interpretation

### Description
This documentation explains the behavior of date-related parameters in API requests, distinguishing between period-based and strict date-based filtering.

### `PeriodeDebut` and `PeriodeFin`
*   **Purpose**: These parameters define a payroll period. Only the **month and year** are considered for filtering.
*   **Usage**: When used, the API will return data relevant to the specified payroll period (month and year).
*   **Example Endpoint**: `SalarieAbsence`
*   **Example Request**: 
```json
{
  "requeteSalarieAbsences": {
    "matriculeSalarie": "xxxxx",
    "periodeDebut": "2025-04-01T21:46:24",
    "periodeFin": "2025-05-01T21:46:24"
  }
}
```
*   **Result Interpretation**: Absences recorded in the April 2025 payslip will be included. An absence on 30/04/2025 recorded in the May 2025 payslip will **not** be present in the results.

### `DateDebut` and `DateFin`
*   **Purpose**: These parameters define a strict date range. **All components of the date** (day, month, year, time) are considered for filtering.
*   **Usage**: When used, the API will return data that falls precisely within the specified date range.
*   **Example Endpoint**: `ListeDSNEvenementielles`
*   **Example Request**: 
```json
{
  "dateDebut": "2024-01-01",
  "dateFin": "2024-12-31"
}
```
*   **Result Interpretation**: All DSN evenementielles generated between January 1st, 2024, and December 31st, 2024 (inclusive), will be included.
```

--------------------------------

### POST /v1/AdminDossier/GererCycleDePaie

Source: https://silae-api.document360.io/docs/gerercycledepaie

This endpoint allows for the configuration of payroll cycle tasks for a given dossier. If no tasks are configured, a new task is added. If tasks are already configured, the last task is replaced.

```APIDOC
## POST /v1/AdminDossier/GererCycleDePaie

### Description
Allows configuration of payroll cycle tasks for a dossier. Adds a task if none exist, replaces the last task if tasks are already configured.

### Method
POST

### Endpoint
/v1/AdminDossier/GererCycleDePaie

### Parameters
#### Request Body
- **dossierTache** (DossierTache) - Required - Structured element containing information of the task to be updated
- **numeroDossier** (string) - Required - The dossier number concerned by the request
```

--------------------------------

### API Request Header Example (Error 1001)

Source: https://silae-api.document360.io/docs/faq-utilisation-des-fonction-api

An example of the correct Content-type header for API requests. Incorrect header values can lead to communication errors (Error 1001). Ensure 'Content-type' is set to 'application/json'.

```json
{
  "Content-type": "application/json"
}
```
Tokens:
Raw