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.

Documentos y operación

Documentos de entrada y salida

Lo que el ERP manda a recibir (órdenes de compra, entradas) o a surtir (pedidos, remisiones). Cada documento lleva la referencia externa del sistema de origen (external_ref): mandar dos veces la misma referencia no crea un duplicado.

Operaciones

Operación	Método y ruta	Alcance
Listar documentos de entrada	GET `/entry-documents`	`receipts:read`
Crear un documento de entrada	POST `/entry-documents`	`receipts:write`
Consultar un documento de entrada	GET `/entry-documents/{id}`	`receipts:read`
Listar documentos de salida	GET `/exit-documents`	`pickings:read`
Crear un documento de salida	POST `/exit-documents`	`pickings:write`
Consultar un documento de salida	GET `/exit-documents/{id}`	`pickings:read`

Rutas de documentos de entrada y salida

Objeto documento de entrada

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

Objeto documento de entrada

{
    "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"
}

Objeto documento de salida

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
priority integer | null
ship_to string | 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 surtir.
- picked_qty number obligatorio
- whs_code string | null
- status string | null

Objeto documento de salida

{
    "id": 1,
    "doc_num": "OV-000001",
    "type": "sale_order",
    "external_ref": "PED-88121",
    "source": "api",
    "status": "open",
    "card_code": "CLI-001",
    "card_name": null,
    "doc_date": "2026-10-06",
    "due_date": "2026-10-06",
    "comments": null,
    "priority": 50,
    "ship_to": null,
    "lines": [
        {
            "line_num": 0,
            "item_code": "P-1001",
            "qty": 6,
            "open_qty": 6,
            "picked_qty": 0,
            "whs_code": "CEDIS-GDL",
            "status": "open"
        }
    ],
    "created_at": "2026-10-06T16:20:11.000000Z",
    "updated_at": "2026-10-06T16:20:11.000000Z"
}