Finanças e pagamentos
FreshBooks no seu produto e nos seus agentes de IA, por uma API
O toolkit do FreshBooks cobre clientes, faturas, pagamentos recebidos, despesas e categorias de despesa de um negócio. Seu cliente conecta o FreshBooks uma vez por OAuth, e seu produto ou agente de IA executa cada operação pelo Connect, que guarda e renova as credenciais e registra cada execução.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/freshbooks_create_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": {}
}
}Como funciona
Do cliente conectado à primeira chamada no FreshBooks.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do FreshBooks. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o FreshBooks.
Fature pelo seu produto
Crie um cliente, monte uma fatura em rascunho e chame Enviar fatura para enviá-la por email, e a cobrança iniciada no seu app chega ao FreshBooks.
Registre pagamentos automaticamente
Quando um pagamento é confirmado em outro lugar, crie um pagamento na fatura para ela virar parcial ou paga na contabilidade do cliente.
Agente lança despesas
Um agente de IA lista as categorias de despesa e cria uma despesa com o categoryid certo a partir de um recibo enviado por um usuário.
Tools
14 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.
- Atualizar clientePUTAltera os campos enviados de um cliente; os outros permanecem como estão. 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.
- Criar pagamentoPOSTRegistra um pagamento recebido em uma fatura, como transferência bancária ou dinheiro, e o retorna em result.payment. Os campos vão dentro de payment, com invoiceid e amount. A fatura passa a parcial ou paga conforme o valor.
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.
Perguntas sobre o toolkit do FreshBooks
Preciso implementar a API do FreshBooks?
Não. O Connect já traz 14 tools do FreshBooks descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do FreshBooks?
Pelo modo que o toolkit aceita: OAuth com o app do seu produto. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
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