Consulter les déclarations

L'API consulter les déclarations permet aux utilisateurs de l'OD de consulter les déclarations de transactions ou de paiements générées automatiquement par celui-ci pour leurs entreprises

Les déclarations sont utilisées par l'OD pour transmettre des données de e-reporting à la PDP choisie par l'utilisateur ou au PPF

Les déclarations doivent être validées par les utilisateurs avant leurs transmissions

L'utilisateur peut consulter les déclarations à valider ou les déclarations qui ont déjà été validées et transmises à la PDP ou au PPF.

Pré-requis

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

Requête

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

v1/declarations/transactions
v1/declarations/paiements

On doit passer:

• L'identifiant utilisateur de l'OD dans l'en-tête X-OD-User-ID
• Les éventuels paramètres de la requête

Par exemple:

cURL

Requête de consultation des déclarations

curl \
-H 'X-OD-User-ID: ${userId}' \
http://<host>:<port>/v1/declarations/transactions?validees=true
# http://<host>:<port>/v1/declarations/paiements

Typescript

Requête de consultation des déclarations

const url = 'http://<host>:<port>/v1/declarations/transactions'
// const url = 'http://<host>:<port>/v1/declarations/paiements'
const response: AxiosResponse = await axios.get(url, {
    headers: {
        'X-OD-User-ID': userId,
    }
});

Paramètres de la requête

Paramètre	Valeur	Description
siren	Numéro SIREN	SIREN de l'entreprise dans le cas où l'utilisateur détient plusieurs entreprises
validees	État des déclarations	Booléen indiquant si les déclarations ont été validées et transmises à la PDP (true) ou non (false par défaut)

Réponse

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

Transactions

Résultats pour la consultation des déclarations de transactions

[
    {
        "id": "49a30e57-a3b0-4b43-9ced-ba39f05837d6",
        "debutPeriode": "2024-01-01",
        "finPeriode": "2024-02-29",
        "type": "Initiale",
        "transactions": [
            {
                "id": "dede8f1f-676e-4413-ab9e-2b867a3da396",
                "type": "ACHAT",
                "statutEReporting": "A_DECLARER",
                "dateRealisation": "2024-02-12T00:00:00.000Z"
            },
            // ... autres transactions
        ],
        "description": "Les nouvelles transactions réalisées sur cette période doivent donner lieu à une déclaration qui fera l'objet d'une transmission initiale."
    },
    // ... autres déclarations
]

Paiements

Résultats pour la consultation des déclarations de paiements

[
    {
        "id": "19f53a63-bd2c-4153-8c32-5e4f25fc0b74",
        "debutPeriode": "2024-05-01",
        "finPeriode": "2024-06-30",
        "type": "Initiale",
        "dateValidation": "2024-07-22",
        "paiements": [
            {
                "id": "2ca98c2c-292b-4cf0-8f3f-088cc2f7fc31",
                "statutEReporting": "DECLAREE",
                "dateEncaissement": "2024-05-25T00:00:00.000Z"
            },
            // ... autres paiements
        ]
    }
    // .. autres déclarations
]

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
404 Not Found	L'entreprise de l'utilisateur n'a pas été trouvée