Inativar um cadastro de pessoa

API's Conta Azul Pro (v2)

API para gerenciamento de dados do ERP Conta Azul Pro

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://developers.contaazul.com/_mock/openapi/

Servidor de produção

https://api-public.contaazul.com/

Autenticação

Operations

Cobranças

Operations

Contratos

Operations

Centro de Custo

Operations

Categorias

Operations

Conta Financeira

Operations

Financeiro

Operations

Produto

Operations

Cadastro de Pessoas

Operations

Lista registros de pessoas

Request

Retorna uma lista de registros de pessoas com base nos filtros fornecidos.

Query

paginainteger

Número da página a ser retornada.

Default 1

tamanho_paginainteger

Número de registros por página.

Default 10

termo_buscastring

Termo de busca para filtrar os registros. A busca será feita no campo de documento, nome do cliente e nome da empresa.

documento[]Array of strings

Lista de documentos para filtrar os registros.

inscricao_estadual[]Array of strings

Lista de inscrições estaduais para filtrar os registros.

inscricao_municipal[]Array of strings

Lista de inscrições municipais para filtrar os registros.

pais[]Array of strings

Lista de nome de países para filtrar os registros.

cidade[]Array of strings

Lista de nomes de cidades para filtrar os registros.

uf[]Array of strings

Lista de sigla de estados para filtrar os registros.

codigo_identificador[]Array of strings

Lista de códigos identificadores para filtrar os registros.

tipo_pessoa[]Array of strings

Lista de tipos de pessoa para filtrar os registros.

data_ativacao_iniciostring(date)

Data de início da ativação. Também deve ser informada a data_ativacao_fim para efetuar a busca.

Example: data_ativacao_inicio=2021-01-31T00:00:00.000Z

data_ativacao_fimstring(date)

Data de fim da ativação. Também deve ser informada a data_ativacao_inicio para efetuar a busca.

Example: data_ativacao_fim=2021-01-31T00:00:00.000Z

tipo_perfilstring

Tipo do perfil da pessoa, indicando se é cliente, fornecedor e/ou transportadora.

Enum"CLIENTE""FORNECEDOR""TRANSPORTADORA"

statusstring

Status da pessoa para filtrar os registros.

Enum"ATIVO""INATIVO""TODOS"

curl -i -X GET \
  'https://developers.contaazul.com/_mock/openapi/v1/pessoa?cidade%5B%5D=string&codigo_identificador%5B%5D=string&data_ativacao_fim=2021-01-31T00%3A00%3A00.000Z&data_ativacao_inicio=2021-01-31T00%3A00%3A00.000Z&documento%5B%5D=string&inscricao_estadual%5B%5D=string&inscricao_municipal%5B%5D=string&pagina=1&pais%5B%5D=string&status=ATIVO&tamanho_pagina=10&termo_busca=string&tipo_perfil=CLIENTE&tipo_pessoa%5B%5D=FISICA&uf%5B%5D=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Operação realizada com sucesso

Bodyapplication/json

uuidstring(uuid)

Identificador único da pessoa

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

nomestring

Nome da pessoa

Example: "John Doe"

documentostring

Documento da pessoa

Example: "12345678901"

inscricao_estadualstring

Inscrição estadual da pessoa

Example: "12345678901"

emailstring(email)

Email da pessoa

Example: "email@email.com"

telefonestring

Telefone da pessoa

Example: "12345678901"

ativoboolean

Indica se a pessoa está ativa

Example: true

id_legadointeger(int64)

Identificador legado da pessoa

Example: 123

uuid_legadostring(uuid)

Identificador do cadastro legado da pessoa

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

perfisArray of strings

Lista de perfis da pessoa

Example: ["Cliente"]

tipo_pessoastring

Tipo de pessoa

Enum"FISICA""JURIDICA""ESTRANGEIRA"

Example: "FISICA"

enderecoobject

Response

application/json

{
  "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "nome": "John Doe",
  "documento": "12345678901",
  "inscricao_estadual": "12345678901",
  "email": "email@email.com",
  "telefone": "12345678901",
  "ativo": true,
  "id_legado": 123,
  "uuid_legado": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "perfis": [
    "Cliente"
  ],
  "tipo_pessoa": "FISICA",
  "endereco": {
    "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "cep": "12345678",
    "logradouro": "nome da rua",
    "numero": "123",
    "complemento": "apartmento 123",
    "bairro": "Nome do bairro",
    "id_cidade": 0,
    "cidade": "Nome da cidade",
    "estado": "Nome do estado",
    "pais": "Nome do país"
  }
}

Criação de registro de pessoa

Request

Bodyapplication/jsonrequired

Criação de registro de pessoa

perfisArray of objects

Lista de perfis

registrosArray of objects

Lista de registros

outros_contatosArray of objects

Lista de outros contatos

enderecosArray of objects

Lista de endereços

duplicarboolean

Duplicar

Example: false

tipo_pessoastring

Tipo de pessoa

Enum"FISICA""JURIDICA""ESTRANGEIRA"

cnpjstring

CNPJ

Example: "33111512000184"

cpfstring

CPF

Example: "12345678900"

nomestring

Nome

Example: "John Doe"

codigostring

Código

Example: "123"

ativoboolean

Ativo

Example: true

optante_simplesboolean

Optante do simples

Example: true

agencia_publicaboolean

Agência pública

Example: true

nome_fantasiastring

Nome fantasia

Example: "Company name"

registro_geralstring

Registro geral

Example: "12345678901"

data_nascimentostring

Data de nascimento

Example: "2022-01-01"

emailstring

Endereço de email

Example: "email@email.com"

telefone_comercialstring

Telefone comercial

Example: "12345678901"

celularstring

Telefone celular

Example: "12345678901"

observacaostring

Observação

Example: "Observation"

id_contato_principalstring

ID do contato principal

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

criado_emstring

Data de criação

Example: "2022-01-01"

excluido_emstring(date-time)

Data de exclusão

Example: "2022-01-01"

origemstring

Origem

Example: "Origin"

id_origemstring(uuid)

ID de origem

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/pessoa \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "perfis": [
      {
        "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "tipo_perfil": "CLIENTE"
      }
    ],
    "registros": [
      {
        "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "indicador_inscricao_estadual": "12345678901",
        "inscricao_estadual": "12345678901",
        "inscricao_nacional": "12345678901",
        "inscricao_suframa": "12345678901"
      }
    ],
    "outros_contatos": [
      {
        "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "nome": "John Doe",
        "email": "email@email.com",
        "telefone_comercial": "12345678901",
        "celular": "12345678901",
        "escritorio": "Office"
      }
    ],
    "enderecos": [
      {
        "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "cep": "12345678",
        "logradouro": "nome da rua",
        "numero": "123",
        "complemento": "apartmento 123",
        "bairro": "Nome do bairro",
        "id_cidade": 0,
        "cidade": "Nome da cidade",
        "estado": "Nome do estado",
        "pais": "Nome do país"
      }
    ],
    "duplicar": false,
    "tipo_pessoa": "FISICA",
    "cnpj": "33111512000184",
    "cpf": "12345678900",
    "nome": "John Doe",
    "codigo": "123",
    "ativo": true,
    "optante_simples": true,
    "agencia_publica": true,
    "nome_fantasia": "Company name",
    "registro_geral": "12345678901",
    "data_nascimento": "2022-01-01",
    "email": "email@email.com",
    "telefone_comercial": "12345678901",
    "celular": "12345678901",
    "observacao": "Observation",
    "id_contato_principal": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "criado_em": "2022-01-01",
    "excluido_em": "2022-01-01",
    "origem": "Origin",
    "id_origem": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
  }'

Responses

Cadastro de pessoa criado com sucesso

Bodyapplication/json

uuidstring(uuid)

Identificador único da pessoa

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

perfisArray of objects

Lista de perfis

registrosArray of objects

Lista de registros

outros_contatosArray of objects

Lista de outros contatos

enderecosArray of objects

Lista de endereços

tipo_pessoastring

Tipo de pessoa

Enum"FISICA""JURIDICA""ESTRANGEIRA"

cnpjstring

CNPJ

Example: "33111512000184"

cpfstring

CPF

Example: "12345678900"

nomestring

Nome

Example: "John Doe"

codigostring

Código

Example: "123"

ativoboolean

Ativo

Example: true

optante_simplesboolean

Optante do simples

Example: true

agencia_publicaboolean

Agência pública

Example: true

nome_fantasiastring

Nome fantasia

Example: "Company name"

registro_geralstring

Registro geral

Example: "12345678901"

data_nascimentostring

Data de nascimento

Example: "2022-01-01"

emailstring

Endereço de email

Example: "email@email.com"

telefone_comercialstring

Telefone comercial

Example: "12345678901"

celularstring

Telefone celular

Example: "12345678901"

observacaostring

Observação

Example: "Observation"

id_contato_principalstring

ID do contato principal

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

criado_emstring

Data de criação

Example: "2022-01-01"

excluido_emstring(date-time)

Data de exclusão

Example: "2022-01-01"

origemstring

Origem

Example: "Origin"

id_origemstring(uuid)

ID de origem

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

Response

application/json

{
  "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "perfis": [
    { … }
  ],
  "registros": [
    { … }
  ],
  "outros_contatos": [
    { … }
  ],
  "enderecos": [
    { … }
  ],
  "tipo_pessoa": "FISICA",
  "cnpj": "33111512000184",
  "cpf": "12345678900",
  "nome": "John Doe",
  "codigo": "123",
  "ativo": true,
  "optante_simples": true,
  "agencia_publica": true,
  "nome_fantasia": "Company name",
  "registro_geral": "12345678901",
  "data_nascimento": "2022-01-01",
  "email": "email@email.com",
  "telefone_comercial": "12345678901",
  "celular": "12345678901",
  "observacao": "Observation",
  "id_contato_principal": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "criado_em": "2022-01-01",
  "excluido_em": "2022-01-01",
  "origem": "Origin",
  "id_origem": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
}

Atualização de registro de pessoa

Request

Path

id_cadastro_pessoastring(uuid)required

UUID do cadastro de pessoa

Bodyapplication/jsonrequired

perfisArray of objects

Lista de perfis

registrosArray of objects

Lista de registros

outros_contatosArray of objects

Lista de outros contatos

enderecosArray of objects

Lista de endereços

duplicarboolean

Duplicar

Example: false

tipo_pessoastring

Tipo de pessoa

Enum"FISICA""JURIDICA""ESTRANGEIRA"

cnpjstring

CNPJ

Example: "33111512000184"

cpfstring

CPF

Example: "12345678900"

nomestring

Nome

Example: "John Doe"

codigostring

Código

Example: "123"

ativoboolean

Ativo

Example: true

optante_simplesboolean

Optante do simples

Example: true

agencia_publicaboolean

Agência pública

Example: true

nome_fantasiastring

Nome fantasia

Example: "Company name"

registro_geralstring

Registro geral

Example: "12345678901"

data_nascimentostring

Data de nascimento

Example: "2022-01-01"

emailstring

Endereço de email

Example: "email@email.com"

telefone_comercialstring

Telefone comercial

Example: "12345678901"

celularstring

Telefone celular

Example: "12345678901"

observacaostring

Observação

Example: "Observation"

id_contato_principalstring

ID do contato principal

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

criado_emstring

Data de criação

Example: "2022-01-01"

excluido_emstring(date-time)

Data de exclusão

Example: "2022-01-01"

origemstring

Origem

Example: "Origin"

id_origemstring(uuid)

ID de origem

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

curl -i -X PUT \
  'https://developers.contaazul.com/_mock/openapi/v1/pessoa/{id_cadastro_pessoa}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "perfis": [
      {
        "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "tipo_perfil": "CLIENTE"
      }
    ],
    "registros": [
      {
        "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "indicador_inscricao_estadual": "12345678901",
        "inscricao_estadual": "12345678901",
        "inscricao_nacional": "12345678901",
        "inscricao_suframa": "12345678901"
      }
    ],
    "outros_contatos": [
      {
        "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "nome": "John Doe",
        "email": "email@email.com",
        "telefone_comercial": "12345678901",
        "celular": "12345678901",
        "escritorio": "Office"
      }
    ],
    "enderecos": [
      {
        "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "cep": "12345678",
        "logradouro": "nome da rua",
        "numero": "123",
        "complemento": "apartmento 123",
        "bairro": "Nome do bairro",
        "id_cidade": 0,
        "cidade": "Nome da cidade",
        "estado": "Nome do estado",
        "pais": "Nome do país"
      }
    ],
    "duplicar": false,
    "tipo_pessoa": "FISICA",
    "cnpj": "33111512000184",
    "cpf": "12345678900",
    "nome": "John Doe",
    "codigo": "123",
    "ativo": true,
    "optante_simples": true,
    "agencia_publica": true,
    "nome_fantasia": "Company name",
    "registro_geral": "12345678901",
    "data_nascimento": "2022-01-01",
    "email": "email@email.com",
    "telefone_comercial": "12345678901",
    "celular": "12345678901",
    "observacao": "Observation",
    "id_contato_principal": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "criado_em": "2022-01-01",
    "excluido_em": "2022-01-01",
    "origem": "Origin",
    "id_origem": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
  }'

Responses

Cadastro de pessoa atualizado com sucesso

Bodyapplication/json

uuidstring(uuid)

Identificador único da pessoa

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

perfisArray of objects

Lista de perfis

registrosArray of objects

Lista de registros

outros_contatosArray of objects

Lista de outros contatos

enderecosArray of objects

Lista de endereços

tipo_pessoastring

Tipo de pessoa

Enum"FISICA""JURIDICA""ESTRANGEIRA"

cnpjstring

CNPJ

Example: "33111512000184"

cpfstring

CPF

Example: "12345678900"

nomestring

Nome

Example: "John Doe"

codigostring

Código

Example: "123"

ativoboolean

Ativo

Example: true

optante_simplesboolean

Optante do simples

Example: true

agencia_publicaboolean

Agência pública

Example: true

nome_fantasiastring

Nome fantasia

Example: "Company name"

registro_geralstring

Registro geral

Example: "12345678901"

data_nascimentostring

Data de nascimento

Example: "2022-01-01"

emailstring

Endereço de email

Example: "email@email.com"

telefone_comercialstring

Telefone comercial

Example: "12345678901"

celularstring

Telefone celular

Example: "12345678901"

observacaostring

Observação

Example: "Observation"

id_contato_principalstring

ID do contato principal

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

criado_emstring

Data de criação

Example: "2022-01-01"

excluido_emstring(date-time)

Data de exclusão

Example: "2022-01-01"

origemstring

Origem

Example: "Origin"

id_origemstring(uuid)

ID de origem

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"

Response

application/json

{
  "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "perfis": [
    { … }
  ],
  "registros": [
    { … }
  ],
  "outros_contatos": [
    { … }
  ],
  "enderecos": [
    { … }
  ],
  "tipo_pessoa": "FISICA",
  "cnpj": "33111512000184",
  "cpf": "12345678900",
  "nome": "John Doe",
  "codigo": "123",
  "ativo": true,
  "optante_simples": true,
  "agencia_publica": true,
  "nome_fantasia": "Company name",
  "registro_geral": "12345678901",
  "data_nascimento": "2022-01-01",
  "email": "email@email.com",
  "telefone_comercial": "12345678901",
  "celular": "12345678901",
  "observacao": "Observation",
  "id_contato_principal": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "criado_em": "2022-01-01",
  "excluido_em": "2022-01-01",
  "origem": "Origin",
  "id_origem": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
}

Remoção do cadastro de pessoa

Request

Bodyapplication/jsonrequired

uuidsArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/pessoa/exclusao-lote \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuids": [
      "35473eec-4e74-11ee-b500-9f61de8a8b8b",
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

Responses

Cadastro de pessoa removido com sucesso

Bodyapplication/json

todosArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

excluidosArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b"]

nao_excluidosArray of strings(uuid)

Example: ["123e4567-e89b-12d3-a456-426614174000"]

Response

application/json

{
  "todos": [
    "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "excluidos": [
    "35473eec-4e74-11ee-b500-9f61de8a8b8b"
  ],
  "nao_excluidos": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Busca cadastro de pessoa por ID

Request

Retorna um resumo do cadastro de pessoa

Path

id_cadastro_pessoastring(uuid)required

Example: 123e4567-e89b-12d3-a456-426614174000

curl -i -X GET \
  https://developers.contaazul.com/_mock/openapi/v1/pessoa/123e4567-e89b-12d3-a456-426614174000/resumo \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Sucesso

Bodyapplication/json

uuidstring(uuid)

Example: "123e4567-e89b-12d3-a456-426614174000"

nomestring

Example: "John Doe"

documentostring

Example: "123.456.789-00"

atrasos_recebimentosnumber(double)

Example: 1500.75

recebimentos_mes_atualnumber(double)

Example: 3000.5

atrasos_pagamentosnumber(double)

Example: 500.25

pagamentos_mes_atualnumber(double)

Example: 2000

emailstring

Example: "john.doe@example.com"

telefone_comercialstring

Example: "+55 11 1234-5678"

celularstring

Example: "+55 11 98765-4321"

criado_emstring

Example: "2023-01-01T12:00:00Z"

codigostring

Example: "ABC123"

perfisArray of strings

Example: ["Cliente","Fornecedor","Transportadora"]

pessoas_legadoArray of objects

Lista de pessoas legado

enderecosArray of objects

Lista de endereços

observacoes_geraisstring

Example: "Nenhuma observação"

optante_simples_nacionalboolean

Example: true

orgao_publicoboolean

Example: false

nome_empresastring

Example: "Empresa Exemplo"

tipo_pessoastring

Example: "Física"

mensagem_pagamentos_abertosArray of objects

Lista de mensagens de pagamentos em aberto

lembretes_vencimentoArray of objects

Lista de lembretes de vencimento

informacoes_adicionaisArray of objects

Lista de informações adicionais

outros_contatosArray of objects

Lista de outros contatos

informacoes_fiscaisArray of objects

Lista de informações fiscais

Response

application/json

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "nome": "John Doe",
  "documento": "123.456.789-00",
  "atrasos_recebimentos": 1500.75,
  "recebimentos_mes_atual": 3000.5,
  "atrasos_pagamentos": 500.25,
  "pagamentos_mes_atual": 2000,
  "email": "john.doe@example.com",
  "telefone_comercial": "+55 11 1234-5678",
  "celular": "+55 11 98765-4321",
  "criado_em": "2023-01-01T12:00:00Z",
  "codigo": "ABC123",
  "perfis": [
    "Cliente",
    "Fornecedor",
    "Transportadora"
  ],
  "pessoas_legado": [
    { … }
  ],
  "enderecos": [
    { … }
  ],
  "observacoes_gerais": "Nenhuma observação",
  "optante_simples_nacional": true,
  "orgao_publico": false,
  "nome_empresa": "Empresa Exemplo",
  "tipo_pessoa": "Física",
  "mensagem_pagamentos_abertos": [
    { … }
  ],
  "lembretes_vencimento": [
    { … }
  ],
  "informacoes_adicionais": [
    { … }
  ],
  "outros_contatos": [
    { … }
  ],
  "informacoes_fiscais": [
    { … }
  ]
}

Inativar um cadastro de pessoa

Request

Inativa um cadastro de pessoa com base nos dados fornecidos na solicitação.

Bodyapplication/jsonrequired

uuidsArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/pessoa/desativacao \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuids": [
      "35473eec-4e74-11ee-b500-9f61de8a8b8b",
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

Responses

Cadastro de pessoa inativado com sucesso

Bodyapplication/json

todosArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

ativosArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

inativosArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

Response

application/json

{
  "todos": [
    "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ativos": [
    "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "inativos": [
    "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Recuperar resumo do cadastro de pessoa a partir do UUID legado

Request

Recupera o resumo do cadastro de uma pessoa utilizando o UUID legado.

Path

uuidLegadostring(uuid)required

UUID legado da pessoa

curl -i -X GET \
  'https://developers.contaazul.com/_mock/openapi/v1/pessoa/legado/{uuidLegado}/resumo' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Resumo do cadastro da pessoa recuperado com sucesso

Bodyapplication/json

uuidstring(uuid)

Identificador único do cadastro de pessoa

Example: "123e4567-e89b-12d3-a456-426614174000"

nomestring

Nome da pessoa

Example: "John Doe"

documentostring

Documento da pessoa

Example: "12345678901"

atrasos_recebimentosnumber(double)

Atrasos em recebimentos

Example: 1500.75

recebimentos_mes_atualnumber(double)

Recebimentos no mês atual

Example: 3000.5

atrasos_pagamentosnumber(double)

Atrasos em pagamentos

Example: 500.25

pagamentos_mes_atualnumber(double)

Pagamentos do mês atual

Example: 3000

emailstring(email)

Email da pessoa

Example: "john.doe@example.com"

telefone_comercialstring

Telefone comercial

Example: "+55 11 1234-5678"

celularstring

Telefone celular

Example: "+55 11 9876-5432"

criado_emstring(date-time)

Data de criação do cadastro

Example: "2023-01-01T12:00:00Z"

codigostring

Código do cadastro

Example: "123"

perfisArray of strings

Lista de perfis da pessoa

Example: ["Cliente","Fornecedor"]

pessoas_legadoArray of objects

Lista de pessoas legado

enderecoobject

observacoes_geraisstring

Observações gerais

Example: "Nenhuma observação"

optante_simples_nacionalboolean

Indica se a pessoa é optante do Simples Nacional

Example: true

orgao_publicoboolean

Indica se a pessoa é um órgão público

Example: false

nome_empresastring

Nome da empresa

Example: "Empresa Exemplo"

tipo_pessoastring

Tipo de pessoa

Example: "Física"

mensagem_pagamentos_abertosobject

lembretes_vencimentoArray of objects

Lembretes de vencimento

informacoes_adicionaisArray of objects

Informações adicionais

outros_contatosArray of objects

Outros contatos

informacoes_fiscaisArray of objects

Informações fiscais

Response

application/json

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "nome": "John Doe",
  "documento": "12345678901",
  "atrasos_recebimentos": 1500.75,
  "recebimentos_mes_atual": 3000.5,
  "atrasos_pagamentos": 500.25,
  "pagamentos_mes_atual": 3000,
  "email": "john.doe@example.com",
  "telefone_comercial": "+55 11 1234-5678",
  "celular": "+55 11 9876-5432",
  "criado_em": "2023-01-01T12:00:00Z",
  "codigo": "123",
  "perfis": [
    "Cliente",
    "Fornecedor"
  ],
  "pessoas_legado": [
    { … }
  ],
  "endereco": {
    "uuid": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "cep": "12345678",
    "logradouro": "nome da rua",
    "numero": "123",
    "complemento": "apartmento 123",
    "bairro": "Nome do bairro",
    "id_cidade": 0,
    "cidade": "Nome da cidade",
    "estado": "Nome do estado",
    "pais": "Nome do país"
  },
  "observacoes_gerais": "Nenhuma observação",
  "optante_simples_nacional": true,
  "orgao_publico": false,
  "nome_empresa": "Empresa Exemplo",
  "tipo_pessoa": "Física",
  "mensagem_pagamentos_abertos": {
    "numero": 5,
    "total": 1000
  },
  "lembretes_vencimento": [
    { … }
  ],
  "informacoes_adicionais": [
    { … }
  ],
  "outros_contatos": [
    { … }
  ],
  "informacoes_fiscais": [
    { … }
  ]
}

Ativar Cadastro de Pessoa

Request

Ativa o cadastro de uma ou mais pessoas com base nos critérios fornecidos.

Bodyapplication/jsonrequired

Critérios para ativação de cadastro de pessoa

uuidsArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/pessoa/ativacao \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuids": [
      "35473eec-4e74-11ee-b500-9f61de8a8b8b",
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

Responses

Cadastro de pessoa ativado com sucesso

Bodyapplication/json

todosArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

ativosArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

inativosArray of strings(uuid)

Example: ["35473eec-4e74-11ee-b500-9f61de8a8b8b","123e4567-e89b-12d3-a456-426614174000"]

Response

application/json

{
  "todos": [
    "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ativos": [
    "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "inativos": [
    "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Protocolo

Operations

Venda

Operations

Serviço

Operations

API's Conta Azul Pro (v2)

Autenticação

Cobranças

Contratos

Centro de Custo

Categorias

Conta Financeira

Financeiro

Produto

Cadastro de Pessoas

Lista registros de pessoas

Request

Responses

Was this helpful?

Criação de registro de pessoa

RequestExpand all

Responses

Was this helpful?

Atualização de registro de pessoa

RequestExpand all

Responses

Was this helpful?

Remoção do cadastro de pessoa

Request

Responses

Was this helpful?

Busca cadastro de pessoa por ID

Request

Responses

Was this helpful?

Inativar um cadastro de pessoa

Request

Responses

Was this helpful?

Recuperar resumo do cadastro de pessoa a partir do UUID legado

Request

Responses

Was this helpful?

Ativar Cadastro de Pessoa

Request

Responses

Was this helpful?

Protocolo

Venda

Serviço

Request

Request