Referencia de la APIÓrdenes de cobro
Consultar
Consulta una orden de cobro con sus conceptos, totales y saldo pendiente.
Descripción general
Este endpoint devuelve una orden de cobro de tu organización: su estatus, sus totales, el saldo pendiente, los datos fiscales del cliente y sus conceptos con impuestos.
Los CFDI de la orden de cobro no vienen en esta respuesta; consúltalos con Listar CFDI.
Requiere el permiso Leer en Órdenes de cobro.
Endpoint
GET
https://app.credonix.mx/api/v1/invoices/{invoiceId}Path param: invoiceId — el id de la orden de cobro.
Consulta una orden de cobro
El ejemplo es una orden de cobro con un pago parcial: total_amount es 1160.00 y remaining_amount (saldo pendiente) es 660.00.
Campos de la respuesta
| Campo | Tipo | Descripcion |
|---|---|---|
id | string | Identificador de la orden de cobro. |
invoice_number | integer | Número consecutivo de la orden de cobro en la organización. |
status | string | created (la fecha de emisión aún no llega), issued, paid, overdue o canceled. |
sat_status | string | pending, emitted, canceled, not_required o rejected. Los CFDI de prueba nunca lo cambian. |
concept | string | Concepto de la orden de cobro. |
description | string | null | Descripción. Se envía al CFDI como condiciones de pago. |
currency | string | MXN o USD. |
issue_date | string | Fecha de emisión, YYYY-MM-DD. |
due_date | string | null | Fecha de vencimiento, YYYY-MM-DD. |
subtotal | string | null | Subtotal de los conceptos. |
total_discount | string | null | Descuento total. |
total_tax | string | null | Impuestos trasladados menos impuestos retenidos. |
total_amount | string | null | Total de la orden de cobro. |
remaining_amount | string | null | Saldo pendiente. |
customer | object | Datos del cliente guardados en la orden de cobro: id, name, legal_name, tax_id, tax_regime, fiscal_zip_code. |
legal_entity | object | null | Razón social emisora: id y name. |
notes | string | null | Notas internas. |
created_automatically | boolean | true si la generó una automatización. |
canceled_at | string | null | Momento de la cancelación. |
liquidated_at | string | null | Momento en que se liquidó. |
items | array | Conceptos, en el orden en que se crearon. unit_price, discount, rate y base son cadenas decimales sin relleno ("1000", "0.16"). rate es una fracción. |
created_at | string | Fecha de creación. |
updated_at | string | Fecha de la última actualización. |
Errores
| Status | Código | Causa |
|---|---|---|
401 | MISSING_API_KEY | INVALID_API_KEY | API_KEY_REVOKED | API key ausente, inválida o revocada. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Órdenes de cobro. |
404 | NOT_FOUND | La orden de cobro no existe en tu organización. |