Comment fonctionne l'API Recouvrement ?

Compte client requis

L'API Recouvrement Rubypayeur vous permet d'ouvrir des dossiers de recouvrement et d'en consulter le suivi de façon automatique. Un gain de temps très important si vous avez du volume à traiter.

Notre API (Application Programming Interface) fonctionne en JSON (JavaScript Object Notation). Elle vous permet d'ouvrir un dossier de recouvrement et d'en consulter son suivi de manière automatique. Cette API est disponible pour tous les clients Rubypayeur (abonnés et non-abonnés).

En utilisant l'API Recouvrement vous acceptez nos conditions générales d'utilisation.

Pour ouvrir un dossier de recouvrement via l'API, vous devrez fournir les informations suivantes : 

• SIREN ou SIRET

• Civilité

• Prénom

• Nom

• Adresse mail

• Téléphone

• Montant TTC

• Numéro

• Date d'émission

• Date d'échéance

• Montant TTC acompte (optionnel)

• Date acompte (optionnel)

• PDF de la facture (10 Mo maximum)

• Un document contractuel comme un contrat / devis / bon de commande / bon de livraison signé ou tout autre document justificatif (10 Mo maximum)

• Réclamation de l'indemnité forfaitaire de 40 euros par facture pour frais de recouvrement (OUI / NON)

• Commentaire éventuel pour préciser le contexte du dossier (optionnel)

Une fois le dossier ouvert, vous récupérez sa référence via l'API.
Vous aurez la possibilité d'interroger l'API à tout moment pour connaitre le statut d'un dossier (à l'aide de sa référence).

Vous pourrez aussi interroger l'API à tout moment pour obtenir la liste complète des références des dossiers ouverts.

Nous mettons à votre disposition une documentation technique pour vous aider à paramétrer correctement l'API. Cette documentation intègre une démonstration Postman (pré-configurée).

Une fois inscrit sur Rubypayeur, vous aurez accès à votre token API Recouvrement directement dans votre espace client (attetion de ne pas confondre avec le token API Data).

https://rubypayeur.notion.site/Documentation-technique-99471b3b28ac4fabac9d9495b747ed49