Consulter une vente

L'API consulter une vente permet aux utilisateurs de l'OD de récupérer toutes les données d'une vente (avec ou sans facture), ses statuts PDP/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 une vente on fait une requête GET sur l'un des chemins d'accès suivants:

v1/ventes/factures/<identifiant facture de vente>
v1/ventes/<identifiant vente>

On doit passer:

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

Par exemple:

cURL

Requête de consultation d'une facture de vente ou d'une vente

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

Typescript

Requête de consultation d'une facture de vente ou d'une vente

const url = 'http://<host>:<port>/v1/ventes/facture/391a4557-a2b5-426f-a9af-db22d8e49db1';
// const url = 'http://<host>:<port>/v1/ventes/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 de vente

Résultat de consultation d'une facture de vente

{
    "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": "ENVOYEE",
    "statutsPdp": [
        {
        "date": "2024-02-27T14:20:02.850Z",
        "statut": "Déposée"
        }
    ],
    "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 vente

Propriété	Valeur
id	Identifiant interne de la facture de vente dans l'OD
siren	Numéro SIREN de l'entreprise vendeuse
numeroFacture	Numéro de la facture
syntaxe	Factur-X | CII | UBL
dateCreation	Date de création de la vente
dateRealisation	Date de réalisation de la prestation de service ou date de livraison des biens
base64	Fichier facture encodé en Base64
statutOd	CREEE | A_ENVOYER | ENVOYEE
statutsPdp	Historique des statuts

Vente

Résultat de consultation d'une vente

{
    "id": "5b9171a0-364a-41f3-a8e1-765df44ea606",
    "siren": "810319517",
    "description": "Imprimante Canon PIXMA MG3650",
    "dateRealisation": "2024-02-02T15:06:31.865Z",
    "codeDevise": "EUR",
    "codeDatePaiementTva": "29",
    "categorie": "TLB1",
    "montantTotalHt": 1234.56,
    "montantTotalTva": 246.91,
    "nombreTransactions": 1,
    "repartitionTva": [
        {
            "taux": 20.0,
            "baseImposition": 1234.56,
            "montantTva": 246.91
        }
    ],
    "statutOd": "CREEE",
    "piecesJointes": [
        {
            "nomFichier": "ticket_de_caisse.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 vente

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

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	La vente n'a pas été trouvée