Criar

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Ao cadastrar um novo cliente, é necessário informar corretamente os dados cadastrais para garantir o funcionamento adequado dos serviços integrados à API.

O tipo de documento é obrigatório. Não é permitido cadastrar, via API, um cliente com o tipo de documento não informado. Da mesma forma, o cliente deve ser cadastrado como estrangeiro somente quando essa condição for aplicável.

Para o correto funcionamento dos serviços, devem ser informados, sempre que disponíveis, os dados do cliente, como:

Documento;
E-mail;
Telefone;
Endereço completo.

Essas informações são necessárias não apenas para fins fiscais, mas também para o funcionamento adequado de serviços como Antifraude, emissão de NFS-e, Boleto e PIX.

Para clientes Pessoa Jurídica, quando aplicável, informe também a Inscrição Municipal e a Inscrição Estadual.

O endereço completo deve ser informado tanto para Pessoa Física quanto para Pessoa Jurídica. Essas informações podem ser necessárias para a emissão de NFS-e e para o envio de informações do município do cliente em operações via PIX.

Para Pessoa Física, utilize o Body :

{
  "status": "ATIVO",
  "tipo": "PESSOA_FISICA",
  "telefone_fixo": "11 22222-2222",
  "telefone_celular": "11 22222-2222",
  "empresa_id": "b51ae983-184f-4d31-9f28-92db414557f9",
  "cpf": "655.812.040-20",
  "nome": "cliente api",
  "email": "[email protected]",
  "aniversario": "20/12/2000",
  "cep": "09720-440",
  "endereco": "Rua Frei Gaspar",
  "bairro": "Centro",
  "cidade": "São Bernardo do Campo",
  "uf": "SP",
  "codigo_ibge": "3548708",
  "numero": "20200",
  "complemento": "apto 89",
  "contato_financeiro": [
    "[email protected]",
    "11 9 9999-9999"
  ],
  "contato_tecnico": [
    "[email protected]",
    "11 9 9999-9999"
  ],
  "contato_contabil": [
    "[email protected]",
    "11 9 9999-9999"
  ],
  "observacoes": "caso tenha"
}

Para Pessoa Jurídica, utilize o Body :

{
  "status": "ATIVO",
  "tipo": "PESSOA_JURIDICA",
  "telefone_fixo": "11 8888-8888",
  "telefone_celular": "11 99999-9999",
  "empresa_id": "b51ae983-184f-4d31-9f28-92db414557f9",
  "cnpj": "12.345.678/0001-95",
  "inscricao_municipal": "se tiver",
  "inscricao_estadual": "se tiver",
  "razao_social": "razao social",
  "nome": "nome fantasia",
  "email": "[email protected]",
  "aniversario": "20/12/2000",
  "cep": "09720-440",
  "endereco": "Rua Frei Gaspar",
  "bairro": "Centro",
  "cidade": "São Bernardo do Campo",
  "uf": "SP",
  "codigo_ibge": "3548708",
  "numero": "12",
  "complemento": "apto 12",
  "contato_tecnico": [
    "[email protected]",
    "11 99999-9999"
  ],
  "contato_financeiro": [
    "[email protected]",
    "11 99999-9999"
  ],
  "contato_contabil": [
    "[email protected]",
    "11 99999-9999"
  ],
  "observacoes": "se quiser",
  "reter_iss": true
}
Path Params
string
required
Body Params
string
enum
required
Defaults to PESSOA_FISICA
Allowed:
string
required
string
required

Utilize a chave CPF para pessoa Física e CNPJ para pessoa Jurídica

string
required
string
required
string
required
string
required
string
required
string
required
string
required
string
required
string
required
string
required

ID da Empresa que na qual cliente será criado

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain