Atualizar cliente no FreshBooks, por uma API
Altera os campos enviados de um cliente; os outros permanecem como estão. Os campos vão dentro de client.
- Identificador
- freshbooks_update_client
A chamada
POST https://connect.reportei.com/api/tools/freshbooks_update_client/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"account_id": "<account_id>",
"client_id": 1,
"client": {}
}
}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 |
|---|---|---|---|
| account_id | string | Sim | account_id of a business, from Get current user. |
| client_id | integer | Sim | Id of the client, from List clients or Create client. |
| client | object | Sim | The fields to change. |
Conexões possíveis
O seu cliente conecta a conta do FreshBooks 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/freshbooks, 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/freshbooks_update_client. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do FreshBooks
- Obter usuário atualGETRetorna o usuário conectado. Cada item de business_memberships traz o papel do usuário e um business com nome e account_id, o account_id que todas as outras ferramentas pedem. Um negócio sem account_id não tem contabilidade, e as outras ferramentas não funcionam nele.
- Listar clientesGETLista os clientes ativos e arquivados de um negócio, com id, nomes, organização, email, telefones, endereço e moeda. A resposta traz result.clients, page, pages e total: aumente page até chegar a pages.
- Criar clientePOSTCria um cliente e o retorna em result.client, com o id que as faturas usam como customerid e as despesas como clientid. Os campos vão dentro de client.
- Listar faturasGETLista as faturas ativas e arquivadas de um negócio, sem suas linhas: id, invoice_number, customerid, organization, create_date, due_date, amount, outstanding, paid, v3_status e payment_status. A resposta traz result.invoices, page, pages e total: aumente page até chegar a pages.
- Obter faturaGETRetorna uma fatura em result.invoice, sem suas linhas: número, cliente, datas, amount, outstanding, paid, discount, notes, terms, v3_status e payment_status.
- Criar faturaPOSTCria uma fatura em rascunho e a retorna em result.invoice. Os campos vão dentro de invoice, que precisa de customerid e create_date; as linhas definem o valor. Um rascunho não conta nos relatórios e o cliente não consegue abri-lo: Enviar fatura o envia por email ou o marca como enviado.
- Atualizar faturaPUTAltera os campos enviados de uma fatura, como datas, número, notes, terms ou discount; os outros permanecem como estão. Os campos vão dentro de invoice. As linhas não são alteradas aqui: um PUT com lines substitui todas elas, e nenhuma ferramenta lê as linhas atuais.
- Enviar faturaPUTEnvia uma fatura por email para email_recipients, com action_email true, ou apenas a marca como enviada, com action_mark_as_sent true, para uma fatura entregue de outra forma. Nos dois casos ela sai do rascunho e passa a contar nos relatórios. Envie uma das duas ações e nenhum outro campo da fatura: o FreshBooks ignora o resto.
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.

Conta Azul