--- title: "Cria ou Altera clientes em lote" method: POST path: "/api/Cliente/Lote" tags: ["Cliente"] --- # Cria ou Altera clientes em lote `POST /api/Cliente/Lote` ## Request - Base URL: `https://pagamentos.meuk8.com.br/CobrancasAPI` - URL: `https://pagamentos.meuk8.com.br/CobrancasAPI/api/Cliente/Lote` - Auth: OAuth 2 - Password - Token URL: `/CobrancasAPI/token` scopes: `BknBankCobrancasAPI` Esta API permite que clientes sejam inseridos ou alterados em lote, 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 | | Email | Texto | Email do cliente | Não | | 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 ao qual o cliente pertence | Não (2)| | Observacoes | Texto | Observações importantes no cadastro do cliente | Não | | NotificacaoCobrancaDias | Número | 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 | Número | 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 | Número | 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 | Número | 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 | Número | 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 | Número | 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 | Número | 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 sétima tentativa de aviso em relação ao vencimento das cobranças será realizada | Não | | SetimaTentativaDias | Número | Número de dias a partir do vencimento | Não | | SetimaTentativaEmail | Booleano | Se esta opção for marcada a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail | Não | | SetimaTentativaSMS | Booleano | Se esta opção for marcada a sétima 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 | Número | 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 | Número | 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 décima tentativa de aviso em relação ao vencimento das cobranças será realizada | Não | | DecimaTentativaDias | Número | Número de dias a partir do vencimento | Não | | DecimaTentativaEmail | Booleano | Se esta opção for marcada a décima 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 décima 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 | ## Headers - `Aeskey` string, required ## Request body - BknBankCobrancasAPIModelsCliente[] - `Id` string: Id do cliente - `Nome` string, required: Nome do cliente - `Email` string: E-mail do cliente - `CPFCNPJ` string, required: CPF/CNPJ do cliente - `Telefone` string: Telefone do cliente - `CelularNotificacao` string: Celular do cliente - `InscricaoMunicipal` string: Inscrição Municipal do cliente - `InscricaoEstadual` string: Inscrição Estadual do cliente - `CEP` string: CEP do cliente - `Logradouro` string: Logradouro do cliente - `Numero` string: Número do cliente - `Complemento` string: Complemento do cliente - `Bairro` string: Bairro do cliente - `Cidade` string: Cidade do cliente - `UF` string: UF do cliente - `Observacoes` string: Observações do cliente - `NotificacaoCobrancaDias` integer: Dias antes do vencimento para notificar - `NotificacaoCobrancaEMail` boolean: Notificação via EMail - `NotificacaoCobrancaSMS` boolean: Notificação via SMS - `NotificacaoCobrancaCartaImpressa` boolean: Notificação via Carta - `PrimeiraTentativaHabilitada` boolean: Habilitado primeira tentativa em atraso - `PrimeiraTentativaDias` integer: Dias primeira tentativa em atraso - `PrimeiraTentativaEMail` boolean: Email da primeira tentativa em atraso - `PrimeiraTentativaSMS` boolean: SMS da primeira tentativa em atraso - `SegundaTentativaHabilitada` boolean: Habilitado segunda tentativa em atraso - `SegundaTentativaDias` integer: Dias segunda tentativa em atraso - `SegundaTentativaEMail` boolean: Email da segunda tentativa em atraso - `SegundaTentativaSMS` boolean: SMS da segunda tentativa em atraso - `TerceiraTentativaHabilitada` boolean: Habilitado terceira tentativa em atraso - `TerceiraTentativaDias` integer: Dias terceira tentativa em atraso - `TerceiraTentativaEMail` boolean: Email da terceira tentativa em atraso - `TerceiraTentativaSMS` boolean: SMS da terceira tentativa em atraso - `QuartaTentativaHabilitada` boolean: Habilitado quarta tentativa em atraso - `QuartaTentativaDias` integer: Dias quarta tentativa em atraso - `QuartaTentativaEMail` boolean: Email da quarta tentativa em atraso - `QuartaTentativaSMS` boolean: SMS da quarta tentativa em atraso - `QuintaTentativaHabilitada` boolean: Habilitado Quinta tentativa em atraso - `QuintaTentativaDias` integer: Dias Quinta tentativa em atraso - `QuintaTentativaEMail` boolean: Email da Quinta tentativa em atraso - `QuintaTentativaSMS` boolean: SMS da Quinta tentativa em atraso - `SextaTentativaHabilitada` boolean: Habilitado Sexta tentativa em atraso - `SextaTentativaDias` integer: Dias Sexta tentativa em atraso - `SextaTentativaEMail` boolean: Email da Sexta tentativa em atraso - `SextaTentativaSMS` boolean: SMS da Sexta tentativa em atraso - `SetimaTentativaHabilitada` boolean: Habilitado Sétima tentativa em atraso - `SetimaTentativaDias` integer: Dias Sétima tentativa em atraso - `SetimaTentativaEMail` boolean: Email da Sétima tentativa em atraso - `SetimaTentativaSMS` boolean: SMS da Sétima tentativa em atraso - `OitavaTentativaHabilitada` boolean: Habilitado Oitava tentativa em atraso - `OitavaTentativaDias` integer: Dias Oitava tentativa em atraso - `OitavaTentativaEMail` boolean: Email da Oitava tentativa em atraso - `OitavaTentativaSMS` boolean: SMS da Oitava tentativa em atraso - `NonaTentativaHabilitada` boolean: Habilitado Nona tentativa em atraso - `NonaTentativaDias` integer: Dias Nona tentativa em atraso - `NonaTentativaEMail` boolean: Email da Nona tentativa em atraso - `NonaTentativaSMS` boolean: SMS da Nona tentativa em atraso - `DecimaTentativaHabilitada` boolean: Habilitado Décima tentativa em atraso - `DecimaTentativaDias` integer: Dias Décima tentativa em atraso - `DecimaTentativaEMail` boolean: Email da Décima tentativa em atraso - `DecimaTentativaSMS` boolean: SMS da Décima tentativa em atraso ## Response `200` 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 - BknBankCobrancasAPIModelsClienteLoteItem[] - `ClienteId` string: Cliente ID criado ou alterado - `CPFCNPJ` string: CpfCnpj do cliente envolvido - `Erro` string: Mensagem de erro caso ocorra alguma excecao ou validacao de dados ## Other responses - `400`: Dados inválidos do cliente - `401`: Não autorizado - `500`: Erro incluindo ou alterando clientes --- [API](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as.md) - [All operations](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/revisions/4b96dba8717a?raw)