Cufy API
Clientes guardados

Listar y buscar clientes guardados

GET/v1/customers

Estado: implementada. Ambientes: simulation, qualification. Permisos: documents:read.

Alcance: Clientes de la empresa y ambiente de la credencial, con RLS; uno ajeno responde 404 igual que uno inexistente. El comprador se valida con las reglas de la emisión (FISCAL_VALIDATION_FAILED). Sin unicidad por identificación. Del más reciente al más antiguo, activos por defecto; cursor firmado ligado a filtros que caduca en 24 h. q ignora mayúsculas y tildes; sin índice de trigramas.

Del más reciente al más antiguo, activos por defecto. Cursor firmado y ligado a filtros, empresa y ambiente; as_of fija el conjunto: los clientes creados después no aparecen hasta empezar de nuevo.

Authorization

ClientApiKey
X-API-Key<token>

Secreto ligado a empresa, actor, permisos y ambiente. No admite cambiar empresa por body/header.

In: header

Query Parameters

cursor?string

Opaco y ligado a filtros/empresa/ambiente; caduca en 24 h. CURSOR_EXPIRED exige reiniciar listado.

Length1 <= length <= 2048
limit?integer
Range1 <= value <= 100
Default50
q?string
Length1 <= length <= 100
status?string

Value in

  • "active"
  • "archived"
external_id?string
Match^[A-Za-z0-9][A-Za-z0-9._:/-]{0,99}$
Length1 <= length <= 100
identification_number?string
Match^[A-Za-z0-9-]+$
Length1 <= length <= 30

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/customers"
{  "items": [],  "next_cursor": "string",  "as_of": "2019-08-24T14:15:22Z"}

Consultar ejecución por operation_id GET

**Estado:** parcial. **Ambientes:** simulation, qualification. **Permisos:** `documents:read`. **Alcance:** Solo consulta operaciones de admisión documental y exige documents:read. Las operaciones de compras, certificados, empresa, solicitudes de producción y exportaciones descritas por el contrato aún no están conectadas. Dentro de la empresa/ambiente de la credencial se exige el permiso de lectura de la clase de recurso destino. No se acumulan permisos de otras clases ni se concede lectura por conocer operation_id.

Guardar un cliente para reutilizarlo al emitir POST

**Estado:** implementada. **Ambientes:** simulation, qualification. **Permisos:** `documents:write`. **Alcance:** Clientes de la empresa y ambiente de la credencial, con RLS; uno ajeno responde 404 igual que uno inexistente. El comprador se valida con las reglas de la emisión (FISCAL_VALIDATION_FAILED). Sin unicidad por identificación. Idempotency-Key obligatoria; external_id único entre los activos, también con solicitudes concurrentes (409 CUSTOMER_EXTERNAL_ID_CONFLICT). Valida el comprador con las mismas reglas de la emisión (FISCAL_VALIDATION_FAILED). Repetir la misma Idempotency-Key devuelve el mismo cliente. external_id usado por otro cliente activo: 409 CUSTOMER_EXTERNAL_ID_CONFLICT con resource_id.