Solavel Documents
Français
Référence développeur

API Finance SolaCount

Version : v1 URL de base : https://solavel.com/api/v1 (remplacez par votre domaine) Format : JSON 33 points d'accès

L'API Finance SolaCount permet de consulter et modifier par programme les données comptables : clients, fournisseurs, factures clients et fournisseurs, paiements, écritures comptables et rapports financiers. Tous les points de terminaison renvoient du JSON. Créer une clé API →

Authentification

Chaque point d'accès protégé nécessite trois en-têtes :

X-API-Key: solabooks_<prefix>.<secret>
X-Organization-Id: 1
X-Client-Id: 4
  • X-API-Key — la clé complète affichée une seule fois lors de la création, dans Paramètres → Accès API
  • X-Organization-Id — l'identifiant entier de votre organisation (visible sur la page Accès API)
  • X-Client-Id — votre identifiant client (visible sur la page Accès API)
Générer une clé : Aller à Paramètres → Accès API dans SolaCount . La clé complète est affichée exactement une fois. Chaque clé a des portées — ne donnez que les portées dont vous avez besoin.

Le point d'accès GET /api/v1/health ne nécessite aucune authentification et peut être utilisé pour vérifier la connectivité.

Format de réponse

Toutes les réponses utilisent une enveloppe JSON cohérente.

Objet unique

{
  "success": true,
  "data": { ... }
}

Liste paginée

{
  "success": true,
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 100,
    "last_page": 4
  }
}

Erreur

{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "Human readable message."
  }
}

Test rapide

Remplacez your_key , 1 et 4 par votre clé API réelle, votre ID d'organisation et votre ID client.

Vérification de l'état (aucune authentification requise)

curl https://solacount.com/api/v1/health

Liste des factures

curl https://solacount.com/api/v1/invoices \
  -H "X-API-Key: your_key" \
  -H "X-Organization-Id: 1" \
  -H "X-Client-Id: 4"

Créer un client

curl -X POST https://solacount.com/api/v1/customers \
  -H "X-API-Key: your_key" \
  -H "X-Organization-Id: 1" \
  -H "X-Client-Id: 4" \
  -H "Content-Type: application/json" \
  -d '{"name":"Demo Customer","email":"billing@example.com"}'

Créer une écriture comptable

curl -X POST https://solacount.com/api/v1/journal-entries \
  -H "X-API-Key: your_key" \
  -H "X-Organization-Id: 1" \
  -H "X-Client-Id: 4" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2026-06-07",
    "reference": "JE-001",
    "description": "Manual accrual",
    "lines": [
      {"account_id": 101, "debit": 1000, "credit": 0},
      {"account_id": 202, "debit": 0, "credit": 1000}
    ]
  }'

Tous les points de terminaison

Cliquez sur n'importe quel point de terminaison pour développer ses détails. 33 points de terminaison au total répartis sur 8 groupes de ressources.

Santé

GET /api/v1/health sans authentification

Confirmez que l'API est en ligne et répond. Aucune authentification requise.

Réponse HTTP 200

{"success":true,"data":{"service":"finance-api","status":"ok","timestamp":"2026-06-07T12:00:00+00:00"}}

Clients

GET /api/v1/customers portée : customers.get

Liste de tous les clients. Prend en charge la recherche et la pagination.

Paramètres de requête

ParamètreTypeDescriptif
search string optionnel Filtrer par nom, email ou téléphone (correspondance partielle)
page integer optionnel Numéro de page (par défaut : 1)
per_page integer optionnel Résultats par page (par défaut : 25, max : 100)

Réponse HTTP 200

{"success":true,"data":[{"id":1,"name":"Demo Customer","email":"billing@example.com","phone":"+1-555-0100","is_active":true}],"meta":{"current_page":1,"per_page":25,"total":3,"last_page":1}}
GET /api/v1/customers/{id} portée : customers.get

Récupérer un seul client par ID.

Réponse HTTP 200

{"success":true,"data":{"id":1,"name":"Demo Customer","email":"billing@example.com","phone":"+1-555-0100","is_active":true}}
POST /api/v1/customers portée : customers.post

Créer un nouveau client.

Corps de la requête (JSON)

ChampTypeDescriptif
name string requis Nom du client
email string optionnel Adresse e-mail (doit être un e-mail valide)
phone string optionnel Numéro de téléphone (max 50 caractères)
is_active boolean optionnel Statut actif (par défaut : vrai)

Réponse HTTP 201

{"success":true,"data":{"id":42,"name":"Demo Customer","email":"billing@example.com","phone":null,"is_active":true}}

Fournisseurs

GET /api/v1/suppliers portée : suppliers.get

Liste de tous les fournisseurs. Prend en charge la recherche et la pagination.

Paramètres de requête

ParamètreTypeDescriptif
search string optionnel Filtrer par nom (correspondance partielle)
page integer optionnel Numéro de page
per_page integer optionnel Résultats par page (max 100)

Réponse HTTP 200

{"success":true,"data":[{"id":1,"name":"Demo Supplier","email":"ap@example.com","tax_id":"GB123456789","is_vat_registered":true}],"meta":{"current_page":1,"per_page":25,"total":1,"last_page":1}}
GET /api/v1/suppliers/{id} portée : suppliers.get

Récupérer un fournisseur unique par ID.

Réponse HTTP 200

{"success":true,"data":{"id":1,"name":"Demo Supplier","email":"ap@example.com","phone":null,"tax_id":"GB123456789","is_overseas":false,"is_vat_registered":true,"reverse_charge":false}}
POST /api/v1/suppliers portée : suppliers.post

Créer un nouveau fournisseur.

Corps de la requête (JSON)

ChampTypeDescriptif
name string requis Nom du fournisseur
email string optionnel Adresse e-mail
phone string optionnel Numéro de téléphone
tax_id string optionnel Numéro de TVA / numéro d'enregistrement fiscal
is_overseas boolean optionnel Indique si le fournisseur est étranger (par défaut : faux)
is_vat_registered boolean optionnel Assujetti à la TVA (par défaut : vrai)
reverse_charge boolean optionnel La TVA autoliquidée s'applique (par défaut : false)

Réponse HTTP 201

{"success":true,"data":{"id":15,"name":"Demo Supplier","email":"ap@example.com","tax_id":"GB123456789","is_vat_registered":true}}

Factures

GET /api/v1/invoices portée : invoices.get

Lister toutes les factures avec la relation client. Prend en charge le filtre de statut et la pagination.

Paramètres de requête

ParamètreTypeDescriptif
status string optionnel Filtre : draft | unpaid | paid | void | overdue
page integer optionnel Numéro de page
per_page integer optionnel Résultats par page (max 100)

Réponse HTTP 200

{"success":true,"data":[{"id":101,"number":"INV-00101","date":"2026-06-01","due_date":"2026-07-01","status":"unpaid","total":5000.00,"customer":{"id":1,"name":"Demo Customer"}}],"meta":{"current_page":1,"per_page":25,"total":48,"last_page":2}}
GET /api/v1/invoices/{id} portée : invoices.get

Récupérer une facture unique avec le client et les lignes d'article.

Réponse HTTP 200

{"success":true,"data":{"id":101,"number":"INV-00101","date":"2026-06-01","due_date":"2026-07-01","status":"unpaid","subtotal":4347.83,"tax_total":652.17,"total":5000.00,"customer":{"id":1,"name":"Demo Customer"},"lines":[{"id":1,"description":"Consulting services","qty":10,"unit_price":434.78,"total":4347.83}]}}
POST /api/v1/invoices portée : invoices.post

Créer une nouvelle facture. Créée avec le statut=brouillon et un numéro généré automatiquement.

Corps de la requête (JSON)

ChampTypeDescriptif
customer_id integer requis ID d'un client existant
date date requis Date de facture (AAAA-MM-JJ)
due_date date optionnel Date d'échéance du paiement (AAAA-MM-JJ)
notes string optionnel Notes internes ou destinées au client
subtotal decimal optionnel Total hors taxes (par défaut : 0)
tax_total decimal optionnel Montant de la taxe (par défaut : 0)
discount_total decimal optionnel Montant de la remise (par défaut : 0)
total decimal optionnel Total TTC (par défaut : 0)

Réponse HTTP 201

{"success":true,"data":{"id":102,"number":"INV-00102","status":"draft","date":"2026-06-07","due_date":"2026-07-07","total":5000.00,"customer_id":1}}
PUT /api/v1/invoices/{id} portée : invoices.update

Mettre à jour une facture brouillon existante. Tous les champs sont optionnels.

Corps de la requête (JSON)

ChampTypeDescriptif
customer_id integer optionnel Nouvel ID client
date date optionnel Date de facture (AAAA-MM-JJ)
due_date date optionnel Date d'échéance du paiement
notes string optionnel Remarques
subtotal decimal optionnel Total hors taxes
tax_total decimal optionnel Montant de la taxe
total decimal optionnel Total TTC

Réponse HTTP 200

{"success":true,"data":{"id":102,"status":"draft","total":6000.00,"customer":{"id":1,"name":"Demo Customer"},"lines":[]}}
POST /api/v1/invoices/{id}/post portée : invoices.post

Enregistrer une facture brouillon dans le grand livre. Nécessite un total > 0 et une date. Change le statut en impayé.

Réponse HTTP 200

{"success":true,"data":{"id":102,"status":"unpaid","posted_at":"2026-06-07T12:00:00Z","total":5000.00}}

Erreurs possibles : invoice_already_posted , invoice_total_required , invoice_date_required

POST /api/v1/invoices/{id}/void portée : invoices.void

Annuler une facture comptabilisée. Inverse toutes les écritures comptables et marque la facture comme annulée.

Réponse HTTP 200

{"success":true,"data":{"id":102,"status":"void"}}
POST /api/v1/invoices/{id}/mark-sent portée : invoices.send

Marquer une facture brouillon comme envoyée au client (change le statut de brouillon à impayé). Idempotent.

Réponse HTTP 200

{"success":true,"data":{"id":102,"status":"unpaid"}}
DELETE /api/v1/invoices/{id} portée : invoices.delete

Supprimer définitivement une facture brouillon et toutes ses lignes. Impossible de supprimer des factures comptabilisées ou des factures avec des allocations de paiement.

Réponse HTTP 200

{"success":true,"data":{"message":"Invoice deleted."}}

Erreurs possibles : posted_invoice_not_deletable , invoice_has_allocations

Factures

GET /api/v1/bills portée : bills.get

Liste de toutes les factures fournisseurs. Prend en charge le filtre par statut et la pagination.

Paramètres de requête

ParamètreTypeDescriptif
status string optionnel Filtre : draft | unpaid | paid | void
page integer optionnel Numéro de page
per_page integer optionnel Résultats par page (max 100)

Réponse HTTP 200

{"success":true,"data":[{"id":55,"number":"BILL-00055","date":"2026-06-01","status":"draft","total":2000.00,"supplier":{"id":3,"name":"Demo Supplier"}}],"meta":{"current_page":1,"per_page":25,"total":12,"last_page":1}}
GET /api/v1/bills/{id} portée : bills.get

Récupérer une seule facture fournisseur avec le fournisseur et les lignes d'articles.

Réponse HTTP 200

{"success":true,"data":{"id":55,"number":"BILL-00055","date":"2026-06-01","due_date":"2026-07-01","status":"draft","reference":"PO-001","total":2000.00,"supplier":{"id":3,"name":"Demo Supplier"},"lines":[]}}
POST /api/v1/bills portée : bills.post

Créer une nouvelle facture fournisseur. Créée avec le statut=brouillon et un numéro BILL-XXXXX généré automatiquement.

Corps de la requête (JSON)

ChampTypeDescriptif
supplier_id integer requis ID d'un fournisseur existant
date date requis Date de la facture fournisseur (AAAA-MM-JJ)
due_date date optionnel Date d'échéance du paiement
reference string optionnel Référence fournisseur / numéro de commande (max 120)
notes string optionnel Notes internes
subtotal decimal optionnel Total hors taxes (par défaut : 0)
tax_total decimal optionnel Montant de la taxe (par défaut : 0)
discount_total decimal optionnel Remise (par défaut : 0)
total decimal optionnel Total TTC (par défaut : 0)

Réponse HTTP 201

{"success":true,"data":{"id":56,"number":"BILL-00056","status":"draft","date":"2026-06-07","total":2000.00,"supplier_id":3}}
PUT /api/v1/bills/{id} portée : bills.update

Mettre à jour une facture fournisseur brouillon existante. Tous les champs sont optionnels.

Corps de la requête (JSON)

ChampTypeDescriptif
supplier_id integer optionnel Nouvel ID fournisseur
date date optionnel Date de la facture fournisseur
due_date date optionnel Date d'échéance du paiement
reference string optionnel Référence fournisseur
total decimal optionnel Total TTC

Réponse HTTP 200

{"success":true,"data":{"id":56,"status":"draft","total":2500.00,"supplier":{"id":3,"name":"Demo Supplier"}}}
POST /api/v1/bills/{id}/post portée : bills.post

Comptabiliser une facture fournisseur brouillon dans le grand livre, en enregistrant la dette à payer.

Réponse HTTP 200

{"success":true,"data":{"id":56,"status":"unpaid","posted_at":"2026-06-07T12:00:00Z"}}

Erreurs possibles : bill_post_failed

DELETE /api/v1/bills/{id} portée : bills.delete

Supprimer définitivement une facture fournisseur brouillon. La facture doit être au statut brouillon sans allocations de paiement.

Réponse HTTP 200

{"success":true,"data":{"message":"Bill deleted."}}

Erreurs possibles : posted_bill_not_deletable , bill_has_allocations

Paiements

GET /api/v1/payments portée : payments.get

Lister tous les paiements (reçus et décaissements).

Paramètres de requête

ParamètreTypeDescriptif
type string optionnel Filtre : receipt | disbursement
status string optionnel Filtre : draft | posted
page integer optionnel Numéro de page
per_page integer optionnel Résultats par page (max 100)

Réponse HTTP 200

{"success":true,"data":[{"id":20,"type":"receipt","payment_date":"2026-06-07","amount_total":5000.00,"status":"draft","customer_id":1}],"meta":{"current_page":1,"per_page":25,"total":8,"last_page":1}}
POST /api/v1/payments portée : payments.post

Enregistrer un reçu de paiement (le client a payé) ou un décaissement (vous avez payé le fournisseur). Optionnellement allouer contre une facture ou une facture fournisseur.

Corps de la requête (JSON)

ChampTypeDescriptif
type string requis receipt (paiement client) ou disbursement (paiement fournisseur)
payment_date date requis Date de paiement (AAAA-MM-JJ)
amount_total decimal requis Montant total payé (doit être > 0)
method string optionnel Méthode de paiement, ex. virement_bancaire, espèces, carte
reference string optionnel Référence bancaire ou numéro de chèque (max 120)
description string optionnel Description ou mémo
customer_id integer cond. Requis pour les paiements de reçu (déduit de la facture si document_type=ar_invoice)
supplier_id integer cond. Requis pour les paiements de décaissement (déduit de la facture fournisseur si document_type=ap_bill)
document_type string optionnel "ar_invoice" ou "ap_bill" — déclenche l'allocation automatique
document_id integer optionnel ID de la facture ou de la facture fournisseur à allouer (requis lorsque document_type est défini)
allocated_amount decimal optionnel Montant à allouer (par défaut : montant_total)

Réponse HTTP 201

{"success":true,"data":{"id":21,"type":"receipt","payment_date":"2026-06-07","amount_total":5000.00,"status":"draft","allocations":[{"document_type":"ar_invoice","document_id":101,"allocated_amount":5000.00}]}}

Erreurs possibles : document_required, document_type_mismatch, invoice_not_found, bill_not_found, client_required, supplier_required

Entrées de journal

GET /api/v1/journal-entries portée : journal_entries.get

Lister les écritures de journal avec les lignes et les comptes. Prend en charge le filtrage par plage de dates.

Paramètres de requête

ParamètreTypeDescriptif
status string optionnel Filtre : draft | posted
from date optionnel Date de début (AAAA-MM-JJ)
to date optionnel Date de fin (AAAA-MM-JJ)
page integer optionnel Numéro de page
per_page integer optionnel Résultats par page (max 100)

Réponse HTTP 200

{"success":true,"data":[{"id":5,"entry_date":"2026-06-07","reference":"JE-001","status":"posted","lines_count":2}],"meta":{"current_page":1,"per_page":25,"total":5,"last_page":1}}
POST /api/v1/journal-entries portée : journal_entries.post

Créer et comptabiliser immédiatement une écriture de journal équilibrée. Les débits totaux doivent être égaux aux crédits totaux (tolérance ±0,01).

Corps de la requête (JSON)

ChampTypeDescriptif
date date requis Date d'écriture (AAAA-MM-JJ)
reference string optionnel Code de référence, par ex. JE-001 (max 120)
description string optionnel Mémo / description (max 2000)
lines array requis Minimum 2 lignes. Chaque ligne : account_id (requis), débit (décimal), crédit (décimal), description (chaîne)

Réponse HTTP 201

{"success":true,"data":{"id":6,"entry_date":"2026-06-07","reference":"JE-001","status":"posted","posted_at":"2026-06-07T12:00:00Z","lines":[{"account_id":101,"account":{"code":"1100","name":"Cash"},"debit":1000,"credit":0},{"account_id":202,"account":{"code":"3000","name":"Equity"},"debit":0,"credit":1000}]}}

Erreurs possibles : journal_not_balanced

DELETE /api/v1/journal-entries/{id} portée : journal_entries.delete

Supprimer une écriture de journal non comptabilisée. Les écritures comptabilisées ne peuvent pas être supprimées via l'API.

Réponse HTTP 200

{"success":true,"data":{"message":"Journal entry deleted."}}

Erreurs possibles : posted_journal_not_deletable

Rapports

Tous les points d'accès de rapport acceptent ?from=YYYY-MM-DD&to=YYYY-MM-DD . Le bilan, la balance des comptes et les rapports d'ancienneté acceptent également ?as_of=YYYY-MM-DD (équivalent à to ).

GET /api/v1/reports/income-statement portée : reports.income_statement

Rapport de résultat. Retourne les revenus, les dépenses et le revenu net pour la période spécifiée.

Paramètres de requête

ParamètreTypeDescriptif
from date optionnel Date de début de période (AAAA-MM-JJ)
to date optionnel Fin de période (AAAA-MM-JJ)

Réponse HTTP 200

{"success":true,"data":{"revenue":150000,"expenses":85000,"net_income":65000}}
GET /api/v1/reports/balance-sheet portée : reports.balance_sheet

Instantané du bilan. Retourne les actifs, les passifs et les capitaux propres à la date spécifiée.

Paramètres de requête

ParamètreTypeDescriptif
to date optionnel Date de référence (AAAA-MM-JJ). Également accepté sous la forme ?as_of=

Réponse HTTP 200

{"success":true,"data":{"assets":{"total":250000},"liabilities":{"total":80000},"equity":{"total":170000}}}
GET /api/v1/reports/cash-flow portée : reports.cash_flow

Tableau des flux de trésorerie pour la période spécifiée (méthode directe).

Paramètres de requête

ParamètreTypeDescriptif
from date optionnel Début de période
to date optionnel Fin de période

Réponse HTTP 200

{"success":true,"data":{"operating":45000,"investing":-12000,"financing":-8000,"net_change":25000}}
GET /api/v1/reports/trial-balance portée : reports.trial_balance

Balance des comptes montrant tous les comptes avec les totaux de débit et de crédit à une date.

Paramètres de requête

ParamètreTypeDescriptif
to date optionnel Date de référence (AAAA-MM-JJ)

Réponse HTTP 200

{"success":true,"data":[{"account_code":"1100","account_name":"Cash","debit":50000,"credit":0},{"account_code":"2000","account_name":"Accounts Payable","debit":0,"credit":15000}]}
GET /api/v1/reports/ar-aging portée : reports.ar_aging

Ancienneté des comptes clients. Factures clients impayées réparties selon leur retard.

Paramètres de requête

ParamètreTypeDescriptif
to date optionnel Date de référence de l'ancienneté (AAAA-MM-JJ)

Réponse HTTP 200

{"success":true,"data":{"current":12000,"1_30":3500,"31_60":800,"61_90":0,"over_90":500,"total":16800}}
GET /api/v1/reports/ap-aging portée : reports.ap_aging

Ancienneté des dettes fournisseurs. Factures fournisseurs impayées regroupées par durée de retard.

Paramètres de requête

ParamètreTypeDescriptif
to date optionnel Date de référence de l'ancienneté (AAAA-MM-JJ)

Réponse HTTP 200

{"success":true,"data":{"current":8000,"1_30":1200,"31_60":0,"61_90":0,"over_90":0,"total":9200}}
GET /api/v1/reports/tax portée : reports.tax

Synthèse TVA / taxe. Retourne la taxe perçue sur les ventes et la taxe payée sur les achats pour la période.

Paramètres de requête

ParamètreTypeDescriptif
from date optionnel Début de période
to date optionnel Fin de période

Réponse HTTP 200

{"success":true,"data":{"tax_collected":15000,"tax_paid":4200,"net_vat_payable":10800}}

Référence d'erreur

Code d'erreur HTTP Signification
invoice_already_posted 422 La facture est déjà comptabilisée dans le grand livre
invoice_total_required 422 Impossible de comptabiliser une facture avec un total nul ou négatif
invoice_date_required 422 La date du document est requise avant la comptabilisation
posted_invoice_not_deletable 422 Annuler ou décomptabiliser la facture avant de la supprimer
invoice_has_allocations 422 Supprimez les allocations de paiement avant de supprimer
posted_bill_not_deletable 422 Impossible de supprimer une facture fournisseur comptabilisée ou non brouillon
bill_has_allocations 422 Supprimez les allocations de paiement avant de supprimer
bill_post_failed 422 La facture fournisseur a échoué à la validation interne de comptabilisation
journal_not_balanced 422 Les débits totaux ne sont pas égaux aux crédits totaux
posted_journal_not_deletable 422 Seules les écritures (non comptabilisées) peuvent être supprimées
document_required 422 document_id est requis lorsque document_type est défini
document_type_mismatch 422 ar_invoice nécessite receipt ; ap_bill nécessite disbursement
invoice_not_found 404 La facture avec cet ID n'existe pas
bill_not_found 404 La facture fournisseur avec cet ID n'existe pas
client_required 422 customer_id est requis pour les paiements receipt
supplier_required 422 supplier_id est requis pour les paiements disbursement

Pagination

Tous les points de terminaison de liste renvoient des résultats paginés. Contrôlez la pagination avec les paramètres de requête :

ParamètrePar défautMaximumDescriptif
page1—Numéro de page à récupérer
per_page25100Nombre de résultats par page

L'objet meta dans chaque réponse de liste contient current_page, per_page, total et last_page.