Guide de démarrage rapide

Ce guide vous mène de votre première requête jusqu'à la création d'un client et d'une facture dans Acomba.

Prérequis

Une clé API (voir Authentification). Pour les étapes 3 et 4, la clé doit permettre l'écriture.

L'adresse de votre API. Elle a la forme https://relay.exoconnect.app/VOTRE_CHEMIN ; VOTRE_CHEMIN est propre à votre installation. Dans les exemples, remplacez BASE_URL par cette adresse.

Données de démonstration

Les noms, codes et montants de ce guide sont fictifs. Faites vos premiers essais d'écriture dans un dossier Acomba de test.

Étape 1 : vérifier votre accès

Un appel simple suffit : il lit la première page du plan comptable.

cURL

Python

JavaScript

Réponse 200

Un 200 confirme que votre clé est valide et que l'API répond.

Pas de 200 ?

401 : l'en-tête x-api-key est absent.

403 : la clé est invalide, expirée ou révoquée.

503 : Acomba n'est pas joignable pour l'instant (pause, fenêtre d'arrêt, service en redémarrage). Réessayez plus tard.

Le détail se trouve dans Codes d'erreur.

Étape 2 : lire un client

Lisez la fiche complète d'un client par son code.

cURL

Python

JavaScript

Réponse 200 (extrait)

id ou unique_id ?

id sert à toutes les routes /by-id/{id}. Mais Acomba réutilise l'id d'une fiche supprimée pour la prochaine fiche créée. Pour relier durablement une fiche Acomba à votre système, conservez aussi metadata.unique_id et vérifiez-le à la relecture. Voir Concepts clés.

Étape 3 : créer un client

number (le code) et name sont obligatoires. Les références à d'autres fiches (terme de paiement, vendeur, territoire…) se passent par leur code numérique Acomba.

cURL

Python

JavaScript

Réponse 200

language_id : 0 français, 1 anglais, 2 espagnol.

Un code déjà utilisé répond 409.

created_id est l'id du nouveau client : GET /api/customers/by-id/416 relit la fiche complète.

Champs inconnus

Un champ qui n'existe pas dans le schéma est ignoré sans erreur. Vérifiez le nom exact de chaque champ dans la référence de l'endpoint.

Étape 4 : créer une facture

code (numéro de la facture) et date sont obligatoires. Le client se désigne par customer_code ou customer_id, et chaque ligne désigne son produit par sku (code produit) ou product_id.

cURL

Python

JavaScript

Réponse 200

Sur une facture, la quantité se donne dans invoiced_qty (quantité facturée) ; sur une commande, une soumission ou un achat, dans ordered_qty. unit_price est le prix avant escompte ; discount_percent applique un escompte. Pour imposer le prix final, utilisez selling_price. Les taxes suivent le groupe de taxes du client, sauf si vous passez tax_context.

Et ensuite ?

Concepts clés

Pagination, résumé ou fiche complète, identifiants, réponses d'écriture, suivi des changements.

Codes d'erreur

Formats d'erreur, codes HTTP et quand réessayer.

Tableaux de bord et analyses

Âge des comptes, comptes à recevoir, trésorerie, ventes, paie : des chiffres déjà calculés.

Authentification

Clés en lecture seule ou en écriture, expiration, données de paie sensibles.

Étape 1 : vérifier votre accès#

Étape 2 : lire un client#

Étape 3 : créer un client#

Étape 4 : créer une facture#

Et ensuite ?#

Étape 1 : vérifier votre accès

Étape 2 : lire un client

Étape 3 : créer un client

Étape 4 : créer une facture

Et ensuite ?