SWS_EcrituresComptables
- 03 Feb 2023
- 2 Minutes à lire
- Impression
- SombreLumière
- PDF
SWS_EcrituresComptables
- Mis à jour le 03 Feb 2023
- 2 Minutes à lire
- Impression
- SombreLumière
- PDF
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
Fonction API
SWS_EcrituresComptables
Description
Permet de récupérer les lignes d'écritures comptables
Les lignes remontées ont les mêmes paramètres mais qui peuvent avoir une valeur/signification différente s'il s'agit d'une ligne "normale" ou s'il s'agit d'une ligne liée à une répartition analytique. Ces lignes de répartition analytique sont précédées de lignes "normales" qui correspondent au total.
Ces lignes ne sont présentes que si la répartition analytique en pourcentage est correctement configurée dans le dossier pour apparaître dans les écritures comptables.
À noter que seul un seul axe de répartition analytique sera remonté via cette fonction API. Pour pouvoir remonter les lignes de plusieurs axes analytiques, il est nécessaire de faire appel à la fonction : SWS_EcrituresComptables3
Groupe de fonctions API
Code API : J30 / EDT003
Paramètres de la requête
| Paramètre | Type | Description |
|---|---|---|
| Token | string | Token d'authentification renvoyé en réponse à l'authentification via SWS_SiteLogin |
| NumeroDossier | string | Numéro du dossier concerné par la requête |
| PeriodeDebut | dateTime | Date de début de la période pour laquelle remonter les écritures comptables |
| PeriodeFin | dateTime | Date de fin de la période pour laquelle remonter les écritures comptables |
Paramètres de la réponse
| Paramètre | Type | Description |
|---|---|---|
| SWS_EcrituresComptablesResult | SWS_EcrituresComptablesResult | Élément structuré contenant la réponse à la requête (Détail ci-dessous) |
SWS_EcrituresComptablesResult
| Paramètre | Type | Description |
|---|---|---|
| Error | string | Vide s'il n'y a pas d'erreur, sinon contient la description de l'erreur rencontrée |
| EcrituresComptables | CPAISWSEcrituresComptables | Élément structuré contenant les informations des écritures comptables (cf. détail ci-dessous) |
CPAISWSEcrituresComptables
| Paramètre | Type | Description |
|---|---|---|
| NumeroDossier | string | Numéro du dossier concerné par la requête |
| PeriodeDebut | dateTime | Date de début de la période pour laquelle sont remontées les écritures comptables |
| PeriodeFin | dateTime | Date de fin de la période pour laquelle sont remontées les écritures comptables |
| Ecritures | CPAISWSEcrituresComptablesLigne[] | Liste d'éléments structurés contenant les informations de chaque ligne d'écritures comptables (cf. détail ci-dessous) |
CPAISWSEcrituresComptablesLigne
| Paramètre | Type | Description |
|---|---|---|
| Periode | dateTime | Période de paie à laquelle est rattachée la ligne d'écritures comptables |
| Compte | string | Numéro du compte |
| Libelle | string | Libellé de la ligne d'écriture pour une ligne "normales". Remplacé par la valeur/catégorie de l'axe analytique à laquelle est rattachée la ligne lorsqu'il s'agit d'une ligne liée à une répartition analytique |
| Sens | string | Indique s'il s'agit d'un crédit (C) ou d'un débit (D). Sera vide s'il s'agit d'une ligne liée à la répartition analytique |
| IndexRepartition | int | Index de l'axe analytique s'il s'agit d'une ligne liée à la répartition analytique. Vaut 0 sinon |
| Valeur | double | Montant de la ligne |
| PctRepartition | double | Pourcentage de la répartition affecté à la catégorie de l'axe analytique indiqué par l'index (IndexRepartition), dans le cas d'une ligne liée à la répartition analytique. Vaut 0 sinon |
Requête
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SWS_EcrituresComptables xmlns="http://www.silae.fr/">
<Token>string</Token>
<NumeroDossier>string</NumeroDossier>
<PeriodeDebut>yyyy-mm-ddThh:mm:ss</PeriodeDebut>
<PeriodeFin>yyyy-mm-ddThh:mm:ss</PeriodeFin>
</SWS_EcrituresComptables>
</soap12:Body>
</soap12:Envelope>
Réponse
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SWS_EcrituresComptablesResponse xmlns="http://www.silae.fr/">
<SWS_EcrituresComptablesResult>
<Error>string</Error>
<EcrituresComptables>
<NumeroDossier>string</NumeroDossier>
<PeriodeDebut>yyyy-mm-ddThh:mm:ss</PeriodeDebut>
<PeriodeFin>yyyy-mm-ddThh:mm:ss</PeriodeFin>
<Ecritures>
<CPAISWSEcrituresComptablesLigne>
<Periode>yyyy-mm-ddThh:mm:ss</Periode>
<Compte>string</Compte>
<Libelle>string</Libelle>
<Sens>string</Sens>
<IndexRepartition>int</IndexRepartition>
<Valeur>double</Valeur>
<PctRepartition>double</PctRepartition>
</CPAISWSEcrituresComptablesLigne>
<CPAISWSEcrituresComptablesLigne>
<Periode>yyyy-mm-ddThh:mm:ss</Periode>
<Compte>string</Compte>
<Libelle>string</Libelle>
<Sens>string</Sens>
<IndexRepartition>int</IndexRepartition>
<Valeur>double</Valeur>
<PctRepartition>double</PctRepartition>
</CPAISWSEcrituresComptablesLigne>
</Ecritures>
</EcrituresComptables>
</SWS_EcrituresComptablesResult>
</SWS_EcrituresComptablesResponse>
</soap12:Body>
</soap12:Envelope>
Cet article vous a-t-il été utile ?