FreshBooks (Pré-visualização)
O FreshBooks é um software de contabilidade para pequenas empresas baseado na nuvem. Envie faturas, acompanhe o tempo, gerencie recibos e despesas.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 | |
|---|---|
| Editora | Microsoft |
| Sítio Web | https://www.freshbooks.com/ |
| Política de privacidade | https://www.freshbooks.com/policies/privacy |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
| Frequência das sondagens de desencadeamento | 1 | 60 segundos |
Ações
| Adicionar novo cliente |
Esta operação cria um novo cliente na sua conta. Pelo menos um campo do cliente (ou seja, nome, sobrenome, organização, e-mail, etc) deve ser especificado, caso contrário, a operação falhará. |
| Atualizar despesas |
Esta operação é utilizada para atualizar uma despesa existente na sua conta. |
| Criar nova despesa |
Esta operação cria uma nova despesa na sua conta. |
| Excluir despesas |
Esta operação é utilizada para eliminar uma despesa existente da sua conta. |
| Listar despesas |
Recupera uma lista de todas as suas despesas. |
Adicionar novo cliente
Esta operação cria um novo cliente na sua conta. Pelo menos um campo do cliente (ou seja, nome, sobrenome, organização, e-mail, etc) deve ser especificado, caso contrário, a operação falhará.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountid | True | string |
Id da conta de despesa. |
|
Nome Próprio
|
fname | string | ||
|
Apelido
|
lname | string | ||
|
Organização
|
organization | string | ||
|
Endereço de E-mail
|
string | |||
|
Número de Telefone
|
bus_phone | string | ||
|
Moeda
|
currency_code | string |
Código de moeda de 3 letras. |
|
|
Endereço 1
|
p_street | string | ||
|
Endereço 2
|
p_street2 | string | ||
|
City
|
p_city | string | ||
|
Código Postal
|
p_code | string | ||
|
Country
|
p_country | string | ||
|
Província
|
p_province | string |
Devoluções
- Body
- Client
Atualizar despesas
Esta operação é utilizada para atualizar uma despesa existente na sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountid | True | string |
Id da conta de despesa. |
|
ID da despesa
|
expenseid | True | string |
ID único da despesa. |
|
Montante
|
amount | string | ||
|
Moeda
|
code | string |
Código de moeda de 3 letras. |
|
|
Categoria
|
categoryid | integer |
Escolha uma categoria de despesa. |
|
|
Funcionários
|
staffid | integer |
Escolha o membro da equipe para gastar. |
|
|
Date
|
date | string |
AAAAA -MM-DD ou formato ISO datetime. |
|
|
Fornecedor
|
vendor | string |
Escolha um fornecedor para gastar. |
|
|
Observações
|
notes | string |
Criar nova despesa
Esta operação cria uma nova despesa na sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountid | True | string |
Id da conta de despesa. |
|
Montante
|
amount | True | string | |
|
Moeda
|
code | string |
Código de moeda de 3 letras. |
|
|
Categoria
|
categoryid | True | integer |
Escolha uma categoria de despesa. |
|
Funcionários
|
staffid | True | integer |
Escolha o membro da equipe para gastar. |
|
Date
|
date | True | string |
AAAAA -MM-DD ou formato ISO datetime. |
|
Fornecedor
|
vendor | string |
Escolha um fornecedor para gastar. |
|
|
Observações
|
notes | string |
Devoluções
- Body
- Expense
Excluir despesas
Esta operação é utilizada para eliminar uma despesa existente da sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountid | True | string |
Id da conta de despesa. |
|
ID da despesa
|
expenseid | True | string |
ID único da despesa. |
Listar despesas
Recupera uma lista de todas as suas despesas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountid | True | string |
Id da conta de despesa. |
Devoluções
Matriz de despesas.
- Itens
- ExpenseList
Acionadores
| Quando um pagamento é registado ou atualizado |
Aciona quando um novo pagamento é registrado ou um já existente é atualizado. |
| Quando uma despesa é criada ou atualizada |
Aciona quando uma nova despesa é criada ou uma existente é atualizada. |
| Quando uma fatura é criada ou atualizada |
Aciona quando uma nova fatura é criada ou uma existente é atualizada. |
Quando um pagamento é registado ou atualizado
Aciona quando um novo pagamento é registrado ou um já existente é atualizado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountid | True | string |
Id da conta de despesa. |
Devoluções
- Body
- Payment
Quando uma despesa é criada ou atualizada
Aciona quando uma nova despesa é criada ou uma existente é atualizada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountid | True | string |
Id da conta de despesa. |
Devoluções
- Body
- Expense
Quando uma fatura é criada ou atualizada
Aciona quando uma nova fatura é criada ou uma existente é atualizada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountid | True | string |
Id da conta de despesa. |
Devoluções
- Body
- Invoice
Definições
Lista de despesas
Matriz de despesas.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
Expense |
Despesa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da despesa
|
id | integer |
Exclusivo para este id de negócio para despesa. |
|
Percentagem de marcação
|
markup_percent | string |
Decimal, porcentagem para marcar a despesa. |
|
ID do projeto
|
projectid | integer |
Id do projeto relacionado, se aplicável. |
|
ID de Cliente
|
clientid | integer |
Identificação do cliente relacionado, se aplicável. |
|
Imposto por cento 1
|
taxPercent1 | string |
Decimal, primeiro percentual de imposto. |
|
Nome Fiscal 1
|
taxName1 | string |
Nome do primeiro imposto. |
|
Primeiro montante 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. |
|
Imposto por cento 2
|
taxPercent2 | string |
Decimal, segundo percentual de imposto. |
|
Nome Fiscal 2
|
taxName2 | string |
Nome do segundo imposto. |
|
Segundo valor do imposto
|
taxAmount2.amount | string |
Valor do segundo imposto. |
|
Segundo código de moeda fiscal
|
taxAmount2.code | string |
Código de moeda de 3 letras. |
|
ID da fatura
|
invoiceid | integer |
Identificação da fatura relacionada, se aplicável. |
|
Situação
|
status | integer |
Valor da tabela de status de despesas. |
|
Nome do Banco
|
bank_name | string |
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 |
Identificação do sistema do 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. |
|
Observações
|
notes | string |
Notas de despesas. |
|
Nome da Conta
|
account_name | string |
Nome da conta relacionada, se aplicável. |
|
Montante
|
amount.amount | string |
Valor decimal. |
|
Código de Moeda
|
amount.code | string |
Código de moeda de 3 letras. |
|
Imposto Composto
|
compounded_tax | boolean |
Verdade se o imposto 2 fosse um imposto composto. |
|
ID da conta
|
accountid | string |
ID da conta de despesas, se aplicável. |
Invoice
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da fatura
|
id | integer |
ID de fatura exclusivo para este sistema. |
|
Número da Fatura
|
invoice_number | string |
ID da fatura visível e especificada pelo usuário. |
|
ID da conta
|
accountid | string |
ID exclusivo para o sistema. |
|
Código da moeda de 3 letras
|
currency_code | string |
Código de moeda de três letras para fatura. |
|
Estado da fatura
|
v3_status | string |
Status da fatura. |
|
Description
|
description | string |
Descrição da primeira linha da fatura. |
|
Observações
|
notes | string |
Notas listadas na fatura. |
|
Código linguístico de duas letras
|
language | string |
Código linguístico de duas letras da fatura. |
|
ID do Cliente
|
customerid | integer |
ID de cliente exclusivo para este sistema. |
|
Organização faturada
|
organization | string |
Nome da organização que está sendo faturada. |
|
Nome do Cliente
|
fname | string |
Nome próprio do cliente na fatura. |
|
Apelido do Cliente
|
lname | string |
Sobrenome do cliente na fatura. |
|
Data de criação da fatura
|
create_date | string |
Data de criação da fatura, formato AAAA-MM-DD. |
|
Data de vencimento da fatura
|
due_date | string |
Data em que a fatura é marcada como devida por, formatoMM-DD AAAA. |
|
Última atualização
|
updated | string |
A fatura de hora foi atualizada pela última vez, AAAA-MM-DD formato HH:MM:SS. |
|
Data de Criação
|
created_at | string |
A fatura de tempo foi criada, AAAA-MM-DD formato HH:MM:SS. |
|
Data de pagamento da fatura
|
date_paid | string |
Data em que a fatura foi totalmente paga, no formato AAAA-MM-DD. |
|
Estado do Pagamento
|
payment_status | string |
Descrição do estado do pagamento. Um de 'não pago', 'parcial', 'pago' e 'auto-pago'. |
|
Valor da fatura
|
amount.amount | string |
Valor total da fatura, com duas casas decimais. |
|
Valor Pago
|
paid.amount | string |
Valor pago na fatura, com duas casas decimais. |
|
Montante em dívida
|
outstanding.amount | string |
Valor pendente na fatura, com duas casas decimais. |
|
Valor do desconto
|
discount.amount | string |
Valor do desconto, com duas casas decimais. |
|
Email
|
client.email | string |
E-mail do cliente. |
Pagamento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de pagamento
|
id | integer |
ID de pagamento exclusivo para este sistema. |
|
Tipo de Pagamento
|
type | string |
Tipo de pagamento - Dinheiro, cheque, crédito |
|
Observação
|
note | string |
Notas listadas no pagamento. |
|
Data de pagamento
|
date | string |
Data em que o pagamento foi efetuado, formato AAAA-MM-DD. |
|
ID do Cliente
|
clientid | integer |
ID de cliente exclusivo para este sistema. |
|
Valor da fatura
|
amount.amount | string |
Valor total do pagamento, com duas casas decimais. |
|
Código da moeda de 3 letras
|
amount.code | string |
Código de moeda de três letras. |
|
ID da conta
|
accounting_systemid | string |
ID exclusivo para negócios. |
|
ID da fatura
|
invoiceid | integer |
ID da fatura relacionada. |
|
Nome Próprio
|
client.fname | string |
Nome próprio do cliente. |
|
Apelido
|
client.lname | string |
Apelido do cliente. |
|
Email
|
client.email | string |
E-mail do cliente. |
|
Nome de utilizador
|
client.username | string |
Nome de utilizador utilizado pelo cliente para iniciar sessão. |
|
Organização
|
client.organization | string |
Nome da empresa do cliente. |
Client
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome Próprio
|
response.result.client.fname | string |
Nome próprio do cliente. |
|
Apelido
|
response.result.client.lname | string |
Apelido do cliente. |
|
Número Fa
|
response.result.client.fax | string |
Número de fax do cliente. |
|
Número de IVA
|
response.result.client.vat_number | string |
Número de contribuinte. |
|
Nome IVA
|
response.result.client.vat_name | string |
Nome do imposto sobre o valor acrescentado. |
|
ID de Cliente
|
response.result.client.id | integer |
Exclusivo para este ID de negócio para o cliente. |
|
Província
|
response.result.client.s_province | string |
Endereço de envio. |
|
Country
|
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 |
Notas mantidas pelo administrador sobre o cliente. |
|
Telemóvel
|
response.result.client.mob_phone | string |
Número de telemóvel. |
|
Telefone residencial
|
response.result.client.home_phone | string |
Número de telefone residencial. |
|
Indústria da Empresa
|
response.result.client.company_industry | string |
Descrição do cliente da indústria está em. |
|
Email
|
response.result.client.email | string |
E-mail do cliente. |
|
Nome de utilizador
|
response.result.client.username | string |
Nome de utilizador utilizado pelo cliente para iniciar sessão. |
|
Província
|
response.result.client.p_province | string |
Endereço de faturação. |
|
Country
|
response.result.client.p_country | string |
Endereço de faturação. |
|
City
|
response.result.client.p_city | string |
Endereço de faturação. |
|
Rua
|
response.result.client.p_street | string |
Endereço de faturação. |
|
Código Postal
|
response.result.client.p_code | string |
Endereço de faturação. |
|
Rua 2
|
response.result.client.p_street2 | string |
Endereço de faturação. |
|
Telemóvel
|
response.result.client.bus_phone | string |
Endereço de faturação. |
|
Tamanho
|
response.result.client.company_size | string |
Endereço de faturação. |
|
ID do sistema
|
response.result.client.accounting_systemid | string |
O identificador exclusivo do cliente empresarial existe em. |
|
Linguagem
|
response.result.client.language | string |
Shortcode indicando o idioma do usuário. |
|
Organização
|
response.result.client.organization | string |
Nome do negócio do cliente. |
|
Código de Moeda
|
response.result.client.currency_code | string |
Código curto de 3 letras para a moeda preferida. |