Exclure un relevé de la comptabilisation de son dépôt
POST/api/v1/bank_statements/:id/exclude
Retire le fichier de la comptabilisation du dépôt dont il fait partie. Le 200 retourne le relevé avec excluded à true et excluded_at renseigné.
Quand vous en avez besoin. Un dépôt se comptabilise en entier ou pas du tout. Un fichier qui ne pourra jamais être comptabilisé - une extraction en échec - bloque tout son dépôt : une comptabilisation nommant un autre fichier répond batch_unresolved, et une comptabilisation nommant le fichier en échec lui-même répond statement_not_reviewable. Un fichier valide que vous ne voulez pas en comptabilité est le cas inverse : il est comptabilisé avec le reste du dépôt, sauf si vous l'excluez d'abord. Dans les deux cas, l'exclure est l'acte explicite : la prochaine comptabilisation nommant un autre fichier du dépôt comptabilise le reste et laisse celui-ci intact.
Ce qu'il déplace. Rien d'autre que l'exclusion. Le state du fichier et ses lignes restent tels quels, et POST /bank_statements/{id}/include le remet exactement comme il était. Une comptabilisation nommant un fichier exclu est refusée avec statement_excluded.
Aucune Idempotency-Key n'est requise : exclure un fichier déjà exclu ne change rien et conserve le premier excluded_at.
Request
Responses
- 200
- 401
- 403
- 404
- 422
The file is excluded from its upload's commit.
La requête ne porte aucun jeton, ou un jeton invalide ou expiré.
Le jeton n'est pas autorisé à effectuer cet appel : le scope OAuth déduit du verbe (write), l'habilitation sur l'espace de travail, le drapeau de fonctionnalité bank_reconciliation, ou le contrôle Pundit propre à l'action. L'exemple ci-dessous est refusé sur le scope.
Aucun relevé portant cet identifiant n'est atteignable par les habilitations du jeton. Un relevé appartenant à un autre espace de travail répond de la même manière, si bien que la réponse ne permet pas d'en sonder l'existence.
statement_not_reviewable: the file's own state forbids the exclusion, and message says which. It is already posted - its entries are in the general ledger - or archived, or it belongs to no upload and so has no upload commit to be excluded from. Nothing you send can change that. No details.