Passer au contenu
RemindCash

Créances

Lister, lire, créer et mettre à jour les projets de créances, avec l'objet à recevoir et chaque champ accepté.

État public de l'API

L'API v1 utilise les clés porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte- porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte--porte-------porte------pere-pere.

Points de fin

Méthode Voie Portée
GET /v1/receivables receivables:read
GET /v1/receivables/{id} receivables:read
POST /v1/receivables receivables:write
PATCH /v1/receivables/{id} receivables:write

Les paiements et les changements d'état sont décrits dans Tracking des paiements.

Objet à recevoir

Champ Type Désignation des marchandises
id entier Identification à recevoir au sein de votre entreprise.
customer_id entier Le client à qui appartient cette créance.
amount_minor entier Montant dû en unités mineures.
paid_minor entier Total enregistré comme payé, en unités mineures.
currency chaîne EUR, GBP, TRY ou USD.
due_date chaîne Date d'échéance locale, YYYY-MM-DD.
status chaîne Voir statuses.
external_reference chaîne ou null Votre propre référence, unique au sein de votre entreprise.
description chaîne ou null Texte libre, jusqu'à 2 000 caractères.
version chaîne Empreintes digitales utilisées pour des mises à jour sécurisées.

Liste des créances

Les résultats sont commandés par id et paginés (voir Pagination].

BASH
curl "https://api.remindcash.com/v1/receivables?per_page=25" \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"
JSON
{
    "data": [
        {
            "id": 1,
            "customer_id": 1,
            "amount_minor": 125000,
            "paid_minor": 0,
            "currency": "USD",
            "due_date": "2026-10-15",
            "status": "draft",
            "external_reference": "INV-1042",
            "description": "Website redesign",
            "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
        }
    ],
    "meta": { "current_page": 1, "per_page": 25, "total": 1 },
    "request_id": "762e599f-c42c-4c49-84fb-9a2f56a3f923"
}

Récupérer une créance

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

Un ID inconnu — ou un ID appartenant à une autre société — renvoie 404 not_found.

Créer un projet de créance

POST /v1/receivables crée une créance dans draft Il faut un Idempotency-Key en-tête et retourne 201 Created.

Champ Requis Règles
customer Un des customer ou customer_id Objet avec display_name (requis, max 160) et au moins un des email ou phone_e164. Optionnel preferred_locale (en, tr) et IANA timezone.
customer_id Un des customer ou customer_id Un client existant dans votre entreprise.
amount Oui Chaîne décimale positive, jusqu'à deux décimales.
currency Oui EUR, GBP, TRY ou USD.
due_date Oui YYYY-MM-DD.
external_reference Numéro Une référence déjà utilisée dans votre entreprise renvoie 409 conflict.
description Numéro Max 2 000 caractères.

phone_e164 doit être en format E.164, par exemple +14155550100. Les champs tels que status ou tenant_id sont rejetés.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042"
  }'

Les nouveaux clients créés de cette façon ont encore besoin de leur contact vérifié et autorisation enregistrée dans l'application avant que tout rappel puisse être envoyé.

Mettre à jour un projet de créance

PATCH /v1/receivables/{id} modifie une ébauche. Envoyer expected_version (le version que vous avez lu en dernier) plus au moins un champ à modifier : customer_id, amount, currency, due_date, external_reference ou description.

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --request PATCH \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: update-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "expected_version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1",
    "due_date": "2026-10-20"
  }'

La réponse contient la valeur à recevoir mise à jour et sa nouvelle version. La mise à jour renvoie 409 conflict lorsque :

  • expected_version ne correspond plus (quelqu'un l'a changé en premier),
  • la créance n'est plus un projet,
  • il s'agit d'une occurrence d'une série récurrente,
  • un paiement existe et vous essayez de changer le client, le montant ou la devise.