API Reference

Retornar Totalizador de Clientes

Retorna a quantidade de clientes baseado na filtragem dos valores inseridos.

Log in to see full request history

Retornar Totalizador de Clientes

De acordo com os dados passados, ele irá filtrar e retornar a quantidade total de clientes, os clientes ativos, inativos, adimplentes, inadimplentes e cadastrados no mês atual.

É necessário passar o token gerado no momento em que o usuário realiza o login no header "Authorization".

Abaixo temos um exemplo de como inserir essa informação usando JSON.

{ "Authorization": "eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0" }
Path Params
string
required

Id do grupo que pertence o estabelecimento. Ex.: 1

Query Params
string

Nome do cliente. Ex.: João, Maria, etc.

boolean

Se o cliente está ativo ou não. Ex.: True ou False

boolean

Se o cliente está em débito ou não. Ex.: True ou False

string

Data inicial da criação do cliente. Ex.: 2023-01-01

string

Data final da criação do cliente. Ex.: 2023-03-01

Headers
string
required

Token gerado no momento em que o usuário realiza o login no portal. Formato: eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json