PROJET
Client	INFODATA
Nom du projet	Accountix
Référent Infodata	JCD/DT
Statut

Rédacteur(s)

Création : — Aurélien Deutsch

Description du projet

Détails de la collection postman concernant Accountix.

WS des écritures comptables

Le projet possède plusieurs appels WS pour les écritures comptables, les WS seront détaillés un par un ci-dessous.

WS - 1. Liste dossiers autorisés

Ce WS permet d'afficher la liste des dossiers autorisés.

Requête

Title : Détails d'un dossier.
Permet de sélectionner le dossier sur lequel effectuer les opérations
UriDomain : https://preprod-samples.integrix.lu/
UriMethod : GET
UriScheme (href): /accountix/api/dos.
UriHeaders :
- x-sso-user-id = Id du user qui peut accéder à ce dossier.
Parametres : null
Body : null

Réponse

Body

[
    {
        "Code": "AC.XXXXX",
        "Label": "NOM"
    }
]

WS - 2. Sélectionner un dossier

Ce WS permet de sélectionner sur quel dossier les prochains WS vont être utilisés.

Il faut appeler ce ws pour appeler le ws /api/dcoAna

Requête

Title : Sélectionner un dossier.
UriDomain : https://preprod-samples.integrix.lu/
UriMethod : GET
UriScheme (href): accountix/api/dos/{codeDossierComptable}.
C'est un des codes du ws /dos
Ex : accountix/api/dos/FAPROM
UriHeaders :
- x-sso-user-id = Id du user qui peut accéder à ce dossier.
Parametres : null
Body : null

Réponse

Body

[
    {
        "id": "AC.ACWEB",
        "label": "ACCOUNTIX WEB"
    }
]

x-witoken : Ce code doit être gardé et passé dans les autres WS sinon l'erreur 401 est retourné lors de l'appel des autres WS.
Un code x-witoken expire après 24 heures si aucun appel WS avec ce code WITOKEN n'a été fait pendant ce laps de temps.

WS - 3. Obtenir les écritures de date à date

Il faut absolument avoir appeler le WS /api/dos/{codeDossierComptable} pour pouvoir l'appeler

Ce WS permet d'obtenir les écritures d'une date à une autre.

Requête

Title : Obtenir les écritures de date à date.
UriDomain : https://preprod-samples.integrix.lu/
UriMethod : GET
UriScheme (href):
- Avec la date d'encodage : /accountix/api/dcoAna?WITH=Date|>=|01/01/2022&WITH=Date|⇐|10/01/2022.
  Attention, ce champs date n'est pas la date de création de l'écriture mais la date d'encodage qui peut être modifiée par l'utilisateur.
- Avec la date de création : /accountix/api/dcoAna?WITH=Creation.Date|>=|01/01/2022&WITH=Creation.Date|⇐|10/01/2022.
- Avec la date de modification : /accountix/api/dcoAna?WITH=Update.Date|>=|01/01/2022&WITH=Update.Date|⇐|10/01/2022.
- Avec la date de dernier changement : /accountix/api/dcoAna?WITH=LastChangeDate|>=|01/01/2022&WITH=LastChangeDate|⇐|10/01/2022
  Si l'écriture n'a pas été modifiée, ce sera la date de création de l'écriture sinon ce sera la date de modification
UriHeaders :
- x-sso-user-id = Id du user qui peut accéder à ce dossier.
- x-witoken = Mettre le code X-WITOKEN que vous avez reçu dans les headers de réponse de l'appel du WS {codeDossierComptable}
Parametres :
Body : null

Réponse

Body

[
    {
        "Id": "1#2022##ACH#1",
        "PieceNumber": "1",
        "Tiers": "INFODATA",
        "AccountingPlan": "ACH",
        "Period": 1,
        "Date": "02/01/2022",
        "DateDeadline": "01/02/2022",
        "Reference": "INFODATA - 36/133 - 2022",
        "Object": "INFODATA - 36/133 - 2022",
        "Devise": "EUR",
        "TotalTtcDevise": 4168.03,
        "TotalTtcCapital": 4168.03,
        "RecordType": "1",
        "Parity": 1.000000,
        "Imputation": [
            {
                "Account": "6413000000",
                "Object": "INFODATA - 36/133 - 2022",
                "BaseDocDev": 3562.42,
                "BaseCapDev": 3562.42,
                "TvaCode": "F17",
                "AmountDocDev": 605.61,
                "AmountCapDev": 605.61
            }
        ],
        "DocumentLettre": 0,
        "Etat": "",
        "PathDoc": "",
        "Creation": {
            "User": "JCD",
            "Date": "10/02/2022",
            "Time": "10:41"
        },
        "Update": {
            "User": "JCD",
            "Date": "11/02/2022",
            "Time": "10:43"
        },
        "LastChangeDate": "11/02/2022"
    }
]

WS - 4. Obtenir une facture

Ce WS permet d'obtenir une facture.

Requête

Title : Obtenir une facture.
UriDomain : https://preprod-samples.integrix.lu/
UriMethod : GET
UriScheme (href): /accountix/api/dcoAna/{id}.
Exemple : /accountix/api/dcoAna/1%232020%23%23ACH%231
UriHeaders :
- x-sso-user-id = Id du user qui peut accéder à ce dossier.
- x-witoken = Mettre le code X-WITOKEN que vous avez reçu dans les headers de réponse de l'appel du WS {codeDossierComptable}
Parametres : null
Body : null

Réponse

Body

[
    {
        "Id": "1#2020##ACH#1",
        "PieceNumber": "1",
        "Tiers": "M2F",
        "AccountingPlan": "ACH",
        "Period": 1,
        "Date": "02/01/2020",
        "DateDeadline": "17/01/2020",
        "Reference": "M2F - 0001-20 - Frais administratifs 01/2020",
        "Object": "M2F - 0001-20 - Frais administratifs 01/2020",
        "Devise": "EUR",
        "TotalTtcDevise": 3276.00,
        "TotalTtcCapital": 3276.00,
        "RecordType": "1",
        "Parity": 1.000000,
        "Imputation": [
            {
                "Account": "6185100000",
                "Object": "M2F - 0001-20 - Frais administratifs 01/2020",
                "BaseDocDev": 2800.00,
                "BaseCapDev": 2800.00,
                "TvaCode": "F17",
                "AmountDocDev": 476.00,
                "AmountCapDev": 476.00,
                "Analytic": [
                    {
                        "Code": "AN",
                        "Affect": "1",
                        "Cost": "CHD",
                        "Subd": "",
                        "Amount": 2800.00,
                        "Qte": null,
                        "Cond": "",
                        "Comment": ""
                    }
                ]
            }
        ],
        "DocumentLettre": 1,
        "lettering": [
            {
                "Date": "29/01/2020",
                "Letterer": "5#2020##BCC#20#18",
                "Object": "M2F - 0001-20 - Frais administratifs 01/2020",
                "Amount": -3276.00
            }
        ]
    }
]

WS - 5. Obtenir les factures avec date >= 01/01/2022 and dont le client est différent de BEBUNCH

Ce WS permet d'obtenir une facture entre après une date et dont le client est différent de BEBUNCH.

Requête

Title : Obtenir les factures avec date >= 01/01/2022 and dont le client est différent de BEBUNCH.
UriDomain : https://preprod-samples.integrix.lu/
UriMethod : GET
UriScheme (href): /accountix/api/dcoAna?WITH=Date|>=|01/01/2020&WITH=AccountingPlan|=|ACH&WITH=Tiers|!=|CodeTiers \\.
UriHeaders :
- x-sso-user-id = Id du user qui peut accéder à ce dossier.
- x-witoken = Mettre le code X-WITOKEN que vous avez reçu dans les headers de réponse de l'appel du WS {codeDossierComptable}
Parametres :
Body : null

Réponse

Body

[
     {
        "Id": "1#2022##ACH#12",
        "PieceNumber": "12",
        "Tiers": "CBC",
        "AccountingPlan": "ACH",
        "Period": 1,
        "Date": "05/01/2022",
        "DateDeadline": "04/02/2022",
        "Reference": "CBC - 428985/446099",
        "Object": "CBC - 428985/446099",
        "Devise": "EUR",
        "TotalTtcDevise": 69.11,
        "TotalTtcCapital": 69.11,
        "RecordType": "1",
        "Parity": 1.000000,
        "Imputation": [
            {
                "Account": "6132000000",
                "Object": "CBC - 428985/446099",
                "BaseDocDev": 59.07,
                "BaseCapDev": 59.07,
                "TvaCode": "F17",
                "AmountDocDev": 10.04,
                "AmountCapDev": 10.04
            }
        ],
        "DocumentLettre": 0,
        "Etat": "",
        "PathDoc": ""
    }
]

WS - 6. Obtenir le pdf de la facture X

Ce WS permet d'obtenir le pdf d'une facture.

Requête

Title : Obtenir le pdf de la facture X
UriDomain : https://preprod-samples.integrix.lu/
UriMethod : GET
UriScheme (href): /accountix/api/dco/{id}/pdf.
Exemple : /accountix/api/dco/1%232022%23%23ACH%2312/pdf
UriHeaders :
- x-sso-user-id = Id du user qui peut accéder à ce dossier.
- x-witoken = Mettre le code X-WITOKEN que vous avez reçu dans les headers de réponse de l'appel du WS {codeDossierComptable}
Parametres : null
Body : null

Réponse

L'appel renverra le PDF de la facture.

Table des matières

Rédacteur(s)

Description du projet

WS des écritures comptables

WS - 1. Liste dossiers autorisés

Requête

Réponse

Body

WS - 2. Sélectionner un dossier

Requête

Réponse

Body

Header

WS - 3. Obtenir les écritures de date à date

Requête

Réponse

Body

WS - 4. Obtenir une facture

Requête

Réponse

Body

WS - 5. Obtenir les factures avec date >= 01/01/2022 and dont le client est différent de BEBUNCH

Requête

Réponse

Body

WS - 6. Obtenir le pdf de la facture X

Requête

Réponse