Table des matières
  Comment ça marche? Trucs & astuces |
|
| Produit | Accountix |
|---|---|
| Projet | Webservice |
| Mot clé | ACX WS |
| Statut |  |
Rédacteur(s)
- Création : — Yassine 11/09/2015 15:42
- ajout Human Text - specification : — Jean Christophe Dewalque 13/11/2015 11:06
Description
Informations relatives aux comptes
Object
{
"id": "AC_GCF",
"$schema": "http://json-schema.org/schema#",
"title": "Comptes",
"type": "object",
"properties": {
"Id": {
"title": "Compte",
"type": "string"
},
"Label": {
"title": "Désignation",
"type": "string"
},
"LabelSearch": {
"title": "Désignation",
"type": "string"
},
"Category": {
"title": "Catégorie",
"type": "object",
"properties": {
"Id": {
"title": "Catégorie",
"type": "string",
"enum": ["1", "2", "3", "4", "5", "6", "7", "9", "10"]
},
"Label": {
"title": "Catégorie",
"type": "string",
"enum": ["Bilan", "Investissement", "Financier", "Clients", "Fournisseur", "Charges", "Produits", "TVA", "Auxilliaires"]
}
}
},
"Group": {
"title": "Groupe",
"type": "string"
},
"Devise": {
"title": "Devise",
"type": "string"
},
"HasCumul": {
"title": "Flag Si Utilise Dans Fac.Cum",
"type": "string"
},
"Financial": {
"id": "AC_GCF_FIN",
"title": "Comptes Financiers",
"type": "object",
"properties": {
"FinJnl": {
"title": "Journal",
"type": "array"
},
"FinBankAccount": {
"title": "Compte Bancaire",
"type": "string"
},
"FinBankSwift": {
"title": "Swift",
"type": "string"
}
},
"required": ["FinJnl"]
},
"Tiers": {
"id": "AC_TIE",
"title": "Tiers (clients/fournisseur)",
"type": "object",
"properties": {
"Title": {
"title": "St/Titre",
"type": "string"
},
"AdressRue": {
"title": "Rue",
"type": "string"
},
"AdressRue2": {
"title": "Rue 2",
"type": "string"
},
"AdressNum": {
"title": "No",
"type": "string"
},
"AdressLand": {
"title": "Pays",
"type": "string"
},
"AdressPostCode": {
"title": "Code Postal",
"type": "string"
},
"AdressLocality": {
"title": "Localité",
"type": "string"
},
"Language": {
"title": "Langue",
"type": "string"
},
"TvaLand": {
"title": "Pays TVA",
"type": "string"
},
"TvaIdentification": {
"title": "No TVA",
"type": "string"
},
"Bank": {
"title": "Compte Bancaire",
"type": "array",
"properties": {
"Account": {
"title": "Compte Bancaire",
"type": "string"
},
"Swift": {
"title": "Swift",
"type": "string"
}
}
},
"Customer": {
"id": "AC_TIE_CLI",
"title": "Tiers clients",
"type": "object",
"properties": {
"CustPaymentTime": {
"id": "AC_DEL",
"title": "Délai de paiement",
"type": "object",
"properties": {
"Code": {
"title": "Délai",
"type": "string"
},
"Label": {
"title": "Libellé",
"type": "string"
}
},
"required": ["Code"]
},
"CustPaymentMode": {
"title": "Mode Paiement",
"type": "object",
"properties": {
"Id": {
"title": "Mode Paiement",
"type": "string",
"enum": ["1", "2", "3", "4", "5", "6", "7", "8", "9", "F", "M", "L", "U", "VI", "CR", "BO"]
},
"Label": {
"title": "Mode Paiement",
"type": "string",
"enum": ["Assurance crédit", "Chèque", "Espèce", "Traite", "Virement", "Prélèvement", "T.I.P", "Domiciliation", "Carte de crédit", "Factoring", "Paiement Manuel", "Lettre de crédit", "Remise documentaire", "Virement Internationaux", "Contre-Remboursement", "Billet à Ordre"]
}
}
}
}
},
"Supplier": {
"id": "AC_TIE_FOU",
"title": "Tiers Fournisseurs",
"type": "object",
"properties": {
"FouPayementTime": {
"id": "AC_DEL",
"title": "Délai de paiement",
"type": "object",
"properties": {
"Code": {
"title": "Délai",
"type": "string"
},
"Label": {
"title": "Libellé",
"type": "string"
}
},
"required": ["Code"]
},
"FouPayementMode": {
"title": "Mode Paiement",
"type": "object",
"properties": {
"Id": {
"title": "Mode Paiement",
"type": "string",
"enum": ["1", "2", "3", "4", "5", "6", "7", "8", "9", "F", "M", "L", "U", "VI", "CR", "BO"]
},
"Label": {
"title": "Mode Paiement",
"type": "string",
"enum": ["Assurance crédit", "Chèque", "Espèce", "Traite", "Virement", "Prélèvement", "T.I.P", "Domiciliation", "Carte de crédit", "Factoring", "Paiement Manuel", "Lettre de crédit", "Remise documentaire", "Virement Internationaux", "Contre-Remboursement", "Billet à Ordre"]
}
}
}
}
},
"Auxiliary": {
"id": "AC_TIE_AUX",
"title": "Tiers Auxiliaires",
"type": "object",
"properties": {
"Centralisateur": {
"title": "Central.",
"type": "string"
}
}
}
}
},
"AccountMaster": {
"title": "Centralisateur",
"type": "boolean"
},
"CurrencyManagement": {
"title": "Devise Gestion",
"type": "array"
},
"Master": {
"title": "Central.",
"type": "string"
}
},
"required": ["Id", "Label", "Category.Id", "Devise"]
}
Links
{
"links": [
{
"description": "liste des comptes",
"rel": "instances",
"method": "GET",
"href": "gcf-obj"
},
{
"description": "Comptes",
"rel": "describedBy",
"method": "OPTIONS",
"href": "gcf"
},
{
"description": "Comptes",
"rel": "create",
"method": "POST",
"href": "gcf"
},
{
"description": "Comptes",
"rel": "update",
"method": "PUT",
"href": "gcf"
},
{
"description": "détail d'un compte",
"rel": "instances",
"method": "GET",
"href": "gcf/{rflid}"
}
]
}
Human Text - specification
: commentaire sur NEW- Objet RFL : AC_GCF
| champs json | pos ext | champs Accountix Fichier FAC.GCF | libellé | format | sous objet RFL | Obligatoire | MTH HTTP CRUD | Commentaire |
|---|---|---|---|---|---|---|---|---|
| Id | 2 | GLB.GCF.CODE | Compte/Tiers | Texte | Y/N | RUD | Obligatoire si update | |
| Label | 3 | GCF.LIB | Désignation | Texte | Y | R | ||
| Category.Id | 4 | GCF.CAT | Catégorie | Texte | Y | CRU | ||
| Category.Label | 200 | GCF.CAT | Catégorie Lib | Texte | N | R | ||
| Group | 5 | GLB.GRP.CODE | Groupe | Texte | N | CRU | ||
| Devise | 6 | GLB.DEV.CODE | Devise | Texte | Y | CRU | ||
| Financial | GLB.GCF.CODE | Information Financier | Objet | AC_GCF_FIN | Y | CRU | Uniquement pour Category.Id = 3 (Financier) | |
| → FinJnl [] | 12 | GCF.JNL.CODE | Journal | Texte | Y | CRU | ||
| → FinBankAccount | 13 | GLB.SWI.CPT | Compte Bancaire | Texte | N | CRU | ||
| → FinBankSwift | 11 | GLB.SWI.CODE | Swift | Texte | N | CRU | ||
| champs Accountix Fichier FAC.TIE | ||||||||
| Tiers | GLB.GCF.CODE | Information Tiers | Objet | AC_TIE | Y | CRU | Uniquement pour Category.Id : - 3 : financier - 4 : client - 5 : fournisseur - 10 : Auxiliaire |
|
| → Title | 30 | TIE.TIT | St/Titre | Texte | N | CRU | ||
| → ContactName | 31 | TIE.CON | Nom du contact | Texte | N | CRU | ||
| → Name | 80 | TIE.SOC.NOM | Nom contact | Texte | N | CRU | ||
| → Firstname | 81 | TIE.SOC.PRE | Prénom contact | Texte | N | CRU | ||
| → AdressRue | 32 | TIE.ADR1 | Rue | Texte | N | CRU | ||
| → AdressRue2 | 33 | TIE.ADR2 | Rue 2 | Texte | N | CRU | ||
| → AdressNum | 34 | TIE.NO | No | Texte | N | CRU | ||
| → AdressLand | 35 | GLB.PAY.CODE | Pays | Texte | N | CRU | ||
| → AdressPostCode | 36 | GLB.CPL.CODE | Code Postal | Texte | N | CRU | ||
| → AdressLocality | 37 | TIE.LOC | Localité | Texte | N | CRU | ||
| → TvaLand | 39 | TIE.PAY.TVA | Pays TVA | Texte | N | CRU | ||
| → TvaIdentification | 72 | TIE.NTVA | No TVA | Texte | N | CRU | ||
| → Bank.Account [] | 56 | GLB.SWI.CPT | Compte Bancaire | Texte | N | CRU | ||
| → Bank.Swift [] | 55 | GLB.SWI.CODE | Swift | Texte | N | CRU | ||
| → Communication[].Type | 42 | 14.M GLB.TYP.TEL | Type de communication | Texte | N | CRU | Type de service : - 1 : Téléphone - 2 : Fax - 3 : Email. Il est possible d’avoir plusieurs types de communication |
|
| → Communication[].value | 46 | 18.M TIE.S.TEL | valeur du type de communication | Texte | N | CRU | ||
| → Customer | GLB.TIE.CODE | Texte | Objet | AC_TIE_CLI | Y | CRU | Uniquement pour Category.Id = 4 (Client) | |
| → → CustPaymentTime | GLB.DEL.CODE | Délai | Objet | AC_DEL | N | CRU | ||
| → → → Code | 41 | GLB.DEL.CODE | Délai | Texte | N | CRU | ||
| → → → Label | 202 | DEL.LIB | Libellé | Texte | N | R | ||
| → → CustPaymentMode.Id | 64 | TIE.TYP.PAIE | Mode Paiement | Texte | N | CRU | ||
| → → CustPaymentMode.Label | 201 | TIE.TYP.PAIE.LIB | Mode Paiement | Texte | N | R | ||
| → Supplier | GLB.TIE.CODE | Texte | Objet | AC_TIE_FOU | Y | CRU | Uniquement pour Category.Id = 5 (Fournisseur) | |
| → → FouPayementTime | GLB.DEL.CODE | Délai | Objet | AC_DEL | N | CRU | ||
| → → → Code | 41 | GLB.DEL.CODE | Délai | Texte | N | CRU | ||
| → → → Label | 202 | DEL.LIB | Libellé | Texte | N | R | ||
| → → FouPayementMode.Id | 64 | TIE.TYP.PAIE | Mode Paiement | Texte | N | CRU | ||
| → → FouPayementMode.Label | 201 | TIE.TYP.PAIE.LIB | Mode Paiement | Texte | N | R | ||
| → Auxiliary | GLB.TIE.CODE | Texte | Objet | AC_TIE_AUX | Y | CRU | Uniquement pour Category.Id = 10 (Auxiliaire) | |
| → → Centralisateur | 7 | TIE.CENTRA | Central. | Texte | N | CRU | ||
| → AccountMaster | 7 | GCF.CENTRA | Centralisateur | Boolean | N | CRU | ||
| → CurrencyManagement [] | 8 | GCF.DEV.GES | Devises de gestion | Texte | N | CRU | ||
ReturnValues
| Response code | Response Header | Body |
|---|---|---|
| Content-Type: application/json |
Example request
Request
- Obtenir tous les gcf sans détail de chacune : GET http://masterdev/accountix/gcf-obj
Response
[
{
"Id": "6403000",
"Label": "Taxes diverses10",
"Category": {
"Id": "6",
"Label": "Charges"
},
"Group": "640",
"Devise": "EUR",
"HasCumul": "0",
"AccountMaster": false,
"CurrencyManagement": [
"EUR"
],
"Master": ""
},
{
"Id": "C707",
"Label": "Dupont XXX",
"Category": {
"Id": "4",
"Label": "Clients"
},
"Group": "",
"Devise": "EUR",
"HasCumul": "1",
"AccountMaster": false,
"CurrencyManagement": [
"EUR"
],
"Master": "4000000"
},
...
Request
- Un seul gcf: GET http://masterdev/accountix/gcf/2722000
Response
[
{
"Id": "2722000",
"Label": "Bons",
"Category": {
"Id": "1",
"Label": "Bilan"
},
"Group": "",
"Devise": "EUR"
}
]
Request
- Les comptes dont la catégorie est différent de 3 : GET http://masterdev/accountix/gcf?WITH=Category.Id%7C%23%7C3
- Remarque : %7C représente des doubles quotes (“). %23 représente un ”#“
Response
[
{
"Id": "2722000",
"Label": "Bons",
"Category": {
"Id": "1",
"Label": "Bilan"
},
"Group": "",
"Devise": "EUR"
},
{
"Id": "6710000",
"Label": "CHARGES EXCEPTIONNELLES SUR OPERATIONS DE GESTION",
"Category": {
"Id": "6",
"Label": "Charges"
},
"Group": "67",
"Devise": "EUR"
},
{
"Id": "4683100",
"Label": "INTERETS NON ECHUS / TIER",
"Category": {
"Id": "1",
"Label": "Bilan"
},
"Group": "",
"Devise": "EUR"
},
{
"Id": "6378000",
"Label": "TAXES DIVERSES",
"Category": {
"Id": "6",
"Label": "Charges"
},
"Group": "63",
"Devise": "EUR"
},
...
Request
- Création d'un client (Exemple TD1969)
Xml raw
[
{
"Id": "TD1969",
"Label": "Thierry Dacremont",
"Category": {
"Id": "4",
"Label": "Clients"
},
"Group": "MM",
"Devise": "EUR",
"Tiers": {
"Title": "Restaurant chez TD",
"AdressRue": "rue Prince Henri",
"AdressRue2": "",
"AdressNum": "15",
"AdressLand": "LU",
"AdressPostCode": "8087",
"AdressLocality": "KELHEN",
"Language": "FR",
"TvaLand": "",
"TvaIdentification": "",
"Bank": [
{
"Account": "",
"Swift": ""
}
],
"Customer": {
"CustPaymentTime": {
"Code": "30DF",
"Label": "30 JOURS DATE FACTURE"
},
"CustPaymentMode": {
"Id": "F",
"Label": "Factoring"
}
}
}
}
]
Response
Opération réalisée avec succès
Request
- Mise à jour d'un compte existant (exemple : changement du libellé du compte 2722000)
Xml raw
[
{
"Id": "2722000",
"Label": "Bons TD",
"Category": {
"Id": "1",
"Label": "Bilan"
},
"Group": "",
"Devise": "EUR"
}
]
Response
Opération réalisée avec succès
