Consultar
Consulta una automatización por calendario personalizado con sus fechas de cobro.
Descripción general
Este endpoint devuelve una automatización por calendario personalizado con sus totales, su próxima fecha de cobro y cada fecha de cobro con sus conceptos. Las fechas de cobro llegan ordenadas por bill_date.
Requiere el permiso Leer en Automatizaciones.
Endpoint
https://app.credonix.mx/api/v1/custom-schedule-automations/{automationId}Path param: automationId — el id de la automatización.
Consulta un calendario personalizado
Devuelve la automatización con sus fechas de cobro. processed indica si la orden de cobro de cada fecha ya se generó. Para ver las órdenes generadas, consulta el historial.
Automatización inexistente
Si el id no existe, pertenece a otra organización o es de otro tipo de automatización (por ejemplo, una recurrente), la API responde 404 con el código NOT_FOUND.
Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
type | string | Siempre custom_schedule. |
id | string | Identificador de la automatización. |
customer_id | string | Cliente de las órdenes de cobro. |
legal_entity_id | string | null | Razón social de las órdenes. Con null, las órdenes usan la razón social predeterminada de la organización. |
concept | string | Concepto de las órdenes de cobro. |
description | string | null | Descripción. |
currency | string | MXN o USD. |
status | string | active, paused o completed. |
grace_period_days | integer | Días entre la fecha de cobro y el vencimiento de la orden. |
subtotal | string | null | Suma de los subtotales de las fechas de cobro. |
total_discount | string | null | Suma de los descuentos. |
total_tax | string | null | Suma de los impuestos (trasladados menos retenidos). |
total_amount | string | null | Suma de los totales. |
next_billing_date | string | null | Próxima fecha de cobro sin procesar (YYYY-MM-DD). null cuando la automatización no está active. |
entries | array | Fechas de cobro. Ver abajo. |
created_at | string | Fecha de creación (ISO 8601). |
updated_at | string | Fecha de la última actualización (ISO 8601). |
entries[]
| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador de la fecha de cobro. Úsalo en Generar órdenes del calendario. |
bill_date | string | Fecha de cobro (YYYY-MM-DD). |
subtotal, total_discount, total_tax, total_amount | string | null | Totales de la fecha de cobro. |
processed | boolean | true cuando la orden de cobro de esa fecha ya se generó. |
processed_at | string | null | Momento en que se generó (ISO 8601). |
items | array | Conceptos de la fecha de cobro. Ver abajo. |
entries[].items[]
| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador del concepto. |
product_id | string | null | Producto vinculado. |
product_name | string | null | Nombre del concepto. |
description | string | null | Descripción del concepto. |
quantity | integer | Cantidad. |
unit_price | string | Precio unitario. |
discount | string | null | Descuento. Un descuento no enviado llega como "0". |
discount_type | string | null | percentage o fixed. |
product_code | string | null | Clave de producto o servicio del SAT. |
unit_code | string | null | Clave de unidad del SAT. |
taxes | array | Impuestos: type, category, rate (fracción: "0.16" es 16 %) y base. |
Los totales se devuelven como string con dos decimales; unit_price, discount, rate y base se devuelven sin decimales fijos.
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 Automatizaciones. |
404 | NOT_FOUND | La automatización no existe en tu organización o es de otro tipo. La respuesta incluye "message": "La automatización no fue encontrada.". |