Referencia de la APIRecurrentes
Consultar
Consulta la información de una automatización recurrente.
Descripción general
Este endpoint devuelve una automatización recurrente con su periodicidad, sus totales, su próxima fecha de cobro y sus conceptos.
El id debe ser de una automatización recurrente: el id de una automatización por calendario personalizado o por plan de proyecto responde 404.
Requiere el permiso Leer en Automatizaciones.
Endpoint
GET
https://app.credonix.mx/api/v1/recurring-automations/{automationId}Path param: automationId — el id de la automatización recurrente.
Consulta una automatización recurrente
Devuelve la automatización completa. next_billing_date indica la fecha de la próxima orden de cobro y last_execution_at, el momento de la última generación.
Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
type | string | Siempre recurring. |
id | string | ID de la automatización. |
customer_id | string | Cliente al que se cobra. |
legal_entity_id | string | null | Razón social que emite las órdenes de cobro. 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 emisión y el vencimiento de cada orden de cobro. |
subtotal, total_discount, total_tax, total_amount | string | null | Totales de cada orden de cobro. |
start_date | string | Fecha de inicio (YYYY-MM-DD). |
end_date | string | null | Fecha de fin (YYYY-MM-DD). |
interval | string | daily, weekly, monthly o yearly. |
repeat_every | integer | Cada cuántos intervalos se repite. |
monthly_mode | string | null | day_of_month o weekday_position. |
weekdays | array | Días de la semana: MON, TUE, WED, THU, FRI, SAT, SUN. |
next_billing_date | string | null | La siguiente fecha de cobro posterior a hoy que no está en el historial (YYYY-MM-DD). null si la automatización no está active. |
last_execution_at | string (fecha) | null | Momento de la última generación. |
items | array | Conceptos de cada orden de cobro. |
created_at, updated_at | string (fecha) | Marcas de tiempo. |
items[]
| Campo | Tipo | Descripción |
|---|---|---|
id | string | ID del concepto. |
product_id | string | null | Producto vinculado. |
product_name, description | string | null | Nombre y descripción del concepto. |
quantity | integer | Cantidad. |
unit_price | string | Precio unitario. |
discount | string | null | Descuento. Llega en "0" cuando no se envió. |
discount_type | string | null | percentage o fixed. |
product_code, unit_code | string | null | Claves del SAT de producto o servicio y de unidad. |
taxes | array | Impuestos: type, category, rate (fracción) y base. Si no se envió base, llega con la base calculada. |
Errores
| Status | Código | Causa |
|---|---|---|
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Automatizaciones. |
404 | NOT_FOUND | La automatización recurrente no existe en tu organización. La respuesta incluye { "message": "La automatización no fue encontrada." }. |