Disputes

Dossier de litige commercial multi-subject piloté par un processus.

Objet métier

Vue d’ensemble

Les endpoints disputes ouvrent, listent, consultent et mettent à jour le périmètre d’un dossier commercial. Sa résolution finale est effectuée explicitement dans le processus associé.

Voir aussi la page du modèle métier dispute pour la sémantique, les relations et le cycle de vie fonctionnel.

Contrat JSON

Objet dispute

Les réponses utilisent l’identifiant préfixé dis_ et le champ object pour rendre le type explicite.

buyer_idstring

Company acheteur commune à tous les subjects.

subjectsarray

Invoices, orders ou line items contextualisés effectivement contestés.

currencystring | null

Devise unique dérivée des subjects monétaires.

amount_disputednumber | null

Montant contesté agrégé optionnel.

statusenum

open, resolved ou cancelled.

resolution_statusenum

pending, accepted, partially_accepted, rejected ou withdrawn.

related_objectsarray

Objets métier significatifs liés au traitement ou à la résolution.

process_instance_idstring | null

Instance de processus courante propriétaire du dossier.

REST

Endpoints

MéthodeEndpointUsage
POST/v1/disputesOuvrir un dossier et démarrer son processus.
GET/v1/disputesLister les dossiers avec filtres marchand, acheteur, facture, statut ou statut de résolution.
GET/v1/disputes/{id}Récupérer un dossier.
POST/v1/disputes/{id}Mettre à jour un dossier encore open.
GET/v1/invoices/{id}/disputesLister les dossiers qui couvrent une invoice.

Événements

Événements associés

Ces événements peuvent être consommés via les webhooks plateforme lorsque le compte est configuré pour les recevoir.

dispute.createddispute.resolveddispute.cancelledinvoice.disputedinvoice.dispute_cleared

Comportement

Points d’attention

  • Un line_item doit toujours être contextualisé par invoice_id et/ou order_id.
  • Tous les subjects monétaires d’un même dossier utilisent la même devise.
  • Le statut terminal d’un processus ne clôt pas automatiquement le litige : la résolution métier reste explicite.