Listar
Obtiene un listado paginado de las órdenes de cobro de tu organización.
Descripción general
Este endpoint devuelve un listado paginado de las órdenes de cobro de tu organización, ordenado por invoice_number de mayor a menor. Cada resultado tiene la misma forma que Consultar orden de cobro. El tamaño de página es fijo en 20 resultados.
Todos los filtros son opcionales y se combinan entre sí. Los filtros de tipo lista (customer_id, status, sat_status, payment_method) aceptan varios valores, repitiendo el parámetro (?status=issued&status=overdue) o separándolos por comas (?status=issued,overdue). Los parámetros desconocidos se ignoran.
Requiere el permiso Leer en Órdenes de cobro.
Endpoint
https://app.credonix.mx/api/v1/invoicesConsulta múltiples órdenes de cobro
Sin filtros devuelve todas las órdenes de cobro de la organización. El ejemplo filtra por cliente.
Query params
| Parametro | Tipo | Requerido | Default | Descripcion |
|---|---|---|---|---|
page | integer ≥ 1 | No | 1 | Página solicitada. El tamaño de página es fijo en 20. |
customer_id | string | No | - | Órdenes de cobro de uno o varios clientes. |
status | created | issued | paid | overdue | canceled | No | - | Filtra por estatus de la orden de cobro. Acepta varios valores. |
sat_status | pending | emitted | canceled | not_required | rejected | No | - | Filtra por estatus SAT. Acepta varios valores. |
currency | MXN | USD | No | - | Filtra por moneda. Si envías varios valores, se validan todos y se usa el primero. |
issue_date_from | YYYY-MM-DD | No | - | Fecha de emisión desde (inclusive). |
issue_date_to | YYYY-MM-DD | No | - | Fecha de emisión hasta (inclusive). |
due_date_from | YYYY-MM-DD | No | - | Fecha de vencimiento desde (inclusive). |
due_date_to | YYYY-MM-DD | No | - | Fecha de vencimiento hasta (inclusive). |
payment_method | PUE | PPD | No | - | Órdenes de cobro con al menos un CFDI emitido con ese método de pago. Los CFDI de prueba no cuentan. |
automation_id | string | No | - | Órdenes de cobro generadas por esa automatización (recurrente, por calendario personalizado o por plan de proyecto). |
search | string | No | - | Busca en el concepto y en el nombre del cliente, sin distinguir mayúsculas. Si el valor son solo dígitos, también busca el invoice_number exacto. |
Filtro inválido
Un valor que no pertenece a la lista permitida, o una fecha que no tiene el formato YYYY-MM-DD, responde 400 con el código INVALID_QUERY_PARAMETER. errors[].field indica el parámetro.
Errores
| Status | Código | Causa |
|---|---|---|
400 | INVALID_PAGE | page no es un entero entre 1 y 107374183. |
400 | INVALID_QUERY_PARAMETER | Valor no permitido en status, sat_status, currency o payment_method, o fecha con formato distinto de YYYY-MM-DD. |
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. |