Consultar | Credonix

Descripción general

Este endpoint devuelve una automatización por plan de proyecto con sus totales, lo que falta por cobrar, sus conceptos y sus hitos. Los hitos llegan ordenados por order_index.

Requiere el permiso Leer en Automatizaciones.

Endpoint

GEThttps://app.credonix.mx/api/v1/project-plan-automations/{automationId}

Path param: automationId — el id de la automatización. Un id de otro tipo de automatización responde 404.

Consulta un plan de proyecto

Devuelve el plan con sus conceptos y sus hitos. completed indica si el hito ya se cobró. Para ver las órdenes generadas, consulta el historial.

Campos de la respuesta

Campo	Tipo	Descripción
`type`	string	Siempre `project_plan`.
`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 emisión y el vencimiento de cada orden.
`subtotal`, `total_discount`, `total_tax`, `total_amount`	string \| null	Totales del proyecto. `total_tax` es trasladados menos retenidos.
`billing_mode`	string	`percentage` o `fixed`.
`auto_even_split`	boolean	Si el total se divide en partes iguales entre los hitos.
`remaining_amount`	string \| null	Lo que falta por cobrar: el total menos las órdenes generadas al completar hitos.
`next_billing_date`	string \| null	La `due_date` más próxima, de hoy en adelante, entre los hitos pendientes que aún no se han ejecutado. `null` cuando la automatización no está `active` o ningún hito pendiente tiene fecha.
`last_execution_at`	string \| null	Última vez que se generó una orden del plan (ISO 8601).
`items`	array	Conceptos del proyecto, con la misma forma que en Consultar calendario personalizado.
`milestones`	array	Hitos. Ver abajo.
`created_at`	string	Fecha de creación (ISO 8601).
`updated_at`	string	Fecha de la última actualización (ISO 8601).

`milestones[]`

Campo	Tipo	Descripción
`id`	string	Identificador del hito. Úsalo en Completar hitos y para editarlo.
`description`	string	Descripción del hito.
`due_date`	string \| null	Fecha estimada (`YYYY-MM-DD`).
`value`	string \| null	En `percentage`, el porcentaje con hasta 6 decimales (por ejemplo `"33.333333"`); en `fixed`, el monto con dos decimales.
`order_index`	integer	Orden del hito.
`completed`	boolean	`true` cuando el hito ya se completó.
`completed_at`	string \| null	Fecha en que se completó (`YYYY-MM-DD`).

Los totales se devuelven como string con dos decimales.

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."`.

Crear plan de proyecto POST

Página anterior

Editar plan de proyecto PATCH

Página siguiente