
Atualizar pessoa no Conta Azul, por uma API
Atualiza parte de uma pessoa: só os campos enviados mudam. Para alterar um endereço existente, envie o id dele obtido em Obter pessoa.
- Identificador
- conta_azul_update_person
A chamada
POST https://connect.reportei.com/api/tools/conta_azul_update_person/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id | string | Sim | Id of the person (UUID), from List people or Create person. |
| nome | string | Não | Name of the person or legal name of the company. |
| tipo_pessoa | string | Não | Física (individual), Jurídica (company) or Estrangeira (foreign).Valores: Física, Jurídica, Estrangeira |
| perfis | array | Não | Profiles of the person, for example one item with tipo_perfil Cliente for a customer. |
| cpf | string | Não | CPF of an individual, for example 123.456.789-00. |
| cnpj | string | Não | CNPJ of a company, for example 12.345.678/0001-90. |
| nome_empresa | string | Não | Trade name of a company. |
| string | Não | Email addresses of the person, separated by commas. | |
| telefone_celular | string | Não | Cell phone with area code, digits only, for example 11987654321. |
| telefone_comercial | string | Não | Business phone with area code, digits only. |
| codigo | string | Não | Code of the person in your own system. |
| observacao | string | Não | Notes about the person. |
| ativo | boolean | Não | false makes the person inactive, and true active again. |
| enderecos | array | Não | Addresses of the person. An item with id changes that address. |
Conexões possíveis
O seu cliente conecta a conta do Conta Azul uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/conta_azul, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/conta_azul_update_person. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Conta Azul
- Listar pessoasGETLista as pessoas da empresa, que são seus clientes, fornecedores e transportadoras, com filtro opcional por texto, perfil ou tipo. A resposta traz items e totalItems; pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Obter pessoaGETRetorna uma pessoa, com tipo, documento, email, telefones, endereços, perfis e os valores em atraso a pagar e a receber.
- Criar pessoaPOSTCria uma pessoa, que é cliente, fornecedor ou transportadora conforme perfis. nome e tipo_pessoa são obrigatórios; envie cpf para pessoa física e cnpj para empresa. A resposta traz o id da pessoa.
- Listar contas a receberGETLista as parcelas a receber (contas a receber) com vencimento em um período, com cliente, categorias, valores pagos e em aberto e status, além dos totais do período em totais. A resposta traz itens e itens_totais; pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Listar contas a pagarGETLista as parcelas a pagar (contas a pagar) com vencimento em um período, com fornecedor, categorias, valores pagos e em aberto e status, além dos totais do período em totais. A resposta traz itens e itens_totais; pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Obter parcelaGETRetorna uma parcela de uma conta a receber ou a pagar, com vencimento, composição do valor, pagamentos (baixas), cobranças e versao, que Atualizar parcela exige.
- Atualizar parcelaPATCHAtualiza parte de uma parcela de conta a receber ou a pagar, como o vencimento, o valor ou a forma de pagamento. Envie a versao retornada por Obter parcela: a atualização é recusada se ela faltar ou estiver desatualizada.
- Criar conta a receberPOSTCria uma conta a receber para um cliente: valor é dividido entre categorias em rateio e entre vencimentos em condicao_pagamento.parcelas. A resposta traz o id do evento financeiro, e suas parcelas aparecem em Listar contas a receber.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
