Services web IRF - ibiza.acec.fribiza.acec.fr/irfdeploy/pdf/IBIZA_IRF_Web_Services_API_V4.pdf · F/ Balance par Exercice par Cycle ... 16/04/2013 Ajout du service ImportEntries EP

Services web IRF

Guide du développeur Version API 2015.01.2 et ultérieures

Guide de l'utilisateur des services WEB IRF – Version au 24/03/2015 2

Table des matières

Révision ......................................................................................................................................................................4

Préambule ..................................................................................................................................................................5

Présentation ...............................................................................................................................................................6

Généralités .................................................................................................................................................................8

A/ TYPES DES DONNÉES ..............................................................................................................................................8

B/ DONNÉES OBLIGATOIRES ........................................................................................................................................8

Service Company ........................................................................................................................................................8

A/ Récupération de la liste des dossiers .................................................................................................................8

B/ Récupération des exercices d'un dossier ........................................................................................................ 10

Service Units ............................................................................................................................................................ 12

A/ Récupération de la liste des unités ................................................................................................................. 12

Service Account ....................................................................................................................................................... 14

A/ Récupération de la liste de comptes (plan comptable) .................................................................................. 14

B/ Récupération des propriétés d'un compte à partir de son numéro ............................................................... 15

C/ Liste des mouvements analytiques ................................................................................................................. 16

Service Journal ......................................................................................................................................................... 19

A/ Récupération de la liste des journaux ............................................................................................................ 19

B/ Récupération des propriétés d'un journal à partir de sa référence ............................................................... 20

Service Entries ......................................................................................................................................................... 22

A/ Grand Livre Général ........................................................................................................................................ 22

B/ Importation des écritures ............................................................................................................................... 24

C/ Importation des écritures avec ventilation analytique ................................................................................... 30

Service Balances ...................................................................................................................................................... 38

A/ Balance Période .............................................................................................................................................. 38

B/ Balance de Situation ....................................................................................................................................... 39

C/ Balance de Situation avec A Nouveaux ........................................................................................................... 41


D/ Balance par Exercice ....................................................................................................................................... 42

E/ Balance par Exercice avec A Nouveaux ........................................................................................................... 44

F/ Balance par Exercice par Cycle ........................................................................................................................ 46

G/ Balance Analytique ......................................................................................................................................... 47

H/ Balance par Compte ....................................................................................................................................... 49

Définition d'un filtre ................................................................................................................................................ 51

Opérateurs disponibles ....................................................................................................................................... 51

Fonctions disponibles .......................................................................................................................................... 51

La fonction "Contient" ..................................................................................................................................... 51

La fonction "Minuscule", "Majuscule" ............................................................................................................ 51

La fonction "Commence par" .......................................................................................................................... 51

Service Analyzes ...................................................................................................................................................... 53

A/ Récupération de la liste des analyses paramétrées dans un dossier ............................................................. 53

B/ Récupération de la liste des axes paramétrés dans une Analyse ................................................................... 55

C/ Récupération de la liste des sections d'une analyse ....................................................................................... 57

D/ Récupération de la liste des sections d'un axe ............................................................................................... 58

Service Employee .................................................................................................................................................... 61

A/ Récupération de la liste des salariés ............................................................................................................... 61

B/ Récupération de la liste des salariés à une date de référence ....................................................................... 64

C/ Récupération des propriétés d'un salarié ....................................................................................................... 64

D/ Récupération des propriétés d'un salarié à une date donnée ....................................................................... 65

Service PayVariables ................................................................................................................................................ 66

A/ Importation de variables de paie .................................................................................................................... 66


Révision

Date Action Auteur

20/01/2015 Ajout du service Analyzes EP

19/01/2015 Ajout du service ImportEntries avec ventilations analytiques EP

19/06/2014 Ajout du service Balances EP

20/02/2014 Ajout du service ImportVariable EP

16/04/2013 Ajout du service ImportEntries EP

04/04/2013 Ajout du service Journal EP

05/02/2013 Création du document EP


Préambule

Ce document a pour but de présenter l'ensemble des services web développés par IBIZA.

Ces services, appelés aussi API (pour Application Programming Interface, ou Interface de programmation

d'applications), permettent à une application d'interagir avec une autre. On parle également d'interopérabilité.

Si une application veut permettre à une autre d'interagir avec elle, elle doit réaliser des services Web.

L'utilisation des standards de développement (REST, WCF, JSON, XML, SOAP, …) garantie une totale

compatibilité entre les différents systèmes.


Présentation

Les API des services web proposées reposent sur l'architecture REST (REpresentational State Transfer), laquelle

permet de définir des méthodes simples à utiliser pour accéder aux données.

Chaque donnée, ou ensemble de données, est vue comme une ressource accessible via une URL.

Les échanges entre le client et le serveur se font via des messages au format XML.

Les ressources sont accessibles via un ensemble de commandes fourni par HTTP : GET, POST, UPD et DELETE.

Ces commandes permettent respectivement de récupérer, de créer, de modifier et de supprimer des données.

Les communications entre le client et le serveur sont "sans état" ; c'est à dire que chaque appel doit contenir

toutes les informations nécessaires pour que la demande soit comprise et puisse s'exécuter sur le serveur.

Ainsi, chaque appel aux APIs doit contenir dans l'entête du message (header) les éléments suivants :

"irfToken" : Jeton crypté pour l'authentification

"partnerID" : identifiant partenaire fournit par IBIZA

L'URL de base des services web est :

https://saas.irf-cloud.com/IRFService/services/IRFService.svc

Il faudra ajouter l' URL de chaque méthode des services web à l'URL de base pour accéder aux services.

Exemple :

https://saas.irf-cloud.com/IRFService/services/IRFService.svc/Company/{database}/Accounts

Une requête GET sur cet URL retournera une réponse valide contenant le plan comptable d'un dossier.

Chaque URL repose sur la hiérarchie entre les données ; ainsi dans l'exemple, il faut connaître l'identifiant du

dossier pour accéder au plan de comptes.

NB: Les accolades "{" et "}" ne font pas partie du message ; elles permettent d'identifier les informations

variables de la requête (URL).

Si une erreur est rencontrée par le serveur, la réponse renvoyée au client aura la forme suivante :


<WCFRestIRFResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <response>

<datetime>2013-02-06T10:37:01.3883571+01:00</datetime> <message>

<error> <details> La valeur ne peut pas être null. Nom du paramètre : irfToken </details>

</error> </message> <result>Error</result>

</response> </WCFRestIRFResult>

Cette réponse correspond à un appel fait sans renseigner les identifiants de connexion dans l'entête du

message.

Description de l'élément <response>

Argument Libellé Type Obligatoire Explication

Datetime Date Date Date et heure de la réponse

Result Résultat Alphanumérique Résultat de l'exécution de la méthode (Error ou Success)

Message Message XML Message complémentaire


Généralités Certaines notions sont communes à tous les éléments traités dans ce manuel.

A/ TYPES DES DONNÉES

Les données gérées par les services décrits dans ce document sont les suivantes :

- Alphanumériques : qui utilise à la fois des chiffres et des signes alphabétiques

- Numériques : qui utilise seulement des chiffres. Il est possible d'avoir des valeurs négatives et avec des

décimales

- Entier : qui utilise seulement des chiffres. Il est pas possible d'avoir des valeurs négatives, mais pas de

décimales.

- Date : qui utilise des dates au format AAAA-MM-JJ (4 chiffres pour l'année, 2 chiffres pour le mois et 2 chiffres

pour le jour) séparée par des tirets (-).

- Booléen : qui utilise les chiffres 0 et 1 pour indiquer respectivement FAUX et VRAI.

- UUID : (Universal Unique IDentifier) chaine de caractères permettant l'identification unique d'un élément.

Ce code servira lors des appels aux APIs afin d'identifier les informations à récupérer.

B/ DONNÉES OBLIGATOIRES

Dans certaines réponses, certaines données peuvent être optionnelles. C'est à dire que leur présence dans la

réponse n'est pas systématique. Elle dépend des critères de recherche, ou du paramétrage des dossiers.

Service Company

A/ Récupération de la liste des dossiers Ce service permet de récupérer la liste des dossiers d'un utilisateur Requête : URL : /companies Méthode HTTP : GET Paramètres


"partnerID" : identifiant partenaire fournit par IRF

Réponse : Schéma XML :


<WCFRestIRFPracticeDatabaseResult >

<response> <datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result></result> <message></message>

</response> <data>

<wsPracticeDatabase > <database>Identifiant du dossier</database> <name>Nom du dossier</name>

</wsPracticeDatabase> ...

</data> </ WCFRestIRFPracticeDatabaseResult >




Result Résultat Alphanumérique Résultat de l'exécution de la méthode invoquée : "Success" ou "Error".

Message Message XML Message associé à la réponse : erreur, etc...

Description de l'élément <data>

Ce nœud correspond aux données renvoyées par la méthode du service web invoquée.

C'est une liste d'éléments. Chaque élément correspond à un dossier (<wsPracticeDatabase> )

Description de l'élément < wsPracticeDatabase>


Database Dossier UUID Identifiant unique du dossier

Name Nom Alphanumérique Nom du dossier

Site Site Alphanumérique Nom du site auquel est rattaché le dossier

internalCode Code interne Alphanumérique Usage réservé

accountingMethod Méthode de tenue comptable Entier (0/1) 0:Engagement 1:Trésorerie

accountingType Type de comptabilité Entier (0/1) 0: Tenue 1: Surveillance

affiliationLabel1 Critère de rattachement #1 Alphanumérique

affiliationLabel2 Critère de rattachement #2 Alphanumérique Critère de rattachement #2




Acccounting Comptabilité Entier (0/1) Si = 1, le module est activé

Billing Devis - Facturation Entier (0/1) Si = 1, le module est activé

Fiscal Fiscalité - Publication Entier (0/1) Si = 1, le module est activé

Immo Immobilisation Entier (0/1) Si = 1, le module est activé

Paie Paie Entier (0/1) Si = 1, le module est activé


B/ Récupération des exercices d'un dossier

Requête : Ce service permet de récupérer les exercices d'un dossier URL : /company/{database}/Exercices Méthode HTTP : GET Paramètres





Réponse : Liste des exercices du dossier Schéma XML :

< WCFRestIRFExercicesResult > <response>

<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result></result> <message></message>

</response> <data>

< exercice > <name>2013</name> <start>2013-01-01</start> <end>2013-12-31</end> <state>1</state>

</ exercice > </data>

</ WCFRestIRFExercicesResult >









C'est une liste d'éléments. Chaque élément correspond à un exercice (<exercice> )

Description de l'élément < exercice>


name Nom de l'exercice Alphanumérique Code unique de l'exercice

start Date de début Date Date de début de l'exercice Format YYYY-MM-DD

end Date de fin Date Date de fin de l'exercice Format YYYY-MM-DD

state Etat Alphanumérique Etat de l'exercice Voir tableau ci-dessous

Description du code Etat d'un exercice :

Valeur Libellé

0 Exercice précédent ouvert

1 Dernier exercice ouvert

2 Exercice clos

Seuls les exercices ayant comme état "0" ou "1" peuvent être utilisés


Service Units

A/ Récupération de la liste des unités Ce service permet de récupérer la liste des unités d'un dossier Requête : URL : /company/{database}/Units Méthode HTTP : GET Paramètres






< WCFRestIRFUnitsResult > <response>


</response> <data>

<unit > <code>Identifiant de l'unité</code> <name>Libellé de l'unité</ name >

</unit > ...

</data> </ WCFRestIRFUnitsResult >









C'est une liste d'éléments. Chaque élément correspond à une unité (<Unit> )

Description de l'élément < Unit>


code Unité Alphanumérique Identifiant unique de l'unité

name Libellé Alphanumérique Libellé de l'unité


Service Account

A/ Récupération de la liste de comptes (plan comptable) Ce service permet de récupérer la liste des comptes paramétrés dans un dossier Requête : URL : /company/{database}/accounts Méthode HTTP : GET Paramètres





Réponse : Liste des comptes (plan comptable) du dossier Schéma XML :

<WCFRestIRFAccountsResult > <response>


</response> <data>

< wsAccounts > <auditable>0</auditable> <bankReconcilable>0</bankReconcilable> <category>9</category> <centralisable>0</centralisable> <closed>0</closed> <collectif/> <name>Capital</name> <number>101000</number> <reconcilable>0</reconcilable>

</ wsAccounts > ...

</data> </ WCFRestIRFAccountsResult >



Se reporter à la description précédente



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsAccount > )

Description de l'élément < wsAccount>


category Catégorie Numérique Cf. tableau des types de compte ci-dessous

number Numéro Alphanumérique Numéro du compte

name Nom Alphanumérique Libellé du compte

reconcilable Lettrable "0" : non, "1" : oui

Permet le lettrage sur des mouvements du compte

centralisable Centralisable "0" : non, "1" : oui

Permet la centralisation des mouvements du compte lors des éditions

auditable Saisie analytique "0" : non, "1" : oui

Permet l'affectation d'une ventilation analytique lors de la saisie d'un mouvement

bankReconcilable Rapprochable "0" : non, "1" : oui

Permet l'utilisation du compte dans la gestion des relevés bancaires et de faire du rapprochement bancaire

closed Fermé "0" : ouvert, "1" : fermé

Indique si le compte est fermé : bloque la saisie des mouvements comptables

collectif Compte collectif Alphanumérique Numéro du compte collectif lié si existant

Valeur numérique Catégorie de compte

1 Clients

2 Fournisseurs

4 Associés

5 Caisses

6 Banques

9 Généraux (charges / produits et divers)

10 Comptes de TVA

11 Organismes Sociaux

12 Etat et collectivités

15 Immobilisations

16 Salariés

B/ Récupération des propriétés d'un compte à partir de son numéro

Ce service permet de récupérer les propriétés d'un compte à partir de son numéro. Requête : URL : /company/{database}/accounts/{account} Méthode HTTP : GET


Paramètres





Account Numéro de compte Numérique Numéro du compte

Réponse : Compte correspondant au numéro indiqué dans la requête Schéma XML :

< WCFRestIRFAccountsResult > <response>


</response> <data>

< wsAccounts > <auditable>0</auditable> <bankReconcilable>0</bankReconcilable> <category>9</category> <centralisable>0</centralisable> <closed>0</closed> <collectif/> <name>Capital</name> <number>101000</number> <reconcilable>0</reconcilable>

</ wsAccounts > </data>

</ WCFRestIRFAccountsResult >

Se reporter au tableau décrivant les propriétés d'un compte.

C/ Liste des mouvements analytiques

Ce service permet de récupère la liste des mouvements analytiques Requête : URL : /company/{database}/AnalyticalMovement Méthode HTTP : GET


Paramètres




database Dossier UUID Identifiant unique du dossier

Réponse : Liste des mouvements analytiques Schéma XML :

<WCFRestIRFAnalyticalMovementResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <response> <result>Success</result> <message /> <datetime>2015-01-22T12:44:11.7252283+01:00</datetime> </response> <data> <wsAnalyticalMovement> <accountName>Missions</accountName> <code>ANA1</code> <credit>0</credit> <date>2014-04-30</date> <debit>69</debit> <description>CB NS 04/2014 diner La Plage</description> <entryQty>0</entryQty> <entryUnit/> <entryVoucherRef/> <name>ANALYSE NIVEAU 1</name> <number>625600</number> <piece>1404028</piece> <ref>BQ</ref> <sectionCode>FP</sectionCode> <sectionName>FRAIS PERMANENTS</sectionName> <subAxis>FILIERE</subAxis> <subSection>AUTRES CHARGES</subSection> <subSubAxis>ACTION</subSubAxis> <subSubSection>Frais de fonctionnement -Paris</subSubSection> </wsAnalyticalMovement>

.../... </ WCFRestIRFAnalyticalMovementResult>




C'est une liste d'éléments. Chaque élément correspond à un dossier (<wsAnalyticalMovement> )

Description de l'élément < wsAnalyticalMovement >


accountName

Code

Credit

Date

Debit

Description

entryQty

entryUnit

entryVoucherRef

Name

Number

Piece

Ref

sectionCode

sectionName

subAxis

subSection

subSubAxis

subSubSection


Service Journal

A/ Récupération de la liste des journaux Ce service permet de récupérer la liste des journaux paramétrés dans un dossier. Requête : URL : /company/{database}/journals Méthode HTTP : GET Paramètres





Réponse : Liste des journaux du dossier Schéma XML :

<WCFRestIRFJournalsResult > <response>


</response> <data>

<wsJournals> <closed>0</closed> <description>A nouveaux</description> <ibanCode/> <number/> <ref>AN</ref>

<type>10</type> </wsJournals> ...

</data> </ WCFRestIRFJournalsResult >






Message Message Alphanumérique Message associé à la réponse : erreur, etc...



C'est une liste d'éléments. Chaque élément correspond à un journal (<wsJournals> )

Description de l'élément < wsJournals>


ref Numéro Alphanumérique Code du journal

description Nom Alphanumérique Nom du journal

type Type Numérique Cf. tableau des types de journal ci-dessous

ibanCode

Number

Closed Fermé Entier (0/1) Indique si le journal est ouvert ou fermé

Valeur numérique Type de journal

5 Caisse

6 Banque

7 Achats

8 Ventes

9 Général

10 A nouveau

11 Reprise

12 Situation

B/ Récupération des propriétés d'un journal à partir de sa référence Ce service permet de récupérer les propriétés d'un journal à partir de sa référence. Requête : URL : /company/{database}/journals/{journal} Exemple : /company/{74D8A14D-C4F7-4106-97B2-A8DF447517F5}/journal/AN Méthode HTTP : GET Paramètres






journal Référence du journal Numérique Référence du journal

Réponse : Journal correspondant à la référence indiquée dans la requête Schéma XML :

< WCFRestIRFJournalsResult > <response>


</response> <data>

<wsJournals> <description>A Nouveaux</description> <ref>AN</ref> <type>10</type> <closed></closed> <ibanCode></ibanCode> <number></number>

</wsJournals> </data>

</ WCFRestIRFJournalsResult >

Se reporter au tableau décrivant les propriétés d'un journal.


Service Entries

A/ Grand Livre Général Ce service permet de récupérer les écritures du Grand Livre. Requête : URL : /company/{database}/GrandLivreGeneral Pour ce type de requête, il faut obligatoirement préciser un filtre : URL : /company/{database}/GrandLivreGeneral/q={détails du filtre} Par exemple : /company/{database}/GrandLivreGeneral/q=starts-with(accountName, "601") /company/{database}/GrandLivreGeneral/q=date >= "20140101"

⇌ Se reporter à la partie consacrée à la présentation du filtre d'une requête Méthode HTTP : GET Paramètres






< WCFRestIRFGeneralLegerResult> <response>


</response> <data>

<wsGeneralLedger> <balance>849.69</balance> <collectif>40100100</collectif> <comment/> <credit>0</credit> <currency>EUR</currency>


<currencyAmount>849.69</currencyAmount> <date>2012-10-19</date> <debit>849.69</debit> <description>ALOES</description> <letter>Oui</letter> <letteredInBetween>Non</letteredInBetween> <name>ALOES</name> <number>00ALOES</number> <paymentMethod>0</paymentMethod> <paymentMethodDescription>Aucun</paymentMethodDescription> <periodEnd/> <periodStart/> <piece>341826</piece> <qtyUnit/> <quantity>0</quantity> <ref>22</ref> <term/>

<voucherRef/> </wsGeneralLedger>

</data> </ WCFRestIRFGeneralLegerResult>



C'est une liste d'éléments. Chaque élément correspond à une écriture (<wsGeneralLedger > )

Description de l'élément < wsGeneralLedger >


Balance Alphanumérique

Collectif

Comment

Credit

Currency

CurrencyAmount

Date

Debit

Description

Letter

letteredInBetween

Name

Number

paymentMethod

paymentMethodDescription

periodEnd

periodStart

piece

qtyUnit


quantity

ref

term

voucherRef

B/ Importation des écritures

Ce service permet d'importer des écritures dans un dossier Requête : URL : /company/{database}/entries Méthode HTTP : POST Paramètres





Corps de la requête Le flux à envoyer au service d'importation d'écriture doit être structuré de la façon suivante :

<importEntryRequest> <importDate>2012-12-31</importDate> <wsImportEntry> <importEntry> <journalRef>VE</journalRef> <date>2012-01-07</date> <piece>FC001</piece> <accountNumber>411DURAND</accountNumber> <accountName>M. DURAND Daniel</accountName> <description>DURAND Facture 01</description> <debit>430.81</debit> <term>2012-02-12</term> <paymentMethod>1</paymentMethod> <paymentStatus>3</paymentStatus> <letter>AAAA</letter> <comment>Lettrage à vérifier</comment> </importEntry> <importEntry> <journalRef>VE</journalRef> <date>2012-01-07</date> <piece>FC001</piece>


<accountNumber>701000</accountNumber> <accountName>Ventes</accountName> <description>DURAND Facture 01</description> <credit>400.00</credit> <unit>DMT</unit> <quantity>152</quantity> </importEntry> .../... </ wsImportEntry > </importEntryRequest>

Description du noeud "importEntryRequest" : Argument Libellé Type Obligatoire Explication

importDate Date d'import Date Date de fin de l'exercice de destination Format YYYY-MM-DD

wsImportEntry Ecritures XML Liste des écritures à intégrer

Remarque importante sur l'élément <importDate> : Cette date correspond à la date de fin de l'exercice dans lequel les écritures doivent être enregistrées. Une date comprise entre la date de début et la date de fin de l'exercice peut également être utilisée. Description de l'élément <wsImportEntry>

Cet élément correspond à la liste des écritures à intégrer. Il contient un ensemble cohérent d'écritures. C'est à dire, que les écritures doivent être équilibrées, affectées à des journaux existants. En effet, la version actuelle des web services ne prend pas en compte la création automatique de journaux. Par contre, les comptes sont créés, s'ils n'existent pas. Dans tous les cas, les erreurs / incohérences rencontrées lors de l'import des écritures sont transmises à l'appelant (voir la description de l'élément <réponse> si dessous). Description de l'élément <importEntry> Il s'agit d'un mouvement comptable. Remarque : 1 écriture = x mouvements comptables avec somme_débit = somme_crédit. Argument Libellé Type Obligatoire Explication

journalRef Journal Alphanumérique Code du journal. Le code journal doit exister dans le plan des journaux du dossier cible. La liste des journaux est récupérée grâce au service web <Journal>

date Date Date

Date comptable du mouvement. La date comptable doit être comprise dans l'exercice cible. Format YYYY-MM-DD

piece Pièce Alphanumérique Référence de la pièce comptable

accountNumber Compte Alphanumérique Si le numéro de compte n'existe pas dans le plan de compte du dossier,


celui-ci sera automatiquement ajouté. Les comptes collectifs doivent être créés en amont dans le dossier pour une intégration correcte des comptes tiers

accountName Nom du compte

Alphanumérique Utilisé uniquement si le compte du mouvement n'est pas présent dans le plan comptable du dossier, pour permettre la création du compte. Si ce champ n'est pas renseigné, le libellé du compte créé prend la valeur du numéro de compte

description Libellé Alphanumérique Permet la centralisation des mouvements du compte lors des éditions

debit Débit Numérique Doit être nul si "crédit" renseigné

credit Crédit Numérique Doit être nul si "débit" renseigné

term Echéance Date Date d'échéance Format YYYY-MM-DD

paymentMethod Méthode de paiement

Alphanumérique 2 caractères. Code BIC de la méthode de paiement à appliquer Voir description ci-dessous

paymentStatus Etat du paiement

Alphanumérique 1 caractère. Ce champ est utilisé seulement dans les factures pour la génération automatique des règlements dans le module "Règlements". Voir description ci-dessous

voucherID Document (pièce jointe)

Alphanumérique URI de la pièce jointe

voucherRef Référence Pièce

Alphanumérique Référence de la pièce jointe

unit Unité Alphanumérique 3 caractères. Code ISO de l'unité liée à la quantité. Voir description ci-dessous. Doit exister dans la table "unit" de la base modèle Ibiza

quantity Quantité Numérique Indication de la quantité attributé au mouvement comptable N'est pris en compte que si "Unité" est renseigne

comment Commentaire Alphanumérique

letter Lettrage Alphanumérique Code reliant un ensemble d'au moins 2 mouvements équilibrés Le lettrage doit être équilibré au sein du flux envoyé

periodStart Période du Date Début de la période d'affectation Format YYYY-MM-DD

periodEnd Période au Date Fin de la période d'affectation Format YYYY-MM-DD

Code des status de paiement Libellé

0 Aucun

1 Bon à payer

2 Bloqué

3 Payé

Code ISO des unités Libellé

A44 DECALITRE

ARE ARE

C62 DEFAULT

CLT CENTILITRE

CMT CENTIMETRE

CRAY Nombre

DAA DECARE

DLT DECILITRE

DMT DECIMETRE

DTN Quintal

GRM GRAMME

HAR HECTARE


HLT HECTOLITRE

HMT HECTOMETRE

HOR HORAIRES

K6 KILOLITRE

KGM Kilogramme

LTR Litre

MLT MILILITRE

MMT MILIMETRE

MTR METRE

TNE TONNE

Code BIC de la méthode de paiement Libellé BIC

01 Chèques payés

02 Remises de chèques

03 Chèques impayés

04 Versements espèces

05 Virements reçus

06 Virements émis

07 LCR/BOR domiciliés

08 Prélèvements et TIP domiciliés

09 Prélèvements et TIP émis

10 Prélèvements et TIP rejetés/impayés

11 Factures cartes de paiement/DAB-GAB

12 Rejet de virement

13 Virements de trésorerie reçus

14 Virements de trésorerie émis

15 Remises de chèques sur caisse

18 Autres virements reçus

21 Autres virements émis

22 TIP domiciliés

23 Prélèvements domiciliés

24 TIP émis

25 Prélèvement émis

26 TIP rejetés / impayés

27 Prélèvements rejetés / impayés

28 Factures cartes payées

29 Retrait DAB-GAB

30 Factures cartes remises

31 Remises d'effets à l'encaissement

32 Remises à l'escompte (papier commercial / chèque)

33 Effets impayés

34 Incidents sur effets

35 Remises de LCR/BOR à l'encaissement

36 Remise de facture CB crédit

37 Remises de LCR/BOR à l'escompte

38 Facture CB impayée / rejetée

39 Virements d'Origine Extérieur (VOE) reçus

42 Achats/Ventes de devises

43 Autres opérations avec l'étranger

46 Achats de devises au comptant

47 Ventes de devises au comptant

48 Levée sur achat à terme

49 Livraison sur vente à terme

51 Achats et Ventes de titres

52 Diverses opérations sur titres

53 Achats/Souscriptions VM/BF

54 Ventes de VM/BF


55 Solde de liquidation - BF

56 Achats OPCVM

57 Ventes OPCVM

58 Achats TCN

59 Ventes TCN

61 Agios

62 Commissions et frais divers

63 Produits financiers

64 Commissions y compris taxes

65 Commissions hors taxes

66 Commissions non taxables

67 Taxes

68 Autres opérations avec l'étranger - Débit

69 Autres opérations avec l'étranger - Crédit

70 Charges financières

71 Tirage de crédits

72 Échéance crédits

73 Émission de valeurs mobilières

74 Émission de titres de créances

75 Remboursement

76 Dépôt à terme

77 Échéance dépôt à terme

80 Achats autres TC

81 Ventes autres TC

82 Contrats

83 Options

84 Achats Bourses Étrangères

85 Ventes Bourses Étrangères

86 Opérations sur titres

87 Revenus sur titres

88 Commissions et droits de garde

89 Remboursement impôts étrangers

90 VCOM émis

91 Opérations diverses

92 Centralisation de recettes

93 Centralisation de dépenses

94 Centralisation de trésorerie

95 Centralisation de trésorerie

96 Télérèglements domiciliés

97 Télérèglements émis

98 Télérèglements rejetés/impayés

99 Annulations et régularisations

Réponse : Résultat de l'importation des écritures Schéma XML :


< WCFRestIRFImportEntriesResult > <response>


</response> </ WCFRestIRFImportEntriesResult >


Le flux XML de réponse est structuré de façon différente, suivant que le traitement s'est bien déroulé (Success)

ou a rencontré une erreur (Error)

Cas d'un traitement effectué avec succès :

Le flux renvoyé par le service web est le suivant :


<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Success</result> <message> <success> <description>Import terminé avec succès</description> <data> <importSessionReport> <category>Mouvements comptables</category> <quantity>3</quantity> </importSessionReport> </data> </success> </message>


La partie "message" présente, par type, le nombre de données importées.

Cas d'un traitement effectué avec erreur :

Dans le cas d'une erreur de format de la requête (donnée absente, erreur de format du message, etc...)



<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Error</result> <message> <error> <number></number> <description> </description> </error>

</message> </response>

</ WCFRestIRFImportEntriesResult >

Dans le cas d'une erreur rencontrée lors du traitement des données à importer :

Réponse à une requête contenant une écriture déséquilibrée :


<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Error</result> <message> <error> <number>107</number> <description>La pièce ou le journal sont déséquilibrés</description> </error> </message>


C/ Importation des écritures avec ventilation analytique

Ce service permet d'importer des écritures dans un dossier en précisant le détails de la ventilation analytique sur un à trois axes. Remarque : se reporter à la partie "Service Analytique" pour le descriptif des données disponibles pour la ventilation analytique. Requête : URL : /company/{database}/entries Méthode HTTP : POST Paramètres






Corps de la requête Le flux à envoyer au service d'importation d'écriture doit être structuré de la même façon que pour l'import d'écriture vu dans la partie précédente.

<importEntryRequest> <importDate>2012-12-31</importDate> <wsImportEntry> <importEntry> <journalRef>VE</journalRef> <date>2012-01-07</date> <piece>FC001</piece> <accountNumber>411DURAND</accountNumber> <accountName>M. DURAND Daniel</accountName> <description>DURAND Facture 01</description> <debit>430.81</debit> <term>2012-02-12</term> <paymentMethod>1</paymentMethod> <paymentStatus>3</paymentStatus> <letter>AAAA</letter> <comment>Lettrage à vérifier</comment>

<importAnalyticalEntries> <importAnalyticalEntry>

<analysis>ANA1</analysis> <axis1>CA</axis1> <axis2>41</axis2> <axis3>1-4-10G</axis3> <debit></debit> <credit>400.00</credit>

</importAnalyticalEntry> <importAnalyticalEntry> <analysis>ANA1</analysis> <axis1>FP</axis1> <axis2>410</axis2> <axis3>1-6-1a</axis3>

<debit></debit> <credit>30.81</credit> </importAnalyticalEntry>

</importAnalyticalEntries> </importEntry>


<importEntry> <journalRef>VE</journalRef> <date>2012-01-07</date> <piece>FC001</piece> <accountNumber>701000</accountNumber> <accountName>Ventes</accountName> <description>DURAND Facture 01</description> <credit>400.00</credit> <unit>DMT</unit> <quantity>152</quantity> </importEntry> .../... </ wsImportEntry > </importEntryRequest>

Description du noeud "importEntryRequest" : Argument Libellé Type Obligatoire Explication


wsImportEntry Ecritures XML Liste des écritures à intégrer

Remarque importante sur l'élément <importDate> : Cette date correspond à la date de fin de l'exercice dans lequel les écritures doivent être enregistrées. Une date comprise entre la date de début et la date de fin de l'exercice peut également être utilisée. Description de l'élément <wsImportEntry>

Cet élément correspond à la liste des écritures à intégrer. Il contient un ensemble cohérent d'écritures. C'est à dire, que les écritures doivent être équilibrées, affectées à des journaux existants. En effet, la version actuelle des web services ne prend pas en compte la création automatique de journaux. Par contre, les comptes sont créés, s'ils n'existent pas. Dans tous les cas, les erreurs / incohérences rencontrées lors de l'import des écritures sont transmises à l'appelant (voir la description de l'élément <réponse> si dessous). Description de l'élément <importEntry> Il s'agit d'un mouvement comptable. Remarque : 1 écriture = x mouvements comptables avec somme_débit = somme_crédit. Argument Libellé Type Obligatoire Explication

journalRef Journal Alphanumérique Code du journal. Le code journal doit exister dans le plan des journaux du dossier cible. La liste des journaux est récupérée grâce au service web <Journal>

date Date Date Date comptable du mouvement.


La date comptable doit être comprise dans l'exercice cible. Format YYYY-MM-DD

piece Pièce Alphanumérique Référence de la pièce comptable

accountNumber Compte Alphanumérique Si le numéro de compte n'existe pas dans le plan de compte du dossier, celui-ci sera automatiquement ajouté. Les comptes collectifs doivent être créés en amont dans le dossier pour une intégration correcte des comptes tiers

accountName Nom du compte

Alphanumérique Utilisé uniquement si le compte du mouvement n'est pas présent dans le plan comptable du dossier, pour permettre la création du compte. Si ce champ n'est pas renseigné, le libellé du compte créé prend la valeur du numéro de compte

description Libellé Alphanumérique Permet la centralisation des mouvements du compte lors des éditions



term Echéance Date Date d'échéance Format YYYY-MM-DD

paymentMethod Méthode de paiement

Alphanumérique 2 caractères. Code BIC de la méthode de paiement à appliquer Voir description ci-dessous

paymentStatus Etat du paiement

Alphanumérique 1 caractère. Ce champ est utilisé seulement dans les factures pour la génération automatique des règlements dans le module "Règlements". Voir description ci-dessous

voucherID Document (pièce jointe)

Alphanumérique URI de la pièce jointe

voucherRef Référence Pièce

Alphanumérique Référence de la pièce jointe

unit Unité Alphanumérique 3 caractères. Code ISO de l'unité liée à la quantité. Voir description ci-dessous. Doit exister dans la table "unit" de la base modèle Ibiza

quantity Quantité Numérique Indication de la quantité attributé au mouvement comptable N'est pris en compte que si "Unité" est renseigne

comment Commentaire Alphanumérique

letter Lettrage Alphanumérique Code reliant un ensemble d'au moins 2 mouvements équilibrés Le lettrage doit être équilibré au sein du flux envoyé

periodStart Période du Date Début de la période d'affectation Format YYYY-MM-DD

periodEnd Période au Date Fin de la période d'affectation Format YYYY-MM-DD

importAnalyticalEntries XML

Description de l'élément <importAnalyticEntries>

Cet élément correspond à la liste des ventilations à effectuer pour l'écriture à laquelle elle est rattachée. Il contient un ensemble cohérent de ventilations/éclatements. C'est à dire, que les ventilations doivent être équilibrées, affectées à des axes existants. Dans tous les cas, les erreurs / incohérences rencontrées lors de l'import des écritures sont transmises à l'appelant (voir la description de l'élément <réponse> si dessous). Description de l'élément <importAnalyticEntry> Il s'agit d'une ventilation d'une écriture. Le but est de ventiler un montant (une écriture) sur une analyse, et sur un ou plusieurs axes (au plus 3).



analysis Code de l'analyse Alphanumérique Code de l'analyse

Axis1 Ventilation 1 Alphanumérique Code de la section de ventilation de niveau 1





Remarques : 1/ Si [debit] et [credit] ne sont pas renseignés, c'est le montant de l'importEntry qui est repris 2/ s'il y a plusieurs éléments importAnalyticalEntry pour 1 axe, le cumul (debit-credit) doit être égale au débit-crédit de l'importEntry 3/ Si une section utilisée n'existe pas, elle est créée pour l'axe associé Réponse : Résultat de l'importation des écritures Schéma XML :










<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Success</result> <message> <success> <description>Import terminé avec succès</description> <data>


<importSessionReport> <category>Comptes</category> <quantity>1</quantity> </importSessionReport> <importSessionReport> <category>Mouvements analytiques</category> <quantity>2</quantity> </importSessionReport> <importSessionReport> <category>Mouvements comptables</category> <quantity>2</quantity> </importSessionReport> </data> </success> </message>



Dans le cas ou le système a dû créer une section analytique, la réponse peut être de cette forme :


<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Success</result> <message> <success> <description>Import terminé avec succès</description> <data> <importSessionReport> <category>Comptes</category> <quantity>1</quantity> </importSessionReport> <importSessionReport> <category>Mouvements analytiques</category> <quantity>2</quantity> </importSessionReport> <importSessionReport> <category>Mouvements comptables</category> <quantity>2</quantity> </importSessionReport>

<importSessionReport> <category>Sections analytiques</category> <quantity>1</quantity> </importSessionReport> </data>


</success> </message>





<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Error</result> <message> <error> <number>code de l'erreur</number> <description>description de l'erreur</description> </error>


</ WCFRestIRFImportEntriesResult >

Dans le cas d'une erreur rencontrée lors du traitement des données à importer :

Réponse à une requête contenant une écriture déséquilibrée :


<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Error</result> <message> <error> <number>107</number> <description>La pièce ou le journal sont déséquilibrés</description> </error> </message>


Erreur renvoyée si le code de l'analyse utilisé n'existe pas dans le dossier :



<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Error</result> <message> <error> <number>117</number> <description>L'axe est inconnu</description> </error> </message>



Service Balances Pour les services suivants, il faudra préciser au moins un élément de filtre

Pour ce type de requête, il faut obligatoirement préciser un filtre : URL : /company/{database}/balances/period/q={détails du filtre} Par exemple : /company/{database}/balances/period/q=starts-with(accountName, "601") /company/{database}/balances/period/q=date >= "20140101"

⇌ Se reporter à la partie consacrée à la présentation du filtre d'une requête

A/ Balance Période

Ce service permet de récupérer les soldes des comptes regroupés par période. Requête : URL : /company/{database}/balances/period Requête avec un filtre sur la période : /company/{database}/balances/period/q=starts-with(period, "2014") Méthode HTTP : GET Paramètres






< WCFRestIRFBalancePeriodResult> <response>


</response> <data>

<wsBalancePeriod> <credit>0</credit>


<debit>59.23</debit> <journal>60</journal> <lettered>Non</lettered> <name>EDF</name> <number>606110</number> <period>2014/01</period>

</wsBalancePeriod> …

</data> </ WCFRestIRFBalancePeriodResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsBalancePeriod > )

Description de l'élément < wsBalancePeriod >


Credit Alphanumérique

Debit

Journal

Leterred

Name

Number

Period

B/ Balance de Situation

Ce service permet de récupérer les soldes des comptes regroupés par situation. Requête : URL : /company/{database}/balances/situation Méthode HTTP : GET Paramètres





Réponse :


Schéma XML :

< WCFRestIRFBalanceSituationResult> <response>


</response> <data>

<wsBalanceSituation> <accountName>CAPITAL APPELE VERSE</accountName> <accountNumber>1013000</accountNumber> <credit>40000</credit> <dateLastEntry>2014-01-01</dateLastEntry> <debit>0</debit> <exerciceEnd>2014-12-31</exerciceEnd> <exerciceStart>2014-01-01</exerciceStart> <exerciceState>Ouvert</exerciceState> <nature>généraux</nature> <nbEcrN>1</nbEcrN> <nbNotLettered>1</nbNotLettered> <reconcilable>Non</reconcilable> <situationEnd>2014-01-30</situationEnd> <situationStart>2014-01-01</situationStart> <solde>-40000</solde>

</wsBalanceSituation></data> </ WCFRestIRFBalanceSituationResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsBalanceSituation > )

Description de l'élément < wsBalanceSituation >


accountName Alphanumérique

accountNumber

Credit

Debit

dateLastEntry

exerciceEnd

exerciceStart

exerciceState

Nature


nbEcrN

nbNotLettered

reconcilable

situationEnd

situationStart

solde

C/ Balance de Situation avec A Nouveaux Ce service permet de récupérer les soldes des comptes regroupés par situation, avec les A nouveaux. Requête : URL : /company/{database}/balances/situationAN Méthode HTTP : GET Paramètres






< WCFRestIRFBalanceSituationANResult> <response>


</response> <data>

<wsBalanceSituationAN> <accountName>CAPITAL APPELE VERSE</accountName> <accountNumber>1013000</accountNumber> <balanceType>A-Nouveaux</balanceType> <credit>40000</credit> <dateLastEntry>2014-01-01</dateLastEntry> <debit>0</debit> <exerciceEnd>2014-12-31</exerciceEnd> <exerciceStart>2014-01-01</exerciceStart> <exerciceState>Ouvert</exerciceState> <nature>généraux</nature> <nbEcrN>1</nbEcrN>


<nbNotLettered>1</nbNotLettered> <reconcilable>Non</reconcilable> <situationEnd>2014-01-30</situationEnd> <situationStart>2014-01-01</situationStart> <solde>-40000</solde>

</wsBalanceSituationAN> </data>

</ WCFRestIRFBalanceSituationANResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsBalanceSituationAN > )

Description de l'élément < wsBalanceSituationAN >



accountNumber

balanceType

Credit

Debit

dateLastEntry

exerciceEnd

exerciceStart

exerciceState

Nature

nbEcrN

nbNotLettered

reconcilable

situationEnd

situationStart

solde

D/ Balance par Exercice

Ce service permet de récupérer les soldes des comptes regroupés par exercice. Requête : URL : /company/{database}/balances/exercice Méthode HTTP : GET Paramètres







< WCFRestIRFExercicesResult> <response>


</response> <data>

<wsBalanceExercice> <accountName>Comptes d'attente</accountName> <accountNote/> <accountNumber>471000</accountNumber> <credit>4736.1</credit> <dateLastEntry>2014-01-13</dateLastEntry> <debit>2448.44</debit> <exerciceEnd>2014-12-31</exerciceEnd> <exerciceStart>2013-07-26</exerciceStart> <exerciceState>Ouvert</exerciceState> <nature>generaux</nature> <nbEcrN>42</nbEcrN> <nbNotLettered>42</nbNotLettered> <note/> <reconcilable>Non</reconcilable> <solde>-2287.66</solde> <state/>

</wsBalanceExercice> …

</data> </ WCFRestIRFExercicesResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsBalanceExercice > )

Description de l'élément < wsBalanceExercice >




accountNote Alphanumérique

accountNumber Alphanumérique

credit Numérique

dateLastEntry Date

debit Numérique

exerciceEnd Date

exerciceStart Date

exerciceState Alphanumérique

nature Alphanumérique

nbEcrN Numérique

nbNotLettered Numérique

note Alphanumérique

reconcilable Alphanumérique

solde Numérique

state Alphanumérique

E/ Balance par Exercice avec A Nouveaux

Ce service permet de récupérer les soldes des comptes regroupés par exercice avec les A Nouveaux. Requête : URL : /company/{database}/balances/exerciceAN Méthode HTTP : GET Paramètres






< WCFRestIRFBalanceExerciceANResult> <response>


</response> <data>

<wsBalanceExerciceAN> <accountName>Comptes d'attente</accountName> <accountNote/>


<accountNumber>471000</accountNumber> <balanceType>Mouvements</balanceType> <credit>4736.1</credit> <dateLastEntry>2014-01-13</dateLastEntry> <debit>2448.44</debit> <exerciceEnd>2014-12-31</exerciceEnd> <exerciceStart>2013-07-26</exerciceStart> <exerciceState>Ouvert</exerciceState> <nature>generaux</nature> <nbEcrN>42</nbEcrN> <nbNotLettered>42</nbNotLettered> <note/> <reconcilable>Non</reconcilable> <solde>-2287.66</solde> <state/>

</wsBalanceExerciceAN> …

</data> </ WCFRestIRFBalanceExerciceANResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsBalanceExerciceAN > )

Description de l'élément < wsBalanceExerciceAN >

Argument Libellé Type Occurence Explication




credit Numérique

balanceType Alphanumérique

dateLastEntry Date

debit Numérique

exerciceEnd Date

exerciceStart Date



nbEcrN Numérique




solde Numérique



F/ Balance par Exercice par Cycle

Ce service permet de récupérer les soldes des comptes regroupés par cycle. Requête : URL : /company/{database}/balances/exerciceByCycle Méthode HTTP : GET Paramètres






< WCFRestIRFBalanceExerciceByCycleResult> <response>


</response> <data>

<wsBalanceExerciceByCycle> <accountName>SG</accountName> <accountNote/> <accountNumber>512000</accountNumber> <credit>2448.44</credit> <cycleCode>B-Trés</cycleCode> <cycleName>Trésorerie</cycleName> <dateLastEntry>2014-01-13</dateLastEntry> <debit>4736.1</debit> <exerciceEnd>2014-12-31</exerciceEnd> <exerciceStart>2013-07-26</exerciceStart> <exerciceState>Ouvert</exerciceState> <nature>generaux</nature> <nbEcrN>42</nbEcrN> <nbNotLettered>42</nbNotLettered> <note/> <reconcilable>Non</reconcilable> <solde>2287.66</solde> <state/>


</wsBalanceExerciceByCycle> …

</data> </ WCFRestIRFBalanceExerciceByCycleResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsBalanceExerciceByCycle > )

Description de l'élément < wsBalanceExerciceByCycle >





credit Numérique

cycleCode Alphanumérique

cycleName Alphanumérique

dateLastEntry Date

debit Numérique

exerciceEnd Date

exerciceStart Date



nbEcrN Numérique




solde Numérique


G/ Balance Analytique Ce service permet de récupérer les soldes des comptes regroupés par axe analytique. Requête : URL : /company/{database}/balances/analytical Méthode HTTP : GET Paramètres





Database Dossier Alphanumérique Identifiant unique du dossier


< WCFRestIRFBalanceAnalyticalResult> <response>


</response> <data>

<wsBalanceAnalytical> <accountName>ACHATS MATIERES PREMIERES</accountName> <code>Tous les axes</code> <credit>313.58</credit> <debit>40364.09</debit> <name>Tous les axes</name> <number>6010000</number> <period>201101</period> <ref>AC</ref> <sectionCode>Non affectable</sectionCode> <sectionName>Non affectable</sectionName> <subAxis/> <subSection/> <subSubAxis/> <subSubSection/> </wsBalanceAnalytical> ...

</data> </ WCFRestIRFBalanceAnalyticalResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsBalanceAnalytical > )

Description de l'élément < wsBalanceAnalytical >


accountName Nom du compte Alphanumérique

code

Credit Montant au crédit

Débit Montant au débit

Name

Number Numéro du compte

Period Période

Ref Code journal

sectionCode Code de la section

sectionName Nom de la section

subAxis Nom du sous axe

subSection Nom de la sous section

subSubAxis Nom du sous sous axe


subSubSection Nom de la sous sous section

H/ Balance par Compte

Ce service permet de récupérer les soldes des comptes regroupés par compte. Requête : URL : /company/{database}/balances/account Méthode HTTP : GET Paramètres






< WCFRestIRFBalanceAccountsResult> <response>


</response> <data>

<wsAccountsBalances> <accountName>SG</accountName> <accountNature>generaux</accountNature> <accountNumber>512000</accountNumber> <exerciceBalance>2287.66</exerciceBalance> <exerciceEnd>2014-12-31</exerciceEnd> <situationBalance/> <situationEnd/>

</wsAccountsBalances> …

</data> </ WCFRestIRFBalanceAccountsResult>




C'est une liste d'éléments. Chaque élément correspond à un compte (<wsAccountsBalances > )

Description de l'élément < wsAccountsBalances >


accountName Nom du compte Alphanumérique

accountNature Nature du compte Alphanumérique

accountNumber Numéro du compte Alphanumérique

exerciceBalance Balance de l'exercice Numérique

exerciceEnd Date de fin d'exercice Date

situationBalance Balance de situation Numérique

situationEnd Date de situation Date


Définition d'un filtre Certains services imposent de préciser un filtre.

En effet, en raison du grand nombre de données, il est indispensable de préciser les données à récupérer :

exercice, période, cycle, etc. ...

Pour définir un filtre, il suffit d'associer un champ (slot) avec la valeur recherchée

Ainsi, pour le service Balances par comptes, on peut définir un filtre sur l'exercice de fin au 31/12/2014.

Par exemple : /company/{database}/balances/account/q= exerciceEnd="2014-12-31"

Les priorités des parenthèses sont respectées. Les opérandes OR et AND sont gérées.

Par exemple : /company/{database}/balances/account/q= /q=date>="20141201" and date<="20141231"

Opérateurs disponibles

Les opérateurs classiques sont disponibles : < > <= >= =

Attention ! ces caractères doivent être "échappés". C'est à dire qu'ils doivent être encodés afin d'être

correctement transmis par le réseau. Ci-dessous la table de correspondance des encodages les plus courants :

caractères Encodage Exemple Commentaire

> > /q=date >="20141201" Test sur la date supérieure au 01/12/2014

< < /q= date <="20141231" Test sur la date inférieure au 31/12/2014

& &

" "

Fonctions disponibles

Des fonctions permettent de faire des filtres sur les données :

La fonction "Contient"

/q=contains(field, chaine). Par exemple : /q=contains(accountNumber,"BORSO")

La fonction "Minuscule", "Majuscule"

/q=lower-case(field)=chaine

/q=upper-case(field)=chaine

La fonction "Commence par"

/q=starts-with(period,"2014")

De cette façon, pour le service BalancePeriod, on peut faire un filtre sur la période. Pour rappel, en base le

champ période (period) contient des valeurs comme "2014/01", "2014/02", ...

Ainsi, on peut définir le filtre suivant : q=starts-with(period, "2014")



Service Analyzes

A/ Récupération de la liste des analyses paramétrées dans un dossier

Ce service permet d'accéder à la liste des analyses paramétrées dans un dossier

2 modes pour ce service : mode "simple" (par défaut) et mode "complet".

Le mode "simple" permet de récupérer uniquement les informations liées aux analyses sans les axes. Le mode

"complet" permet de récupérer également la liste des axes de l'analyse.

Requête :

URL : /company/{database}/analyzes (mode simple)

URL : /company/{database}/analyzes/complete (mode complet)

Méthode HTTP : GET

Paramètres





Réponse : La réponse du mode "simple" contient la liste des analyses du dossier. Schéma XML :

< WCFRestIRFAnalyzesResult> <response>

<datetime>2015-01-04T16:21:01.4659998+01:00</datetime> <result>Success</result> <message></message>

</response> <data>

<wsAnalyzes> <analysisDescription>ANALYSE NIVEAU 1</analysisDescription>

<analysisID>{5CE6CC72-563A-4805-9E62-0F8526A54024}</analysisID> <analysisName>ANALYSE 1</analysisName> <software>0</software> <ventilationKind>0</ventilationKind> </wsAnalyzes>…

</data>


</ WCFRestIRFAnalyzesResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsAnalyzes > )

Description de l'élément < wsAnalyzes > mode "simple"


analysisDescription Description de l'analyse Alphanumérique

analysisID Identifiant de l'analyse UUID Utilisé dans les requêtes pour identifier l'analyse

analysisName Nom de l'analyse Alphanumérique

software Module Numérique Module auquel s'applique l'analyse (cf tableau ci-dessous)

ventilationKind Unité de saisie Numérique Unité de saisie des valeurs ventillées (cf tableau ci-dessous)

Description des valeurs de Module :

Code Libellé

0 Comptabilité

1 Comptabilité et Paie

2 Paie

Description des valeurs de l'unité de saisie :

Code Libellé

0 Pourcentage

1 Montant

2 Unité

La réponse du mode "complet" contient la liste des analyses ainsi que les axes de chaque analyse Schéma XML :



</response> <data>


<analysisID>{5CE6CC72-563A-4805-9E62-0F8526A54024}</analysisID> <analysisName>ANALYSE 1</analysisName>


<axis1>{5CE6CC72-563A-4805-9E62-0F8526A54024}</axis1> <axis1Name>BUREAU</axis1Name> <axis2>{0FD11CC7-A89B-4B37-8345-5ACA3A87BE19}</axis2> <axis2Name>FILIERE</axis2Name> <axis3>{341F90A7-8FC8-4425-B1E0-8408139D11AB}</axis3> <axis3Name>ACTION</axis3Name> <software>0</software> <ventilationKind>0</ventilationKind> </wsAnalyzes>…

</data> </ WCFRestIRFAnalyzesResult>

Description de l'élément < wsAnalyzes > mode "complet"





axis1 Code axe 1 UUID Id de l'axe de niveau 1

axis1Name Nom axe 1 Alphanumérique Nom de l'axe de niveau 1





Software Module Numérique Module auquel s'applique l'analyse (cf tableau ci-dessous)

ventilationKind Date de situation Numérique Unité de saisie des valeurs ventillées (cf tableau ci-dessous)

Remarque : le mode complet permet d'obtenir les mêmes informations que le service de récupération de la liste

des axes paramétrés dans une analyse

B/ Récupération de la liste des axes paramétrés dans une Analyse

Ce service permet d'accéder à la liste des analyses paramétrées dans un dossier

Requête :

URL : /company/{database}/analyzes/{analysis}/axes

idem à URL : /company/{database}/analyzes/complete (mode complet)

Méthode HTTP : GET

Paramètres






Analysis Analyse UUID Identifiant de l'analyse

Réponse : La réponse contient la liste des axes d'une analyse. Schéma XML :



</response> <data>


<analysisID>{5CE6CC72-563A-4805-9E62-0F8526A54024}</analysisID> <analysisName>ANALYSE 1</analysisName> <axis1>{5CE6CC72-563A-4805-9E62-0F8526A54024}</axis1> <axis1Name>BUREAU</axis1Name> <axis2>{0FD11CC7-A89B-4B37-8345-5ACA3A87BE19}</axis2> <axis2Name>FILIERE</axis2Name> <axis3>{341F90A7-8FC8-4425-B1E0-8408139D11AB}</axis3> <axis3Name>ACTION</axis3Name> <software>0</software> <ventilationKind>0</ventilationKind> </wsAnalyzes>…

</data> </ WCFRestIRFAnalyzesResult>



C'est une liste d'éléments. Chaque élément correspond à un compte (<wsAnalyzes > )

Description de l'élément < wsAnalyzes >












software Module Numérique Module auquel s'applique l'analyse (cf tableau ci-dessous)

ventilationKind Date de situation Numérique Unité de saisie des valeurs ventillées (cf tableau ci-dessous)

C/ Récupération de la liste des sections d'une analyse

Ce service permet d'accéder à la liste des sections paramétrées au niveau d'une analyse

Requête :

URL : /company/{database}/analyzes/{analysis}/sections

Méthode HTTP : GET

Paramètres






Réponse : La réponse contient la liste des sections d'une analyse. Schéma XML :

< WCFRestIRFSectionsAnalyzesResult> <response>


</response> <data>

<wsAnalysisSections> <analysisID>{5CE6CC72-563A-4805-9E62-0F8526A54024}</analysisID> <analyticalSections>

<analyticalSection> <closed>0</closed> <code>11</code> <description>BANQUE DE DONNEES</description> <key>0</key>

</analyticalSection> .../...

</analysisSections>


<axis>{5CE6CC72-563A-4805-9E62-0F8526A54024}</axis> </wsAnalysisSections> .../...

</data> </ WCFRestIRFSectionsAnalyzesResult>



C'est une liste d'éléments. Chaque élément correspond à une section d'un axe (<wsAnalysisSections > )

Description de l'élément < wsAnalysisSections >


analysisID Code de l'analyse UUID

axis Code de l'axe UUID

analyticalSections Liste des sections XML

Description de l'élément < analyticalSections >

Liste des sections analytiques d'un axe (<analyticalSection > )

Description de l'élément < analyticalSection >


Code Code de la section Alphanumérique

Description Description de la section Alphanumérique

closed Fermé Entier (0/1)

D/ Récupération de la liste des sections d'un axe

Ce service permet d'accéder à la liste des sections paramétrées au niveau d'un axe d'une analyse

Requête :

URL : /company/{database}/analyzes/{analysis}/axes/{axe}/sections

Méthode HTTP : GET

Paramètres







Axe Axe UUID Identifiant de l'axe

Réponse : La réponse contient la liste des analyses du dossier. Schéma XML :

< WCFRestIRFSectionsAnalyzesResult> <response>


</response> <data>

<wsAnalysisSections> <analysisID>{5CE6CC72-563A-4805-9E62-0F8526A54024}</analysisID> <analyticalSections>

<analyticalSection> <closed>0</closed> <code>11</code> <description>BANQUE DE DONNEES</description> <key>0</key>

</analyticalSection> .../...

</analysisSections> <axis>{5CE6CC72-563A-4805-9E62-0F8526A54024}</axis>

</wsAnalysisSections> .../...

</data> </ WCFRestIRFSectionsAnalyzesResult>



C'est une liste d'éléments. Chaque élément correspond à une section d'un axe (<wsAnalysisSections > )

Description de l'élément < wsAnalysisSections >


analysisID Code de l'analyse UUID

axis Code de l'axe UUID

analyticalSections Liste des sections XML


Description de l'élément < analyticalSections >

Liste des sections analytiques d'un axe (<analyticalSection > )

Description de l'élément < analyticalSection >


Code Code de la section Alphanumérique

Description Description de la section Alphanumérique

closed Fermé Entier (0/1)

Key Clé % Entier


Service Employee

A/ Récupération de la liste des salariés

Ce service permet d'accéder à la liste des salarié pour un dossier

Requête : URL : /company/{database}/employees Méthode HTTP : GET Paramètres






<WCFRestIRFEmployeeResult > <response>


</response> <data>

<wsEmployees> <accidentRate>{4C38E45D-E5A1-42B6-BC69-DDA7F69F08FF}</accidentRate> <accidentRateName>TAUX 1</accidentRateName> <accountNumber/> <activityRate>0.66</activityRate> <area/> <birthDate>1968-05-10</birthDate> <birthDepartement>92</birthDepartement> <birthTown>LEVALLOIS PERRET</birthTown> <branch>{41BE5D2B-3235-4B01-BE31-3CE4379C5BC7}</branch> <branchName>Recrut Consult</branchName> <building/> <capitationStart/> <ccnStatut>02</ccnStatut> <chain/> <classification>{C6AB625D-7341-496C-B0C9-447FCB08723B}</classification> <coef>310</coef> <collectiveSchedule>151.67</collectiveSchedule> <companyLength>2012-02-25</companyLength>


<contract>0</contract> <contractID>{589F5683-BDFF-4E03-BA93-9B323FACD75E}</contractID> <contractStr>Standard</contractStr> <contractType>1</contractType> <convention>{AA66B85F-6040-482D-BB2A-F77E12D74E19}</convention> <dateRenew/> <deductionRate>0</deductionRate> <deductionRateStr>Non</deductionRateStr> <depName/> <department/> <echelon/> <educationalQualification/> <educationalQualificationStr/> <employeeID>{97528092-8E2B-48FA-8483-BB382AB48C19}</employeeID> <endValidityDate/> <endValidityDatePerson/> <entranceDate>2012-02-25</entranceDate> <entryReason>{BD4F6030-B908-4AE8-A2D5-88691A822AD5}</entryReason> <exitDate/> <exitReason/> <exonerationCICE>0</exonerationCICE><exonerationType/> <familyStr/> <firstName>Baptiste</firstName> <followedByCDI/> <freeEmployee>Techniciens</freeEmployee> <friday>4.62</friday> <groupLength/> <lastName>REVEON</lastName> <level/> <linkedEmployeeID/> <manualClassif>0</manualClassif> <manualClassifStr>Non</manualClassifStr> <minHourly>0</minHourly> <minMonthly>0</minMonthly> <minSMIC>0</minSMIC> <minYearly>0</minYearly> <monday>4.62</monday> <multiEmployer>0</multiEmployer> <multiEmployerStr>Non</multiEmployerStr> <nationality>{A27D4B79-C432-4D55-AFC5-C46FE15A4474}</nationality> <nbPoints>0</nbPoints> <nbrChildren>0</nbrChildren> <nbrPersons>0</nbrPersons> <nrContractAff>23699</nrContractAff> <nrPoints>0</nrPoints> <organismAddress>{DC7B2391-9D63-4E8E-9375-30BDDA9FF182}</organismAddress> <payContract>{B4EF80F3-E978-4294-8577-BCE07B87D056}</payContract> <payEmployee>{267CF3AE-58BC-4DFE-B153-22A2895C7AE6}</payEmployee> <payPerson>{52151FF0-D0C8-4EB1-A23B-3EC952D3BD8D}</payPerson> <payedHoliday>0</payedHoliday> <personID>{7DB2B59B-FB52-4021-9B23-4BDB4F194C75}</personID> <pointValue>2.77</pointValue> <position>2-2</position>


<postCode>38550</postCode> <professionLength/> <rateCICE>100</rateCICE> <registryNr>REV000001</registryNr> <retired>0</retired> <retirementStatut>04</retirementStatut> <rubricVaryingCode/> <rubricVaryingColumn/> <salary>2500</salary> <salaryHourly>25</salaryHourly> <salaryOtherEmp>0</salaryOtherEmp> <salaryReplace>0</salaryReplace> <salaryReplaceStr>Autre</salaryReplaceStr> <salaryType>1</salaryType> <salaryTypeStr>Mensuel brut</salaryTypeStr> <salaryYearly>0</salaryYearly> <saturday>0</saturday> <schedule>100</schedule> <serName/><service/> <ssn>168059204445208</ssn> <startValidityDate>2013-10-09</startValidityDate> <startValidityDatePerson>2012-01-12</startValidityDatePerson> <statut>04</statut> <statutCCNStr>Non cadre</statutCCNStr> <statutRetraiteStr>Non cadre</statutRetraiteStr> <statutStr>Agent de maîtrise</statutStr> <street>Place de la république</street> <sunday>0</sunday> <taxDomicile>1</taxDomicile> <taxDomicileStr>France</taxDomicileStr> <thursday>4.62</thursday> <title>M.</title> <town>LE PEAGE DE ROUSSILLON</town> <transportRate>{8BED0D77-ADB6-40BE-963F-79B7DBCD856A}</transportRate> <transportRateName>TP</transportRateName> <trimestrialPay>0</trimestrialPay> <tuesday>4.62</tuesday> <typeContratStr>CDI</typeContratStr> <typeTravailStr>Temps partiel</typeTravailStr> <wednesday>4.62</wednesday> <workType>01</workType>

</wsEmployees>... </data>

</ WCFRestIRFEmployeeResult >






Message Message Alphanumérique Message associé à la réponse : erreur, etc...



C'est une liste d'éléments. Chaque élément correspond à un dossier (<wsEmployees> )

Description de l'élément < wsEmployees >


employeeID Code interne Alphanumérique Identifiant du salarié. Donnée à utiliser dans l'uri lors de l'appel au service d'import de variables de paie

registryNr Matricule du salarié Alphanumérique Matricule du salarié. Code à utiliser dans les requêtes XML pour l'import de variables

B/ Récupération de la liste des salariés à une date de référence

Ce service permet d'accéder à la liste des salariés d' un dossier à une date précise

Requête :

URL : /company/{database}/employees/dateref/{dateref}

Méthode HTTP : GET

Paramètres





DateRef Date de référence Date Date au format AAAAMMJJ

Réponse : La réponse contient la liste des salariés présents à la date de référence. Se reporter à la partie présentant le schéma <wsEmployees> ci-dessus.

C/ Récupération des propriétés d'un salarié

Ce service permet d'accéder à la fiche active d'un salarié d' un dossier

Requête :


URL : /company/{database}/employees/{employeeID}

Méthode HTTP : GET

Paramètres





EmployeeID Identifiant unique du salarié Alphanumérique Correspond à l'information [employeeID] du service "Employees"

Réponse : En cas de succès, le résultat contient la fiche du salarié correspondant au code passé dans la requête. Se reporter à la partie présentant le schéma <wsEmployees> ci-dessus.

D/ Récupération des propriétés d'un salarié à une date donnée

Ce service permet d'accéder à la fiche d'un salarié d' un dossier à une date précise

Requête :

URL : /company/{database}/employees/{employeeID}/dateref/{dateref}

Méthode HTTP : GET

Paramètres





EmployeeID Identifiant unique du salarié Alphanumérique Correspond à l'information [employeeID] du service "Employees".

DateRef Date de référence Date Date au format AAAAMMJJ

Réponse : En cas de succès, le résultat contient la fiche du salarié correspondant au code passé dans la requête. Se reporter à la partie présentant le schéma <wsEmployees> ci-dessus.


Service PayVariables

A/ Importation de variables de paie Ce service permet de créer des variables de paie dans un dossier Requête : URL : /company/{database}/payvariables Méthode HTTP : POST Paramètres





Corps de la requête Le flux à envoyer au service d'importation de variables de paie doit être structuré de la façon suivante :

<wsImportPaieVariables> <importDate>2013-01-20</importDate> <payVariables> <year>2013</year> <month>01</month> <payVariable> <registryNr>REV000001</registryNr> <rubricID>3000</rubricID> <description>Congés payés</description> <value>0.5</value> <unit>day</unit> <startDate> <date>2013-01-15</date> <information>am</information> </startDate> <endDate> <date>2013-01-15</date> <information>am</information> </endDate> </payVariable> <payVariable> … </payVariable> </payVariables>


</wsImportPaieVariables>

Description du noeud "wsImportPaieVariables " : Argument Libellé Type Obligatoire Explication


payVariables Variable XML Liste des variables à intégrer

Remarque importante sur l'élément <importDate> : Cette date correspond à la date de fin de l'exercice dans lequel les variables de paie doivent être enregistrées. Une date comprise entre la date de début et la date de fin de l'exercice peut également être utilisée. Description de l'élément < payVariables >

Cet élément correspond à la liste des variables de paie à intégrer. Dans tous les cas, les erreurs / incohérences rencontrées lors de l'import des variables de paie sont transmises à l'appelant (voir la description de l'élément <réponse> si dessous). Argument Libellé Type Obligatoire Explication

year Année numérique Année au format YYYY sur laquelle va porter l'import

month Mois numérique Mois au format MM sur lequel va porter l'import

payVariable Variables de paie XML Liste des variables à importer

Description de l'élément < payVariable > Il s'agit d'une variable de paie. Argument Libellé Type Obligatoire Explication

registryNr Matricule du salarié Alphanumérique Identifiant du salarié

rubricID Code rubrique Alphanumérique Code de la rubrique du partenaire

value Valeur Alphanumérique Valeur à appliquer à la rubrique

eventDate Date de l'évènement XML Date de l'évènement

startDate Date de début Date Date de début de l'évènement Format YYYY-MM-DD

endDate Date de fin Date Date de fin de l'évènement Format YYYY-MM-DD

description Description Alphanumérique Descriptif associé à la rubrique

comment Commentaire Alphanumérique Commentaire complémentaire

Remarques : 1/ Si le flux XML ne contient de date d'évènement, c'est la date de début qui est utilisée. 2/ Si le flux XML contient une date d'évènement, les nœuds date de début et date de fin ne sont plus utiles


3/ Le code de la rubrique correspond au code de la rubrique dans le système d'information du partenaire. Un paramétrage de mise en correspondance entre les variables du partenaires et les variables IBIZA devra être effectué au préalable. Ceci conditionne le bon déroulement du traitement d'importation de variables de paie. Réponse : Résultat de l'importation des écritures Schéma XML :


<datetime></datetime> <result></result> <message></message>







< WCFRestIRFPaieVariableResult > <response>

<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Success</result> <message>

<success>L'import pour l'ensemble des matricules s'est terminé avec succès.</success>


</ WCFRestIRFPaieVariableResult >





<WCFRestIRFPaieVariableResult > <response>

<datetime>2014-02-26T16:15:58.4212646+01:00</datetime> <result>Error</result> <message>message</message>

</response> </WCFRestIRFPaieVariableResult>

Par exemple, si l'élément "importDate" est absent de la requête :

< WCFRestIRFPaieVariableResult > <response>

<datetime>2013-02-04T16:21:01.4659998+01:00</datetime> <result>Error</result> <message> Invalid request : field importDate missing</message>

</response> </ WCFRestIRFPaieVariableResult >

Ou bien dans le cas d'une erreur rencontrée lors du traitement des données à importer :

Réponse à une requête contenant code partenaire inconnu :


<datetime>2014-02-26T16:15:58.4212646+01:00</datetime> <result>Error</result> <message>

<error> <details>7845-Partner info {BE62697A-C2EE-4757-9A86-747A656FF0D7} does not

exists in the client file </details>

</error> </message>


Réponse à une requête contenant un code rubrique partenaire n'ayant pas de correspondance avec une

rubrique dans l'application IBIZA/RRH


<datetime>2014-02-26T16:15:58.4212646+01:00</datetime> <result>Error</result> <message>

<error> <details>7845-Lot creation failed ! L'import pour la rubrique [rubricID] a échoué.

Ce code rubrique n'a pas de correspondance.</details>


</error> </message>


Documents

Services web IRF - ibiza.acec.fribiza.acec.fr/irfdeploy/pdf/IBIZA_IRF_Web_Services_API_V4.pdf · F/ Balance par Exercice par Cycle ... 16/04/2013 Ajout du service ImportEntries EP