CredonixDocs
Referencia de la APICalendario personalizado

Editar

Actualiza parcialmente una automatización por calendario personalizado.

Descripción general

Este endpoint actualiza parcialmente una automatización por calendario personalizado. Todos los campos del cuerpo son opcionales y siguen las mismas reglas que en Crear calendario personalizado:

  • Omitido → el campo no cambia.
  • null en description → la descripción se limpia. legal_entity_id no acepta null.
  • entries → reemplaza el calendario completo. Las fechas se emparejan por bill_date:
    • Una fecha que ya existe conserva su id y su processed, y se reemplazan sus conceptos y totales.
    • Una fecha nueva se agrega.
    • Una fecha guardada que no envías se elimina, aunque ya esté procesada. Envía todas las fechas que quieras conservar.

Si la automatización está active y queda una fecha sin procesar con fecha de hoy, su orden de cobro se genera al guardar, igual que al crear. Si la orden no se puede generar, el historial registra la ejecución con estatus error y la solicitud responde 200 de todos modos.

Después de guardar, una automatización active sin fechas sin procesar pasa a completed, y una completed con fechas sin procesar pasa a active.

Puedes enviar note para dejar una nota en la actividad de la automatización. Una solicitud exitosa devuelve 200 con la automatización completa.

Requiere el permiso Administrar en Automatizaciones.

Endpoint

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

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

Agregar una fecha de cobro de hoy


La automatización tenía una sola fecha de cobro, 2026-10-14. El cuerpo agrega 2026-09-14, que es hoy, y vuelve a enviar 2026-10-14 para conservarla. La orden de la fecha de hoy se genera al guardar: esa fecha llega con processed: true. La fecha 2026-10-14 conserva su id, y next_billing_date apunta a ella.

{
  "entries": [
    {
      "bill_date": "2026-09-14",
      "items": [
        {
          "product_name": "Servicio de consultoría",
          "description": "Consultoría especializada",
          "quantity": 1,
          "unit_price": "500",
          "product_code": "84111506",
          "unit_code": "E48",
          "taxes": [
            {
              "type": "iva",
              "category": "transferred",
              "rate": "0.16"
            }
          ]
        }
      ]
    },
    {
      "bill_date": "2026-10-14",
      "items": [
        {
          "product_name": "Servicio de consultoría",
          "description": "Consultoría especializada",
          "quantity": 1,
          "unit_price": "700",
          "product_code": "84111506",
          "unit_code": "E48",
          "taxes": [
            {
              "type": "iva",
              "category": "transferred",
              "rate": "0.16"
            }
          ]
        }
      ]
    }
  ]
}

Reglas de los campos

CampoTipoRequeridoNotas
customer_idstringNoid de un cliente de tu organización.
legal_entity_idstringNoid de una razón social de tu organización. No acepta null.
conceptstringNoNo puede estar vacío.
descriptionstring | nullNonull limpia la descripción.
currencystringNoMXN o USD.
grace_period_daysintegerNoNúmero JSON entero, mayor o igual a 0.
entriesarrayNoCalendario completo, con las mismas reglas que en Crear calendario personalizado.
notestringNoNota para la actividad de la automatización. Máximo 500 caracteres.

No se aceptan otros campos: cualquier campo desconocido responde 400 con VALIDATION_ERROR.

Errores

StatusCódigoCausa
400VALIDATION_ERRORUn campo no cumple sus reglas. errors indica el campo y el motivo.
400INVALID_AUTOMATIONLos conceptos no cumplen las reglas de los conceptos.
400CUSTOMER_NOT_FOUNDcustomer_id no es un cliente de tu organización.
400LEGAL_ENTITY_NOT_FOUNDlegal_entity_id no es una razón social de tu organización.
400PRODUCT_NOT_FOUNDUn product_id no es un producto de tu organización.
401MISSING_API_KEY, INVALID_API_KEY, API_KEY_REVOKEDAPI key ausente, inválida o revocada.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Administrar 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