Documentação das APIs

Consulta por nome ou cpf/cnpj

Retorna todos os clientes por nome ou cpf/cnpj

Requisiçao

CampoTipoDescrição
nomeTextoNome do cliente, aceita consulta parcial
cpgcnpjTextoCPF/CNPJ do cliente, aceita consulta parcial
startNúmeroPosição do início da consulta
SizeNúmeroQuantidade de itens retornados

Resposta

CampoTipoDescrição
IdNuméricoIdentificador único do cliente
NomeTextoNome do cliente
EmailTextoEmail do cliente
CPFCNPJNuméricoCPF/CNPJ do cliente
TelefoneNuméricoTelefone do cliente
CelularNotificacaoNuméricoNúmero do celular do cliente
InscricaoMunicipalNuméricoInscrição Municipal da empresa
InscricaoEstadualNuméricoInscrição Estadual da empresa
CEPNuméricoCEP do cliente
LogradouroTextoLogradouro do cliente
NumeroNuméricoNúmero residencial do cliente
ComplementoTextoComplemento para ponto de referência
BairroTextoBairro aonde o cliente reside
CidadeTextoCidade aonde o cliente se localiza
UFTextoEstado a qual o cliente pertence
ObservacoesTextoObservações importantes no cadastro do cliente
TotalRecebidoNuméricoValor total recebido das cobranças relacionadas a esse cliente
NotificacaoCobrancaDiasNuméricoNúmero de dias antes do vencimento da cobrança para o cliente ser notificado
NotificacaoCobrancaEmailBoleanoSe esta opção for marcada irá notificar via e-mail
NotificacaoCobrancaSMSBoleanoSe esta opção for marcada irá notificar via sms
NotificacaoCobrancaCartaImpressaBoleanoSe esta opção for marcada irá notificar via carta impressa
PrimeiraTentativaHabilitadaBoleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada
PrimeiraTentativaDiasNuméricoNúmero de dias a partir do vencimento
PrimeiraTentativaEmailBoleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
PrimeiraTentativaSMSBoleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
SegundaTentativaHabilitadaBoleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada
SegundaTentativaDiasNuméricoNúmero de dias a partir do vencimento
SegundaTentativaEmailBoleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
SegundaTentativaSMSBoleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
TerceiraTentativaHabilitadaBoleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada
TerceiraTentativaDiasNuméricoNúmero de dias a partir do vencimento
TerceiraTentativaEmailBoleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
TerceiraTentativaSMSBoleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
QuartaTentativaHabilitadaBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada
QuartaTentativaDiasNuméricoNúmero de dias a partir do vencimento
QuartaTentativaEmailBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
QuartaTentativaSMSBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
QuintaTentativaHabilitadaBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada
QuintaTentativaDiasNuméricoNúmero de dias a partir do vencimento
QuintaTentativaEmailBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
QuintaTentativaSMSBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
SextaTentativaHabilitadaBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada
SextaTentativaDiasNuméricoNúmero de dias a partir do vencimento
SextaTentativaEmailBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
SextaTentativaSMSBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
SetimaTentativaHabilitadaBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada
SetimaTentativaDiasNuméricoNúmero de dias a partir do vencimento
SetimaTentativaEmailBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
SetimaentativaSMSBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
OitavaTentativaHabilitadaBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada
OitavaTentativaDiasNuméricoNúmero de dias a partir do vencimento
OitavaTentativaEmailBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
OitavaTentativaSMSBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
NonaTentativaHabilitadaBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada
NonaTentativaDiasNuméricoNúmero de dias a partir do vencimento
NonaTentativaEmailBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
NonaTentativaSMSBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
DecimaTentativaHabilitadaBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada
DecimaTentativaDiasNuméricoNúmero de dias a partir do vencimento
DecimaTentativaEmailBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail
DecimaTentativaSMSBoleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!