Desarrolladores API v1

Endpoints de la API. Especificación exacta de cada operación de la API v1 (parámetros, cuerpo, respuestas y ejemplos), generada del documento OpenAPI con el que se valida cada respuesta real. Los procedimientos completos están en Guías.

GET /entry-documents/{id}

Consultar un documento de entrada

Alcance (cliente de integración)
receipts:read
Permiso (token de usuario)
Token válido
Idempotency-Key
No aplica

Parámetros de ruta

  • id integer obligatorio

    Identificador numérico del recurso.

Respuestas

200 El documento con su avance por línea.
  • data objeto obligatorio
    14 campos de data
    • id integer obligatorio
    • doc_num string | null obligatorio
    • type string obligatorio
    • external_ref string | null
    • source string | null

      api, import, web o sap.

    • status string | null obligatorio
    • card_code string | null
    • card_name string | null
    • doc_date string (date) | null
    • due_date string (date) | null
    • comments string | null
    • created_at string (date-time) | null
    • updated_at string (date-time) | null
    • lines array de objetos obligatorio
      7 campos de lines
      • line_num integer | null
      • item_code string | null obligatorio
      • qty number obligatorio
      • open_qty number obligatorio

        Lo que falta por recibir.

      • received_qty number obligatorio
      • whs_code string | null
      • status string | null
401 Falta el token o no es válido.

Cuerpo: el sobre de error.

402 La función no está en el plan de la empresa, o la cuenta está suspendida o cancelada.

Cuerpo: el sobre de error.

403 Al cliente le falta el alcance (missing_scope), al usuario el permiso (forbidden), o el token de usuario no tiene acceso a la ruta (client_not_allowed: aplicación móvil o usuario con verificación en dos pasos).

Cuerpo: el sobre de error.

404 El recurso no existe.

Cuerpo: el sobre de error.

429 Se superó el límite por minuto. Reintente después de los segundos de Retry-After.

Cuerpo: el sobre de error.

Probar

Probar con una instancia

La solicitud sale del navegador hacia la instancia indicada; nada pasa por chainlink.mx. El token se conserva solo en esta pestaña.

Obtener un token con un cliente de integración

Credenciales de Configuración › Clientes API (grant client_credentials). El secreto se usa una vez y no se guarda. Los tokens de usuario se obtienen fuera de la consola; ver Autenticación.

Solicitud 
curl "https://empresa.chainlink.mx/api/v1/entry-documents/101" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json"
Respuesta 
{
    "data": {
        "id": 1,
        "doc_num": "OC-000001",
        "type": "purchase_order",
        "external_ref": "OC-2026-0042",
        "source": "api",
        "status": "open",
        "card_code": "PRV-001",
        "card_name": null,
        "doc_date": "2026-10-06",
        "due_date": "2026-10-06",
        "comments": null,
        "lines": [
            {
                "line_num": 0,
                "item_code": "P-1001",
                "qty": 48,
                "open_qty": 48,
                "received_qty": 0,
                "whs_code": "CEDIS-GDL",
                "status": "open"
            },
            {
                "line_num": 1,
                "item_code": "P-1002",
                "qty": 120,
                "open_qty": 120,
                "received_qty": 0,
                "whs_code": "CEDIS-GDL",
                "status": "open"
            }
        ],
        "created_at": "2026-10-06T16:20:11.000000Z",
        "updated_at": "2026-10-06T16:20:11.000000Z"
    }
}