Documentación API pública V1 — Trowel Developers

POST/api/public/v1/customers

customers:write

Body de entrada

PublicCustomerCreate

Crear cliente

Datos necesarios para crear un cliente.

PropiedadTipoDescripción

codestring | nullCódigo interno del proveedor.

businessNameobligatoriostringRazón social.

commercialNamestring | nullNombre comercial.

taxIdentifierstring | nullIdentificador fiscal.

activebooleanEstado activo.

Ejemplo JSON

{
  "code": "CLI-001",
  "businessName": "Cliente SL",
  "commercialName": "Cliente",
  "taxIdentifier": "B87654321",
  "active": true
}

Respuesta

201Cliente creado.

PublicCustomer

Cliente

Representación pública de un cliente.

PropiedadTipoDescripción

idobligatoriouuidIdentificador interno estable.

codestring | nullCódigo del proveedor.

businessNameobligatoriostringRazón social.

commercialNamestring | nullNombre comercial.

taxIdentifierstring | nullIdentificador fiscal.

activeobligatoriobooleanEstado activo.

createdAtobligatoriodate-timeFecha de creación.

modifiedAtobligatoriodate-timeÚltima modificación.

concurrencyTokenobligatoriostringToken opaco de concurrencia.

Ejemplo JSON

{
  "id": "a4c7603a-8c87-46c8-a3f5-09fbbe79f82e",
  "code": "CLI-001",
  "businessName": "Cliente SL",
  "commercialName": "Cliente",
  "taxIdentifier": "B87654321",
  "active": true,
  "createdAt": "2026-10-10T12:00:00",
  "modifiedAt": "2026-10-10T12:00:00",
  "concurrencyToken": "ct_customer_example"
}

Ejemplo de respuesta

{
  "id": "a4c7603a-8c87-46c8-a3f5-09fbbe79f82e",
  "code": "CLI-001",
  "businessName": "Cliente SL",
  "commercialName": "Cliente",
  "taxIdentifier": "B87654321",
  "active": true,
  "createdAt": "2026-10-10T12:00:00",
  "modifiedAt": "2026-10-10T12:00:00",
  "concurrencyToken": "ct_customer_example"
}

Errores

400Solicitud incorrectaapplication/json

401Autenticación inválida o no proporcionadaapplication/json

403Permisos insuficientesapplication/json

404Recurso no encontradoapplication/json

409Conflicto con el estado actualapplication/json

410Recurso ya no disponibleapplication/json

422Error de validaciónapplication/json

429Límite de solicitudes excedidoapplication/json

Ver modelo de error

PublicApiError

Error de API

Formato estable de los errores públicos.

PropiedadTipoDescripción

statusobligatoriointegerCódigo HTTP.

codeobligatoriostringCódigo estable para tratamiento automático.

messageobligatoriostringMensaje legible.

correlationIdobligatoriostringIdentificador para soporte y trazabilidad.

currentConcurrencyTokenstring | nullToken actual cuando existe un conflicto.

validationErrorsobject<string,string[]>Errores agrupados por campo.

Ejemplo JSON

{
  "status": 422,
  "code": "validation_error",
  "message": "The request is invalid.",
  "correlationId": "01J9EXAMPLE",
  "validationErrors": {
    "unitCode": [
      "The unit does not exist."
    ]
  }
}