Cria ou Altera clientes em lote

Esta API permite que clientes sejam inseridos ou alterados em lote, a lista é limitada a 500 itens

Requisição

CampoTipoDescriçãoObrigatório
IdGUIDIdentificador único do clienteNão
NomeTextoNome do clienteSim
EmailTextoEmail do clienteNão
CPFCNPJTextoCPF/CNPJ do clienteSim
TelefoneTextoTelefone do clienteNão
CelularNotificacaoTextoNúmero do celular do clienteNão (1)
InscricaoMunicipalTextoInscrição Municipal da empresaNão
InscricaoEstadualTextoInscrição Estadual da empresaNão
CEPTextoCEP do clienteNão (2)
LogradouroTextoLogradouro do clienteNão (2)
NumeroTextoNúmero residencial do clienteNão (2)
ComplementoTextoComplemento para ponto de referênciaNão
BairroTextoBairro onde o cliente resideNão (2)
CidadeTextoCidade onde o cliente se localizaNão (2)
UFTextoEstado ao qual o cliente pertenceNão (2)
ObservacoesTextoObservações importantes no cadastro do clienteNão
NotificacaoCobrancaDiasNúmeroNúmero de dias antes do vencimento da cobrança para o cliente ser notificadoNão
NotificacaoCobrancaEmailBooleanoSe esta opção for marcada, irá notificar via e-mailNão
NotificacaoCobrancaSMSBooleanoSe esta opção for marcada, irá notificar via smsNão
NotificacaoCobrancaCartaImpressaBooleanoSe esta opção for marcada irá notificar, via carta impressaNão
PrimeiraTentativaHabilitadaBooleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
PrimeiraTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
PrimeiraTentativaEmailBooleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
PrimeiraTentativaSMSBooleanoSe esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
SegundaTentativaHabilitadaBooleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
SegundaTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
SegundaTentativaEmailBooleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
SegundaTentativaSMSBooleanoSe esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
TerceiraTentativaHabilitadaBooleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
TerceiraTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
TerceiraTentativaEmailBooleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
TerceiraTentativaSMSBooleanoSe esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
QuartaTentativaHabilitadaBooleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
QuartaTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
QuartaTentativaEmailBooleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
QuartaTentativaSMSBooleanoSe esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
QuintaTentativaHabilitadaBooleanoSe esta opção for marcada a quinta tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
QuintaTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
QuintaTentativaEmailBooleanoSe esta opção for marcada a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
QuintaTentativaSMSBooleanoSe esta opção for marcada a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
SextaTentativaHabilitadaBooleanoSe esta opção for marcada a sexta tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
SextaTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
SextaTentativaEmailBooleanoSe esta opção for marcada a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
SextaTentativaSMSBooleanoSe esta opção for marcada a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
SetimaTentativaHabilitadaBooleanoSe esta opção for marcada a sétima tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
SetimaTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
SetimaTentativaEmailBooleanoSe esta opção for marcada a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
SetimaTentativaSMSBooleanoSe esta opção for marcada a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
OitavaTentativaHabilitadaBooleanoSe esta opção for marcada a oitava tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
OitavaTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
OitavaTentativaEmailBooleanoSe esta opção for marcada a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
OitavaTentativaSMSBooleanoSe esta opção for marcada a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
NonaTentativaHabilitadaBooleanoSe esta opção for marcada a nona tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
NonaTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
NonaTentativaEmailBooleanoSe esta opção for marcada a nona tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
NonaTentativaSMSBooleanoSe esta opção for marcada a nona tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão
DecimaTentativaHabilitadaBooleanoSe esta opção for marcada a décima tentativa de aviso em relação ao vencimento das cobranças será realizadaNão
DecimaTentativaDiasNúmeroNúmero de dias a partir do vencimentoNão
DecimaTentativaEmailBooleanoSe esta opção for marcada a décima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mailNão
DecimaTentativaSMSBooleanoSe esta opção for marcada a décima tentativa de aviso em relação ao vencimento das cobranças será realizada via SMSNão

(1) - Necessário se quiser enviar notificação para o número de celular.
(2) - Este campo é obrigatório caso o cliente opte por realizar o pagamento da cobrança via boleto.

Resposta

CampoTipoDescrição
ClienteIdGUIDCliente ID criado ou alterado
CPFCNPJTextoCpf ou Cnpj do cliente envolvido
ErroTextoMensagem de erro caso ocorra alguma exceção ou validação de dados
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Lista de clientes para criacao ou alteracao

Headers
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request 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