Table des matières
  Comment ça marche? Trucs & astuces |
|
| Produit | Accountix |
|---|---|
| Projet | Webservice |
| Mot clé | ACX WS |
| Statut |  |
Rédacteur(s)
— Yassine 11/09/2015 15:48
Description
Définitions des informations relatives à un document
Object
{"id": "ACC_DCO","$schema": "http://json-schema.org/schema#","title": "Document commerciaux","type": "object","properties": {"Id": {"title": "No Id","type": "string"},"PieceNumber": {"title": "No Piece","type": "string"},"Tiers": {"title": "Tiers","type": "string"},"AccountingPlan": {"title": "Journal","type": "string"},"Period": {"title": "Période","type": "number"},"Date": {"title": "Date","type": "string","format": "date"},"DateDeadline": {"title": "Date Echeance","type": "string","format": "date"},"Reference": {"title": "Référence","type": "string"},"Object": {"title": "Objet","type": "string"},"Devise": {"title": "Devise","type": "string"},"TotalTtcDevise": {"title": "Montant TTC","type": "number"},"TotalTtcCapital": {"title": "Montant TTC Capital","type": "number"},"RecordType": {"title": "Type enreg.","type": "string"},"Parity": {"title": "Parite","type": "number"},"Imputation":{"title": "Compte Imputation","type": "array","properties": {"Account": {"title": "Compte Imputation","type": "string"},"Object": {"title": "Objet Imputation","type": "string"},"BaseDocDev": {"title": "Base Tva Devise","type": "number"},"BaseCapDev": {"title": "Base Tva Devise Capital","type": "number","SHOW_IN_TABLE": false},"TvaCode": {"title": "Code TVA","type": "string"},"AmountDocDev": {"title": "Montant Tva Devise","type": "number"},"AmountCapDev": {"title": "Montant Tva Devise capital","type": "number","SHOW_IN_TABLE": false}}},"DocumentLettre": {"title": "Document Lettré","type": "number"},"Etat": {"title": "Etat","type": "string"},"PathDoc": {"title": "Path du Document","type": "string"}},"required": ["Id","Tiers","AccountingPlan","Period","Date","Devise","TotalTtcDevise","Imputation.Account","Imputation.BaseDocDev","Imputation.BaseCapDev","Imputation.TvaCode","Imputation.AmountDocDev","Imputation.AmountCapDev"]}
Object AC_DCO_ANA
{"id": "AC_DCO_ANA","$schema": "http://json-schema.org/schema#","title": "Document commerciaux avec Analytique","type": "object","properties": {"Id": {"title": "No Id","type": "string"},"PieceNumber": {"title": "No Piece","type": "string"},"Tiers": {"title": "Tiers","type": "string"},"AccountingPlan": {"title": "Journal","type": "string"},"Period": {"title": "Période","type": "number"},"Date": {"title": "Date","type": "string","format": "date"},"DateDeadline": {"title": "Date Echeance","type": "string","format": "date"},"Reference": {"title": "Référence","type": "string"},"Object": {"title": "Objet","type": "string"},"Devise": {"title": "Devise","type": "string"},"TotalTtcDevise": {"title": "Montant TTC","type": "number"},"TotalTtcCapital": {"title": "Montant TTC Capital","type": "number"},"RecordType": {"title": "Type enreg.","type": "string"},"Parity": {"title": "Parite","type": "number"},"Imputation":{"title": "Compte Imputation","type": "array","properties": {"Account": {"title": "Compte Imputation","type": "string"},"Object": {"title": "Objet Imputation","type": "string"},"BaseDocDev": {"title": "Base Tva Devise","type": "number"},"BaseCapDev": {"title": "Base Tva Devise Capital","type": "number"},"TvaCode": {"title": "Code TVA","type": "string"},"AmountDocDev": {"title": "Montant Tva Devise","type": "number"},"AmountCapDev": {"title": "Montant Tva Devise capital","type": "number"},"Analytic":{"title": "Analytique","type": "object","properties": {"Code": {"title": "Analytique","type": "string"},"Affect": {"title": "Affectation","type": "string"},"Cost": {"title": "Costcenter/Répart.","type": "string"},"Subd": {"title": "Subdivision","type": "string"},"Amount": {"title": "Montant","type": "number"},"Qte": {"title": "Quantité","type": "number"},"Cond": {"title": "Conditionnement","type": "string"},"Comment": {"title": "Commentaire","type": "string"}}}}},"DocumentLettre": {"title": "Document Lettré","type": "number"}},"required": ["Id","Tiers","AccountingPlan","Period","Date","Devise","TotalTtcDevise","Imputation.Account","Imputation.BaseDocDev","Imputation.BaseCapDev","Imputation.TvaCode","Imputation.AmountDocDev","Imputation.AmountCapDev","Imputation.Analytic.Code"]}
Links
Human Text - specification
ReturnValues
| Response code | Response Header | Body |
|---|---|---|
| Content-Type: application/json |
Lecture d'un DCO
Request
- GET /dco/3%2323%23%23VEN%23245
- Retourne les infos du document 3#23##VEN#245
Response
[
{
"Id": "3#23##VEN#245",
"PieceNumber": "245",
"Tiers": "NM",
"AccountingPlan": "VEN",
"Period": 9,
"Date": "01/09/2014",
"DateDeadline": "01/09/2014",
"Reference": "Ref 1",
"Object": "Facture",
"Devise": "USD",
"TotalTtcDevise": 1500,
"TotalTtcCapital": 1230,
"RecordType": "2",
"Parity": 0.82,
"Imputation": [
{
"Account": "7060000",
"Object": "NM Ref 1",
"BaseDocDev": 1000,
"BaseCapDev": 820,
"TvaCode": "V15",
"AmountDocDev": 150,
"AmountCapDev": 123
},
{
"Account": "7070000",
"Object": "NM Ref 1",
"BaseDocDev": 304.35,
"BaseCapDev": 249.57,
"TvaCode": "V15",
"AmountDocDev": 45.65,
"AmountCapDev": 37.43
}
],
"DocumentLettre": 0
"EtatDoc" : "E"
"PathDoc" : "\\192.168.0.2\dos\xxxxx.pdf"
}
]
Création d'un DCO
Request
- Création d'un nouveau document (NEW)
- En retour, on obtient le numéro de document créé (dans l'exemple le document 3#24##VEN#146)
- POST /dco
JSON raw
[
{
"Id": "NEW",
"PieceNumber": "NEW",
"Tiers": "SCHOUN",
"AccountingPlan": "VEN",
"Period": 6,
"Date": "16/06/2015",
"DateDeadline": "16/07/2015",
"Reference": "Facture 134/SCHOUN",
"Object": "Facture 134/SCHOUN",
"Devise": "EUR",
"TotalTtcDevise": 10,
"TotalTtcCapital": 10,
"RecordType": "1",
"Parity": 1,
"Imputation": [
{
"Account": "7020000",
"Object": "Facture 134/SCHOUN",
"BaseDocDev": 12.33,
"BaseCapDev": 12.33,
"TvaCode": "VI15",
"AmountDocDev": 0,
"AmountCapDev": 0
},
{
"Account": "7020000",
"Object": "Facture 134/SCHOUN",
"BaseDocDev": -12.33,
"BaseCapDev": 12.33,
"TvaCode": "VI15",
"AmountDocDev": 0,
"AmountCapDev": 0
},
{
"Account": "7011010",
"Object": "Facture 134/SCHOUN",
"BaseDocDev": 10,
"BaseCapDev": 10,
"TvaCode": "VI15",
"AmountDocDev": 0,
"AmountCapDev": 0
}
],
"DocumentLettre": 0
"EtatDoc" : "E"
"PathDoc" : "\\192.168.0.2\dos\xxxxx.pdf"
}
]
Response
{
"id": "3#24##VEN#146",
"msg": "Opération réalisée avec succès"
}
Modification d'un DCO
Request
- Mise à jour d'un document existant (exemple : changement de la DateDeadLine sur le document 3#24##VEN#146)
- PUT /dco
JSON raw
[
{
"Id": "3#24##VEN#146",
"PieceNumber": "146",
"Tiers": "SCHOUN",
"AccountingPlan": "VEN",
"Period": 6,
"Date": "18/07/2015",
"DateDeadline": "16/07/2015",
"Reference": "Facture 134/SCHOUN",
"Object": "Facture 134/SCHOUN",
"Devise": "EUR",
"TotalTtcDevise": 10,
"TotalTtcCapital": 10,
"RecordType": "1",
"Parity": 1,
"Imputation": [
{
"Account": "7020000",
"Object": "Facture 134/SCHOUN",
"BaseDocDev": 12.33,
"BaseCapDev": 12.33,
"TvaCode": "VI15",
"AmountDocDev": 0,
"AmountCapDev": 0
},
{
"Account": "7020000",
"Object": "Facture 134/SCHOUN",
"BaseDocDev": -12.33,
"BaseCapDev": 12.33,
"TvaCode": "VI15",
"AmountDocDev": 0,
"AmountCapDev": 0
},
{
"Account": "7011010",
"Object": "Facture 134/SCHOUN",
"BaseDocDev": 10,
"BaseCapDev": 10,
"TvaCode": "VI15",
"AmountDocDev": 0,
"AmountCapDev": 0
}
],
"DocumentLettre": 0
"EtatDoc" : "E"
"PathDoc" : "\\192.168.0.2\dos\xxxxx.pdf"
}
]
Response
Opération réalisée avec succès
Request
- Suppression d'un document existant (exemple : 3#24##VEN#148)
- DELETE /dco/3%2324%23%23VEN%23148
Response
Opération réalisée avec succès
Check reference
Request
- Vérification si la référence d'un document existe déjà pour un Tiers (exemple : 3#24##VEN#148)
- GET /dco/tie/code_tiers/refcheck/Texte_référence?EXEID=Numéro_exercice
- Exemple GET /dco/tie/ABRASIEN/refcheck/REF?EXEID=24
- Recherche la référence “REF” dans les documents du Tiers “ABRASIEN” pour l'exercice 24
Response
- Si document trouvé, retourne le code du document
- Sinon vide (pas de message d'erreur)
1#24##ACH#5
- Quelques exemples d'erreurs retournées :
- Modification d'une écriture déjà comptabilisée :
<head>
<title>Error response</title>
</head>
<body>
<h1>Error response</h1>
<p>Error code 404.
<p>Message: Ecriture # Brouillard, modification impossible.
<p>Error code explanation: 404 = Nothing matches the given URI.
</body>
- Tentative de modification d'un document inexistant :
<head>
<title>Error response</title>
</head>
<body>
<h1>Error response</h1>
<p>Error code 404.
<p>Message: Enregistrement 3#24##VEN#999 inexistant !.
<p>Error code explanation: 404 = Nothing matches the given URI.
</body>
