Pour: Administrateurs
Consultez les factures à l'aide d'une clé de gestion.
Répertoriez les factures publiées de votre plateforme et consultez-en une, avec ses montants, son mode de paiement et son remboursement, pour votre comptabilité ou vos rapports.
Dans cet article4 sections
Avant de commencer
Cette page traite de la lecture des factures. Les détails concernant les factures sont indiqués sous https://prd-api-manage.caseactive.com/v1/<hub id>. Cette fonction permet de voir toutes les factures publiées pour chaque cas, y compris les cas déjà clos. Elle ne permet pas de créer, de modifier, de rembourser ou de payer des factures.
Appels
| Appel | Ce que cela fait |
|---|---|
GET /invoices | Listes des factures publiées, avec les dernières factures en premier. |
GET /invoices/<case_id>/<invoice_id> | Lise une facture. |
| Paramètre | Ce que cela fait | Requis | Défaut |
|---|---|---|---|
status | Seuls les factures ayant ce statut peuvent être traitées : open, paid, void, uncollectible ou processing. | Non. | Tout |
case_id | Seules les factures de un seul cas sont incluses. | Non. | Chaque cas est différent. |
limit | Combien de factures peuvent être affichées par une seule page ? Jusqu’à 1000 factures. | Non. | 20 |
start_key | Le startKey de la page précédente | Non. | Première page |
Tant que des factures restent en attente, appelez nextLink, ou envoyez des données sous la forme de startKey à start_key. Cette liste ne contient aucun filtre par date, ni par la dernière fois où une facture a été modifiée. Pour savoir ce qui a changé depuis votre dernière synchronisation, y compris les paiements et les remboursements, recherchez dans la table case_invoices en utilisant filter_by=updated_on:>, suivi de l’heure de votre dernière synchronisation en secondes Unix. Les modifications sont répertoriées quelques secondes après leur enregistrement. Commencez donc chaque recherche un peu avant la fin de la précédente. Ajoutez filter_by=refund_status:=succeeded pour trouver les remboursements. Consultez Recherche des cas et des utilisateurs avec une fonction de gestion.
Une facture
Toute somme de monnaie correspond à un nombre entier en centimes, en dollars américains : 96300 équivaut à 963,00 dollars.
{
"data": {
"case_id": "cc-1a2b3c4d5e6f70",
"invoice_id": "invoice::20260915143000_ab12cd34ef5678",
"host_id": "ca-7e6d5c4b3a2f10",
"name": "September legal services",
"description": "Consultation and filing for Jane Sample's claim",
"invoice_number": "INV-1042",
"po_number": "PO-778",
"terms": "Net 15",
"host_ref_id": "acct-1042",
"notes": "Thank you for your business.",
"participants_ids": ["cu-4f1c2a9e8b7d60"],
"user_id": "cu-9d8c7b6a5f4e30",
"status": "paid",
"due_date": "2026-09-30T17:00:00+00:00",
"transactions": {
"transactions": [
{"transaction_type": "charge", "description": "Consultation (hours)", "value": 35000, "quantity": 2, "currency": "usd"},
{"transaction_type": "charge", "description": "Court filing fee", "value": 30000, "quantity": 1, "currency": "usd"}
],
"discount": 0.1,
"tax": 0.07
},
"subtotal": 100000,
"discount": 0.1,
"discount_amount": 10000,
"discounted_amount": 90000,
"tax": 0.07,
"tax_amount": 6300,
"total": 96300,
"payment_gateway": "stripe",
"stripe_payment": {"user_id": "cu-4f1c2a9e8b7d60", "fees": 2863, "stripe_fee": 2823, "application_fee": 40, "net": 93437},
"payment_attempts": [{"datetime": "2026-09-20T14:05:12+00:00", "success": true, "user_id": "cu-4f1c2a9e8b7d60"}],
"completed_on": "2026-09-20T14:05:20+00:00",
"published": 1,
"created_on": "2026-09-15T14:30:00+00:00",
"updated_on": "2026-09-20T14:05:20+00:00"
}
}
| Champ | Ce qu'il contient |
|---|---|
invoice_id, case_id | L’avis de paie, ainsi que l’enveloppe sur laquelle il est établi… Lisez l’un des deux documents ensemble. |
name, description | Son titre et sa description |
invoice_number, po_number, terms, notes, host_ref_id | Tiré sur la facture. host_ref_id est son identifiant de référence. |
participants_ids | Les personnes à qui cela est destiné… |
user_id | Qui l’a créé ? |
status | open : en attente de paiement. paid : payé en ligne ou marqué comme payé. void : annulé. uncollectible et processing : définis par votre personnel. paid et void sont les décisions définitives. |
due_date | Lorsqu’il est temps… |
transactions | Ses lignes sont constituées de valeurs du type charge ou credit. En plus, il y a une valeur description, des valeurs en centaines value, et une valeur quantity. De plus, il y a des taux qui s’appliquent à ces valeurs. |
subtotal | Les charges moins les crédits ne jamais être inférieures à 0. |
discount, discount_amount, discounted_amount | Le taux d’intérêt, exprimé en pourcentage (0.1), est de 10 %. Le montant déduit, en centimes, est également indiqué. Enfin, le montant total après la déduction est également mentionné. |
tax, tax_amount | Le taux d’imposition sous forme de fraction0.07 Il s’agit de 7 % ; le montant imposable, en centimes, correspond au montant après déduction des frais. |
total | Quel est le montant à payer, en centimes ? |
payment_gateway | Lorsque le paiement s’effectue en ligne, stripe ; lorsque votre personnel le marque comme ayant été payé, manual. |
stripe_payment | Pour un paiement en ligne : qui a payé, quelles sont les frais et le montant net en centimes. |
payment_attempts | Chaque personne essaie de payer en ligne : quand cela a fonctionné, et pourquoi pas. |
refunded | Un remboursement, si tel est le cas : son status (pending, succeeded, failed ou canceled), amount en centimes, et reason. L’état de la facture reste constant, c’est-à-dire paid. |
completed_on | Lorsque le paiement a été effectué ou que l’opération est annulée. |
Si un appel est refusé
| Statut | message | Pourquoi |
|---|---|---|
| 404 | InvoiceDoesNotExistException | Il n’y a aucune facture sur cette affaire, dans votre centre de traitement. |
| 400 | InvoiceNotPublishedException | La facture est un virement bancaire. |
| 400 | SchemaFieldsException | status n’est pas l’un des cinq. |
| 400 | InvalidStartKeyException | start_key n’était pas dans cette liste. |
Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.