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 16:08
Description
Définition des informations DAP (DOD et DFI)
Object
{"id": "AC_DAP","$schema": "http://json-schema.org/schema#","title": "Documents apurements","type": "object","properties": {"Id": {"title": "No Id","type": "string"},"PieceNumber": {"title": "Numero de piece","type": "string"},"Period": {"title": "Période","type": "number"},"RecordType": {"title": "Type enreg.","type": "string","enum": [ "1", "2", "3"]},"Date": {"title": "Date","type": "string","format": "date"},"FinancialAccount": {"title": "Compte Financier","type": "number"},"RecordDevise": {"title": "Devise Enreg.","type": "string"},"Parity": {"title": "Parité","type": "number"},"AccountingPlan": {"title": "Journal","type": "string"},"Detail":{"title": "Type De Traitement","type": "array","properties": {"TreatmentType":{"title": "Type De Traitement","type": "object","properties": {"Id": {"title": "Type De Traitement","type": "number","enum": [ "1", "2"]},"Label": {"title": "Type de traitement","type": "string","enum": [ "Documents", "Général ou Compte"]}}},"Document": {"title": "Document","type": "string"},"Account": {"title": "Compte","type": "string"},"CapitalDebitAmount": {"title": "Montant Debit En Capital","type": "number"},"CapitalCreditAmount": {"title": "Montant Credit En Capital","type": "number"},"RecordDebitAmount": {"title": "Montant Debit En Devise Record","type": "number"},"RecordCreditAmount": {"title": "Montant Credit En Devise Record","type": "number"},"Devise": {"title": "Devise","type": "string"},"LineDebitAmount": {"title": "Montant débit Ligne","type": "number"},"LineCreditAmount": {"title": "Montant crédit Ligne","type": "number"},"Object": {"title": "Objet","type": "string"},"Tva": {"title": "Code TVA","type": "string"},"Ttc": {"title": "Montant Ttc En Devise De Ligne Pour La Ligne De Ht (sv Pour Db/cr)","type": "number"},"Number": {"title": "Numero De Ligne A Affecter Au Mouvement Generer","type": "number"},"Parity": {"title": "Parité de ligne","type": "number"},"Control": {"title": "Controlant","type": "number"}}}},"required": ["Id","Period","Date","FinancialAccount","RecordDevise","AccountingPlan","Detail.TreatmentType.Id","Detail.Document","Detail.Account","Detail.Devise","Detail.LineDebitAmount","Detail.LineCreditAmount","Detail.Ttc"]}
Links
Human Text - specification
ReturnValues
| Response code | Response Header | Body |
|---|---|---|
| Content-Type: application/json |
Example sur fichier DOD
Request
-
- Retourne les infos du document 6#24##ODG#1
Response
[
{
"Id": "6#24##ODG#1",
"PieceNumber": "1",
"Period": 1,
"RecordType": "2",
"Date": "31/01/2015",
"FinancialAccount": null,
"RecordDevise": "EUR",
"Parity": 1,
"AccountingPlan": "ODG",
"Detail": [
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "6010000",
"CapitalDebitAmount": 500,
"CapitalCreditAmount": 0,
"RecordDebitAmount": 500,
"RecordCreditAmount": 0,
"Devise": "EUR",
"LineDebitAmount": 500,
"LineCreditAmount": 0,
"Object": "Test ODG - WbS",
"Tva": "",
"Ttc": null,
"Number": 1,
"Parity": 1,
"Control": null
},
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "7010000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 500,
"RecordDebitAmount": 0,
"RecordCreditAmount": 500,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 500,
"Object": "Test ODG - Wbs",
"Tva": "",
"Ttc": null,
"Number": 2,
"Parity": 1,
"Control": null
}
]
}
]
Request
- Création d'un nouveau document (NEW)
- En retour, on obtient le numéro de document créé (dans l'exemple le document 6#24##ODG#23)
Xml raw
[
{
"Id": "NEW",
"PieceNumber": "1",
"Period": 1,
"RecordType": "2",
"Date": "31/01/2015",
"FinancialAccount": null,
"RecordDevise": "EUR",
"Parity": 1,
"AccountingPlan": "ODG",
"Detail": [
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "6010000",
"CapitalDebitAmount": 500,
"CapitalCreditAmount": 0,
"RecordDebitAmount": 500,
"RecordCreditAmount": 0,
"Devise": "EUR",
"LineDebitAmount": 500,
"LineCreditAmount": 0,
"Object": "Test ODG - WbS",
"Tva": "",
"Ttc": null,
"Number": 1,
"Parity": 1,
"Control": null
},
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "7010000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 500,
"RecordDebitAmount": 0,
"RecordCreditAmount": 500,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 500,
"Object": "Test ODG - Wbs",
"Tva": "",
"Ttc": null,
"Number": 2,
"Parity": 1,
"Control": null
}
]
}
]
Response
{
"id": "6#24##ODG#23",
"msg": "Opération réalisée avec succès"
}
Request
- Mise à jour d'un document existant (exemple : changement de la Date sur le document 6#24##ODG#1)
Xml raw
[
{
"Id": "6#24##ODG#1",
"PieceNumber": "1",
"Period": 1,
"RecordType": "2",
"Date": "29/01/2015",
"FinancialAccount": null,
"RecordDevise": "EUR",
"Parity": 1,
"AccountingPlan": "ODG",
"Detail": [
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "6010000",
"CapitalDebitAmount": 500,
"CapitalCreditAmount": 0,
"RecordDebitAmount": 500,
"RecordCreditAmount": 0,
"Devise": "EUR",
"LineDebitAmount": 500,
"LineCreditAmount": 0,
"Object": "Test ODG - WbS",
"Tva": "",
"Ttc": null,
"Number": 1,
"Parity": 1,
"Control": null
},
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "7010000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 500,
"RecordDebitAmount": 0,
"RecordCreditAmount": 500,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 500,
"Object": "Test ODG - Wbs",
"Tva": "",
"Ttc": null,
"Number": 2,
"Parity": 1,
"Control": null
}
]
}
]
Response
Opération réalisée avec succès
Request
- Suppression d'un document existant (exemple : 6#24##ODG#1)
Response
Opération réalisée avec succès
- 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 6#24##ODG#999 inexistant !.
<p>Error code explanation: 404 = Nothing matches the given URI.
</body>
Example sur fichier DFI
Request
-
- Retourne les infos du document 5#24##BGL#2
Response
[
{
"Id": "5#24##BGL#2",
"PieceNumber": "2",
"Period": 3,
"RecordType": "2",
"Date": "30/03/2015",
"FinancialAccount": 5120000,
"RecordDevise": "EUR",
"Parity": null,
"AccountingPlan": "BGL",
"Detail": [
{
"TreatmentType": {
"Id": 1,
"Label": "Documents"
},
"Document": "6#24##OD#6#4",
"Account": "4130000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 50,
"RecordDebitAmount": 0,
"RecordCreditAmount": 50,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 50,
"Object": "TRF SUR EFFET A L'ENCAISSEMENT",
"Tva": "",
"Ttc": null,
"Number": 1,
"Parity": 1,
"Control": null
},
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "6142000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 100,
"RecordDebitAmount": 0,
"RecordCreditAmount": 100,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 100,
"Object": "",
"Tva": "",
"Ttc": null,
"Number": 3,
"Parity": 1,
"Control": null
}
]
}
]
Request
- Création d'un nouveau document (NEW)
- En retour, on obtient le numéro de document créé (dans l'exemple le document 5#24##BGL#19)
Xml raw
[
{
"Id": "NEW",
"PieceNumber": "NEW",
"Period": 3,
"RecordType": "2",
"Date": "30/03/2015",
"FinancialAccount": 5120000,
"RecordDevise": "EUR",
"Parity": null,
"AccountingPlan": "BGL",
"Detail": [
{
"TreatmentType": {
"Id": 1,
"Label": "Documents"
},
"Document": "6#24##OD#6#4",
"Account": "4130000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 50,
"RecordDebitAmount": 0,
"RecordCreditAmount": 50,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 50,
"Object": "TRF SUR EFFET A L'ENCAISSEMENT",
"Tva": "",
"Ttc": null,
"Number": 1,
"Parity": 1,
"Control": null
},
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "6142000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 100,
"RecordDebitAmount": 0,
"RecordCreditAmount": 100,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 100,
"Object": "",
"Tva": "",
"Ttc": null,
"Number": 3,
"Parity": 1,
"Control": null
}
]
}
]
Response
{
"id": "5#24##BGL#19",
"msg": "Opération réalisée avec succès"
}
Request
- Mise à jour d'un document existant (exemple : changement de la Date sur le document 5#24##BGL#19)
Xml raw
[
{
"Id": "5#24##BGL#19",
"PieceNumber": "2",
"Period": 3,
"RecordType": "2",
"Date": "29/03/2015",
"FinancialAccount": 5120000,
"RecordDevise": "EUR",
"Parity": null,
"AccountingPlan": "BGL",
"Detail": [
{
"TreatmentType": {
"Id": 1,
"Label": "Documents"
},
"Document": "6#24##OD#6#4",
"Account": "4130000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 50,
"RecordDebitAmount": 0,
"RecordCreditAmount": 50,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 50,
"Object": "TRF SUR EFFET A L'ENCAISSEMENT",
"Tva": "",
"Ttc": null,
"Number": 1,
"Parity": 1,
"Control": null
},
{
"TreatmentType": {
"Id": 2,
"Label": "Général ou Compte"
},
"Document": "",
"Account": "6142000",
"CapitalDebitAmount": 0,
"CapitalCreditAmount": 100,
"RecordDebitAmount": 0,
"RecordCreditAmount": 100,
"Devise": "EUR",
"LineDebitAmount": 0,
"LineCreditAmount": 100,
"Object": "",
"Tva": "",
"Ttc": null,
"Number": 3,
"Parity": 1,
"Control": null
}
]
}
]
Response
Opération réalisée avec succès
Request
- Suppression d'un document existant (exemple : 5#24##BGL#19)
Response
Opération réalisée avec succès
- 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 5#24##BGL#999 inexistant !.
<p>Error code explanation: 404 = Nothing matches the given URI.
</body>
