Antes de empezar
- El área de datos
billingde la clínica está activada. Está desactivada por defecto; si no, cada llamada responde403 DATA_AREA_OFF. - Tu clave tiene
billing.invoices.readpara las facturas,billing.payments.readpara cargos, cobros y saldos, ybilling.packages.readpara los bonos. - Las respuestas identifican al paciente solo por su
id, nunca por su nombre ni sus datos fiscales. Para el nombre, lee el paciente conGET /patients/{id}(áreapatients). - Todos los importes van en céntimos y con su moneda (
currency, normalmenteEUR).
¿Este paciente debe algo?
Respuesta
pending es lo que debe y credit el dinero que pagó y todavía no se ha aplicado a nada. Se dan por separado, nunca compensados, igual que en la ficha del paciente. uninvoiced es el total de sus cargos abiertos que ninguna factura documenta todavía, cobrados o no.
Qué debe, sesión a sesión
Cada sesión con precio, venta de bono o concepto suelto es un cargo. Su estado de cobro (settlement) sale de lo cobrado: pending, partial o settled.
uninvoiced=true (lo que falta por facturar) o por fecha de servicio con from y to (YYYY-MM-DD). Un cargo anulado (status: "voided") no debe nada: cortesía, error de registro, cita cancelada o cubierto con bono.
Cobros
cash, card, bizum, transfer, other) y a qué cargos se aplicó (applications). Un cobro corregido queda reversed y no cuenta; solo aparece con includeReversed=true. Las notas internas del cobro no salen por la API.
Facturas
number: null; el número fiscal se asigna al emitirla. pending es lo que queda por cobrar. Una rectificativa (serie R) apunta a la factura que corrige con correctsInvoiceId. Las anuladas solo aparecen con includeVoided=true. Para ver las líneas:
chargeId.
Bonos
remaining son las sesiones que le quedan y total las que tenía al venderse. Con una credencial personal (MCP o clave personal) solo se leen los bonos de pacientes de tus centros; los demás responden 404, como si no existieran.
Desde un asistente
Por MCP, las mismas operaciones sonbrelio_list_invoices, brelio_get_invoices, brelio_list_charges, brelio_list_receipts, brelio_get_balances y brelio_list_packages. Solo aparecen cuando la clínica activa Facturación y tú tienes el permiso. Prueba: «¿Qué sesiones tiene pendientes de pago Ana Pérez?»: el asistente busca a la paciente y lee sus cargos.