POST /customer (Customer)
create_customerCreate a customer in Conexa, including personal or legal entity details, address, contacts, login access, and tax deduction settings.
Instructions
Criação de um cliente no sistema Conexa. ⚠ Fique atento ao produto do seu sistema. Há campos que não são necessários!
Campos do body:
companyId (integer) [obrigatório]: ID da unidade
name (string) [obrigatório]: Nome do cliente
tradeName (string / null): Nome fantasia
pronunciation (string / null): Pronúncia
fieldOfActivity (string / null): Ramo de atividade
notes (string / null): Observações
cellNumber (string / null): Celular
website (string / null): Site
hasLoginAccess (boolean): Tem acesso a área do cliente
login (string / null) [obrigatório]: Login da área do cliente
password (string / null) [obrigatório]: Senha da área do cliente
automaticallyIssueNfse (string / null): Emitir NFS-e automaticamente. A opção deve ser uma das seguintes: whenGeneratingBilling , afterPaymentBilling , notIssue
notesNfse (string / null): Observações da NFS-e
taxDeductions (object): Retenção de Imposto Municipal e Federal
taxDeductions.iss (boolean): Retém ISS (Imposto Municipal)
taxDeductions.ir (boolean): Retém IR (Imposto Federal)
taxDeductions.pis (boolean): Retém PIS (Imposto Federal)
taxDeductions.inss (boolean): Retém INSS (Imposto Federal)
taxDeductions.csll (boolean): Retém CSLL (Imposto Federal)
taxDeductions.cofins (boolean): Retém COFINS (Imposto Federal)
naturalPerson (object): Objeto com os dados referentes a um cliente Pessoa Física
naturalPerson.cpf (string / null): CPF
naturalPerson.rg (string / null): RG
naturalPerson.birthDate (date): Data de aniversário. Formato: yyyy-MM-dd
naturalPerson.issuingAuthority (string / null): Órgão expedidor
naturalPerson.profession (string / null): Profissão
naturalPerson.maritalStatus (string / null): O estado civil do cliente, sendo: " married ", " single ", " divorced ", " widowed " ou " not informed "
legalPerson (object): Objeto com os dados referentes a um cliente Pessoa Jurídica
legalPerson.cnpj (string / null): CNPJ
legalPerson.foundationDate (date): Data de fundação. Formato: yyyy-MM-dd
legalPerson.stateInscription (string / null): Inscrição estadual
legalPerson.municipalInscription (string / null): Inscrição municipal
foreign (object): Objeto com os dados de estrangeiro
foreign.document (string / null): Número do documento de identificação estrangeiro
foreign.birthDate (date): Data de aniversário. Formato: yyyy-MM-dd
foreign.profession (string / null): Profissão
address (object): Objeto com o endereço do cliente
address.zipCode (string / null): CEP
address.country (string / null): País de origem (apenas se for estrangeiro )
address.state (string / null): Sigla do estado (UF)
address.city (string / null): Cidade
address.street (string / null): Logradouro
address.number (string / null): Número
address.neighborhood (string / null): Bairro
address.additionalDetails (string / null): Complemento
phones (string[]): Array com os telefones de contato. Os telefones devem ter 10 ou 11 números.
emailsMessage (string[]): Array com os e-mails para envio de recados
emailsFinancialMessages (string[]): Array com os e-mails para envio de avisos financeiros
tagsId (integer[]): Array com os IDs das Tags para associar ao cliente
extraFields (array of objects): Array de objetos de Campos Extras
extraFields[].id (integer) [obrigatório]: ID do Campo Extra
extraFields[].value (string): Valor para o Campo Extra
isNetworkingProfileVisible (boolean): Exibir perfil do cliente na área de Networking da área do cliente
isBlockedBookingCustomerArea (boolean): Não permite que o cliente cadastre novas reservas pela área do cliente, caso hasLoginAccess seja true
isAllowedBookingOutsideBusinessHours (boolean): Permite reservar fora do horário de funcionamento padrão, caso hasLoginAccess seja true
internetPlan (string / null): Nome do plano de internet (Disponível apenas com o módulo Mikrotik ativo)
businessPresentation (string / null): Breve apresentação sobre o cliente
offeredServicesProducts (string / null): Serviços e produtos oferecidos
receptionOrientations (string / null): Orientações para atendimento
mailingOrientations (string / null): Orientações para correspondência
mailingAddress (object): Objeto com o endereço para correspondências
mailingAddress.zipCode (string / null): CEP
mailingAddress.state (string / null): Sigla do estado (UF)
mailingAddress.city (string / null): Cidade
mailingAddress.street (string / null): Logradouro
mailingAddress.number (string / null): Número
mailingAddress.neighborhood (string / null): Bairro
mailingAddress.additionalDetails (string / null): Complemento
mailingAddress.landmark (string / null): Ponto de referência
extensionNumbers (string[]): Array com os ramais
defaultDueDay (integer): Dia de vencimento padrão do cliente
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Corpo JSON da requisição (campos na descrição da tool) |