Clientes: consulta e cadastro na API V1

Permissões: customers.read para consultar, customers.create para cadastrar, customers.update para alterar.

Consultar clientes

GET /api/v1/customers permite filtros como search, code, taxvat, type, status, updated_since e per_page. A paginação retorna meta e links.

Também existem GET /api/v1/customers/by-code/{code} e GET /api/v1/customers/by-document/{document}. No segundo caso o documento deve ser composto por números.

Cadastrar cliente

Os campos obrigatórios para POST /api/v1/customers são name (mínimo 3 caracteres) e type (F = pessoa física, J = pessoa jurídica).

curl -X POST "https://audacia.com.br/api/v1/customers" \
  -H "Authorization: Bearer SEU_TOKEN" -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"name":"Cliente de Exemplo","type":"F","code":"CLIENTE-TESTE"}'

Campos opcionais incluem taxvat, email, telephone, mobile e addresses. O array de endereços possui validações próprias. Consulte um cliente existente antes de cadastrar outro para reduzir duplicidades. Os exemplos devem ser executados somente em homologação ou com dados autorizados.