Consulter un achat

L'API consulter un achat permet aux utilisateurs de l'OD de récupérer toutes les données d'un achat (avec ou sans facture), son statut OD, ses pièces jointes et ses paiements

Pré-requis

• Posséder un compte OD
• Avoir créé une connexion PDP ou PPF

Requête

Pour consulter un achat on fait une requête GET sur l'un des chemins d'accès suivants:

v1/achats/factures/<identifiant facture d'achat>
v1/achats/<identifiant achat>

On doit passer:

• L'identifiant utilisateur de l'OD dans l'en-tête X-OD-User-ID
• L'identifiant de la facture d'achat ou de l'achat dans l'URL

Par exemple:

cURL

Requête de consultation d'une facture d'achat ou d'un achat

curl \
-H 'X-OD-User-ID: ${userId}' \
http://<host>:<port>/v1/achats/factures/391a4557-a2b5-426f-a9af-db22d8e49db1
# http://<host>:<port>/v1/achats/391a4557-a2b5-426f-a9af-db22d8e49db1

Typescript

Requête de consultation d'une facture d'achat ou d'un achat

const url = 'http://<host>:<port>/v1/achats/factures/391a4557-a2b5-426f-a9af-db22d8e49db1';
// const url = 'http://<host>:<port>/v1/achats/391a4557-a2b5-426f-a9af-db22d8e49db1';
const response: AxiosResponse = await axios.get(url, {
    headers: {
        'X-OD-User-ID': userId,
    }
});

Réponse

Si tout s'est bien passé, la réponse de l'OD est de la forme suivante:

Facture d'achat

Résultat de la consultation d'une facture d'achat

{
    "id": "62ea94db-5329-4393-8a80-27a120942f67",
    "siren": "810319517",
    "numeroFacture": "FACTURE-2024-123456",
    "syntaxe": "Factur-X",
    "dateCreation": "2024-02-27T14:17:13.459Z",
    "base64": "PHN2ZyBoZWlnaHQ9IjI2IiB4bWxucz0iaHR0cDov...",
    "statutOd": "RECUE",
    "nomFournisseur": "The Global Chain Sweden AB",
    "dateEmission": "2018-02-08",
    "devise": "EUR",
    "montantTTC": "12500",
    "montantTVA": "2500",
    "type": "Facture",
    "paiements": [
        {  
            "id": "f47d9ab9-a47f-440a-976d-081a951d7698",
            "dateEncaissement": "2024-02-26T15:43:55.076Z",
            "montantHt": 103.55,
            "tauxTva": 20
        },
        {
            "id": "145a0398-539e-4456-9ebc-651db5db5330",
            "dateEncaissement": "2024-02-26T15:43:55.076Z",
            "montantHt": 34.55,
            "tauxTva": 5
        },
        // ... autres paiements
    ]
}

Données facture achat

Propriété	Valeur
id	Identifiant interne de la facture d'achat dans l'OD
siren	Numéro SIREN de l'entreprise acheteuse
numeroFacture	Numéro de la facture
syntaxe	Factur-X | CII | UBL
dateCreation	Date de création de l'achat
base64	Fichier facture encodé en Base64
statutOd	RECUE | REFUSEE
nomFournisseur	Le nom du fournisseur
dateEmission	La date d'émission de la facture
devise	La devise des montants de la facture
montantTTC	Le total du montant TTC de la facture
montantTVA	Le total du montant de la TVA de la facture
type	Facture | Avoir

Achat

Résultat de la consultation d'un achat

{
    "id": "30565821-9aaa-4ac2-9363-5f7fbf41f87e",
    "siren": "810 319 517",
    "description": "Imprimante Canon PIXMA MG3650",
    "dateRealisation": "2024-02-02T15:06:31.865Z",
    "codeDevise": "EUR",
    "categorie": "TLB1",
    "montantTotalHt": 1234.56,
    "montantTotalTva": 246.91,
    "repartitionTva": [
        {
            "taux": 20.0,
            "baseImposition": 1234.56,
            "montantTva": 246.91
        }
    ],
    "statutOd": "CREE",
    "piecesJointes": [
        {
            "nomFichier": "Imprimante_Canon_PIXMA_MG3650.pdf",
            "contentType": "application/pdf",
            "content": "PHN2ZyBoZWlnaHQ9IjI2IiB4bWxucz0iaHR0cDov..."
        },
        // ... autres fichiers
    ],
    "paiements": [
        {  
            "id": "f47d9ab9-a47f-440a-976d-081a951d7698",
            "dateEncaissement": "2024-02-26T15:43:55.076Z",
            "montantHt": 103.55,
            "tauxTva": 20
        },
        {
            "id": "145a0398-539e-4456-9ebc-651db5db5330",
            "dateEncaissement": "2024-02-26T15:43:55.076Z",
            "montantHt": 34.55,
            "tauxTva": 5
        },
        // ... autres paiements
    ]
}

Données achat

Propriétés	Valeur
id	Identifiant interne de l'achat dans l'OD
siren	Numéro SIREN de l'entreprise acheteuse
description	Description de l'achat
dateRealisation	Date de réalisation de la prestation de service ou date de livraison des biens
codeDevise	Code ISO 4217
Catégorie	Catégorie de transaction
montantTotalHt	Montant total hors taxes
montantTotalTva	Montant total TVA
repartitionTva[i].taux	Taux de TVA
repartitionTva[i].baseImposition	Base d'imposition
repartitionTva[i].montantTva	Montant TVA
statutOd	CREE

Pièces jointes

Propriétés	Valeur
pieceJointe[i].nomFichier	Nom du fichier
pieceJointe[i].contentType	Type MIME du fichier
pieceJointe[i].base64	Fichier encodé en Base64

Paiements

Propriétés	Valeur
paiements[i].id	Identifiant du paiement
paiements[i].dateEncaissement	Date d'encaissement du paiement
paiements[i].montantHt	Montant hors-taxe du paiement
paiements[i].tauxTva	Taux de TVA du paiement

Erreurs

Si une erreur s'est produite, les codes et messages suivants peuvent être retournés:

Code	Message
401 Unauthorized	Informations d'authentification invalides
403 Forbidden	Droits insuffisants pour effectuer cette action
404 Not Found	L'achat n'a pas été trouvé