--- title: "Consulta por nome ou cpf/cnpj" method: GET path: "/api/Cliente" tags: ["Cliente"] --- # Consulta por nome ou cpf/cnpj `GET /api/Cliente` Retorna todos os clientes por nome ou cpf/cnpj. ### Requisiçao | **Campo** | **Tipo** | **Descrição** | **Obrigatório** | |--|--|--|--| | Nome | Texto | Nome do cliente, aceita consulta parcial| Não | | Cpfcnpj | Texto | CPF/CNPJ do cliente, aceita consulta parcial| Não | | Start | Número |Posição do início da consulta | Não | | Size | Número | Quantidade de itens retornados | Não | ### Resposta | **Campo** | **Tipo** | **Descrição** | |--|--|--| | Id | GUID| Identificador único do cliente | | Nome | Texto | Nome do cliente | | Email | Texto | Email do cliente | | CPFCNPJ | Numérico |CPF/CNPJ do cliente | | Telefone | Numérico | Telefone do cliente | | CelularNotificacao | Numérico | Número do celular do cliente| | InscricaoMunicipal | Numérico | Inscrição Municipal da empresa | | InscricaoEstadual | Numérico |Inscrição Estadual da empresa | | CEP | Numérico | CEP do cliente | | Logradouro | Texto | Logradouro do cliente | | Numero | Numérico | Número residencial do cliente | | Complemento | Texto | Complemento para ponto de referência | | Bairro | Texto | Bairro onde o cliente reside | | Cidade | Texto | Cidade onde o cliente se localiza | | UF | Texto | Estado a qual o cliente pertence | | Observacoes | Texto | Observações importantes no cadastro do cliente | | NotificacaoCobrancaDias | Numérico | Número de dias antes do vencimento da cobrança para o cliente ser notificado | | NotificacaoCobrancaEmail | Booleano | Se esta opção for marcada, irá notificar via e-mail | | NotificacaoCobrancaSMS | Booleano | Se esta opção for marcada, irá notificar via sms | | NotificacaoCobrancaCartaImpressa | Booleano | Se esta opção for marcada irá notificar, via carta impressa | | PrimeiraTentativaHabilitada | Booleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada | | PrimeiraTentativaDias | Numérico | Número de dias a partir do vencimento | | 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 | | 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 | | SegundaTentativaHabilitada | Booleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada | | SegundaTentativaDias | Numérico | Número de dias a partir do vencimento | | 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 | | 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 | | TerceiraTentativaHabilitada | Booleano| Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada | | TerceiraTentativaDias | Numérico | Número de dias a partir do vencimento | | 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 | | 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 | | QuartaTentativaHabilitada | Booleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada| | QuartaTentativaDias | Numérico | Número de dias a partir do vencimento | | 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 | | 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 | | QuintaTentativaHabilitada | Booleano | Se esta opção for marcada, a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada| | QuintaTentativaDias | Numérico | Número de dias a partir do vencimento | | 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 | | 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 | | SextaTentativaHabilitada | Booleano | Se esta opção for marcada, a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada | | SextaTentativaDias | Numérico | Número de dias a partir do vencimento | | 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| | 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| | SetimaTentativaHabilitada | Booleano | Se esta opção for marcada, a setima tentativa de aviso em relação ao vencimento das cobranças será realizada | | SetimaTentativaDias | Numérico | Número de dias a partir do vencimento | | 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 | | 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| | OitavaTentativaHabilitada | Booleano | Se esta opção for marcada, a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada | | OitavaTentativaDias | Numérico | Número de dias a partir do vencimento| | 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 | | 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 | | NonaTentativaHabilitada | Booleano | Se esta opção for marcada, a nona tentativa de aviso em relação ao vencimento das cobranças será realizada | | NonaTentativaDias | Numérico | Número de dias a partir do vencimento | | 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 | | 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 | | DecimaTentativaHabilitada | Booleano | Se esta opção for marcada, a decima tentativa de aviso em relação ao vencimento das cobranças será realizada | | DecimaTentativaDias | Numérico | Número de dias a partir do vencimento | | 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 | | 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 | ## Query parameters - `Nome` string - `Cpfcnpj` string - `Start` integer - `Size` integer ## Headers - `Aeskey` string, required ## Response `200` Clientes consultados com sucesso - 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 Setima tentativa em atraso - `SetimaTentativaDias` integer — Dias Setima tentativa em atraso - `SetimaTentativaEMail` boolean — Email da Setima tentativa em atraso - `SetimaTentativaSMS` boolean — SMS da Setima 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 Decima tentativa em atraso - `DecimaTentativaDias` integer — Dias Decima tentativa em atraso - `DecimaTentativaEMail` boolean — Email da Decima tentativa em atraso - `DecimaTentativaSMS` boolean — SMS da Decima tentativa em atraso ## Other responses - `500` — Erro efetuando a consulta --- [API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/versions/14db4977f490/schema)