Passer au contenu

Concepts

Sociétés et clés, états des créances, montants en unités mineures, dates d'échéance locales et versions.

Entreprises

Chaque clé API appartient exactement à une entreprise. Une clé ne peut que voir et modifier les enregistrements de cette entreprise. Demander un ID qui appartient à une autre entreprise renvoie 404 not_found, donc les enregistrements d'autres entreprises ne peuvent pas être découverts.

Statuts à recevoir

État Signification
draft Créé mais pas actif. Aucun rappel n'est prévu ou envoyé.
active Les rappels suivent l'horaire de l'entreprise.
partially_paid Une partie du montant a été comptabilisée comme étant payée; les rappels utilisent le montant restant.
paid Les rappels futurs s'arrêtent.
paused Les rappels sont en attente jusqu'à la reprise.
disputed Le client conteste le montant; aucun rappel n'est envoyé.
cancelled Fermé sans paiement. Aucun rappel n'est envoyé.

Montants

Envoyer des montants comme strings avec jusqu'à deux décimales, par exemple "1250.00". Une virgule est acceptée comme séparateur décimal ("1250,50"). Les montants doivent être positifs.

Les réponses retournent entier minor units: amount_minor: 125000 est 1,250.00. Les devises supportées sont EUR, GBP, TRY et USD. RemindCash ne convertit jamais entre les devises.

Dates et heures

  • due_date est une date de calendrier local au format YYYY-MM-DD, et non un horodatage.
  • Des instantanés comme recorded_at ou submitted_at sont des horodatages ISO 8601 dans TUC.
  • Les heures d'envoi des rappels sont calculées dans le fuseau horaire IANA de l'entreprise (ou du client), y compris les changements d'économie de jour.

Versions

Chaque réponse à recevoir comprend une empreinte digitale de 64 caractères de version. Passez-la sous expected_version lorsque vous mise à jour d'un draft. Si la créance a changé dans l'intervalle, la mise à jour est rejeté avec 409 conflict au lieu d'écraser des données plus récentes.

Rappels et sécurité

L'envoi est décidé par le moteur de rappel après l'activation dans l'application. Avant chaque envoi, il vérifie de nouveau le statut de la créance, le montant payé, l'opt-out client, le plan et la disponibilité du canal, donc un à recevoir marqué payé ou pause n'est pas rappelé.