Consulta por nome ou cpf/cnpj

Retorna todos os clientes por nome ou cpf/cnpj.

Requisição

CampoTipoDescriçãoObrigatório
NomeTextoNome do cliente, aceita consulta parcialNão
CpfcnpjTextoCPF/CNPJ do cliente, aceita consulta parcialNão
StartNúmeroPosição do início da consultaNão
SizeNúmeroQuantidade de itens retornadosNão

Resposta

CampoTipoDescrição
IdGUIDIdentificador único do cliente
NomeTextoNome do cliente
EmailTextoEmail do cliente
CPFCNPJTextoCPF/CNPJ do cliente
TelefoneTextoTelefone do cliente
CelularNotificacaoTextoNúmero do celular do cliente
InscricaoMunicipalTextoInscrição Municipal da empresa
InscricaoEstadualTextoInscrição Estadual da empresa
CEPTextoCEP do cliente
LogradouroTextoLogradouro do cliente
NumeroTextoNúmero residencial do cliente
ComplementoTextoComplemento para ponto de referência
BairroTextoBairro onde o cliente reside
CidadeTextoCidade onde o cliente se localiza
UFTextoEstado ao qual o cliente pertence
ObservacoesTextoObservações importantes no cadastro do cliente
NotificacaoCobrancaDiasNúmeroNúmero de dias antes do vencimento da cobrança para o cliente ser notificado
NotificacaoCobrancaEmailBooleanoSe esta opção for marcada, irá notificar via e-mail
NotificacaoCobrancaSMSBooleanoSe esta opção for marcada, irá notificar via sms
NotificacaoCobrancaCartaImpressaBooleanoSe esta opção for marcada irá notificar, via carta impressa
PrimeiraTentativaHabilitadaBooleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada
PrimeiraTentativaDiasNúmeroNúmero de dias a partir do vencimento
PrimeiraTentativaEmailBooleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
PrimeiraTentativaSMSBooleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
SegundaTentativaHabilitadaBooleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada
SegundaTentativaDiasNúmeroNúmero de dias a partir do vencimento
SegundaTentativaEmailBooleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
SegundaTentativaSMSBooleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
TerceiraTentativaHabilitadaBooleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada
TerceiraTentativaDiasNúmeroNúmero de dias a partir do vencimento
TerceiraTentativaEmailBooleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
TerceiraTentativaSMSBooleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
QuartaTentativaHabilitadaBooleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada
QuartaTentativaDiasNúmeroNúmero de dias a partir do vencimento
QuartaTentativaEmailBooleanoSe esta opção for marcada, a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
QuartaTentativaSMSBooleanoSe esta opção for marcada, a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
QuintaTentativaHabilitadaBooleanoSe esta opção for marcada, a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada
QuintaTentativaDiasNúmeroNúmero de dias a partir do vencimento
QuintaTentativaEmailBooleanoSe esta opção for marcada, a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
QuintaTentativaSMSBooleanoSe esta opção for marcada, a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
SextaTentativaHabilitadaBooleanoSe esta opção for marcada, a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada
SextaTentativaDiasNúmeroNúmero de dias a partir do vencimento
SextaTentativaEmailBooleanoSe esta opção for marcada, a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
SextaTentativaSMSBooleanoSe esta opção for marcada, a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
SetimaTentativaHabilitadaBooleanoSe esta opção for marcada, a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada
SetimaTentativaDiasNúmeroNúmero de dias a partir do vencimento
SetimaTentativaEmailBooleanoSe esta opção for marcada, a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
SetimaTentativaSMSBooleanoSe esta opção for marcada, a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
OitavaTentativaHabilitadaBooleanoSe esta opção for marcada, a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada
OitavaTentativaDiasNúmeroNúmero de dias a partir do vencimento
OitavaTentativaEmailBooleanoSe esta opção for marcada, a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
OitavaTentativaSMSBooleanoSe esta opção for marcada, a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
NonaTentativaHabilitadaBooleanoSe esta opção for marcada, a nona tentativa de aviso em relação ao vencimento das cobranças será realizada
NonaTentativaDiasNúmeroNúmero de dias a partir do vencimento
NonaTentativaEmailBooleanoSe esta opção for marcada, a nona tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
NonaTentativaSMSBooleanoSe esta opção for marcada, a nona tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
DecimaTentativaHabilitadaBooleanoSe esta opção for marcada, a décima tentativa de aviso em relação ao vencimento das cobranças será realizada
DecimaTentativaDiasNúmeroNúmero de dias a partir do vencimento
DecimaTentativaEmailBooleanoSe esta opção for marcada, a décima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
DecimaTentativaSMSBooleanoSe esta opção for marcada, a décima tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Nome do cliente, aceita consulta parcial

string

CPF/CNPJ do cliente, aceita consulta parcial

int32

Inicio da consulta

int32

Tamanho da consulta

Headers
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json