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.

Socios de negocio

Clientes y proveedores

Los socios de negocio de las salidas (clientes) y de las entradas (proveedores).

Operaciones

OperaciónMétodo y rutaAlcance
Listar clientes GET /clients clients:read
Crear un cliente POST /clients clients:write
Consultar un cliente GET /clients/{id} clients:read
Actualizar un cliente (PUT) PUT /clients/{id} clients:write
Actualizar un cliente PATCH /clients/{id} clients:write
Eliminar un cliente DEL /clients/{id} clients:write
Listar proveedores GET /providers providers:read
Crear un proveedor POST /providers providers:write
Consultar un proveedor GET /providers/{id} providers:read
Actualizar un proveedor (PUT) PUT /providers/{id} providers:write
Actualizar un proveedor PATCH /providers/{id} providers:write
Eliminar un proveedor DEL /providers/{id} providers:write
Rutas de clientes y proveedores

Objeto cliente

  • id integer obligatorio
  • name string obligatorio
  • document_type string | null

    Tipo de documento fiscal (una letra).

  • document_id integer | null

    Número de documento fiscal; único.

  • email string | null
  • phone string | null
  • created_at string (date-time) | null
  • updated_at string (date-time) | null
Objeto cliente 
{
    "id": 1,
    "name": "Comercial del Pacífico",
    "document_type": "V",
    "document_id": 5022331,
    "email": null,
    "phone": null,
    "created_at": "2026-10-06T16:20:11.000000Z",
    "updated_at": "2026-10-06T16:20:11.000000Z"
}

Objeto proveedor

  • id integer obligatorio
  • name string obligatorio
  • email string | null
  • phone string | null
  • description string | null
  • paymentinfo string | null

    Condiciones o datos de pago.

  • created_at string (date-time) | null
  • updated_at string (date-time) | null
Objeto proveedor 
{
    "id": 1,
    "name": "Aceites del Centro",
    "email": null,
    "phone": null,
    "description": null,
    "paymentinfo": null,
    "created_at": "2026-10-06T16:20:11.000000Z",
    "updated_at": "2026-10-06T16:20:11.000000Z"
}