Tools do FreshBooks
As 14 operações do FreshBooks que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- 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.
- Listar despesasGETLista as despesas de um negócio, com id, amount, date, vendor, categoryid, clientid, notes e status. A resposta traz result.expenses, page, pages e total: aumente page até chegar a pages.
- Criar despesaPOSTCria uma despesa e a retorna em result.expense. Os campos vão dentro de expense, que precisa de categoryid; amount e date são os usuais.
- Atualizar despesaPUTAltera os campos enviados de uma despesa; os outros permanecem como estão. Os campos vão dentro de expense.
- Listar categorias de despesaGETLista as categorias de despesa de um negócio, como Advertising, com categoryid, o id que Criar despesa pede, e parentid. A resposta traz result.categories, page, pages e total.
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