Parcourir les ventes

L'API parcourir les ventes permet aux utilisateurs de l'OD de parcourir rapidement les ventes (avec ou sans facture), en récupérant un minimum d'information pour chaque objet

Pré-requis

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

Requête

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

v1/ventes/factures
v1/ventes

On doit passer:

• L'identifiant utilisateur de l'OD dans l'en-tête X-OD-User-ID
• Dans la chaîne de requête :
  • Les paramètres de pagination
  • Optionnellement les paramètres de filtrage

Par exemple:

cURL

Requête de parcours des factures de vente ou des ventes

curl \
-H 'X-OD-User-ID: ${userId}' \
http://<host>:<port>/v1/ventes/factures?pageNumber=1&pageSize=25&orderBy=dateCreation&sortOrder=asc&siren=810319517
# http://<host>:<port>/v1/ventes?pageNumber=1&pageSize=25&orderBy=dateCreation&sortOrder=asc&siren=810319517

Typescript

Requête de parcours des factures de vente ou des ventes

const url = 'http://<host>:<port>/v1/ventes/factures?pageNumber=1&pageSize=25&orderBy=dateCreation&sortOrder=asc&siren=810319517'
// const url = 'http://<host>:<port>/v1/ventes?pageNumber=1&pageSize=25&orderBy=dateCreation&sortOrder=asc&siren=810319517'
const response: AxiosResponse = await axios.get(url, {
    headers: {
        'X-OD-User-ID': userId,
    }
});

Paramètres de pagination

Paramètre	Valeur	Défaut
pageNumber	1..N	1
pageSize	1...N	20
orderBy	dateCreation ou numeroFacture	dateCreation
sort	asc ou desc	asc

Paramètres de filtrage

Paramètre	Valeur	Description
siren	Numéro SIREN	[PAS ENCORE IMPLEMENTE]

Réponse

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

Factures de vente

Résultat pour le parcours des factures de vente

{
    "items": [
        {
            "id": "26ad3a21-615e-40ea-a05a-2ac8e8a2f373",
            "siren": "810319517",
            "numeroFacture": "FACTURE-2024-123456",
            "syntaxe": "Factur-X",
            "dateCreation": "2024-01-17T14:37:31.737Z",
        },
        // ... autres factures de vente
    ],
    "meta": {
        "pageNumber": 1,
        "pageSize": 20,
        "pageCount": 3,
        "itemCount": 55
    }
}

Données facture de vente

Propriété	Valeur
id	Identifiant interne de la facture de vente dans l'OD
siren	Numéro SIREN de l'entreprise
numeroFacture	Numéro de la facture
syntaxe	Factur-X | CII | UBL
dateCreation	Date de création de la facture

Ventes

Résultat pour le parcours des ventes

{
    "items": [
        {
            "id": "26ad3a21-615e-40ea-a05a-2ac8e8a2f373",
            "siren": "810319517",
            "description": "Imprimante Canon PIXMA MG3650",
            "dateCreation": "2024-01-17T14:37:31.737Z",
            "dateRealisation": "2024-02-26T16:24:36.687Z",
        },
        // ... autres ventes
    ],
    "meta": {
        "pageNumber": 1,
        "pageSize": 20,
        "pageCount": 3,
        "itemCount": 55
    }
}

Données vente

Propriété	Valeur
id	Identifiant interne de la vente dans l'OD
siren	Numéro SIREN de l'entreprise
description	Description de la vente
dateCreation	Date de création de la vente
dateRealisation	Date de réalisation de la prestation de service ou date de livraison des biens

Pagination

Propriété	Valeur
pageNumber	numéro de la page
pageSize	taille de la page
pageCount	nombre total de pages de la taille demandée
itemCount	nombre total de factures de vente ou de ventes

Erreurs

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

Code	Message
400 Bad Request	Requête invalide - Voir messages d'erreur
401 Unauthorized	Informations d'authentification invalides
403 Forbidden	Droits insuffisants pour effectuer cette action