CredonixDocs
Referencia de la APICalendario personalizado

Historial

Lista las ejecuciones de una automatización por calendario personalizado.

Descripción general

Este endpoint devuelve el historial de una automatización por calendario personalizado: una fila por cada ejecución, con la fecha de cobro que generó, el resultado y la orden de cobro creada. Los resultados están paginados de 20 en 20 y ordenados del más reciente al más antiguo.

  • Las órdenes que se generan automáticamente, incluida la de una fecha de hoy al crear o editar la automatización, se registran como automated.
  • Las órdenes generadas con Generar órdenes del calendario se registran como manual.
  • Una ejecución con estatus error se puede reintentar con Reintentar ejecución.

Requiere el permiso Leer en Automatizaciones.

Endpoint

GEThttps://app.credonix.mx/api/v1/custom-schedule-automations/{automationId}/history

Path param: automationId — el id de la automatización.

Automatización sin ejecuciones


Una automatización que todavía no ha generado órdenes responde 200 con results vacío.

Query params

ParámetroTipoDescripción
pageintegerPágina, empieza en 1. Por defecto 1.

Forma de cada ejecución

Cada elemento de results tiene esta forma. Este ejemplo es la ejecución que registra Generar órdenes del calendario:

{
  "id": "cmu21aovp00mhv1dq3ox00rbp",
  "automation": {
    "type": "custom_schedule",
    "id": "cmu21ao1600ldv1dqtv2dukvo"
  },
  "milestone_id": null,
  "scheduled_date": "2026-10-14",
  "executed_date": "2026-09-14",
  "execution_type": "manual",
  "status": "success",
  "generated_invoice_id": "cmu21aovi00m9v1dqx23mo1m4",
  "executed_by": {
    "type": "api_key",
    "name": "Integración ERP"
  },
  "created_at": "2026-09-15T02:09:50.965Z",
  "updated_at": "2026-09-15T02:09:50.965Z"
}
CampoTipoDescripción
idstringIdentificador de la ejecución. Úsalo en Reintentar ejecución.
automationobjetoAutomatización de la ejecución: type e id.
milestone_idstring | nullSiempre null en un calendario personalizado.
scheduled_datestring | nullFecha de cobro (YYYY-MM-DD) que generó la orden.
executed_datestringFecha (YYYY-MM-DD) en que se ejecutó.
execution_typestringmanual o automated.
statusstringsuccess, error o partially_executed.
generated_invoice_idstring | nullid de la orden de cobro generada. Consúltala con Consultar orden de cobro.
executed_byobjetoQuién la ejecutó: { "type": "api_key", "name": ... } con el nombre de la API key, { "type": "user", "name": ... } para un usuario de la aplicación, o { "type": "automation", "name": ... } para una ejecución automática.
created_atstringFecha de creación (ISO 8601).
updated_atstringFecha de la última actualización (ISO 8601).

Errores

StatusCódigoCausa
400INVALID_PAGEpage no es un número entero entre 1 y 107374183.
401MISSING_API_KEY, INVALID_API_KEY, API_KEY_REVOKEDAPI key ausente, inválida o revocada.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Leer en Automatizaciones.
404NOT_FOUNDLa automatización no existe en tu organización o es de otro tipo. La respuesta incluye "message": "La automatización no fue encontrada.".
Abrir Credonix