Catalogue des événements
Chaque événement est une ligne du flux d’événements, et le webhook les livre dans l’ordre.
type |
subject_type |
Quand | data |
|---|---|---|---|
invoice.pending, credit_note.pending |
invoice, credit_note |
acceptée | les champs de la réponse 202, type compris. isf n’est pas encore connu : il arrive avec l’événement final |
invoice.normalised, credit_note.normalised |
idem | normalisée | tous les champs de la page Imprimer votre facture, champs d’impression et lignes compris |
invoice.failed, credit_note.failed |
idem | échec définitif | reason_code, reason, et les champs d’identité |
pos.token_expiring |
pos |
un jeton expire bientôt | pos { id, name }, token_expires_at, days_left |
pos.token_expired |
pos |
un jeton a expiré | pos, token_expires_at |
pos.token_invalid |
pos |
un point de vente est en pause parce que la DGI refuse son jeton (une fois par jour au plus tant que cela dure) | pos, reason |
pos.deactivated |
pos |
vous en avez désactivé un | pos { id, nid } |
pos.reactivated |
pos |
vous en avez réactivé un | pos { id, nid }, token_status |
business.suspended |
business |
l’entreprise ne prend plus de factures : vous l’avez mise en pause (status: "paused"), ou nous l’avons suspendue (status: "suspended"). Émis aussi quand nous levons notre suspension d’une entreprise que vous aviez mise en pause avant : elle revient à paused et le reste jusqu’à ce que vous la repreniez. Les factures déjà acceptées attendent ; aucune n’échoue. Lisez status, pas le type, pour connaître l’état |
status (paused ou suspended) |
business.resumed |
business |
l’entreprise reprend les factures (status: "active") : vous l’avez reprise, ou nous avons levé notre suspension. Les factures qui attendaient sont alors normalisées |
status |
business.ended |
business |
vous l’avez terminée, votre partenariat a pris fin, ou l’entreprise a été transférée vers un compte autonome (elle répond alors 404) | status |
business.deleted |
business |
nous avons supprimé une entreprise qui n’a jamais eu de document normalisé, à la demande du contribuable ou à la vôtre : typiquement un NIF saisi par erreur, qui est de nouveau libre. Rien n’en reste lisible : tout appel sur elle répond 404 à partir de là, et son external_id peut être réutilisé. Le dernier événement de cette entreprise |
business { id, external_id }, reason_code (DELETED_NEVER_NORMALISED). Lisez external_id dans data.business : celui de l’enveloppe est vide à partir de là |
business.queue_blocked |
business |
des factures attendent et cette entreprise n’a plus de point de vente actif, donc rien ne peut les normaliser (une fois par jour au plus tant que cela dure). Ajoutez un point de vente : elles sont alors normalisées | waiting_invoices, reason |
report.ready, report.failed |
report |
un rapport est terminé, le vôtre ou celui que votre équipe a demandé dans la console Ripa (un X ou un X périodique, origin: "CONSOLE") |
id, type, origin, state, point_of_sale, nid, session_number, period_start, period_end ; reason_code et reason en cas d’échec |
z_report.closed |
report |
un Z a clos sa session | comme report.ready |
Chaque data nomme aussi l’entreprise, dans business (notre identifiant et le vôtre). Il n’y a pas d’événement sans son fait. Un événement de règlement contient jusqu’à 100 lignes ; au-delà il dit lines_omitted: true et vous lisez la facture (Imprimer votre facture). Le data d’une facture ou d’un avoir porte read_by_reference quand sa référence ne tient pas dans un chemin, comme sa réponse.