v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBCliente
Cria ou Altera clientes em lote
Informe os dados dos clientes para inserir ou alterar, a lista é limitada a 500 itens
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Id | GUID | Identificador único do cliente | Não |
| Nome | Texto | Nome do cliente | Sim |
| Texto | Email do cliente | Sim | |
| CPFCNPJ | Texto | CPF/CNPJ do cliente | Sim |
| Telefone | Texto | Telefone do cliente | Não |
| CelularNotificacao | Texto | Número do celular do cliente | Não (1) |
| InscricaoMunicipal | Texto | Inscrição Municipal da empresa | Não |
| InscricaoEstadual | Texto | Inscrição Estadual da empresa | Não |
| CEP | Texto | CEP do cliente | Não (2) |
| Logradouro | Texto | Logradouro do cliente | Não (2) |
| Numero | Texto | Número residencial do cliente | Não (2) |
| Complemento | Texto | Complemento para ponto de referência | Não |
| Bairro | Texto | Bairro onde o cliente reside | Não (2) |
| Cidade | Texto | Cidade onde o cliente se localiza | Não (2) |
| UF | Texto | Estado a qual o cliente pertence | Não (2) |
| Observacoes | Texto | Observações importantes no cadastro do cliente | Não |
| NotificacaoCobrancaDias | Numérico | Número de dias antes do vencimento da cobrança para o cliente ser notificado | Não |
| NotificacaoCobrancaEmail | Booleano | Se esta opção for marcada, irá notificar via e-mail | Não |
| NotificacaoCobrancaSMS | Booleano | Se esta opção for marcada, irá notificar via sms | Não |
| NotificacaoCobrancaCartaImpressa | Booleano | Se esta opção for marcada irá notificar, via carta impressa | Não |
| PrimeiraTentativaHabilitada | Booleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| PrimeiraTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| PrimeiraTentativaEmail | Booleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| PrimeiraTentativaSMS | Booleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| SegundaTentativaHabilitada | Booleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| SegundaTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| SegundaTentativaEmail | Booleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| SegundaTentativaSMS | Booleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| TerceiraTentativaHabilitada | Booleano | Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| TerceiraTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| TerceiraTentativaEmail | Booleano | Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| TerceiraTentativaSMS | Booleano | Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| QuartaTentativaHabilitada | Booleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| QuartaTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| QuartaTentativaEmail | Booleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| QuartaTentativaSMS | Booleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| QuintaTentativaHabilitada | Booleano | Se esta opção for marcada a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| QuintaTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| QuintaTentativaEmail | Booleano | Se esta opção for marcada a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| QuintaTentativaSMS | Booleano | Se esta opção for marcada a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| SextaTentativaHabilitada | Booleano | Se esta opção for marcada a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| SextaTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| SextaTentativaEmail | Booleano | Se esta opção for marcada a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| SextaTentativaSMS | Booleano | Se esta opção for marcada a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| SetimaTentativaHabilitada | Booleano | Se esta opção for marcada a setima tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| SetimaTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| SetimaTentativaEmail | Booleano | Se esta opção for marcada a setima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| SetimaentativaSMS | Booleano | Se esta opção for marcada a setima tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| OitavaTentativaHabilitada | Booleano | Se esta opção for marcada a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| OitavaTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| OitavaTentativaEmail | Booleano | Se esta opção for marcada a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| OitavaTentativaSMS | Booleano | Se esta opção for marcada a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| NonaTentativaHabilitada | Booleano | Se esta opção for marcada a nona tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| NonaTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| NonaTentativaEmail | Booleano | Se esta opção for marcada a nona tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| NonaTentativaSMS | Booleano | Se esta opção for marcada a nona tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Não |
| DecimaTentativaHabilitada | Booleano | Se esta opção for marcada a decima tentativa de aviso em relação ao vencimento das cobranças será realizada | Não |
| DecimaTentativaDias | Numérico | Número de dias a partir do vencimento | Não |
| DecimaTentativaEmail | Booleano | Se esta opção for marcada a decima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não |
| DecimaTentativaSMS | Booleano | Se esta opção for marcada a decima tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS | Nã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
| Campo | Tipo | Descrição |
|---|---|---|
| ClienteId | GUID | Cliente ID criado ou alterado |
| CPFCNPJ | Texto | Cpf ou Cnpj do cliente envolvido |
| Erro | Texto | Mensagem de erro caso ocorra alguma exceção ou validação de dados |
post/api/Cliente/Lote
Headers
Aeskeystring required
Request body
Example request
[
{
"Id": "02d3fc5c-8759-4692-b894-4c20d3b34a5d",
"Nome": "Teste Empresa",
"Email": "email@empresa.com",
"CPFCNPJ": "79661388000121",
"Telefone": "1128625266",
"CelularNotificacao": "11999382810",
"InscricaoMunicipal": "4508699",
"InscricaoEstadual": "152548505",
"CEP": "66613163",
"Logradouro": "Rua Terceira",
"Numero": "24",
"Complemento": "Predio azul",
"Bairro": "Floresta",
"Cidade": "Itaituba",
"UF": "PA",
"Observacoes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vitae laoreet purus, vitae tristique justo. Mauris erat est, viverra nec ligula et, vehicula aliquet ligula. Proin condimentum leo nec purus iaculis euismod. Praesent nec sem mi. In dictum ante ex, eu porttitor magna dapibus non.",
"NotificacaoCobrancaDias": 0,
"NotificacaoCobrancaEMail": false,
"NotificacaoCobrancaSMS": false,
"NotificacaoCobrancaCartaImpressa": false,
"PrimeiraTentativaHabilitada": true,
"PrimeiraTentativaDias": 2,
"PrimeiraTentativaEMail": true,
"PrimeiraTentativaSMS": true,
"SegundaTentativaHabilitada": true,
"SegundaTentativaDias": 10,
"SegundaTentativaEMail": true,
"SegundaTentativaSMS": true,
"TerceiraTentativaHabilitada": true,
"TerceiraTentativaDias": 15,
"TerceiraTentativaEMail": true,
"TerceiraTentativaSMS": true,
"QuartaTentativaHabilitada": true,
"QuartaTentativaDias": 20,
"QuartaTentativaEMail": true,
"QuartaTentativaSMS": true,
"QuintaTentativaHabilitada": true,
"QuintaTentativaDias": 40,
"QuintaTentativaEMail": true,
"QuintaTentativaSMS": true,
"SextaTentativaHabilitada": true,
"SextaTentativaDias": 60,
"SextaTentativaEMail": true,
"SextaTentativaSMS": true,
"SetimaTentativaHabilitada": true,
"SetimaTentativaDias": 75,
"SetimaTentativaEMail": true,
"SetimaTentativaSMS": false,
"OitavaTentativaHabilitada": false,
"OitavaTentativaDias": 0,
"OitavaTentativaEMail": false,
"OitavaTentativaSMS": false,
"NonaTentativaHabilitada": false,
"NonaTentativaDias": 0,
"NonaTentativaEMail": false,
"NonaTentativaSMS": false,
"DecimaTentativaHabilitada": false,
"DecimaTentativaDias": 0,
"DecimaTentativaEMail": false,
"DecimaTentativaSMS": false
}
]Response
Clientes criados ou alterados, de acordo com a situação. Se houver erros, será informado no campo Erro e em caso de sucesso o campo Erro estará null