Valider une déclaration

L'API valider une déclaration permet aux utilisateurs de l'OD de valider une déclaration de transaction ou de paiement générée 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

Lors de la transmission, seules les déclarations validées par l'utilisateur sont prises en compte

Pré-requis

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

Requête

Pour valider une transaction ou un paiement on fait une requête PATCH sur un des chemins d'accès suivants:

v1/declarations/transactions/<identifiant de déclaration>
v1/declarations/paiements/<identifiant de déclaration>

On doit passer:

• L'identifiant utilisateur de l'OD dans l'en-tête X-OD-User-ID
• Le contenu du patch au format JSON Patch dans le corps de la requête

Le contenu du patch doit affecter:

• La valeur VALIDEE à la propriété statut de la déclaration

Par exemple:

cURL

Requête de validation d'une déclaration

curl \
-X PATCH \
-H 'X-OD-User-ID: ${userId}' \
-H 'Content-Type: application/json-patch+json; charset=utf-8' \
-d @validation-declaration.json \
http://<host>:<port>/v1/declarations/transactions/26ad3a21-615e-40ea-a05a-2ac8e8a2f373
# http://<host>:<port>/v1/declarations/paiements/26ad3a21-615e-40ea-a05a-2ac8e8a2f373

Typescript

Requête de validation d'une déclaration

const url = 'http://<host>:<port>/v1/declarations/transactions/26ad3a21-615e-40ea-a05a-2ac8e8a2f373'
// const url = 'http://<host>:<port>/v1/declarations/paiements/26ad3a21-615e-40ea-a05a-2ac8e8a2f373'
const data = fs.readFileSync('validation-declaration.json');
const response: AxiosResponse = await axios.patch(url, data, {
    headers: {
        'X-OD-User-ID': userId,
        'Content-Type': 'application/json-patch+json; charset=utf-8',
    }
});

Fichier validation-declaration.json

[
    {
        "op": "replace",
        "path": "/statut",
        "value": "VALIDEE"
    }
]

Réponse

Si le changement de statut a réussi, la réponse de l'OD est 204 No Content

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

Impact

• La propriété dateValidation de la déclaration a maintenant la valeur de la date à laquelle elle a été validée et transmise à la PDP choisie par l'utilisateur ou au PPF.
• La déclaration a été transmise à la PDP choisie par l'utilisateur ou au PPF sous forme de flux 10.