Para: Administradores
Lea las facturas con una clave de administración.
Enumera las facturas publicadas de tu centro y revisa una de ellas, con sus importes, pago y reembolso, para tu propia contabilidad o elaboración de informes.
En este artículo4 secciones
Antes de empezar
Esta página trata sobre cómo leer las facturas. Los datos relacionados con las facturas se encuentran en https://prd-api-manage.caseactive.com/v1/<hub id>. La función “Key” permite ver todas las facturas publicadas, incluyendo aquellas que ya han sido cerradas, pero no puede crear, modificar, reembolsar o pagar ninguna factura.
Llamadas
| Llamar | Lo que hace |
|---|---|
GET /invoices | Listas que contienen las facturas publicadas; las más recientes van en primer lugar. |
GET /invoices/<case_id>/<invoice_id> | Lee una factura. |
| Parámetro | Lo que hace | Requerido | Por defecto |
|---|---|---|---|
status | Solo las facturas que tengan este estado: open, paid, void, uncollectible o processing. | No. | Todo |
case_id | Solo hay una factura en este caso. | No. | Cada caso es diferente. |
limit | ¿Cuántas facturas puede contener una página? Hasta 1000. | No. | 20 |
start_key | El startKey de la página anterior | No. | Primera página |
Mientras todavía haya facturas pendientes, llame a nextLink, o envíe datos a startKey como start_key. Esta lista no tiene filtrado por fecha, ni por cuándo se modificó una factura por última vez. Para saber qué ha cambiado desde tu última sincronización, incluyendo los pagos y los reembolsos, busca en la tabla case_invoices utilizando filter_by=updated_on:>, seguido del tiempo de tu última sincronización en segundos Unix. Los cambios se registran unos segundos después de su inclusión en el sistema; por lo tanto, comienza cada ventana un poco antes de que la anterior termine. Agrega filter_by=refund_status:=succeeded para encontrar los reembolsos. Consulte Buscar casos y usuarios con el botón de gestión.
Una factura
Cada cantidad representa un número entero en centavos, en dólares estadounidenses: 96300 equivale a 963.00 dólares.
{
"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"
}
}
| Campo | Lo que contiene |
|---|---|
invoice_id, case_id | La factura, y el caso en el que se encuentra. Lea una factura con ambos elementos. |
name, description | Su título y descripción |
invoice_number, po_number, terms, notes, host_ref_id | Se ha escrito en la factura. host_ref_id es su identificación de referencia. |
participants_ids | La gente a la que se le ofrece esto… |
user_id | ¿Quién lo creó? |
status | open: En espera de ser pagado. paid: Pagado en línea o marcado como pagado. void: Anulado. uncollectible y processing: Establecidos por su personal. paid y void son los resultados finales. |
due_date | Cuando llegue el momento adecuado. |
transactions | Sus líneas son: cada una de ellas es un charge o un credit. Además, incluye un description, un value en centésimas, y un quantity. También hay tasas que se aplican a estos valores. |
subtotal | Los montos adeudados, menos los créditos, nunca deben ser inferiores a 0. |
discount, discount_amount, discounted_amount | La tasa de descuento, expresada como fracción (0.1), es del 10%. El descuento en centavos también se indica claramente. Y el monto total después del descuento también se indica. |
tax, tax_amount | La tasa impositiva en forma de fracción0.07 Es del 7%. El impuesto, en centavos, se aplica sobre la cantidad después de aplicar el descuento. |
total | Lo que se debe, en centavos |
payment_gateway | Cuando el pago se realiza en línea, stripe; cuando tu personal lo marca como pagado, manual. |
stripe_payment | En el caso de un pago en línea: quién pagó, cuáles fueron los costos y la cantidad neta en centavos. |
payment_attempts | Cada intento de pago en línea: ¿funcionó o no? ¿Y por qué no funcionó? |
refunded | Un reembolso, si lo hubiera: su valor se indica en status (pending, succeeded, failed o canceled), así como en amount en centavos y reason. El estado de la factura permanece en paid. |
completed_on | Cuando el pago se realizó o fue anulado. |
Si se rechaza una llamada
| Estado | message | Por qué |
|---|---|---|
| 404 | InvoiceDoesNotExistException | En ese caso, no existe ninguna factura que tenga esa identificación. |
| 400 | InvoiceNotPublishedException | La factura es un cheque. |
| 400 | SchemaFieldsException | status no es uno de los cinco. |
| 400 | InvalidStartKeyException | start_key no pertenece a esta lista. |
Para información sobre el cuerpo de error y los demás códigos, vea Como manejar los errores de la API y los códigos de estado.