latestOpenAPI 3.0.12026-08-1914141.6 MB

c656412a58bc

Clientes

Listar clientes

Lista os clientes que existem na sua organização.

get/clients

Query parameters

offsetinteger

Número da página a ser retornada

limitinteger

Número de itens retornados na página

activeboolean

Com esse parâmetro é possível filtrar os clientes ativos e inativos

namestring

Com esse parâmetro é possível filtrar os clientes pelo nome ou razão social

social_revenuestring

Com esse parâmetro é possível filtrar os clientes pelo CPF / CNPJ (com ou sem os caracteres especiais)

Response

idinteger required

ID do cliente

namestring required

Nome do cliente

socialstring required

Razão social

social_revenuestring

CPF/CNPJ

statusboolean required

O cliente está ativo?