FreshBooks (versão prévia)
O FreshBooks é um software de contabilidade de pequenas empresas baseado em nuvem. Enviar faturas, acompanhar o tempo, gerenciar recibos e despesas.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL |
Suporte do Microsoft LogicApps Suporte do Microsoft Power Automate Suporte do Microsoft Power Apps |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://www.freshbooks.com/ |
| Política de privacidade | https://www.freshbooks.com/policies/privacy |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
| Frequência das pesquisas de gatilho | 1 | 60 segundos |
Ações
| Adicionar novo cliente |
Essa operação cria um novo cliente em sua conta. Pelo menos um campo do cliente (ou seja, nome, sobrenome, organização, email etc) deve ser especificado, caso contrário, a operação falhará. |
| Atualizar despesas |
Essa operação é usada para atualizar uma despesa existente em sua conta. |
| Criar novas despesas |
Essa operação cria uma nova despesa em sua conta. |
| Excluir despesas |
Essa operação é usada para excluir uma despesa existente de sua conta. |
| Listar despesas |
Recupera uma lista de todas as suas despesas. |
Adicionar novo cliente
Essa operação cria um novo cliente em sua conta. Pelo menos um campo do cliente (ou seja, nome, sobrenome, organização, email etc) deve ser especificado, caso contrário, a operação falhará.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountid | True | string |
ID da conta de despesas. |
|
Primeiro Nome
|
fname | string | ||
|
Apelido
|
lname | string | ||
|
Organização
|
organization | string | ||
|
Endereço de Email
|
string | |||
|
Número de Telefone
|
bus_phone | string | ||
|
Moeda
|
currency_code | string |
Código de moeda de 3 letras. |
|
|
Endereço de Rua 1
|
p_street | string | ||
|
Endereço de Rua 2
|
p_street2 | string | ||
|
City
|
p_city | string | ||
|
Código postal
|
p_code | string | ||
|
País
|
p_country | string | ||
|
Província
|
p_province | string |
Retornos
- Corpo
- Client
Atualizar despesas
Essa operação é usada para atualizar uma despesa existente em sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountid | True | string |
ID da conta de despesas. |
|
ID de despesas
|
expenseid | True | string |
ID exclusiva da despesa. |
|
Quantidade
|
amount | string | ||
|
Moeda
|
code | string |
Código de moeda de 3 letras. |
|
|
Categoria
|
categoryid | integer |
Escolha uma categoria de despesa. |
|
|
Equipe
|
staffid | integer |
Escolha o membro da equipe para despesas. |
|
|
Date
|
date | string |
YYYY-MM-DD ou data de formato ISO. |
|
|
Fornecedor
|
vendor | string |
Escolha um fornecedor para despesas. |
|
|
Anotações
|
notes | string |
Criar novas despesas
Essa operação cria uma nova despesa em sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountid | True | string |
ID da conta de despesas. |
|
Quantidade
|
amount | True | string | |
|
Moeda
|
code | string |
Código de moeda de 3 letras. |
|
|
Categoria
|
categoryid | True | integer |
Escolha uma categoria de despesa. |
|
Equipe
|
staffid | True | integer |
Escolha o membro da equipe para despesas. |
|
Date
|
date | True | string |
YYYY-MM-DD ou data de formato ISO. |
|
Fornecedor
|
vendor | string |
Escolha um fornecedor para despesas. |
|
|
Anotações
|
notes | string |
Retornos
- Corpo
- Expense
Excluir despesas
Essa operação é usada para excluir uma despesa existente de sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountid | True | string |
ID da conta de despesas. |
|
ID de despesas
|
expenseid | True | string |
ID exclusiva da despesa. |
Listar despesas
Recupera uma lista de todas as suas despesas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountid | True | string |
ID da conta de despesas. |
Retornos
Matriz de despesas.
- Itens
- ExpenseList
Gatilhos
| Quando um pagamento é registrado ou atualizado |
Dispara quando um novo pagamento é registrado ou um existente é atualizado. |
| Quando uma despesa é criada ou atualizada |
Dispara quando uma nova despesa é criada ou uma existente é atualizada. |
| Quando uma fatura é criada ou atualizada |
Dispara quando uma nova fatura é criada ou uma existente é atualizada. |
Quando um pagamento é registrado ou atualizado
Dispara quando um novo pagamento é registrado ou um existente é atualizado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountid | True | string |
ID da conta de despesas. |
Retornos
- Corpo
- Payment
Quando uma despesa é criada ou atualizada
Dispara quando uma nova despesa é criada ou uma existente é atualizada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountid | True | string |
ID da conta de despesas. |
Retornos
- Corpo
- Expense
Quando uma fatura é criada ou atualizada
Dispara quando uma nova fatura é criada ou uma existente é atualizada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountid | True | string |
ID da conta de despesas. |
Retornos
- Corpo
- Invoice
Definições
ExpenseList
Matriz de despesas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
Expense |
Expense
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de despesas
|
id | integer |
Exclusivo para essa ID de negócios para despesas. |
|
Porcentagem de marcação
|
markup_percent | string |
Decimal, porcentagem para marcar as despesas. |
|
ID do projeto
|
projectid | integer |
ID do projeto relacionado, se aplicável. |
|
ID do cliente
|
clientid | integer |
ID do cliente relacionado, se aplicável. |
|
Percentual de Impostos 1
|
taxPercent1 | string |
Decimal, primeiro percentual de impostos. |
|
Nome do Imposto 1
|
taxName1 | string |
Nome do primeiro imposto. |
|
Primeiro valor da tarefa
|
taxAmount1.amount | string |
Valor do primeiro imposto. |
|
Primeiro código de moeda fiscal
|
taxAmount1.code | string |
Código de moeda de 3 letras. |
|
Percentual de Impostos 2
|
taxPercent2 | string |
Decimal, segundo percentual de impostos. |
|
Nome do Imposto 2
|
taxName2 | string |
Nome do segundo imposto. |
|
Segundo valor do imposto
|
taxAmount2.amount | string |
Quantidade de segundo imposto. |
|
Segundo código de moeda fiscal
|
taxAmount2.code | string |
Código de moeda de 3 letras. |
|
ID da fatura
|
invoiceid | integer |
ID da fatura relacionada, se aplicável. |
|
Situação
|
status | integer |
Valor da tabela de status da despesa. |
|
Nome do banco
|
bank_name | string |
O nome da despesa bancária foi importado, se aplicável. |
|
Fornecedor
|
vendor | string |
Nome do fornecedor. |
|
Tem Recibo
|
has_receipt | boolean |
True se o recibo estiver anexado. |
|
ID do sistema externo
|
ext_systemid | integer |
ID do sistema contratante relacionado, se aplicável. |
|
Date
|
date | string |
Data da despesa. |
|
ID da transação
|
transactionid | string |
ID da transação relacionada, se aplicável. |
|
Anotações
|
notes | string |
Notas sobre despesas. |
|
Nome da Conta
|
account_name | string |
Nome da conta relacionada, se aplicável. |
|
Quantidade
|
amount.amount | string |
Valor decimal. |
|
Código de moeda
|
amount.code | string |
Código de moeda de 3 letras. |
|
Imposto composto
|
compounded_tax | boolean |
True se o imposto 2 era um imposto composto. |
|
ID da conta
|
accountid | string |
Id da conta de despesas, se aplicável. |
Invoice
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da fatura
|
id | integer |
ID de fatura exclusiva para esse sistema. |
|
Número da fatura
|
invoice_number | string |
ID da fatura visível e especificada pelo usuário. |
|
AccountID
|
accountid | string |
ID exclusiva do sistema. |
|
Código de moeda de 3 letras
|
currency_code | string |
Código de moeda de três letras para fatura. |
|
Status da fatura
|
v3_status | string |
Status da fatura. |
|
Description
|
description | string |
Descrição da primeira linha de fatura. |
|
Anotações
|
notes | string |
Anotações listadas na fatura. |
|
Código de idioma de duas letras
|
language | string |
Código de idioma de duas letras da fatura. |
|
ID do cliente
|
customerid | integer |
ID do cliente exclusivo para esse sistema. |
|
Organização faturada
|
organization | string |
Nome da organização que está sendo faturada. |
|
Nome do cliente
|
fname | string |
Nome do cliente na fatura. |
|
Sobrenome do cliente
|
lname | string |
Sobrenome do cliente na fatura. |
|
Data de criação da fatura
|
create_date | string |
A fatura de data foi criada, formato YYYY-MM-DD. |
|
Data de conclusão da fatura
|
due_date | string |
A fatura de data é marcada como vencida pelo formato YYYY-MM-DD. |
|
Última Atualização
|
updated | string |
A fatura de hora foi atualizada pela última vez, formato YYYY-MM-DD HH:MM:SS. |
|
Criar Data
|
created_at | string |
A fatura de hora foi criada, formato YYYY-MM-DD HH:MM:SS. |
|
Data de pagamento da fatura
|
date_paid | string |
A fatura de data foi totalmente paga, formato YYYY-MM-DD. |
|
Status do pagamento
|
payment_status | string |
Descrição do status do pagamento. Um de 'não pago', 'parcial', 'pago' e 'pago automaticamente'. |
|
Valor da fatura
|
amount.amount | string |
Valor total da fatura, para duas casas decimais. |
|
Valor pago
|
paid.amount | string |
Valor pago na fatura, para duas casas decimais. |
|
Valor pendente
|
outstanding.amount | string |
Valor pendente na fatura, para duas casas decimais. |
|
Valor do desconto
|
discount.amount | string |
Valor de desconto, para duas casas decimais. |
|
Email
|
client.email | string |
Email do cliente. |
Pagamento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de pagamento
|
id | integer |
ID de pagamento exclusiva para esse sistema. |
|
Tipo de pagamento
|
type | string |
Tipo de pagamento – Caixa, cheque, crédito |
|
Observação
|
note | string |
Anotações listadas sobre o pagamento. |
|
Data de pagamento
|
date | string |
Data em que o pagamento foi feito, formato YYYY-MM-DD. |
|
ID do cliente
|
clientid | integer |
ID do cliente exclusivo para esse sistema. |
|
Valor da fatura
|
amount.amount | string |
Valor total do pagamento, para duas casas decimais. |
|
Código de moeda de 3 letras
|
amount.code | string |
Código de moeda de três letras. |
|
AccountID
|
accounting_systemid | string |
ID exclusiva para empresas. |
|
ID da fatura
|
invoiceid | integer |
ID da fatura relacionada. |
|
Primeiro Nome
|
client.fname | string |
Nome do cliente. |
|
Apelido
|
client.lname | string |
Sobrenome do cliente. |
|
Email
|
client.email | string |
Email do cliente. |
|
Nome de usuário
|
client.username | string |
Nome de usuário usado pelo cliente para fazer logon. |
|
Organização
|
client.organization | string |
Nome da empresa do cliente. |
Cliente
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Primeiro Nome
|
response.result.client.fname | string |
Nome do cliente. |
|
Apelido
|
response.result.client.lname | string |
Sobrenome do cliente. |
|
Número fa
|
response.result.client.fax | string |
Número de fax do cliente. |
|
Número do IVA
|
response.result.client.vat_number | string |
Número do imposto de valor adicionado. |
|
Nome do IVA
|
response.result.client.vat_name | string |
Nome do imposto sobre valor adicionado. |
|
ID do cliente
|
response.result.client.id | integer |
Exclusivo para essa ID de negócios para o cliente. |
|
Província
|
response.result.client.s_province | string |
Endereço de envio. |
|
País
|
response.result.client.s_country | string |
Endereço de envio. |
|
City
|
response.result.client.s_city | string |
Endereço de envio. |
|
Rua
|
response.result.client.s_street | string |
Endereço de envio. |
|
Rua 2
|
response.result.client.s_street2 | string |
Endereço de envio. |
|
Código postal
|
response.result.client.s_code | string |
Endereço de envio. |
|
Observação
|
response.result.client.note | string |
Anotações mantidas pelo administrador sobre o cliente. |
|
Celular
|
response.result.client.mob_phone | string |
Número de telefone celular. |
|
Telefone Residencial
|
response.result.client.home_phone | string |
Número de telefone residencial. |
|
Setor da Empresa
|
response.result.client.company_industry | string |
A descrição do cliente do setor está dentro. |
|
Email
|
response.result.client.email | string |
Email do cliente. |
|
Nome de usuário
|
response.result.client.username | string |
Nome de usuário usado pelo cliente para fazer logon. |
|
Província
|
response.result.client.p_province | string |
Endereço de cobrança. |
|
País
|
response.result.client.p_country | string |
Endereço de cobrança. |
|
City
|
response.result.client.p_city | string |
Endereço de cobrança. |
|
Rua
|
response.result.client.p_street | string |
Endereço de cobrança. |
|
Código postal
|
response.result.client.p_code | string |
Endereço de cobrança. |
|
Rua 2
|
response.result.client.p_street2 | string |
Endereço de cobrança. |
|
Telefone
|
response.result.client.bus_phone | string |
Endereço de cobrança. |
|
Tamanho
|
response.result.client.company_size | string |
Endereço de cobrança. |
|
ID do sistema
|
response.result.client.accounting_systemid | string |
O identificador exclusivo do cliente de negócios existe. |
|
Linguagem
|
response.result.client.language | string |
Shortcode que indica o idioma do usuário. |
|
Organização
|
response.result.client.organization | string |
Nome para negócios do cliente. |
|
Código de moeda
|
response.result.client.currency_code | string |
Código curto de 3 letras para moeda preferencial. |