Insertar, actualizar o eliminar recaudo contra entrega

Orquesta el cambio de valor de recaudo (RCE) para una guía.

POST /orquestador/recaudo v3.2.0
Autenticación
Bearer Token
Ambiente
API Gateway — entorno de pruebas (integración externa / Suite)

Descripción

Orquesta el cambio de valor de recaudo (RCE) para una guía.

Flujo cliente externo: valida nit + id_cliente, tipificación en BD, consulta AGW y federada, luego tracking, población, acuerdo SIFA, vínculos y persistencia en CM/AGW según estado.

Flujo Suite Logística: con x-source válido, resuelve identidad desde federada (identificacion → NIT, proceso → id_cliente), tipificación fija Coordinadora y pipeline común sin consulta AGW HTTP.

Atajos: tracking 1 + fuente AGW → Pub/Sub editarRecaudoAgw; tracking 1 + fuente no AGW → sync federada directa.

Quick Start

  1. Obtén tus credenciales de acceso (Bearer Token).
  2. Selecciona el ambiente y completa los parámetros requeridos.
  3. Envía la solicitud y procesa la respuesta.

Ejemplo rápido

Generando ejemplo…

Endpoint

POST /orquestador/recaudo

Base URL https://api-test.coordinadora.tech/suite/guias

Parámetros

Sin parámetros declarados.

Body *

{
    "$ref": "#/components/schemas/SolicitudCambioRecaudo"
}

Ejemplo de request

{
    "codigoRemision": "36390050443",
    "referencia": "",
    "referenciaRecaudo": "ref-001-test",
    "referenciaDetalle": [],
    "valor": 10000
}

Respuesta

200
Operación procesada. data contiene el resultado o null según el atajo/flujo.
{
    "isError": false,
    "data": {
        "codigoRemision": "36390050443",
        "nivelServicio": 22,
        "estado": "Recaudo Insertado",
        "referencia": "",
        "referenciaDetalle": [],
        "valorAnterior": 0,
        "valorNuevo": 10000
    },
    "timestamp": "2026-07-06T22:08:36.000Z",
    "id": "52c072ed-05c2-4f35-af94-cd9dc1aac3a5-ca7a"
}

Ejemplo de respuesta

200 Operación procesada. `data` contiene el resultado o `null` según el atajo/flujo. 
{
    "isError": false,
    "data": {
        "codigoRemision": "36390050443",
        "nivelServicio": 22,
        "estado": "Recaudo Insertado",
        "referencia": "",
        "referenciaDetalle": [],
        "valorAnterior": 0,
        "valorNuevo": 10000
    },
    "timestamp": "2026-07-06T22:08:36.000Z",
    "id": "52c072ed-05c2-4f35-af94-cd9dc1aac3a5-ca7a"
}

Errores

400
Error de validación (Zod), integridad x-source o regla de negocio.
{
    "isError": true,
    "message": "El valor debe ser cero o mayor a cero en pesos, con máximo dos decimales",
    "code": "BAD_MESSAGE",
    "timestamp": "2026-07-06 17:08:11",
    "statusCode": 400,
    "id": "4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f7a"
}
403
Token inválido o sin permisos en API Gateway
RBAC: access denied
500
Error interno o de infraestructura
{
    "isError": true,
    "message": "El cambio no pudo ser realizado, por favor intente nuevamente",
    "code": "TRANSACCION-E1",
    "timestamp": "2026-07-06 17:12:00",
    "statusCode": 500,
    "id": "a3b4c5d6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3"
}