Services web IRF - compta.inexweb.fr · RECUPERATION DES BUDGETS D’UN EXERCICE COMPTABLE ... 16/04/2013 Ajout du service ImportEntries EP 04/04/2013 Ajout du service Journal EP

Services Web IRFServices web IRF

V. 2017.11.01 – NOVEMBRE 2017

Services web IRF Guide du développeur

Services web IRF

Guide du développeur

Sommaire

1

Sommaire SOMMAIRE ................................................................................................................................................................. 1

CLAUSE DE CONFIDENTIALITE ...................................................................................................................................... 4

REVISION ..................................................................................................................................................................... 6

PREAMBULE ................................................................................................................................................................ 7

PRESENTATION............................................................................................................................................................ 8

GENERALITES ............................................................................................................................................................. 11

ENTETES HTTP ............................................................................................................................................................. 11 TYPES DE DONNEES ........................................................................................................................................................ 12 STRUCTURE DE LA REPONSE ............................................................................................................................................. 12 MOT DE PASSE SUR LES DOSSIERS ..................................................................................................................................... 13

DEFINITION D'UN FILTRE ........................................................................................................................................... 15

OPERATEURS DISPONIBLES .............................................................................................................................................. 15 FONCTIONS DISPONIBLES ................................................................................................................................................ 16

La fonction "Contient" ..................................................................................................................................... 16 La fonction "Minuscule", "Majuscule" ............................................................................................................. 16 La fonction "Commence par" ........................................................................................................................... 16

SERVICE COMPANY ................................................................................................................................................... 17

RECUPERATION DE LA LISTE DES DOSSIERS........................................................................................................................... 17 RECUPERATION DES EXERCICES D'UN DOSSIER ..................................................................................................................... 19 RECUPERATION DES CARACTERISTIQUES D'UN DOSSIER .......................................................................................................... 20

SERVICE UNITS .......................................................................................................................................................... 25

RECUPERATION DE LA LISTE DES UNITES .............................................................................................................................. 25

SERVICE ACCOUNT ................................................................................................................................................ 27

RECUPERATION DE LA LISTE DE COMPTES (PLAN COMPTABLE) ................................................................................................. 27 RECUPERATION DES PROPRIETES D'UN COMPTE A PARTIR DE SON NUMERO ............................................................................... 29 LISTE DES MOUVEMENTS ANALYTIQUES .............................................................................................................................. 30

SERVICE THIRDPARTY ............................................................................................................................................ 34

RECUPERATION DE LA LISTE DES TIERS ................................................................................................................................ 34

SERVICE JOURNAL ................................................................................................................................................. 39

RECUPERATION DE LA LISTE DES JOURNAUX ......................................................................................................................... 39 RECUPERATION DES PROPRIETES D'UN JOURNAL A PARTIR DE SA REFERENCE .............................................................................. 40

Services web IRF


Sommaire

2

SERVICE GRAND LIVRE GENERAL ........................................................................................................................... 43

SERVICE ENTRIES ................................................................................................................................................... 46

IMPORTATION DES ECRITURES .......................................................................................................................................... 46 IMPORTATION DES ECRITURES AVEC UNE PIECE ATTACHEE ...................................................................................................... 54

Importation des écritures avec une pièce attachée stockée dans Ibiza ........................................................... 54 Importation des écritures avec une pièce attachée accessible via un lien hypertext ...................................... 57

IMPORTATION DES ECRITURES AVEC VENTILATION ANALYTIQUE ............................................................................................... 58

SERVICE BALANCES ............................................................................................................................................... 70

BALANCE PERIODE ......................................................................................................................................................... 70 BALANCE DE SITUATION .................................................................................................................................................. 71 BALANCE DE SITUATION AVEC A NOUVEAUX ....................................................................................................................... 74 BALANCE PAR EXERCICE .................................................................................................................................................. 76 BALANCE PAR EXERCICE AVEC A NOUVEAUX ....................................................................................................................... 78 BALANCE PAR EXERCICE PAR CYCLE ................................................................................................................................... 81 BALANCE ANALYTIQUE ................................................................................................................................................... 84 BALANCE PAR COMPTE ................................................................................................................................................... 86

SERVICE ANALYZES ................................................................................................................................................ 88

RECUPERATION DE LA LISTE DES ANALYSES PARAMETREES DANS UN DOSSIER ............................................................................. 88 RECUPERATION DE LA LISTE DES AXES PARAMETRES DANS UNE ANALYSE ................................................................................... 91 RECUPERATION DE LA LISTE DES SECTIONS D'UNE ANALYSE ..................................................................................................... 93 RECUPERATION DE LA LISTE DES SECTIONS D'UN AXE ............................................................................................................. 95

SERVICE EMPLOYEE ............................................................................................................................................... 99

RECUPERATION DE LA LISTE DES SALARIES ........................................................................................................................... 99 RECUPERATION DE LA LISTE DES SALARIES A UNE DATE DE REFERENCE ..................................................................................... 103 RECUPERATION DES PROPRIETES D'UN SALARIE .................................................................................................................. 104 RECUPERATION DES PROPRIETES D'UN SALARIE A UNE DATE DONNEE ..................................................................................... 104 RECUPERATION D’INDICATEURS SUR LES SALARIES .............................................................................................................. 105

Ancienneté des salariés ................................................................................................................................. 105 Informations du salarié .................................................................................................................................. 108 Top 10 des rémunérations ............................................................................................................................. 111 La pyramide des âges .................................................................................................................................... 112 Les compteurs du bulletin .............................................................................................................................. 115

SERVICE PAYVARIABLES ...................................................................................................................................... 118

IMPORTATION DE VARIABLES DE PAIE ............................................................................................................................... 118

SERVICE BUDGET ................................................................................................................................................. 124

RECUPERATION DES BUDGETS D’UN EXERCICE COMPTABLE ................................................................................................... 124

Services web IRF


Sommaire

3

RECUPERATION DES BUDGETS CUMULES A UNE PERIODE PAR COMPTE .................................................................................... 126

SERVICE SUIVI COMPTABLE ................................................................................................................................. 129

RECUPERATION DU SUIVI COMPTABLE POUR UN EXERCICE .................................................................................................... 129

SERVICE RELEVES BANCAIRES .............................................................................................................................. 132

IMPORTS DE RELEVES BANCAIRES .................................................................................................................................... 132 Format CFONB ............................................................................................................................................... 132

SERVICE DP ......................................................................................................................................................... 139

RECUPERATION DES INFORMATIONS GENERALES DU DP ...................................................................................................... 139 RECUPERATION DES INFORMATIONS LIEES AUX ASSOCIES ..................................................................................................... 143

ANNEXES ............................................................................................................................................................. 147

ENUMERATIONS .......................................................................................................................................................... 147 Etats d’un exercice comptable ....................................................................................................................... 147 Formes juridiques .......................................................................................................................................... 147 Régimes d’imposition .................................................................................................................................... 149 Catégories de comptes .................................................................................................................................. 149 Types de journaux .......................................................................................................................................... 150 Status de paiement ........................................................................................................................................ 150 Codes ISO des unités liées aux quantités ....................................................................................................... 151 Codes BIC des méthodes de paiement ........................................................................................................... 152 Modules ......................................................................................................................................................... 156 Unités de saisie (ventilations analytiques) ..................................................................................................... 156 Personnalités juridiques ................................................................................................................................. 157 Types d’établissements .................................................................................................................................. 157

Services web IRF


Clause de confidentialité

4


CLAUSE DE CONFIDENTIALITÉ DE LA SOCIETE UTILISATRICE (PARTENAIRE) ENVERS LA SOCIETE

IBIZA SOFTWARE (FOURNISSEUR) POUR L’UTILISATION DES APIs PROPOSÉES PAR LE

FOURNISSEUR.

Les supports informatiques fournis par la société Ibiza Software, et tous documents de quelque

nature, qu’ils soient résultant de leur traitement par le partenaire restent la propriété d’Ibiza

Software.

Les données contenues dans ces supports et documents sont strictement couvertes par le secret

professionnel (article 226-13 du code pénal). Conformément aux articles 34 et 35 de la loi du 6

janvier 1978 modifiée relative à l’informatique, aux fichiers et aux libertés, la société le partenaire

s’engage à prendre toutes précautions utiles afin de préserver la sécurité des informations et

notamment d’empêcher qu’elles ne soient déformées, endommagées ou communiquées à des

personnes non autorisées.

Le partenaire s’engage donc à respecter, de façon absolue, les obligations suivantes et à les faire

respecter par son personnel, c’est-à-dire notamment à :

• ne prendre aucune copie des documents et supports d’informations confiés, à l’exception

de celles nécessaires pour les besoins de l’exécution de sa prestation, objet du présent

contrat ;

• ne pas utiliser les documents et informations traités à des fins autres que celles spécifiées

au présent contrat ;

• ne pas divulguer ces documents ou informations à d’autres personnes, qu’il s’agisse de

personnes privées ou publiques, physiques ou morales ;

• prendre toutes mesures permettant d’éviter toute utilisation détournée ou frauduleuse des

fichiers informatiques en cours d’exécution du contrat ;

• prendre toutes mesures, notamment de sécurité matérielle, pour assurer la conservation

des documents et informations traités tout au long de la durée du présent contrat ;

Services web IRF



5

En fin de contrat, Le partenaire s’engage à :

• procéder à la destruction de tous fichiers manuels ou informatisés stockant les

informations saisies ;

ou à :

• restituer intégralement les supports d’informations selon les modalités prévues au présent

contrat.

A ce titre, également, le partenaire ne pourra sous-traiter l’exécution des prestations à une autre

société, ni procéder à une cession de marché. [Les supports d’informations qui lui seront remis

devront être traités sur le territoire français métropolitain.]

La société Ibiza Software se réserve le droit de procéder à toute vérification qui lui paraîtrait utile

pour constater le respect des obligations précitées par le partenaire.

Il est rappelé que, en cas de non-respect des dispositions précitées, la responsabilité du titulaire

peut également être engagée sur la base des dispositions des articles 226-17 et 226-5 du code

pénal.

La société Ibiza Software pourra prononcer la résiliation immédiate du contrat, sans indemnité en

faveur du titulaire, en cas de violation du secret professionnel ou de non-respect des dispositions

précitées.

Services web IRF


Révision

6

Révision

Date Action Auteur

15/10/2017 Nouvelle charte graphique EP

10/10/2017 Normalisation des entêtes http EP

05/10/2017 Nouvelles APIs : DP, Relevés bancaires EP

10/09/2017 Enrichissement de la réponse après un import d’écritures EP

13/02/2016 Gestion des dossiers protégés par mot de passe EP

10/02/2016 Ajout du service Tiers EP

30/01/2016 Ajout du service Budget SB

31/01/2016 Ajout du service AccountingFollowup SB

25/10/2016 Ajout API indicateurs salaries EP

12/09/2016 V5 EP

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

Services web IRF


Préambule

7

Préambule Ce document contient des informations appartenant à IBIZA SOFTWARE. Les copies, la distribution

ou la communication de ce document en tout ou partie à des tiers non autorisés constituent une

violation des droits de propriété d’IBIZA SOFTWARE et des règles de confidentialité établies par IBIZA

SOFTWARE. Ce document ne peut en aucun cas être modifié ou distribué sans l’approbation du

service l’ayant rédigé. Veuillez contacter le propriétaire du document avant toute réutilisation ou

diffusion. Ce document annule et remplace toutes les versions précédentes. Merci de vous assurer

que vous utilisez bien la dernière version et de détruire de façon sécurisée toute copie des versions

antérieures que vous auriez en votre possession, qu’elles soient en format papier ou électronique.

Services web IRF


Présentation

8

Présentation 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, JSON, XML, …) garanti une totale compatibilité

entre les différents systèmes.

A

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 (requêtes) entre le client et le serveur se font via des messages au format XML.

Les échanges (réponses) entre le serveur et le client se font via des messages au format XML ou

JSON. Le choix du format de la réponse se fait en utilisant l’entête HTTP ContentType (

application/xml ou application/json )

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. Dans les APIs proposées par Ibiza, certaines ne sont pas encore

disponibles.

Les communications entre le client et le serveur sont "sans état" (stateless) ; 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 HTTP) les éléments

suivants :

• "IRF-Token" : Jeton crypté pour l'authentification

Services web IRF


Présentation

9

• "IRF-partnerID" : Identifiant partenaire fournit par IBIZA

• "Authorization" : Si le dossier est protégé par mot de passe (cf Généralités)

B

Depuis la version 2017.09.1 des services web IRF, de nouveaux entêtes HTTP

permettent de compléter et préciser les propriétés de la requête. Se reporter à

la partie « Entêtes HTTP » de ce document

L'URL de base des services web est :

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

Il faudra ajouter la partie spécifique 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.

A

Les accolades "{" et "}" ne font pas partie du message ; elles permettent

d'identifier les informations variables de la requête (URL).

Dans le cas de l’utilisation de données de type UUID (GUID), les accolades

doivent être conservées.

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>

Services web IRF


Présentation

10

</message>

<result>Error</result>

</response>

</WCFRestIRFResult>

Cette réponse correspond à un appel fait sans renseigner le jeton d’authentification 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

Services web IRF


Généralités

11

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

Entêtes HTTP

Le tableau suivant présente la liste des entêtes HTTP utilisées dans les échanges avec les services

web IRF

irfToken Jeton d’authentification permettant l’accès aux

dossiers.

Déprécié. Voir IRF-Token

partnerID Identifiant du partenaire.

Déprécié. Voir IRF-PartnerID

IRF-PartnerID Identifiant partinaire. Permet l’identification du

partenaire sur la plateforme d’IBIZA. Remplace

l’entête partnerID.

IRF-Token Jeton d’authentification permettant l’accès aux

dossiers. Remplace l’entête irfToken.

IRF-Request L’appel à certaines API nécessite de préciser un

filtre afin de restreindre la liste des

informations renvoyées.

Ex : starts-with(accountNumber, "6") and

periodEnd="2016-05-31"

IRF-GroupBy Liste des champs sur lesquel faire un

regroupement. Les champs du regroupement

doivent être séparés par des espaces

Ex : debit credit accountNumber

IRF-ExportedFields Liste des champs à renvoyer. L’utilisateur peut

restreindre la liste des champs renvoyés. Les

Services web IRF


Généralités

12

champs doivent être séparés par des points-

virgules ( ; )

Ex : debit;credit;accountNumber. Seuls les

champs debit, credit et accountNumber seront

renvoyés dans la réponse.

Types de données

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

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

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

avec des décimales

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

de décimales.

- Date (D) : 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é par des tirets (-).

- Booléen (B) : 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.

- Enumération (Enum) : Type de donnée associant un code à un libellé. Les tableaux de descritpino

de ces éléments se trouvent dans les annexes de ce document.

Structure de la réponse

Sauf cas particulier, toutes les réponses obtenues à partir d’un message GET sont structurées de

façon identique :

Services web IRF


Généralités

13

<WCFRest_Nom_du_service_Result >

<response>

<datetime>AAAA-MM-JJThh:mm:ss.nnnnnnn+01:00</datetime>

<result></result>

<message></message>

</response>

<data>

…/…

</data>

</ WCFRestIRFPracticeDatabaseResult >


Argument Libellé Type Explication

Datetime Date Date Date et heure de la réponse

Result Résultat A Résultat de l'exécution de la méthode invoquée : "Success"

ou "Error".

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

Le contenu de la balise data est contextuel à l’API invoquée.

Mot de passe sur les dossiers

Certains dossiers possèdent un accès restreint au travers d’un mot de passe définit depuis la

plateforme IBIZA.

Afin d’accéder aux données de ces dossiers, il faut ajouter dans l’entête http Authorization dans les

entêtes http envoyées lors de l’appel aux APIs

Nom de l’entête : Authorization

Valeur du paramètre : IRF-COMPANY-ACCES [valeur MD5 du mot de passe]

Services web IRF


Généralités

14

Exemple :

Authorization : IRF-COMPANY-ACCESS 60E838DC72F24196AAAA1C629806EA97

Où 60E838DC72F24196AAAA1C629806EA97 correspond à la valeur MD5 du mot de passe IBIZA

Pour savoir si un dossier est protégé par un mot de passe, il faut se référer à l’information password

(true/false) renvoyée par les APIs suivantes :

/Companies

/Company/{databaseID}/Informations

/Company/{databaseID}

Se reporter au descriptif de ces APIs dans ce document.

Services web IRF


Définition d'un filtre

15


C

Certains services imposent de préciser un filtre.

En effet, en raison du grand nombre de données, il peut être indispensable de restreindre la

quantité des données à récupérer.

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 : [GET] /company/{database}/balances/account

Entête HTTP IRF-Request : 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 : [GET] /company/{database}/balances/account

Entête HTTP IRF-Request : exerciceEnd="20161231" and starts-with(accountNumber,"129")

A A partir de la version 2017.12.1 des API, il est recommandé d’utiliser l’entête http

IRF-Request en lieu et place du paramètre de l’uri « q= »

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

> > date >="20141201" Test sur la date supérieure ou égale au

01/12/2014

< < date <="20141231" Test sur la date inférieure ou égale au

31/12/2014

Services web IRF



16

& &

" "

Si vous utilisez l’entête http IRF-Request, l’encodage des opérateurs n’est plus nécessaire

IRF-Request : date >= "20141201"

IRF-Request : date <= "20141231"

Fonctions disponibles

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

La fonction "Contient"

IRF-Request : contains(field, chaine).

Par exemple : IRF-Request : contains(accountNumber,"BORSO")

La fonction "Minuscule", "Majuscule"

IRF-Request : lower-case(field)=chaine

IRF-Request : upper-case(field)=chaine

La fonction "Commence par"

IRF-Request : starts-with(field,chaine)

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 : IRF-Request : starts-with(period, "2014")

Services web IRF


Service Company

17

Service Company Récupération de la liste des dossiers

Ce service permet de récupérer la liste des dossiers auquel le jeton d’authentification utilisé

donne accès

URL : [GET] /companies

Paramètres


• "IRF-PartnerID" : identifiant partenaire fournit par IRF

Réponse :

Schéma XML :

<WCFRestIRFPracticeDatabaseResult >

<response>


<result></result>

<message></message>

</response>

<data>

<wsPracticeDatabase >

<database>Identifiant du dossier</database>

<name>Nom du dossier</name>

</wsPracticeDatabase>

...

</data>

</ WCFRestIRFPracticeDatabaseResult >

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>)

Services web IRF


Service Company

18

Description de l'élément < wsPracticeDatabase>


Database Dossier UUID Identifiant unique du dossier

Name Nom A Nom du dossier

Site Site A Nom du site auquel est rattaché le

dossier

internalCode Code interne A Usage réservé

accountingMethod Méthode de tenue

comptable

E (0/1) 0 : Engagement / 1 :Trésorerie

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

affiliationLabel1 Critère de rattachement #1 A

affiliationLabel2 Critère de rattachement #2 A Critère de rattachement #2




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

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

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

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

Password Mot de passe A L’accès au dossier est protégé par

un mot de passe

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

Services web IRF


Service Company

19

Récupération des exercices d'un dossier

Ce service permet de récupérer les exercices d'un dossier

URL : [GET] /company/{database}/Exercices

Paramètres





Réponse :

Liste des exercices du dossier

Schéma XML :

< WCFRestIRFExercicesResult >

<response>


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

Services web IRF


Service Company

20



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 A Code unique de l'exercice

start Date de début D Date de début de l'exercice

end Date de fin D Date de clôture de l'exercice

state Etat Enum Etat de l'exercice

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

Récupération des caractéristiques d'un dossier

URL : [GET] /company/{database}/Informations

Ce service permet de récupérer les propriétés d'un dossier

Paramètres





Réponse :

Liste des propriétés du dossier

Services web IRF


Service Company

21

Schéma XML :

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

<response>

<result>Success</result>

<message i:nil="true"/>


<duration>00:00:02.316</duration>

</response>

<data i:type="wsCompanyInformationsView">

<SIREN>316574799</SIREN>

<SIRET>31680879900048</SIRET>

<address_building> </address_building>

<address_country>FRANCE</address_country>

<address_postCode>95703</address_postCode>

<address_street>6 rue du Rocher</address_street>

<address_town>ROISSY CHARLES DE GAULLE CEDEX</address_town>

<businessType>3</businessType>

<codeNAF>5245B</codeNAF>

<database>{97E9E571-F9C4-40DC-8D52-A15DCA2162ED}</database>

<email/>

<executiveStatus/>

<exerciceDurationN>12</exerciceDurationN>

<exerciceDurationN1>12</exerciceDurationN1>




<exerciceEnd_N>2015-12-31</exerciceEnd_N>

<exerciceEnd_N1>2014-12-31</exerciceEnd_N1>




<exerciceStart_N>2015-01-01</exerciceStart_N>

<fax/>

<firstName>Pierre</firstName>

<internalCode>MYCOMPANY</internalCode>

Services web IRF


Service Company

22

<lastName>RETR</lastName>

<legalName>WORLDCOMPANY</legalName>

<mainActivity/>

<mobile/>

<password>true</password>

<taxationRegime>1</taxationRegime>

<tel/>

<title>M</title>

<vatPayer>1</vatPayer>

<workforce/>

</data>

</WCFRestIRFPracticeDatabaseResult>




SIREN Numéro de SIREN A

SIRET Numéro de SIRET A

address_building Immeuble A

address_country Pays A

address_postCode Code postal N

address_street Rue A

address_town Ville A

businessType Forme juridique Enum Voir Annexes

codeNAF Code NAF A

database Code du dossier A

Services web IRF


Service Company

23

email courriel A

executiveStatus

exerciceDurationN Durée de l’exercice courant

(n)

N

exerciceDurationN1 Durée de l’exercice n-1 N



exerciceEnd_N Date de clôture exercice

courant (n)

D

exerciceEnd_N1 Date de clôture exercice n-1 D



exerciceStart_N Date de début exercice

courant (n)

D

fax Numéro de fax A

firstName Prénom du gérant A

internalCode Code interne du dossier A

lastName Nom du gérant A

legalName Raison sociale A

mainActivity Activité principale A Activité principale de l’entreprise

mobile Numéro de téléphone

mobile

A

Services web IRF


Service Company

24

password Mot de passe B 1 : Accès protégé par mot de passe

0 : Pas de mot de passe

taxationRegime Régime d’imposition Enum Voir Annexes

tel Numéro de téléphone A

title A

vatPayer Asujéti à la TVA B 1 : Assujéti

0 : Non assujéti

workforce Effectifs N

Services web IRF


Service Units

25

Service Units Récupération de la liste des unités

Ce service permet de récupérer la liste des unités d'un dossier

URL : [GET] /company/{database}/Units

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFUnitsResult >

<response>


<result></result>

<message></message>

</response>

<data>

<unit >

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

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

</unit >

...

</data>

</ WCFRestIRFUnitsResult >


Services web IRF


Service Units

26


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

Description de l'élément < Unit>


code Unité A Identifiant unique de l'unité

name Libellé A Libellé de l'unité

Services web IRF


Service Account

27

Service Account 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

URL : [GET] /company/{database}/accounts

Paramètres





Réponse :

Liste des comptes (plan comptable) du dossier

Schéma XML :

<WCFRestIRFAccountsResult >

<response>


<result></result>

<message></message>

</response>

<data>

< wsAccounts >

<auditable>0</auditable>

<bankReconcilable>0</bankReconcilable>

<category>9</category>

<centralisable>0</centralisable>

Services web IRF


Service Account

28

<closed>0</closed>

<collectif/>

<name>Capital</name>

<number>101000</number>

<reconcilable>0</reconcilable>

</ wsAccounts >

...

</data>

</ WCFRestIRFAccountsResult >



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

Description de l'élément < wsAccount>


category Catégorie N Cf. tableau des types de compte ci-

dessous

number Numéro A Numéro du compte

name Nom A 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

Services web IRF


Service Account

29

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 A Numéro du compte collectif lié si

existant

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.

URL : [GET] /company/{database}/accounts/{account}

Paramètres





Account Numéro de compte A Numéro du compte

Réponse :

Compte correspondant au numéro indiqué dans la requête

Schéma XML :

< WCFRestIRFAccountsResult >

<response>


<result></result>

Services web IRF


Service Account

30

<message></message>

</response>

<data>

< wsAccounts >



<category>9</category>


<closed>0</closed>

<collectif/>

<name>Capital</name>



</ wsAccounts >

</data>

</ WCFRestIRFAccountsResult >

Description de l'élément < wsAccount>

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

Liste des mouvements analytiques

Ce service permet de récupère la liste des mouvements analytiques

URL : [GET] /company/{database}/AnalyticalMovement

Paramètres




database Dossier UUID Identifiant unique du dossier

Réponse :

Services web IRF


Service Account

31

Liste des mouvements analytiques

Schéma XML :

<WCFRestIRFAnalyticalMovementResult

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

<response>


<message />


</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>


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

Services web IRF


Service Account

32



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

Services web IRF


Service Account

33

subSubAxis

subSubSection

Services web IRF


Service Thirdparty

34

Service Thirdparty Récupération de la liste des tiers

Ce service permet de récupérer la liste des comptes de tiers ainsi que les détails (adresse, compte

bancaire, …)

URL : [GET] /company/{database}/thirdparty

Paramètres




database Dossier UUID Identifiant unique du dossier

Réponse :

Liste des comptes de tiers

Schéma XML :

<WCFRestIRFThirdPartyResult >

<response>





</response>

<data >

<wsThirdParty>

<SIRET/>

<VATNumber/>

<associateName/>

Services web IRF


Service Thirdparty

35

<associateNumber/>




<closed>0</closed>

<codeSWIFT/>

<collectiveName>FOURNISSEURS</collectiveName>

<collectiveNumber>401000</collectiveNumber>

<fax/>

<ibanCode/>

<mainAddress_area/>

<mainAddress_building/>

<mainAddress_country>FRANCE</mainAddress_country>

<mainAddress_postCode/>

<mainAddress_postalInseeCode/>

<mainAddress_street/>

<mainAddress_town/>

<mainContactFirstName/>

<mainContactLastName/>

<name>AB DEDOUANEMENT</name>

<natureAuxi>Fournisseur</natureAuxi>

<number>ABD</number>

<paymentMethod>Aucun</paymentMethod>


<telephone/>

<webSite/>

</wsThirdParty>

.../...

</data>

</ WCFRestIRFThirdPartyResult>



Services web IRF


Service Thirdparty

36

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

Description de l'élément < wsThirdParty >


SIRET SIRET

VATNumber Numéro du compte de

TVA

associateName Nom du compte associé A

associateNumber Numéro du compte

associé

auditable Analytique E (0/1) Permet l'affectation d'une

ventilation analytique lors de la

saisie d'un mouvement

bankReconcilable Rapprochable E (0/1) Non appliccable pour les

comptes de tiers

centralisable Centralisable E (0/1) Permet la centralisation des

mouvements du compte lors

des éditions

closed Compte fermé E (0/1) Indique si le compte est fermé :

bloque la saisie des

mouvements comptables

codeSWIFT Code BIC (SWIFT) A

collectiveName Nom du compte

collectif

A

collectiveNumber Numéro de compte du

collectif

N

fax Fax A

Services web IRF


Service Thirdparty

37

ibanCode IBAN du compte A

mainAddress_area Région A

mainAddress_building Immeuble A

mainAddress_country Pays A

mainAddress_postCode Code postal A

mainAddress_postalInseeCode Code postal normalize A

mainAddress_street Rue A

mainAddress_town Ville A

mainContactFirstName Prénom A

mainContactLastName Nom A

name Libellé du compte de

tiers

A

natureAuxi Nature de l’auxiliaire A

number Numéro du compte de

tiers

paymentMethod Méthode de paiement A 2 caractères. Voir Annexes

Code BIC de la méthode de

paiement à appliquer

reconcilable Lettrage manuel E (0/1) Permet le lettrage sur des

mouvements du compte

telephone Téléphone A

webSite A dresse du site internet A

Services web IRF


Service Thirdparty

38

Services web IRF


Service Journal

39

Service Journal 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.

URL : [GET] /company/{database}/journals

Paramètres





Réponse :

Liste des journaux du dossier

Schéma XML :

<WCFRestIRFJournalsResult >

<response>


<result></result>

<message></message>

</response>

<data>

<wsJournals>

<closed>0</closed>

<description>A nouveaux</description>

<ibanCode/>

<number/>

<ref>AN</ref>

Services web IRF


Service Journal

40

<type>10</type>

</wsJournals>

...

</data>

</ WCFRestIRFJournalsResult >



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

Description de l'élément < wsJournals>


ref Numéro A Code du journal

description Nom A Nom du journal

type Type Enum Voir annexes

ibanCode

Number

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

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.

Services web IRF


Service Journal

41

URL : [GET] /company/{database}/journals/{journal}

Exemple : /company/{74D8A14D-C4F7-4106-97B2-A8DF447517F5}/journal/AN

Paramètres





journal Référence du journal N Référence du journal

Réponse :

Journal correspondant à la référence indiquée dans la requête

Schéma XML :

< WCFRestIRFJournalsResult >

<response>


<result></result>

<message></message>

</response>

<data>

<wsJournals>

<description>A Nouveaux</description>

<ref>AN</ref>

<type>10</type>

<closed></closed>

<ibanCode></ibanCode>

<number></number>

</wsJournals>

Services web IRF


Service Journal

42

</data>

</ WCFRestIRFJournalsResult >

Se reporter au tableau décrivant les propriétés d'un journal ci-dessus (wsJournal).

Services web IRF


Service Grand Livre Général

43

Service Grand Livre Général Ce service permet de récupérer les écritures du Grand Livre.

URL : [GET] /company/{database}/GrandLivreGeneral

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFGeneralLegerResult>

<response>


<result></result>

<message></message>

</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>

Services web IRF



44

<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 A

Collectif

Comment

Credit

Currency

Services web IRF



45

CurrencyAmount

Date

Debit

Description

Letter

letteredInBetween

Name

Number

paymentMethod

paymentMethodDescription

periodEnd

periodStart

piece

qtyUnit

quantity

ref

term

voucherRef

Services web IRF


Service Entries

46

Service Entries Importation des écritures

Ce service permet d'importer des écritures dans un dossier

URL : [POST] /company/{database}/entries

Paramètres





Corps de la requête

Le flux à envoyer au service d'importation d'écritures 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>


<term>2012-02-12</term>


<paymentStatus>3</paymentStatus>

<letter>AAAA</letter>

Services web IRF


Service Entries

47

<comment>Lettrage à vérifier</comment>

</importEntry>

<importEntry>


<date>2012-01-07</date>


<accountNumber>701000</accountNumber>

<accountName>Ventes</accountName>


<credit>400.00</credit>

<unit>DMT</unit>


</importEntry>

.../...

</ wsImportEntry >

</importEntryRequest>

Description du noeud "importEntryRequest" :


importDate Date d'import D Date de fin de l'exercice de destination

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.

Services web IRF


Service Entries

48

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 Oblig. Explication

journalRef Journal A 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 D

Date comptable du mouvement.

La date comptable doit être

comprise dans l'exercice cible.

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

accountNumber Compte A 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

Services web IRF


Service Entries

49

accountName Nom du compte A 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é A Permet la centralisation des

mouvements du compte lors des

éditions

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

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

term Echéance D Date d'échéance

paymentMethod Méthode de paiement A 2 caractères. Voir Annexes.


paiement à appliquer.

paymentStatus Etat du paiement A 1 caractère. Voir Annexes

Ce champ est utilisé seulement

dans les factures pour la génération

automatique des règlements dans

le module "Règlements".

voucherID Document A URI de la pièce jointe (voir la partie

du dcoument présentant l’import

d’écritures avec une pièce attachée)

voucherRef Référence Pièce A Référence de la pièce jointe

unit Unité A 3 caractères. Voir Annexes

Services web IRF


Service Entries

50

Code ISO de l'unité liée à la quantité.

Doit exister dans la table "unit" de la

base modèle Ibiza

quantity Quantité N Indication de la quantité attributé au

mouvement comptable

N'est pris en compte que si "Unité"

est renseigne

comment Commentaire A

letter Lettrage A 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 D Début de la période d'affectation

periodEnd Période au D Fin de la période d'affectation

Réponse :

Résultat de l'importation des écritures

Schéma XML :

< WCFRestIRFImportEntriesResult >

<response>


<result></result>

<message></message>

</response>

</ WCFRestIRFImportEntriesResult >

Services web IRF


Service Entries

51


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 :


<response>



<message>

<success>

<description>Import terminé avec succès</description>

<data>

<importSessionReport>

<category>Mouvements comptables</category>


</importSessionReport>

</data>

</success>

</message>

</response>


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...)


<response>



Services web IRF


Service Entries

52

<message>

<error>

<number></number>

<description> </description>

</error>

</message>

</response>


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 :


<response>



<message>

<error>


<description>La pièce ou le journal sont

déséquilibrés</description>

</error>

</message>

</response>


Lors de l'appel à l'API /Entries, on peut préciser que l'on souhaite récupérer les identifiants des

écritures importées.

Exemple de flux xml à envoyer au travers de l'API /Entries :



<responseDetail>

<entry fields="header">yes</entry>

Services web IRF


Service Entries

53

</responseDetail>

<wsImportEntry>

<importEntry>


<date>2017-08-05</date>

<piece>2017-1436</piece>


<description>Turbines Friedman A9954875</description>


<term></term>

<voucherRef>7256665</voucherRef>

</importEntry>

<importEntry>


<date>2017-08-05</date>



<description>Turbine Friedman A9954875</description>


<term></term>


</importEntry>

<importEntry>


<date>2017-08-05</date>



<description>Turbines Friedman A9954875</description>


<term></term>


</importEntry>

</wsImportEntry>


Réponse obtenue :

Services web IRF


Service Entries

54

<WSImportEntry>

<success sessionID = "{76DA3501-7930-4D04-BB3F-4F7617EA8309}">





<detail>

<entry objectID = "{95CA3671-ABA1-40DF-EFDE-9ED49B4823D3}">


</entry>

</detail>


</success>

</WSImportEntry>

L'identifiant de l'écriture correspond à l'attribut objectID récupéré dans chaque noeud Entry de la

réponse.

Cette valeur pourra être utilisée dans les filtres sur l'API /GrandLivreGeneral (ex Entête HTTP IRF-

Request : header='{95CA3671-ABA1-40DF-EFDE-9ED49B4823D3}')

Importation des écritures avec une pièce attachée

Il est possible de lier les mouvements des écritures à un document PDF (facture, ticket de caisse, …)

La structure XML à envoyer doit contenir la balise voucherID qui contiendra la référence du

document

Cette référence consistera en une codification interne à Ibiza ou un lien hypertext pointant sur le

document

Importation des écritures avec une pièce attachée stockée dans Ibiza

Pour importer un document dans IBIZA en le liant à une écriture, il faut utilser la balise

<importDocument>

Services web IRF


Service Entries

55



<wsImportEntry>

<importDocument>

<objectID>{9E4DCC1A-836C-4165-AE0D-790BE85BF236}</objectID>

<name>YBOX_LT12059A12A0043_4667306.pdf</name>

<fileName>YBOX_LT12059A12A0043_4667306.pdf</fileName>

<mime>application/pdf</mime>

<encodedData>contenu du document encode en base64</encodedData>

</importDocument>

<importEntry>

<journalRef>60</journalRef>

<date>2017-10-05</date>

<piece>ID%480 ACHATS 201711 017</piece>

<voucherID>Ibiza: {9E4DCC1A-836C-4165-AE0D-790BE85BF236}</voucherID>


<accountNumber>401ZZZ</accountNumber>

<accountName>401ZZZ</accountName>

<description>SOSHOP</description>


</importEntry>

<importEntry>


<date>2017-10-05</date>




<accountName>47100000</accountName>



</importEntry>

<importEntry>


<date>2017-10-05</date>




Services web IRF


Service Entries

56




<debit>3.17</debit>

</importEntry>

</wsImportEntry>



Voir la description des balises du nœud importEntry dans la partie précédente de ce document


voucherID Identifiant du

document

A Contient la référence permettant

d’accéder au document précédé de

ibiza:

Description de l'élément <importDocument>

Il s'agit de la description du document à importer


objectID Identifiant du

document

UUID Identifiant unique du document

Cet identifiant doit être unique, et

changer à chaque nouveau

document

name Nom du document A

Nom du fichier

fileName Nom du fichier A Nom du fichier avec son extension

Services web IRF


Service Entries

57

mime Type mime du

document

A Type mime du document

Ex : application/pdf

encodedData Base64 du document A Contenu du document à importer

encodé en base64

Importation des écritures avec une pièce attachée accessible via un lien

hypertext

Pour lier un document à une écriture par un lien hypertext, il suffit d’utiliser la balise voucherID en

lui donnant comme valeur le lien vers le document.



<wsImportEntry>

<importEntry>


<date>2017-10-05</date>


<voucherID>https://my.server.com/documents/925595/download?151</voucherID>


<accountNumber>401ZZZ</accountNumber>

<accountName>401ZZZ</accountName>



</importEntry>

<importEntry>


<date>2017-10-05</date>






Services web IRF


Service Entries

58


</importEntry>

<importEntry>


<date>2017-10-05</date>







<debit>3.17</debit>

</importEntry>

</wsImportEntry>



Voir la description des balises du nœud importEntry dans la partie précédente de ce document


voucherID Identifiant du

document

A Contient le lien hypertext

permettant d’accéder au document

stocké en dehors d’IBIZA

Importation des écritures avec ventilation analytique

Ce service permet d'importer des écritures dans un dossier en précisant le détail 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.

URL : [POST] /company/{database}/entries

Services web IRF


Service Entries

59

Paramètres






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.



<wsImportEntry>

<importEntry>


<date>2012-01-07</date>


<accountNumber>411DURAND</accountNumber>

<accountName>M. DURAND Daniel</accountName>



<term>2012-02-12</term>


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

Services web IRF


Service Entries

60

<debit></debit>


</importAnalyticalEntry>

<importAnalyticalEntry>

<analysis>ANA1</analysis>

<axis1>FP</axis1>

<axis2>410</axis2>

<axis3>1-6-1a</axis3>

<debit></debit>


</importAnalyticalEntry>

</importAnalyticalEntries>

</importEntry>

<importEntry>


<date>2012-01-07</date>



<accountName>Ventes</accountName>



<unit>DMT</unit>


</importEntry>

.../...

</ wsImportEntry >


Description du noeud "importEntryRequest" :


importDate Date d'import D Date de fin de l'exercice de destination

Format YYYY-MM-DD

Services web IRF


Service Entries

61

wsImportEntry Ecritures XML Liste des écritures à intégrer


Cette date correspond à la date de fin de l'exercice dans lequel les écritures doivent être

enregistrées.


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.




Il s'agit d'un mouvement comptable.

Remarque : 1 écriture = x mouvements comptables avec somme_débit = somme_crédit.


journalRef Journal A 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>

Services web IRF


Service Entries

62

date Date D

Date comptable du

mouvement.

La date comptable doit être

comprise dans l'exercice cible.

piece Pièce A Référence de la pièce

comptable

accountNumber Compte A 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 A 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é A Permet la centralisation des

mouvements du compte lors

des éditions

debit Débit N Doit être nul si "crédit"

renseigné

credit Crédit N Doit être nul si "débit"

renseigné

Services web IRF


Service Entries

63

term Echéance D Date d'échéance

paymentMethod Méthode de

paiement

A 2 caractères. Voir Annexes


paiement à appliquer

paymentStatus Etat du paiement A 1 caractère. Voir Annexes

Ce champ est utilisé seulement

dans les factures pour la

génération automatique des

règlements dans le module

"Règlements".

voucherID Document A URI de la pièce jointe

voucherRef Référence Pièce A Référence de la pièce jointe

unit Unité A 3 caractères. Voir Annexes

Code ISO de l'unité liée à la

quantité.

Doit exister dans la table "unit"

de la base modèle Ibiza

quantity Quantité N Indication de la quantité

attributé au mouvement

comptable

N'est pris en compte que si

"Unité" est renseigne

comment Commentaire A

letter Lettrage A Code reliant un ensemble d'au

moins 2 mouvements équilibrés

Services web IRF


Service Entries

64

Le lettrage doit être équilibré au

sein du flux envoyé

periodStart Période du D Début de la période

d'affectation

Format YYYY-MM-DD

periodEnd Période au D Fin de la période d'affectation

Format YYYY-MM-DD

importAnalyticalEntries XML Description de la ventilation

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.



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

A Code de l'analyse

Axis1 Ventilation 1 A Code de la section de ventilation de niveau 1



Services web IRF


Service Entries

65

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

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

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 :


Schéma XML :


<response>


<result></result>

<message></message>

</response>







Services web IRF


Service Entries

66


<response>



<message>

<success>


<data>


<category>Comptes</category>




<category>Mouvements analytiques</category>







</data>

</success>

</message>

</response>



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


<response>



<message>

<success>


Services web IRF


Service Entries

67

<data>


<category>Comptes</category>




<category>Mouvements analytiques</category>








<category>Sections analytiques</category>



</data>

</success>

</message>

</response>




etc. ...)


<response>



<message>

<error>

<number>code de l'erreur</number>

<description>description de l'erreur</description>

</error>

Services web IRF


Service Entries

68

</message>

</response>


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 :


<response>



<message>

<error>


<description>La pièce ou le journal sont

déséquilibrés</description>

</error>

</message>

</response>


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


<response>



<message>

<error>


<description>L'axe est inconnu</description>

</error>

Services web IRF


69

</message>

</response>


Services web IRF


Service Balances

70

Service Balances Balance Période

Ce service permet de récupérer les soldes des comptes regroupés par période.

URL : [GET] /company/{database}/balances/period

Requête avec un filtre sur la période : Entête HTTP IRF-Request : starts-with(period, "2014")

Méthode HTTP : GET

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFBalancePeriodResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsBalancePeriod>

<credit>0</credit>


<journal>60</journal>

Services web IRF


Service Balances

71

<lettered>Non</lettered>

<name>EDF</name>


<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 A

Debit

Journal

Leterred

Name

Number

Period

Balance de Situation

Ce service permet de récupérer les soldes des comptes regroupés par situation.

Services web IRF


Service Balances

72

URL : [GET] /company/{database}/balances/situation

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFBalanceSituationResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsBalanceSituation>

<accountName>CAPITAL APPELE VERSE</accountName>


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

Services web IRF


Service Balances

73

<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 A

accountNumber

Credit

Debit

dateLastEntry

exerciceEnd

exerciceStart

exerciceState

Nature

nbEcrN

nbNotLettered

reconcilable

Services web IRF


Service Balances

74

situationEnd

situationStart

solde

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.

URL : [GET] /company/{database}/balances/situationAN

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFBalanceSituationANResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsBalanceSituationAN>

<accountName>CAPITAL APPELE VERSE</accountName>


Services web IRF


Service Balances

75

<balanceType>A-Nouveaux</balanceType>

<credit>40000</credit>


<debit>0</debit>




<nature>généraux</nature>

<nbEcrN>1</nbEcrN>



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


accountName A

accountNumber

balanceType

Credit

Debit

Services web IRF


Service Balances

76

dateLastEntry

exerciceEnd

exerciceStart

exerciceState

Nature

nbEcrN

nbNotLettered

reconcilable

situationEnd

situationStart

solde

Balance par Exercice

Ce service permet de récupérer les soldes des comptes regroupés par exercice.

URL : [GET] /company/{database}/balances/exercice

Paramètres





Réponse :

Services web IRF


Service Balances

77

Schéma XML :

< WCFRestIRFExercicesResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsBalanceExercice>

<accountName>Comptes d'attente</accountName>

<accountNote/>








<nature>generaux</nature>

<nbEcrN>42</nbEcrN>


<note/>


<solde>-2287.66</solde>

<state/>

</wsBalanceExercice>

…

</data>

</ WCFRestIRFExercicesResult>



Services web IRF


Service Balances

78

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

Description de l'élément < wsBalanceExercice >


accountName A

accountNote A

accountNumber A

credit N

dateLastEntry D

debit N

exerciceEnd D

exerciceStart D

exerciceState A

nature A

nbEcrN N

nbNotLettered N

note A

reconcilable A

solde N

state A

Balance par Exercice avec A Nouveaux

Services web IRF


Service Balances

79

Ce service permet de récupérer les soldes des comptes regroupés par exercice avec les A

Nouveaux.

URL : [GET] /company/{database}/balances/exerciceAN

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFBalanceExerciceANResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsBalanceExerciceAN>

<accountName>Comptes d'attente</accountName>

<accountNote/>


<balanceType>Mouvements</balanceType>






Services web IRF


Service Balances

80



<nbEcrN>42</nbEcrN>


<note/>


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


accountName A

accountNote A

accountNumber A

credit N

balanceType A

dateLastEntry D

debit N

exerciceEnd D

Services web IRF


Service Balances

81

exerciceStart D

exerciceState A

nature A

nbEcrN N

nbNotLettered N

note A

reconcilable A

solde N

state A

Balance par Exercice par Cycle

Ce service permet de récupérer les soldes des comptes regroupés par cycle.

URL : [GET] /company/{database}/balances/exerciceByCycle

Paramètres





Réponse :

Schéma XML :

Services web IRF


Service Balances

82

< WCFRestIRFBalanceExerciceByCycleResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsBalanceExerciceByCycle>

<accountName>SG</accountName>

<accountNote/>



<cycleCode>B-Trés</cycleCode>

<cycleName>Trésorerie</cycleName>







<nbEcrN>42</nbEcrN>


<note/>


<solde>2287.66</solde>

<state/>

</wsBalanceExerciceByCycle>

…

</data>

</ WCFRestIRFBalanceExerciceByCycleResult>



Services web IRF


Service Balances

83

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

Description de l'élément < wsBalanceExerciceByCycle >


accountName A

accountNote A

accountNumber A

credit N

cycleCode A

cycleName A

dateLastEntry D

debit N

exerciceEnd D

exerciceStart D

exerciceState A

nature A

nbEcrN N

nbNotLettered N

note A

reconcilable A

solde N

state A

Services web IRF


Service Balances

84

Balance Analytique

Ce service permet de récupérer les soldes des comptes regroupés par axe analytique.

URL : [GET] /company/{database}/balances/analytical

Paramètres




Database Dossier Alphanumérique Identifiant unique du dossier

Réponse :

Schéma XML :

< WCFRestIRFBalanceAnalyticalResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsBalanceAnalytical>

<accountName>ACHATS MATIERES PREMIERES</accountName>

<code>Tous les axes</code>



<name>Tous les axes</name>


<period>201101</period>

<ref>AC</ref>

<sectionCode>Non affectable</sectionCode>

<sectionName>Non affectable</sectionName>

Services web IRF


Service Balances

85

<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 A

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

Services web IRF


Service Balances

86

subAxis Nom du sous axe

subSection Nom de la sous section

subSubAxis Nom du sous sous axe

subSubSection Nom de la sous sous

section

Balance par Compte

Ce service permet de récupérer les soldes des comptes regroupés par compte.

URL : [GET] /company/{database}/balances/account

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFBalanceAccountsResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsAccountsBalances>

Services web IRF


Service Balances

87

<accountName>SG</accountName>

<accountNature>generaux</accountNature>


<exerciceBalance>2287.66</exerciceBalance>


<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 A

accountNature Nature du compte A

accountNumber Numéro du compte A

exerciceBalance Balance de l'exercice N

exerciceEnd Date de fin d'exercice D

situationBalance Balance de situation N

situationEnd Date de situation D

Services web IRF


Service Analyzes

88

Service Analyzes 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.

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

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

Paramètres





Réponse :

La réponse du mode "simple" contient la liste des analyses du dossier.

Schéma XML :

< WCFRestIRFAnalyzesResult>

<response>



<message></message>

</response>

<data>

Services web IRF


Service Analyzes

89

<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 A

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

l'analyse

analysisName Nom de l'analyse A

software Module N Module auquel s'applique l'analyse

Voir Annexes

ventilationKind Unité de saisie N Unité de saisie des valeurs ventillées

Voir Annexes

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

Schéma XML :

Services web IRF


Service Analyzes

90


<response>



<message></message>

</response>

<data>

<wsAnalyzes>




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



</wsAnalyzes>…

</data>


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



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

identifier l'analyse


Services web IRF


Service Analyzes

91

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

axis1Name Nom axe 1 A Nom de l'axe de niveau 1





Software Module Enum Module auquel s'applique l'analyse

Voir Annexes

ventilationKind Date de situation Enum Unité de saisie des valeurs ventillées

Voir Annexes

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

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

URL : [GET] /company/{database}/analyzes/{analysis}/axes

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

Paramètres





Analysis Analyse UUID Identifiant de l'analyse

Services web IRF


Service Analyzes

92

Réponse :

La réponse contient la liste des axes d'une analyse.

Schéma XML :


<response>



<message></message>

</response>

<data>

<wsAnalyzes>




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



</wsAnalyzes>…

</data>




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

Services web IRF


Service Analyzes

93

Description de l'élément < wsAnalyzes >



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

identifier l'analyse








software Module Enum Module auquel s'applique l'analyse

Voir Annexes

ventilationKind Date de situation Enum Unité de saisie des valeurs

Voir Annexes

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

URL : [GET] /company/{database}/analyzes/{analysis}/sections

Paramètres



Services web IRF


Service Analyzes

94




Réponse :

La réponse contient la liste des sections d'une analyse.

Schéma XML :

< WCFRestIRFSectionsAnalyzesResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsAnalysisSections>


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

Services web IRF


Service Analyzes

95



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 A

Description Description de la section A

closed Fermé E (0/1)

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

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

Paramètres

Services web IRF


Service Analyzes

96






Axe Axe UUID Identifiant de l'axe

Réponse :

La réponse contient la liste des analyses du dossier.

Schéma XML :

< WCFRestIRFSectionsAnalyzesResult>

<response>


<result></result>

<message></message>

</response>

<data>

<wsAnalysisSections>


<analyticalSections>

<analyticalSection>

<closed>0</closed>

<code>11</code>

<description>BANQUE DE DONNEES</description>

<key>0</key>

</analyticalSection>

.../...

</analysisSections>

Services web IRF


Service Analyzes

97

<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 A

Description Description de la section A

closed Fermé E (0/1)

Services web IRF


98

Key Clé % E

Services web IRF


Service Employee

99

Service Employee Récupération de la liste des salariés

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

URL : [GET] /company/{database}/employees

Paramètres





Réponse :

Schéma XML :

<WCFRestIRFEmployeeResult >

<response>


<result></result>

<message></message>

</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>

Services web IRF


Service Employee

100

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

Services web IRF


Service Employee

101

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

Services web IRF


Service Employee

102

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

Services web IRF


Service Employee

103

</wsEmployees>

...

</data>

</ WCFRestIRFEmployeeResult >



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

Description de l'élément < wsEmployees >


employeeID Code interne A 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é A Matricule du salarié. Code à utiliser dans les

requêtes XML pour l'import de variables

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

URL : [GET] /company/{database}/employees/dateref/{dateref}

Paramètres





Services web IRF


Service Employee

104

DateRef Date de référence D 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.

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

URL : [GET] /company/{database}/employees/{employeeID}

Paramètres





EmployeeID Identifiant unique du

salarié

A 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.


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é à une date précise

URL : [GET] /company/{database}/employees/{employeeID}/dateref/{dateref}

Services web IRF


Service Employee

105

Paramètres





EmployeeID Identifiant unique du

salarié

A Correspond à l'information [employeeID] du

service "Employees".

DateRef Date de référence D 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.


Récupération d’indicateurs sur les salariés

Plusieurs APIs permettent de récupérer des données qui permettront de réaliser des tableaux de

bords ou graphiques : Pyramide des âges, Top 10 des rémunérations, Ancienneté, etc. …

Ancienneté des salariés

URL : [GET] /company/{companyID}/employees/seniority/etp

URL : [GET] /company/{companyID}/employees/seniority

Paramètres




Services web IRF


Service Employee

106


La requête est faite en se basant sur les données à la date du jour. Elle permet d’obtenir des

données du salarié avec les taux d’activité en « équivalent temps plein ».

Réponse :

En cas de succès, le résultat contient les données caractéristiques des salariés présents à la date

de référence.

Les données renvoyées sont de type « wsEmployeeSeniority » :

Donnée Libellé Type Explication

salaryTab_activityRate Taux d’activité N Taux d’activité du salarié. Utile dans le cas

d’une requête de type ETP (Equivalent temps

plein)

firstName Prénom A Prénom du salarié

lastName Nom A Nom du salarié

Seniority Ancienneté N Ancienneté du salarié

Identity_sex Sexe A Homme / Femme

Statut Statut du salarié A Statut du salarié (cadre, agent de maitrise, …)

Exemple de retour :

Services web IRF


Service Employee

107

<WCFRestIRFpayEmployeeSeniorityResult


<response>





</response>

<data>

<wsEmployeeSeniority>

<firstName>Guy</firstName>

<identity_sex>Homme</identity_sex>

<lastName>MSA</lastName>

<salaryTab_activityRate>1</salaryTab_activityRate>

<seniority>0</seniority>

<statut>Ouvrier</statut>

</wsEmployeeSeniority>

<wsEmployeeSeniority>

<firstName>Louane</firstName>

<identity_sex>Femme</identity_sex>

<lastName>RAPPEL AUTRE REVENU BRUT</lastName>

<salaryTab_activityRate>1</salaryTab_activityRate>


<statut>Cadre</statut>

</wsEmployeeSeniority>

…/…

</data>

</WCFRestIRFpayEmployeeSeniorityResult>

Il est possible d’appeler ce service avec les paramètres suivants :

- En précisant une date :

/company/{companyID}/employees/seniority/etp/date/{date}

La donnée {date} doit être au format AAAAMMJJ

- En ajoutant des critères de sélection complémentaires

/company/{companyID}/employees/seniority/etp/date/{date}

Entête HTTP IRF-Request : identity_sex="Homme"

Services web IRF


Service Employee

108

/company/{companyID}/employees/seniority/etp

Entête HTTP IRF-Request : salaryTab_activityRate!=1

Les mêmes API sont disponibles pour les temps plein.

- /company/{companyID}/employees/seniority

- /company/{companyID}/employees/seniority/date/{date}

Entête HTTP IRF-Request : identity_sex="Homme"

Entête HTTP IRF-Request : salaryTab_activityRate!=1

Le format de la réponse est le même que pour les requêtes de type ETP.

Informations du salarié

URL : [GET] /company/{companyID}/employees/details

Paramètres





Réponse :


de référence.

Les données renvoyées sont de type « wsEmployeeDetails » :


activityRate Taux d’activité N Taux d’activité du salarié. Utile

dans le cas d’une requête de type

ETP (Equivalent temps plein)

Services web IRF


Service Employee

109

Contract Contrat A Ex : Standard, Stagiaire, Jeunes

Entreprises Innovantes, …

ContractType Type de contrat A CDI, CDD, CDD d’usage

endValidityDate Date de fin de validité D Date de fin de validité de la fiche

salarié

Family Situation de famille A Ex : Marié, Célibataire, …



registryNr Matricule A Matricule du salarié

Salary Salaire N Salaire

SalaryType Type de salaire A Ex : Mensuel brut, Forfait jour, …

Seniority Ancienneté N Ancienneté du salarié

Ssn Numéro de sécurité sociale A Numéro de sécurité sociale

startValidityDate Date de début de validité D Date de début de validité de la fiche

salarié

Statut Statut du salarié A Ex : cadre, agent de maitrise, …

Title Civilité A Homme / Femme

workType Type de travail A Ex : Temps complet

Exemple de retour :

Services web IRF


Service Employee

110

<WCFRestIRFpayEmployeeDetailsResult


<response>





</response>

<data>

<wsEmployeeDetails>

<actitityRate>1</actitityRate>

<contract>Standard</contract>

<contractType>CDI</contractType>

<endValidityDate/>

<family>Pacs</family>

<firstName>Marie</firstName>

<lastName>RAPPEL IJSS</lastName>

<registryNr>RAP000004</registryNr>

<salary>3500</salary>

<salaryType>Forfait jour</salaryType>


<ssn>284016938813411</ssn>

<startValidityDate>2014-10-01</startValidityDate>


<title>Madame</title>

<workType/>

</wsEmployeeDetails>

…/…

</data>

</ WCFRestIRFpayEmployeeDetailsResult>


- En précisant une année :

/company/{companyID}/employees/details/date/{date}


Services web IRF


Service Employee

111

- En ajoutant des critères de sélection complémentaires au travers de l’entête HTTP IRF-

Resquest

Entête HTTP IRF-Request : title="Homme"

Entête HTTP IRF-Request : activityRate!=1

Top 10 des rémunérations

URL : [GET] /company/{companyID}/employees/topTen

Paramètres





Réponse :

En cas de succès, le résultat contient les données caractéristiques des 10 salariés ayant la plus

forte rémunération pour l’année de référence.

Les données renvoyées sont de type « wsTopTen » :





value Salaire annuel brut N Salaire annuel brut pour l’année de référence

Year Année de référence A Année de référence

Services web IRF


Service Employee

112

Exemple de retour :

<WCFRestIRFpayTopTenResult


<response>





</response>

<data>

<wsTopTen>

<firstName>Brice</firstName>

<lastName>URSSAF</lastName>

<registryNr>URS000001</registryNr>

<value>12515.2</value>

<year>2016</year>

</wsTopTen>

<wsTopTen>

<firstName>Marie</firstName>

<lastName>RAPPEL IJSS</lastName>

<registryNr>RAP000004</registryNr>

<value>10907.54</value>

<year>2016</year>

</wsTopTen>

…/…

</data>

</ WCFRestIRFpayTopTenResult>


- En précisant une année :

/company/{companyID}/employees/topten/year/{year}

La donnée {year} doit être au format AAAA

La pyramide des âges

Services web IRF


Service Employee

113

URL : [GET] /company/{companyID}/employees/age/etp (equivalent temps plein)

URL : [GET] /company/{companyID}/employees/age (temps plein)

Paramètres





La requête est faite en se basant sur les données à la date du jour. Elle permet d’obtenir des

données du salarié avec les taux d’activité en « équivalent temps plein ».

Réponse :


de référence.

Les données renvoyées sont de type « wsEmployeeAge » :


activityRate Taux d’activité N Taux d’activité du salarié. Utile dans le cas d’une

requête de type ETP (Equivalent temps plein)

birthdate Date de naissance D Date de naissance du salarié



sex Sexe A Homme / Femme

Statut Statut du salarié A Statut du salarié (cadre, agent de maitrise, …)

Services web IRF


Service Employee

114

Exemple de retour :

< WCFRestIRFpayEmployeeAgeResult


<response>





</response>

<data>

<wsEmployeeAge>

<activityRate>1</activityRate>

<birthdate>1985-08-24</birthdate>

<firstName>Guy</firstName>

<lastName>MSA</lastName>

<sex>Homme</sex>

<statut>Ouvrier</statut>

</wsEmployeeAge>

<wsEmployeeAge>

<activityRate>1</activityRate>

<birthdate>1986-07-13</birthdate>

<firstName>Louane</firstName>

<lastName>RAPPEL AUTRE REVENU BRUT</lastName>

<sex>Femme</sex>


</wsEmployeeAge> …/…

</data>

</WCFRestIRFpayEmployeeAgeResult>


- En précisant une date :

/company/{companyID}/employees/age/etp/date/{date}


- En ajoutant des critères de sélection complémentaires

Services web IRF


Service Employee

115

/company/{companyID}/employees/age/etp/date/{date}

Entête HTTP IRF-Request : sex="Homme"

/company/{companyID}/employees/age/etp


Les mêmes API sont disponibles pour les temps plein.

- /company/{companyID}/employees/age

- /company/{companyID}/employees/age/date/{date}

Entête HTTP IRF-Request : sex="Homme"


Le format de la réponse est le même que pour les requêtes de type ETP.

Les compteurs du bulletin

URL : [GET] /company/{companyID}/employees/payrolls/counters

Paramètres





Réponse :

En cas de succès, le résultat contient les compteurs renseignés pour la période de référence. Par

défaut, la période de référence correspond au mois et à l’année courant.

Les données renvoyées sont de type « wsPayrollCounters » :


Counter Code A Code du compteur

Services web IRF


Service Employee

116

Description Libellé A Libellé de la rubrique

endDate Date fin D Date de fin du bulletin

Exercice Exercice N Exercice comptable de la période ex : 2016


givenDate Date de remise D Date de remise du


payrollNumber Numéro N Numéro du bulletin

Period Période N Période du bulletin ex : 1


startDate Date début D Date de début du

Value Valeur N Valeur du compteur

Exemple de retour :

<WCFRestIRFpayPayrollCountersResult


<response>





</response>

<data>

<wsPayrollCounters>

<counter>cptAbattementBrutBulletin</counter>

<description>Cumul de l'abattement brut du bulletin</description>

<endDate>2016-04-30</endDate>

<exercice>2016</exercice>


Services web IRF


Service Employee

117

<givenDate>2016-04-30</givenDate>


<payrollNumber>3</payrollNumber>

<period>4</period>


<startDate>2016-04-01</startDate>

<value>0</value>

</wsPayrollCounters>

<wsPayrollCounters>

<counter>cptAbattementBrutBulletinPrev</counter>

<description>Cumul de l'abattement brut du bulletin (prév.)</description>

<endDate>2016-04-30</endDate>

<exercice>2016</exercice>


<givenDate>2016-04-30</givenDate>


<payrollNumber>3</payrollNumber>

<period>4</period>


<startDate>2016-04-01</startDate>

<value>0</value>

</wsPayrollCounters>

…/…

</data>

</WCFRestIRFpayPayrollCountersResult>


- En précisant une période :

/company/{companyID}/employees/payrolls/counters/period/{year}/{month}

La donnée {year} doit être au format AAAA et {month} au format MM

- En renseignant une réquête complémentaire :

/company/{companyID}/employees/payrolls/counters/period/{year}/{month}

Entête HTTP IRF-Request : {query}

/company/{companyID}/employees/payrolls/counters

Entête HTTP IRF-Request : {query}

Services web IRF


Service PayVariables

118

Service PayVariables Importation de variables de paie

Ce service permet de créer des variables de paie dans un dossier

URL : [POST] /company/{database}/payvariables

Paramètres






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

suivante :

<wsImportPaieVariables>


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

Services web IRF



119

</startDate>

<endDate>

<date>2013-01-15</date>

<information>am</information>

</endDate>

</payVariable>

<payVariable>

…

</payVariable>

</payVariables>

</wsImportPaieVariables>

Description du noeud "wsImportPaieVariables " :


importDate Date

d'import

D Date de fin de l'exercice de destination

Format YYYY-MM-DD

payVariables Variable XML Liste des variables à intégrer


Cette date correspond à la date de fin de l'exercice dans lequel les variables de paie doivent être

enregistrées.


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).

Services web IRF



120


year Année N Année au format YYYY sur laquelle va

porter l'import

month Mois N 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.


registryNr Matricule du salarié A Identifiant du salarié

rubricID Code rubrique A Code de la rubrique du partenaire

value Valeur A Valeur à appliquer à la rubrique

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

startDate Date de début D Date de début de l'évènement

endDate Date de fin D Date de fin de l'évènement

description Description A Descriptif associé à la rubrique

comment Commentaire A 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.

Services web IRF



121

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 :


Schéma XML :


<response>

<datetime></datetime>

<result></result>

<message></message>

</response>







Services web IRF



122

< WCFRestIRFPaieVariableResult >

<response>



<message>

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

succès.</success>

</message>

</response>

</ WCFRestIRFPaieVariableResult >




etc. ...)

<WCFRestIRFPaieVariableResult >

<response>



<message>message</message>

</response>

</WCFRestIRFPaieVariableResult>

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

< WCFRestIRFPaieVariableResult >

<response>



<message> Invalid request : field importDate missing</message>

</response>

</ WCFRestIRFPaieVariableResult >

Services web IRF



123

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 :


<response>



<message>

<error>

<details>7845-Partner info {BE62697A-C2EE-4757-9A86-

747A656FF0D7} does not exists in the client file

</details>

</error>

</message>

</response>


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

avec une rubrique dans l'application IBIZA/RRH


<response>



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

</response>


Services web IRF


Service Budget

124

Service Budget Récupération des budgets d’un exercice comptable

Ce service permet de récupérer les montants budgétés par comptes et par période pour un

exercice comptable.

Par exemple, si vous demandez le budget du compte 606110 pour la période de septembre 2016

(donc au 30/09/2016), le montant récupéré sera le montant saisi uniquement pour cette période.

Le budget total sur l’exercice et la date de fin d’exercice peuvent aussi être récupérés.

URL : [GET] /company/{database}/budget/period

Requête avec un filtre sur l’exercice, le compte et/ou la période, exemples :


Entête HTTP IRF-Request : starts-with(accountNumber, "601") and starts-with(periodEnd,

"2016")

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFBudgetPeriodResult>

<response>


<result></result>

<message></message>

</response>

Services web IRF


Service Budget

125

<data>

<wsBudgetPeriod>


<accountName>Charges à payer</accountName>

<periodEnd>2016-03-31</periodEnd >

<periodAmount>59.23</periodTotal >


<exerciceTotal>253.68</exerciceTotal>

</ wsBudgetPeriod >

…

</data>

</ WCFRestIRFBudgetPeriodResult >



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

Description de l'élément <wsBudgetPeriod> (“Budget par période”)


accountNumber Numéro du compte N

accountName Intitulé du compte A

periodEnd Date de fin de période D Date de fin du mois de la période

concernée (ou date de fin d’exercice)

periodAmount Montant sur la période N Montant budgeté pour la période

demandée. Les montants créditeurs sont

< 0, les montants débiteurs sont > 0

exerciceEnd Date de fin d’exercice D

Services web IRF


Service Budget

126

exerciceTotal Montant total sur l’exercice N Budget total sur l’exercice, les montants

créditeurs sont < 0, les montants

débiteurs sont > 0

Récupération des budgets cumulés à une période par compte

Ce service permet de récupérer les montants budgétés cumulés par comptes et par période.

Par exemple, sur un exercice civil, si vous demandez le budget cumulé du compte 606110 pour la

période de septembre (donc au 30/09), le montant récupéré sera la somme des périodes de

janvier à septembre inclus.

Le montant total sur l’exercice et la date de fin d’exercice sont systématiquement rappelés.

URL : [GET] /company/{database}/budget/periodCumul

Requête avec un filtre sur l’exercice, le compte et/ou la période :

Entête HTTP IRF-Request : period="2016-06-30"

Entête HTTP IRF-Request : starts-with(accountNumber, "6")

Paramètres





Réponse :

Schéma XML :

< WCFRestIRFBudgetPeriodCumulResult>

<response>


<result></result>

Services web IRF


Service Budget

127

<message></message>

</response>

<data>

<wsBudgetPeriodCumul>


<accountName>Charges à payer</accountName>

<periodEnd>2016-09-30</periodEnd >

<periodAmount>167.23</periodTotal >


<exerciceTotal>253.68</exerciceTotal>

</wsBudgetPeriodCumul>

…

</data>

</ WCFRestIRFBudgetPeriodCumulResult>



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

Description de l'élément <wsBudgetPeriodCumul> (“Budget cumulé par période”)


accountNumber Numéro du compte N

accountName Intitulé du compte A


exerciceTotal Montant total N Budget total sur l’exercice, les montants créditeurs

sont < 0, les montants débiteurs sont > 0

periodAmount Montant cumulé N Budget cumulé du début de l’exercice jusqu’à la

période demandée. Les montants créditeurs sont

< 0, les montants débiteurs sont > 0

Services web IRF


Service Budget

128

periodEnd Date de fin de période D Date de fin du mois de la période concernée (ou

date de fin d’exercice)

Services web IRF


Service Suivi comptable

129

Service Suivi comptable Récupération du suivi comptable pour un exercice

Ce service permet de récupérer les éléments constituant le tableau du suivi comptable par journal

et par période pour un exercice comptable. Les informations récupérées sont :

- Le nombre de mouvements (1 écriture de 3 mouvements retournera 3)

- L’indicateur « Periode terminée »

- L’indicateur « Période vérifiée »

Seuls les journaux non fermés sont récupérés.

URL : [GET] /company/{database}/accountingFollowup

Requête avec un filtre sur la date de fin d’exercice :

Entête HTTP IRF-Request : starts-with(exerciceEnd, "2016")


Paramètres





Réponse :

Schéma XML :

< WCFRestIRFAccountingFollowupResult>

<response>


<result></result>

<message></message>

</response>

Services web IRF



130

<data>

<wsAccountingFollowup>

<journalRef>AC</ journalRef >

<journalDescription>Achats</ journalDescription>

<periodCode>201603</periodCode>

<periodIndex>12</periodIndex>

<periodEnd>2016-03-31</periodEnd>

<nbEntries>34</nbEntries>

<isFilled>1</isFilled>

<isAudited>0</isAudited>


</wsAccountingFollowup>

…

</data>

</ WCFRestIRFAccountingFollowupResult >



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

Description de l'élément <wsAccountingFollowup>


journalRef Code du journal A

journalDescription Intitulé du journal A

periodCode Code de la période N AAAAMM

periodIndex Index de la période E

periodEnd Date de fin de la période D

nbEntries Nombre de mouvements E

Services web IRF



131

isFilled Période terminée E (0/1) "0" : non / "1" : oui

isAudited Période vérifiée E (0/1) "0" : non / "1" : oui


Services web IRF


Service Relevés bancaires

132

Service Relevés bancaires Imports de relevés bancaires

Format CFONB

Ce service permet d’importer dans un dossier des lignes de relevés bancaires.

C

L’import de lignes de relevés bancaires au format CFONB se base sur l’existance

dans le paramatrage du dossier de relevés bancaires définis sur des comptes

de banques disposant d’un RIB.

URL : [POST] /company/{database}/BankStatement/ImportCfonb

Paramètres






Le flux à envoyer au service d'importation de lignes de relevés bancaires doit être structuré de la

façon suivante :

< importBankStatementRequest>

<externalIdentifier> </externalIdentifier>

<wsImportCfonb>

Flux base 64

</wsImportCfonb>

</ importBankStatementRequest>

Description du noeud " importBankStatementRequest" :

Services web IRF



133


externalIdentifier Identifiant externe UUID Permet d’identifier le flux dans le

système qui envoit le flux.

wsImportCfonb Lignes de relevés Base64 Flux CFONB des lignes de relevés

bancaires à importer encodé en

base 64

Description de l'élément <wsImportCfonb>

Le flux à importer doit respecter la norme CFONB pour les relevés bancaires qui structure les

données à traiter.

A

Lors de l’import de lignes de relevés banciares, un test un effectué sur la

présence de doublons entre les données à importer et les lignes déjà importées

dans le dossier.

Si un doublon est détecté, la ligne correspondante dans le flux à importer est

ignorée.

Réponse :

Résultat de l'importation des lignes de relevés bancaires

Schéma XML :

< WCFRestIRFBankStatementResult>

<response>


<result></result>

<message></message>

</response>

</ WCFRestIRFBankStatementResult>

Services web IRF



134






<WCFRestIRFBankStatementResult xmlns:i="http://www.w3.org/2001/XMLSchema-

instance">

<response>


<message>

<success>

<externalIdentifier> <externalIdentifier>

<reports>

<report>

<rib>139511202583002900000</rib>

<lines>59</lines>

<import>59</import>

</report>

</reports>

</success>

</message>



</response>

</WCFRestIRFBankStatementResult>

La partie "message" présente le détails de la réponse.

Description de l'élément < message >


externalIdentifier Identifiant externe UUID Fait référence à l’identifiant externe

passé par l’émletteur du message

Services web IRF



135

reports Rapport d’exécution de

l’import

XML Liste des résultats des imports par RIB

Description de l'élément < reports >


report Rapport d’exécution de l’import XML Pour chaque RIB traité, détails des

résultats.

Description de l'élément < report >

Structure XML qui restitue le rapport d’import des lignes de relevé pour un RIB


rib Numéro du RIB A Numéro du RIB

lines Nombre de lignes à traiter N Lignes du flux à importer

import Nombre de lignes importées N Nombre de lignes correctement importées

dans le dossier

fail Nombre de lignes en échec N Si des erreurs sont rencontrées, nombre de

lignes en Echec

reason Description A Si des echec(s) sont rencontrés lors de

l’import, cette zone contient le détails des

résultats, sous la forme d’une chaîne de

caractères présentant les résultats pour

chaque ligne traitée. Chaque résultat est

séparé par un point-virgule ( ; )

Cas de traitement retournant une erreur :

Services web IRF



136

Si l’iditifant externe est vide ou absent du message, l’erreur suivante est retournée :


instance">

<response>


<message>

<error>

<details>102-Error during server processing : Parameter externalIdentifier is

missing</details>

</error>

</message>



</response>


Dans le cas où le(s) RIB(s) référencé(s) dans le flux à importer ne sont pas trouvés dans les

paramétrages du dossier le résultat suivant est retourné. Cette une réponse indiquant que le

traitement s’est effectué avec succès,


instance">

<response>


<message>

<error>

<externalIdentifier> </externalIdentifier>

<reports>

<reports>

<report>

<rib>139511202583002900000</rib>

<lines>59</lines>

<import>0</import>

<fail>59</fail>

<reason>Rib introuvable</reason>

Services web IRF



137

</report>

</reports>

</reports>

</error>

</message>



</response>


Cas de dates non cohérentes entre les dates d’exercice du dossier et les dates des lignes de relevé

à importer


instance">

<response>


<message>


<error>

<reports>

<report>

<rib>139511202583002900000</rib>

<lines>59</lines>

<import>0</import>

<fail>59</fail>

<reason>hors exercice;hors exercice;hors exercice;hors exercice;hors

exercice;hors exercice;hors exercice;hors exercice;hors exercice;hors exercice;hors








Services web IRF



138


exercice;</reason>

</report>

</reports>

</error>

</message>



</response>


Exemple d’un flux avec une seule ligne contenant une date hors exercice :


instance">

<response>


<message>


<error>

<reports>

<report>

<rib>139511202583002900000</rib>

<lines>59</lines>

<import>58</import>

<fail>1</fail>

<reason>;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;hors exercice;;;;;;;;;;;;;;;;;;;;;;;</reason>

</report>

</reports>

</error>

</message>



</response>


Services web IRF


Service DP

139

Service DP Récupération des informations générales du DP

Ce service permet de récupérer les informations générales liées au DP :

- Informations générales

- Paramètres juridiques

- Informations légales

- Liste des établissmeents

- Chiffre d’affaire, effectifs

URL : [GET] /company/{database}/DP

Paramètres





Réponse :

Schéma XML :

<WCFRestIRFDPResult>

<response>


<message/>


</response>

<data>

<compCrmParameters>

<salesRevenue/>

<workforce/>

Services web IRF


Service DP

140

</compCrmParameters>

<identity>

<firstName/>

<lastName/>

<title/>

</identity>

<juridicalParameters>

<actionNumber/>

<activityStartDate/>

<capital/>

<creationDate/>

<duration/>

</juridicalParameters>

<legal>

<area/>

<building/>

<country>

<ISOcode>FR</ISOcode>

</country>

<postCode/>

<street/>

<town/>

</legal>

<branches>

<branch>

<branchType>0</branchType>

<usageName>MONTZAKIT</usageName>

</branch>

</branches>

<legalName>MONTZAKIT</legalName>

<SIREN/>

<webSite/>

<businessType>3</businessType>

<commercialQuality>1</commercialQuality>

<monoBranch>1</monoBranch>

<personType>0</personType>

</data>

Services web IRF


Service DP

141

</WCFRestIRFDPResult>




compCrmPArameters CRM XML Informations liées à l’activité

identity Gérant XML Identité du gérant

juridicalParameters Informations juridiques XML

legal Adresse de l’entreprise XML

branches Etablissements XML Liste des établissements

legalName Rasion sociale A

SIREN Code SIREN A

webSite Site web A

businessType Forme juridique Enum Voir Annexes

commercialQuality Qualité commerciale E (0/1) 1 : Oui / 0 : Non

monoBranch Société mono étab. E (0/1) 1 : Mono-établissement

personType Personnalité juridique Enum Voir Annexes

La réponse est constituée d’une liste d’informations organisées par types. Chaque type est décrit

dans les tableaux ci-dessous.

Description de l'élément < compCrmParameters >


Services web IRF


Service DP

142

salesRevenue N Chiffre d’affaires

workforce E Effectifs de l’entreprise

Description de l'élément < identity >


firstName A Prénom du gérant

lastName A Nom patrimonial du gérant

Title A Fonction

Description de l'élément < juridicalParameters >


actionNumber Nombre d’actions N Nombre d’actions / parts de la société

activityStartDate Début d’activité D Date de début d’activité

capital Capital N Montant du capital

creationDate Date de création D Date de création

duration Durée N Durée en années

Description de l'élément < legal >


area Commune A

building Immeuble A

country Pays XML Code ISO du pays

Services web IRF


Service DP

143

postCode Code postal N

street Rue A

town Ville A

Description de l'élément < branch >


branchType Type d’établissement Enum Voir Annexes

codeNAF Code NAF XML Code et libellé du code NAF

nic Code NIC A

usageName Nom d’usage A

Récupération des informations liées aux associés

Ce service permet de récupérer les informations liées aux associés, personnes physiques et

personnes morales.

URL : [GET] /company/{database}/DP/Associates

Paramètres





Réponse :

Schéma XML :

Services web IRF


Service DP

144

<WCFRestIRFDPAssociatesResult >

<response>


<message/>

<datetime>AAAA-MM-JJTHH:mm:ss.nnnnnnn+02:00</datetime>

</response>

<data >

<wsDPJuridicalAssociatesView>

<dateEntry/>

<dateLeave/>

<formJurid> </formJurid>

<name> </name>

<nameComplement> </nameComplement>

<siren></siren>

<address_building/>

<address_street> </address_street>

<address_area/>

<address_postCode></address_postCode>

<address_town> </address_town>

<address_country/>

<nbParts></nbParts>

<pourcDet></pourcDet>


<exerciceEnd></exerciceEnd>

</wsDPJuridicalAssociatesView>

<wsDPJuridicalAssociatesView>

<dateEntry/>

<dateLeave/>

<title></title>

<birthName> </birthName>

<lastName> </lastName>

<firstName> </firstName>

<birthDate></birthDate>

<birthDepartement></birthDepartement>

<birthTown/>

Services web IRF


Service DP

145

<birthCountry/>

<address_building/>

<address_street></address_street>

<address_area/>

<address_postCode></address_postCode>

<address_town> </address_town>

<address_country/>

<nbParts></nbParts>

<pourcDet></pourcDet>


<exerciceEnd></exerciceEnd>


…/…


</data>

</WCFRestIRFDPAssociatesResult>



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

>)

Description de l'élément < wsDPJuridicalAssociatesView >


Services web IRF


Service DP

146

Services web IRF


ANNEXES

147

ANNEXES Enumérations

Etats d’un exercice comptable

Description du code State :

Valeur Libellé

0 Exercice précédent ouvert

1 Dernier exercice ouvert

2 Exercice clos

Formes juridiques

Description du code BusinessType :

Valeur Libellé

0 Autres

1 EURL

2 SNC

3 SARL

4 SA

5 SAS

6 SCI

8 SCM

9 GIE

Services web IRF


ANNEXES

148

10 SCP

11 ASS

12 SC

13 SCPI

14 SCA

15 SCS

16 CUMA

17 EARL

18 Entreprise individuelle

19 GAEC

20 GFA

21 GFR

22 Groupement forestier

23 Indivision

24 Société civile d'exploitation agricole

25 SELARL

26 Société Civile

27 Société de fait

28 Société de participation

29 SASU

30 Comité d'entreprise

31 Coopérative

Services web IRF


ANNEXES

149

32 GEIE

33 Mutuelle

34 Société civile d'exploitation vinicole

35 Société d'économie mixte

36 Société civile holding

37 Personne morale de droit étranger

Régimes d’imposition

Description du code TaxationRegime :

Valeur Libellé

0 Impôt société

1 Impôt revenu

2 Mixité IS IR - Société Commandite Simple

99 Non soumis

Catégories de comptes

Description du code Category :

Valeur Libellé

1 Clients

2 Fournisseurs

4 Associés

5 Caisses

Services web IRF


ANNEXES

150

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

Types de journaux

Description du code Type :

Valeur Libellé

5 Caisse

6 Banque

7 Achats

8 Ventes

9 Général

10 A nouveau

11 Reprise

12 Situation

Status de paiement

Description du code PaymentStatus :

Services web IRF


ANNEXES

151

Valeur Libellé

0 Aucun

1 Bon à payer

2 Bloqué

3 Payé

Codes ISO des unités liées aux quantités

Description du code unit :

Valeur 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

Services web IRF


ANNEXES

152

HLT HECTOLITRE

HMT HECTOMETRE

HOR HORAIRES

K6 KILOLITRE

KGM Kilogramme

LTR Litre

MLT MILILITRE

MMT MILIMETRE

MTR METRE

TNE TONNE

Codes BIC des méthodes de paiement

Description du code paymentMethod :

Valeur Libellé

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

Services web IRF


ANNEXES

153

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

Services web IRF


ANNEXES

154

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

Services web IRF


ANNEXES

155

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

Services web IRF


ANNEXES

156

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

Modules

Description des valeurs de Software :

Code Libellé

0 Comptabilité

1 Comptabilité et Paie

2 Paie

Unités de saisie (ventilations analytiques)

Services web IRF


ANNEXES

157

Description du code VentilationKind :

Code Libellé

0 Pourcentage

1 Montant

2 Unité

Personnalités juridiques

Description du code PersonType :

Code Libellé

0 Personne morale

1 Personne physique

Types d’établissements

Description du code BranchType :

Code Libellé

0 Principal et siège social

1 Principal

2 Siège social

3 Secondaire

4 Pseudo établissement

Documents

Services web IRF - compta.inexweb.fr · RECUPERATION DES BUDGETS D’UN EXERCICE COMPTABLE ... 16/04/2013 Ajout du service ImportEntries EP 04/04/2013 Ajout du service Journal EP