
Mettre à jour une personne avec l'API Conta Azul
Met à jour une partie d'une personne : seuls les champs envoyés changent. Pour modifier une adresse existante, envoyez son id obtenu avec Obtenir une personne.
- Identifiant
- conta_azul_update_person
L'appel
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>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| id | string | Oui | Id of the person (UUID), from List people or Create person. |
| nome | string | Non | Name of the person or legal name of the company. |
| tipo_pessoa | string | Non | Física (individual), Jurídica (company) or Estrangeira (foreign).Valeurs : Física, Jurídica, Estrangeira |
| perfis | array | Non | Profiles of the person, for example one item with tipo_perfil Cliente for a customer. |
| cpf | string | Non | CPF of an individual, for example 123.456.789-00. |
| cnpj | string | Non | CNPJ of a company, for example 12.345.678/0001-90. |
| nome_empresa | string | Non | Trade name of a company. |
| string | Non | Email addresses of the person, separated by commas. | |
| telefone_celular | string | Non | Cell phone with area code, digits only, for example 11987654321. |
| telefone_comercial | string | Non | Business phone with area code, digits only. |
| codigo | string | Non | Code of the person in your own system. |
| observacao | string | Non | Notes about the person. |
| ativo | boolean | Non | false makes the person inactive, and true active again. |
| enderecos | array | Non | Addresses of the person. An item with id changes that address. |
Connexions possibles
Votre client connecte son compte Conta Azul une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/conta_azul, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/conta_azul_update_person. Il devient la définition de tool de votre agent sans conversion.
Autres tools Conta Azul
- Lister les personnesGETListe les personnes de l'entreprise, c'est-à-dire ses clients, fournisseurs et transporteurs, avec filtre optionnel par texte, profil ou type. La réponse contient items et totalItems ; paginez avec pagina, et une page plus courte que tamanho_pagina est la dernière.
- Obtenir une personneGETRenvoie une personne, avec type, document, email, téléphones, adresses, profils et les montants en retard à payer et à recevoir.
- Créer une personnePOSTCrée une personne, qui est un client, un fournisseur ou un transporteur selon perfis. nome et tipo_pessoa sont obligatoires ; envoyez cpf pour un particulier et cnpj pour une entreprise. La réponse contient l'id de la personne.
- Lister les créancesGETListe les échéances à recevoir (contas a receber) arrivant à échéance sur une période, avec client, catégories, montants payés et ouverts et statut, plus les totaux de la période dans totais. La réponse contient itens et itens_totais ; paginez avec pagina, et une page plus courte que tamanho_pagina est la dernière.
- Lister les dettesGETListe les échéances à payer (contas a pagar) arrivant à échéance sur une période, avec fournisseur, catégories, montants payés et ouverts et statut, plus les totaux de la période dans totais. La réponse contient itens et itens_totais ; paginez avec pagina, et une page plus courte que tamanho_pagina est la dernière.
- Obtenir une échéanceGETRenvoie une échéance d'une créance ou d'une dette, avec date d'échéance, composition du montant, paiements (baixas), encaissements et versao, qu'exige Mettre à jour une échéance.
- Mettre à jour une échéancePATCHMet à jour une partie d'une échéance de créance ou de dette, comme la date d'échéance, le montant ou le mode de paiement. Envoyez la versao renvoyée par Obtenir une échéance : la mise à jour est refusée si elle manque ou n'est plus à jour.
- Créer une créancePOSTCrée une créance pour un client : valor est réparti entre les catégories dans rateio et entre les échéances dans condicao_pagamento.parcelas. La réponse contient l'id de l'événement financier, et ses échéances apparaissent dans Lister les créances.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
