Zoho Invoice Basic (Independent Publisher) (versão prévia)
Personalize e crie faturas profissionais e seja pago pelo seu trabalho árduo. A Zoho Invoice é um software de gerenciamento de fatura online para pequenas empresas que é fácil de usar e completamente gratuito, para sempre.
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 | Troy Taylor |
| URL | https://www.troystaylor.com |
| troy@troystaylor.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://www.zoho.com/us/invoice/ |
| Política de privacidade | https://www.zoho.com/privacy.html |
| Categorias | Financiar; Vendas e CRM |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| ID da organização do Zoho | cadeia | O identificador da organização Zoho para esta api | Verdade |
| ID do cliente | cadeia | A ID do cliente para esta api | Verdade |
| Segredo de Cliente | secureString | O segredo do cliente para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar um contato |
Atualiza um contato existente. |
| Atualizar uma fatura |
Atualize uma fatura existente. Para excluir um item de linha, basta removê-lo da lista de line_items. |
| Criar um contato |
Cria um novo contato. |
| Criar uma fatura |
Cria uma fatura para um cliente. |
| Excluir um contato |
Exclui um contato existente. |
| Excluir uma fatura |
Exclui uma fatura existente. As faturas que têm a anotação de pagamento ou créditos aplicadas não podem ser excluídas. |
| Obter contatos |
Recupere uma lista de todos os contatos com paginação. |
| Obter faturas |
Recupere uma lista de faturas com paginação. |
| Obter um contato |
Recupere os detalhes de um contato existente. |
| Obter uma fatura |
Recuperar os detalhes de uma fatura |
Atualizar um contato
Atualiza um contato existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contact_id | True | string |
O identificador de contato. |
|
Nome do contato
|
contact_name | True | string |
O nome do contato. |
|
Nome da Empresa
|
company_name | string |
O nome da empresa. |
|
|
Condições de Pagamento
|
payment_terms | integer |
As condições de pagamento. |
|
|
ID da moeda
|
currency_id | string |
O identificador de moeda. |
|
|
Site
|
website | string |
O site. |
|
|
Value
|
value | string |
O valor do campo personalizado. |
|
|
Index
|
index | integer |
O número do índice. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Atenção
|
attention | string |
O nome da atenção. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
Endereço 2
|
street2 | string |
O endereço 2. |
|
|
Estado
|
state_code | string |
A abreviação de estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Zip
|
zip | string |
O cep. |
|
|
País
|
country | string |
O país. |
|
|
Fac-símile
|
fax | string |
O número do fax. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Atenção
|
attention | string |
O nome da atenção. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
Endereço 2
|
street2 | string |
O endereço 2. |
|
|
Estado
|
state_code | string |
A abreviação de estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Zip
|
zip | string |
O cep. |
|
|
País
|
country | string |
O país. |
|
|
Fac-símile
|
fax | string |
O número do fax. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Saudação
|
salutation | string |
A saudação. |
|
|
Primeiro Nome
|
first_name | string |
O nome. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
|
|
Email
|
string |
O endereço de email. |
||
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Telemóvel
|
mobile | string |
O número do celular. |
|
|
É o contato primário
|
is_primary_contact | boolean |
Se é o contato primário. |
|
|
ID do modelo de fatura
|
invoice_template_id | string |
O identificador do modelo de fatura. |
|
|
Nome do modelo de fatura
|
invoice_template_name | string |
O nome do modelo de fatura. |
|
|
Estimar ID do modelo
|
estimate_template_id | string |
O identificador do modelo de estimativa. |
|
|
Estimar nome do modelo
|
estimate_template_name | string |
O nome do modelo de estimativa. |
|
|
ID do modelo de nota de crédito
|
creditnote_template_id | string |
O identificador do modelo de anotação de crédito. |
|
|
Nome do modelo de anotação de crédito
|
creditnote_template_name | string |
O nome do modelo de anotação de crédito. |
|
|
ID do modelo de email da fatura
|
invoice_email_template_id | string |
O identificador do modelo de email da fatura. |
|
|
Nome do modelo de email da fatura
|
invoice_email_template_name | string |
O nome do modelo de email da fatura. |
|
|
Estimar a ID do modelo de email
|
estimate_email_template_id | string |
O identificador do modelo de email de estimativa. |
|
|
Estimar o nome do modelo de email
|
estimate_email_template_name | string |
O nome do modelo de email de estimativa. |
|
|
ID do modelo de email da Nota de Crédito
|
creditnote_email_template_id | string |
O identificador do modelo de email de anotação de crédito. |
|
|
Nome do modelo de email da nota de crédito
|
creditnote_email_template_name | string |
O nome do modelo de email da nota de crédito. |
|
|
Código de idioma
|
language_code | string |
O código do idioma. |
|
|
Anotações
|
notes | string |
As anotações. |
|
|
Registro de IVA
|
vat_reg_no | string |
O número de registro do IVA. |
|
|
Registro de Imposto
|
tax_reg_no | string |
O número do registro do imposto. |
|
|
Código do país
|
country_code | string |
O código do país. |
|
|
Tratamento de IVA
|
vat_treatment | string |
O tipo de tratamento de IVA. |
|
|
Tratamento Tributário
|
tax_treatment | string |
O tipo de tratamento tributário. |
|
|
Regime Tributário
|
tax_regime | string |
O regime tributário. |
|
|
Nome Legal
|
legal_name | string |
O nome legal. |
|
|
O TDS está registrado
|
is_tds_registered | boolean |
Se o TDS está registrado. |
|
|
Local de contato
|
place_of_contact | string |
O local de contato. |
|
|
Número do GST
|
gst_no | string |
O número do GST. |
|
|
Tratamento GST
|
gst_treatment | string |
O tipo de tratamento GST. |
|
|
Nome da Autoridade Fiscal
|
tax_authority_name | string |
O nome da autoridade fiscal. |
|
|
Código de isenção de impostos
|
tax_exemption_code | string |
O código de isenção de impostos. |
|
|
Isenção do AvaTax
|
avatax_exempt_no | string |
O número isento do AvaTax. |
|
|
Código de uso do AvaTax
|
avatax_use_code | string |
O código de uso do AvaTax. |
|
|
ID de isenção de impostos
|
tax_exemption_id | string |
O identificador de isenção fiscal. |
|
|
ID da Autoridade Fiscal
|
tax_authority_id | string |
O identificador da autoridade fiscal. |
|
|
NIF
|
tax_id | string |
O identificador de imposto. |
|
|
ID do imposto TDS
|
tds_tax_id | string |
O identificador de imposto do TDS. |
|
|
É tributável
|
is_taxable | boolean |
Se é tributável. |
|
|
Facebook
|
string |
O nome de usuário do Facebook. |
||
|
Twitter
|
string |
O identificador do Twitter. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
|
ID de contato
|
contact.contact_id | string |
O identificador de contato. |
|
Nome do contato
|
contact.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
contact.company_name | string |
O nome da empresa. |
|
Tem transação
|
contact.has_transaction | boolean |
Se tem transação. |
|
Tipo de contato
|
contact.contact_type | string |
O tipo de contato. |
|
É tributável
|
contact.is_taxable | boolean |
Se é tributável. |
|
NIF
|
contact.tax_id | string |
O identificador de imposto. |
|
ID do imposto TDS
|
contact.tds_tax_id | string |
O identificador de imposto do TDS. |
|
Nome do Imposto
|
contact.tax_name | string |
O nome do imposto. |
|
Percentual de Impostos
|
contact.tax_percentage | integer |
O percentual de imposto. |
|
ID da Autoridade Fiscal
|
contact.tax_authority_id | string |
O identificador da autoridade fiscal. |
|
ID de isenção de impostos
|
contact.tax_exemption_id | string |
O identificador de isenção fiscal. |
|
Nome da Autoridade Fiscal
|
contact.tax_authority_name | string |
O nome da autoridade fiscal. |
|
Código de isenção de impostos
|
contact.tax_exemption_code | string |
O código de isenção de impostos. |
|
Local de contato
|
contact.place_of_contact | string |
O local de contato. |
|
Número do GST
|
contact.gst_no | string |
O número do GST. |
|
Tratamento de IVA
|
contact.vat_treatment | string |
O tratamento do IVA. |
|
Tratamento Tributário
|
contact.tax_treatment | string |
O tratamento tributário. |
|
Regime Tributário
|
contact.tax_regime | string |
O regime tributário. |
|
Nome Legal
|
contact.legal_name | string |
O nome legal. |
|
O TDS está registrado
|
contact.is_tds_registered | boolean |
Se o TSD está registrado. |
|
Tratamento GST
|
contact.gst_treatment | string |
O tratamento GST. |
|
Está vinculado ao Zoho CRM
|
contact.is_linked_with_zohocrm | boolean |
Se está vinculado ao Zoho CRM. |
|
Site
|
contact.website | string |
O site. |
|
ID do contato primário
|
contact.primary_contact_id | string |
O identificador de contato primário. |
|
Condições de Pagamento
|
contact.payment_terms | integer |
As condições de pagamento. |
|
Rótulo de Termos de Pagamento
|
contact.payment_terms_label | string |
O rótulo de termos de pagamento. |
|
ID da moeda
|
contact.currency_id | string |
O identificador de moeda. |
|
Código de moeda
|
contact.currency_code | string |
O código de moeda. |
|
Símbolo de moeda
|
contact.currency_symbol | string |
O símbolo de moeda. |
|
Código de idioma
|
contact.language_code | string |
O código do idioma. |
|
Valor de recebimento pendente
|
contact.outstanding_receivable_amount | double |
O valor a receber pendente. |
|
Bcy de valor a receber pendente
|
contact.outstanding_receivable_amount_bcy | double |
O valor de recebimento pendente do BCY. |
|
Valor a receber créditos não utilizados
|
contact.unused_credits_receivable_amount | double |
O valor a receber de créditos não utilizados. |
|
Valor a receber créditos não utilizados BCY
|
contact.unused_credits_receivable_amount_bcy | double |
O valor a receber de créditos não utilizados do BCY. |
|
Situação
|
contact.status | string |
O status. |
|
Lembrete de pagamento habilitado
|
contact.payment_reminder_enabled | boolean |
Se o lembrete de pagamento está habilitado. |
|
Campo Personalizado
|
contact.custom_fields | array of object | |
|
Value
|
contact.custom_fields.value | string |
O valor do campo personalizado. |
|
Index
|
contact.custom_fields.index | integer |
O número do índice. |
|
Etiqueta
|
contact.custom_fields.label | string |
O rótulo. |
|
Atenção
|
contact.billing_address.attention | string |
O nome da atenção. |
|
Endereço
|
contact.billing_address.address | string |
O endereço. |
|
Rua
|
contact.billing_address.street2 | string |
O endereço da rua. |
|
Código de estado
|
contact.billing_address.state_code | string |
O código de estado. |
|
City
|
contact.billing_address.city | string |
A cidade. |
|
Estado
|
contact.billing_address.state | string |
O estado. |
|
Zip
|
contact.billing_address.zip | string |
O cep. |
|
País
|
contact.billing_address.country | string |
O país. |
|
Fac-símile
|
contact.billing_address.fax | string |
O número do fax. |
|
Telefone
|
contact.billing_address.phone | string |
O número de telefone. |
|
Atenção
|
contact.shipping_address.attention | string |
O nome da atenção. |
|
Endereço
|
contact.shipping_address.address | string |
O endereço. |
|
Rua
|
contact.shipping_address.street2 | string |
O endereço da rua. |
|
Código de estado
|
contact.shipping_address.state_code | string |
O código de estado. |
|
City
|
contact.shipping_address.city | string |
A cidade. |
|
Estado
|
contact.shipping_address.state | string |
O estado. |
|
Zip
|
contact.shipping_address.zip | string |
O cep. |
|
País
|
contact.shipping_address.country | string |
O país. |
|
Fac-símile
|
contact.shipping_address.fax | string |
O número do fax. |
|
Telefone
|
contact.shipping_address.phone | string |
O número de telefone. |
|
Facebook
|
contact.facebook | string |
A conta do Facebook. |
|
Twitter
|
contact.twitter | string |
O identificador do Twitter. |
|
Pessoas de Contato
|
contact.contact_persons | array of object | |
|
Saudação
|
contact.contact_persons.salutation | string |
A saudação. |
|
Primeiro Nome
|
contact.contact_persons.first_name | string |
O nome. |
|
Apelido
|
contact.contact_persons.last_name | string |
O sobrenome. |
|
Email
|
contact.contact_persons.email | string |
O endereço de email. |
|
Telefone
|
contact.contact_persons.phone | string |
O número de telefone. |
|
Telemóvel
|
contact.contact_persons.mobile | string |
O número do celular. |
|
É o contato primário
|
contact.contact_persons.is_primary_contact | boolean |
Se é o contato primário. |
|
ID do modelo de fatura
|
contact.default_templates.invoice_template_id | string |
O identificador do modelo de fatura. |
|
Nome do modelo de fatura
|
contact.default_templates.invoice_template_name | string |
O nome do modelo de fatura. |
|
Estimar ID do modelo
|
contact.default_templates.estimate_template_id | string |
O identificador do modelo de estimativa. |
|
Estimar nome do modelo
|
contact.default_templates.estimate_template_name | string |
O nome do modelo de estimativa. |
|
ID do modelo de nota de crédito
|
contact.default_templates.creditnote_template_id | string |
O identificador do modelo de anotação de crédito. |
|
Nome do modelo de anotação de crédito
|
contact.default_templates.creditnote_template_name | string |
O nome do modelo de anotação de crédito. |
|
ID do modelo de email da fatura
|
contact.default_templates.invoice_email_template_id | string |
O identificador do modelo de email da fatura. |
|
Nome do modelo de email da fatura
|
contact.default_templates.invoice_email_template_name | string |
O nome do modelo de email da fatura. |
|
Estimar a ID do modelo de email
|
contact.default_templates.estimate_email_template_id | string |
O identificador do modelo de email de estimativa. |
|
Estimar o nome do modelo de email
|
contact.default_templates.estimate_email_template_name | string |
O nome do modelo de email de estimativa. |
|
ID do modelo de email da Nota de Crédito
|
contact.default_templates.creditnote_email_template_id | string |
O identificador do modelo de email de anotação de crédito. |
|
Nome do modelo de email da nota de crédito
|
contact.default_templates.creditnote_email_template_name | string |
O nome do modelo de email da nota de crédito. |
|
Anotações
|
contact.notes | string |
As anotações. |
|
Hora de Criação
|
contact.created_time | string |
A hora criada. |
|
Hora da Última Modificação
|
contact.last_modified_time | string |
A hora da última modificação. |
Atualizar uma fatura
Atualize uma fatura existente. Para excluir um item de linha, basta removê-lo da lista de line_items.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de fatura
|
invoice_id | True | string |
O identificador da fatura. |
|
ID do cliente
|
customer_id | string |
O identificador do cliente. |
|
|
Pessoa de Contato
|
contact_persons | array of integer |
A pessoa de contato. |
|
|
Número da fatura
|
invoice_number | string |
O número da fatura. |
|
|
Número de referência
|
reference_number | string |
O número de referência. |
|
|
Local de fornecimento
|
place_of_supply | string |
O local de fornecimento. |
|
|
Tratamento de IVA
|
vat_treatment | string |
O tratamento do IVA. |
|
|
Tratamento GST
|
gst_treatment | string |
O tratamento GST. |
|
|
Tratamento Tributário
|
tax_treatment | string |
O tratamento tributário. |
|
|
Uso do CFDI
|
cfdi_usage | string |
O uso do CFDI. |
|
|
Número do GST
|
gst_no | string |
O número do GST. |
|
|
ID do Modelo
|
template_id | string |
O identificador de modelo. |
|
|
Date
|
date | string |
A data. |
|
|
Condições de Pagamento
|
payment_terms | integer |
As condições de pagamento. |
|
|
Rótulo de Termos de Pagamento
|
payment_terms_label | string |
O rótulo de termos de pagamento. |
|
|
Data de vencimento
|
due_date | string |
A data de conclusão. |
|
|
Desconto
|
discount | float |
O desconto. |
|
|
É desconto antes do imposto
|
is_discount_before_tax | boolean |
Se o desconto é antes do imposto. |
|
|
Tipo de desconto
|
discount_type | string |
O tipo de desconto. |
|
|
Is Inclusive Tax
|
is_inclusive_tax | boolean |
Se é inclusivo de impostos. |
|
|
Taxa de câmbio
|
exchange_rate | float |
A taxa de câmbio. |
|
|
ID da fatura recorrente
|
recurring_invoice_id | string |
O identificador de fatura recorrente. |
|
|
ID da estimativa de fatura
|
invoiced_estimate_id | string |
O identificador de estimativa faturado. |
|
|
Nome do vendedor
|
salesperson_name | string |
O nome do vendedor. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Value
|
value | float |
O valor. |
|
|
ID do projeto
|
project_id | string |
O identificador do projeto. |
|
|
ID
|
item_id | string |
O identificador do item. |
|
|
ID do projeto
|
project_id | string |
O identificador do projeto. |
|
|
IDs de entrada de tempo
|
time_entry_ids | array of integer |
Os identificadores de entrada de hora. |
|
|
ID de despesas
|
expense_id | string |
O identificador de despesas. |
|
|
Nome
|
name | string |
O nome. |
|
|
Tipo de Produto
|
product_type | string |
O tipo de produto. |
|
|
HSN ou SAC
|
hsn_or_sac | integer |
O número HSN ou SAC. |
|
|
Código da chave do item SAT
|
sat_item_key_code | integer |
O código de chave do item SAT. |
|
|
Código da chave de unidade
|
unitkey_code | string |
O código da chave de unidade. |
|
|
Description
|
description | string |
A descrição. |
|
|
Pedido
|
item_order | integer |
A ordem do item. |
|
|
Rate
|
rate | float |
A taxa. |
|
|
Quantidade
|
quantity | double |
A quantidade. |
|
|
Unidade
|
unit | string |
A unidade. |
|
|
Desconto
|
discount | float |
O desconto. |
|
|
NIF
|
tax_id | string |
O identificador de imposto. |
|
|
ID do imposto TDS
|
tds_tax_id | string |
O identificador de imposto do TDS. |
|
|
ID de isenção de impostos
|
tax_exemption_id | string |
O identificador de isenção fiscal. |
|
|
Código de uso do AvaTax
|
avatax_use_code | string |
O código de uso do AvaTax. |
|
|
AvaTax Exempt No
|
avatax_exempt_no | string |
O número isento do AvaTax. |
|
|
Nome do Imposto
|
tax_name | string |
O nome do imposto. |
|
|
Tipo de imposto
|
tax_type | string |
O tipo de imposto. |
|
|
Percentual de Impostos
|
tax_percentage | float |
O percentual de imposto. |
|
|
Total
|
item_total | float |
O total do item. |
|
|
Configurado
|
configured | boolean |
Se configurado. |
|
|
Campo Adicional
|
additional_field1 | string |
O campo adicional. |
|
|
Nome
|
gateway_name | string |
O nome. |
|
|
Permitir pagamentos parciais
|
allow_partial_payments | boolean |
Se deseja permitir pagamentos parciais. |
|
|
Corpo Personalizado
|
custom_body | string |
O corpo personalizado. |
|
|
Assunto Personalizado
|
custom_subject | string |
O assunto personalizado. |
|
|
Anotações
|
notes | string |
As anotações. |
|
|
Termos
|
terms | string |
Os termos. |
|
|
Encargo de envio
|
shipping_charge | float |
A carga de envio. |
|
|
Ajuste
|
adjustment | float |
O ajuste. |
|
|
Descrição do ajuste
|
adjustment_description | string |
A descrição do ajuste. |
|
|
Reason
|
reason | string |
O motivo. |
|
|
ID da Autoridade Fiscal
|
tax_authority_id | string |
O identificador da autoridade fiscal. |
|
|
ID de isenção de impostos
|
tax_exemption_id | string |
O identificador de isenção fiscal. |
|
|
Código de uso do AvaTax
|
avatax_use_code | string |
O código de uso do AvaTax. |
|
|
Código fiscal do AvaTax
|
avatax_tax_code | string |
O código fiscal do AvaTax. |
|
|
Número isento do AvaTax
|
avatax_exempt_no | string |
O número isento do AvaTax. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
|
ID
|
invoice.invoice_id | string |
O identificador da fatura. |
|
Pagamento iniciado pela ACH
|
invoice.ach_payment_initiated | boolean |
Se o pagamento da ACH foi iniciado. |
|
Número
|
invoice.invoice_number | string |
O número da fatura. |
|
É pré-GST
|
invoice.is_pre_gst | boolean |
Se é pré-GST. |
|
Local de fornecimento
|
invoice.place_of_supply | string |
O local de fornecimento. |
|
Número do GST
|
invoice.gst_no | string |
O número do GST. |
|
Tratamento GST
|
invoice.gst_treatment | string |
O tratamento GST. |
|
Tratamento Tributário
|
invoice.tax_treatment | string |
O tratamento tributário. |
|
Uso do CFDI
|
invoice.cfdi_usage | string |
O uso do CFDI. |
|
Tratamento de IVA
|
invoice.vat_treatment | string |
O tratamento do IVA. |
|
Registro de IVA
|
invoice.vat_reg_no | string |
O número de registro do IVA. |
|
Date
|
invoice.date | string |
A data. |
|
Situação
|
invoice.status | string |
O status. |
|
Condições de Pagamento
|
invoice.payment_terms | integer |
As condições de pagamento. |
|
Rótulo de Termos de Pagamento
|
invoice.payment_terms_label | string |
O rótulo de termos de pagamento. |
|
Data de vencimento
|
invoice.due_date | string |
A data de conclusão. |
|
Data de pagamento esperada
|
invoice.payment_expected_date | string |
A data de pagamento esperada. |
|
Data do último pagamento
|
invoice.last_payment_date | string |
A última data de pagamento. |
|
Número de referência
|
invoice.reference_number | string |
O número de referência. |
|
ID do cliente
|
invoice.customer_id | string |
O identificador do cliente. |
|
Nome do cliente
|
invoice.customer_name | string |
O nome do cliente. |
|
Pessoas de Contato
|
invoice.contact_persons | array of string |
As pessoas de contato. |
|
ID da moeda
|
invoice.currency_id | string |
O identificador de moeda. |
|
Código de moeda
|
invoice.currency_code | string |
O código de moeda. |
|
Taxa de câmbio
|
invoice.exchange_rate | double |
A taxa de câmbio. |
|
Desconto
|
invoice.discount | double |
O desconto. |
|
É desconto antes do imposto
|
invoice.is_discount_before_tax | boolean |
Se o desconto é antes do imposto. |
|
Tipo de desconto
|
invoice.discount_type | string |
O tipo de desconto. |
|
É Tax Inclusive
|
invoice.is_inclusive_tax | boolean |
Se é inclusivo de impostos. |
|
ID da fatura recorrente
|
invoice.recurring_invoice_id | string |
O identificador de fatura recorrente. |
|
É exibido pelo cliente
|
invoice.is_viewed_by_client | boolean |
Se é exibido pelo cliente. |
|
Tem Anexo
|
invoice.has_attachment | boolean |
Se tem anexo. |
|
Tempo exibido pelo cliente
|
invoice.client_viewed_time | string |
O tempo exibido pelo cliente. |
|
Item de Linha
|
invoice.line_items | array of object | |
|
ID
|
invoice.line_items.line_item_id | string |
O identificador do item de linha. |
|
ID
|
invoice.line_items.item_id | string |
O identificador do item. |
|
ID do projeto
|
invoice.line_items.project_id | string |
O identificador do projeto. |
|
Nome do Projeto
|
invoice.line_items.project_name | string |
O nome do projeto. |
|
Tipo de Item
|
invoice.line_items.item_type | string |
O tipo de item. |
|
Tipo de Produto
|
invoice.line_items.product_type | string |
O tipo de produto. |
|
time_entry_ids
|
invoice.line_items.time_entry_ids | array of integer |
time_entry_ids |
|
ID de despesas
|
invoice.line_items.expense_id | string |
O identificador de despesas. |
|
Nome do Recibo de Despesa
|
invoice.line_items.expense_receipt_name | string |
O nome do recibo da despesa. |
|
Nome
|
invoice.line_items.name | string |
O nome. |
|
Description
|
invoice.line_items.description | string |
A descrição. |
|
Ordem do Item
|
invoice.line_items.item_order | integer |
A ordem do item. |
|
Taxa BCY
|
invoice.line_items.bcy_rate | double |
A taxa BCY. |
|
Rate
|
invoice.line_items.rate | double |
A taxa. |
|
Quantidade
|
invoice.line_items.quantity | double |
A quantidade. |
|
Unidade
|
invoice.line_items.unit | string |
A unidade. |
|
Valor do desconto
|
invoice.line_items.discount_amount | double |
O valor do desconto. |
|
Desconto
|
invoice.line_items.discount | double |
O desconto. |
|
ID
|
invoice.line_items.tax_id | string |
O identificador de imposto. |
|
ID do imposto TDS
|
invoice.line_items.tds_tax_id | string |
O identificador de imposto do TDS. |
|
Nome
|
invoice.line_items.tax_name | string |
O nome do imposto. |
|
Tipo de imposto
|
invoice.line_items.tax_type | string |
O tipo de imposto. |
|
Percentual de Impostos
|
invoice.line_items.tax_percentage | double |
O percentual de imposto. |
|
Total de Itens
|
invoice.line_items.item_total | double |
O total do item. |
|
Código da chave do item SAT
|
invoice.line_items.sat_item_key_code | integer |
O código de chave do item SAT. |
|
Código da chave de unidade
|
invoice.line_items.unitkey_code | string |
O código da chave de unidade. |
|
Encargo de envio
|
invoice.shipping_charge | double |
A carga de envio. |
|
Ajuste
|
invoice.adjustment | double |
O ajuste. |
|
Descrição do ajuste
|
invoice.adjustment_description | string |
A descrição do ajuste. |
|
Subtotal
|
invoice.sub_total | double |
O subtotal. |
|
Total de Impostos
|
invoice.tax_total | double |
O total de impostos. |
|
Total
|
invoice.total | double |
O total. |
|
Imposto
|
invoice.taxes | array of object | |
|
Nome
|
invoice.taxes.tax_name | string |
O nome do imposto. |
|
Quantidade
|
invoice.taxes.tax_amount | double |
O valor do imposto. |
|
Lembrete de pagamento habilitado
|
invoice.payment_reminder_enabled | boolean |
Se o lembrete de pagamento está habilitado. |
|
Pagamento Feito
|
invoice.payment_made | double |
O pagamento feito. |
|
Créditos aplicados
|
invoice.credits_applied | double |
Os créditos aplicados. |
|
Valor do imposto retido
|
invoice.tax_amount_withheld | double |
O valor do imposto retido. |
|
Saldo
|
invoice.balance | double |
O equilíbrio. |
|
Valor de desativação
|
invoice.write_off_amount | double |
A quantidade de desativação. |
|
Permitir pagamentos parciais
|
invoice.allow_partial_payments | boolean |
Se deseja permitir pagamentos parciais. |
|
Precisão de preço
|
invoice.price_precision | integer |
A precisão do preço. |
|
Gateway
|
invoice.payment_options.payment_gateways | array of object | |
|
Configurado
|
invoice.payment_options.payment_gateways.configured | boolean |
Se configurado. |
|
Campo Adicional
|
invoice.payment_options.payment_gateways.additional_field1 | string |
O campo adicional. |
|
Nome
|
invoice.payment_options.payment_gateways.gateway_name | string |
O nome do gateway. |
|
É enviado por email
|
invoice.is_emailed | boolean |
Se foi enviado por e-mail. |
|
Lembretes enviados
|
invoice.reminders_sent | integer |
O número de lembretes enviados. |
|
Data do Último Lembrete Enviado
|
invoice.last_reminder_sent_date | string |
A data do último lembrete enviado. |
|
Endereço
|
invoice.billing_address.address | string |
O endereço. |
|
City
|
invoice.billing_address.city | string |
A cidade. |
|
Estado
|
invoice.billing_address.state | string |
O estado. |
|
Zip
|
invoice.billing_address.zip | string |
O cep. |
|
País
|
invoice.billing_address.country | string |
O país. |
|
Fac-símile
|
invoice.billing_address.fax | string |
O número do fax. |
|
Endereço
|
invoice.shipping_address.address | string |
O endereço. |
|
City
|
invoice.shipping_address.city | string |
A cidade. |
|
Estado
|
invoice.shipping_address.state | string |
O estado. |
|
Zip
|
invoice.shipping_address.zip | string |
O cep. |
|
País
|
invoice.shipping_address.country | string |
O país. |
|
Fac-símile
|
invoice.shipping_address.fax | string |
O número do fax. |
|
Anotações
|
invoice.notes | string |
As anotações. |
|
Termos
|
invoice.terms | string |
Os termos. |
|
Campo Personalizado
|
invoice.custom_fields | array of object | |
|
ID
|
invoice.custom_fields.customfield_id | string |
O identificador de campo personalizado. |
|
Tipo de Dados
|
invoice.custom_fields.data_type | string |
O tipo de dados. |
|
Index
|
invoice.custom_fields.index | integer |
O número do índice. |
|
Etiqueta
|
invoice.custom_fields.label | string |
O rótulo. |
|
Mostrar em PDF
|
invoice.custom_fields.show_on_pdf | boolean |
Se deve ser exibido em PDF. |
|
Mostrar em todos os PDFs
|
invoice.custom_fields.show_in_all_pdf | boolean |
Se deve ser exibido em todos os PDFs. |
|
Value
|
invoice.custom_fields.value | double |
O valor do campo personalizado. |
|
ID do Modelo
|
invoice.template_id | string |
O identificador de modelo. |
|
Nome do Modelo
|
invoice.template_name | string |
O nome do modelo. |
|
Hora de Criação
|
invoice.created_time | string |
A hora criada. |
|
Hora da Última Modificação
|
invoice.last_modified_time | string |
A hora da última modificação. |
|
Nome do anexo
|
invoice.attachment_name | string |
O nome do anexo. |
|
Pode enviar emails
|
invoice.can_send_in_mail | boolean |
Se pode enviar emails. |
|
ID do vendedor
|
invoice.salesperson_id | string |
O identificador do vendedor. |
|
Nome do vendedor
|
invoice.salesperson_name | string |
O nome do vendedor. |
|
URL
|
invoice.invoice_url | string |
O endereço da URL da fatura. |
Criar um contato
Cria um novo contato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do contato
|
contact_name | True | string |
O nome do contato. |
|
Nome da Empresa
|
company_name | string |
O nome da empresa. |
|
|
Condições de Pagamento
|
payment_terms | integer |
As condições de pagamento. |
|
|
ID da moeda
|
currency_id | string |
O identificador de moeda. |
|
|
Site
|
website | string |
O site. |
|
|
Value
|
value | string |
O valor do campo personalizado. |
|
|
Index
|
index | integer |
O número do índice. |
|
|
Atenção
|
attention | string |
O nome da atenção. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
Endereço 2
|
street2 | string |
O endereço 2. |
|
|
Estado
|
state_code | string |
A abreviação de estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Zip
|
zip | string |
O cep. |
|
|
País
|
country | string |
O país. |
|
|
Fac-símile
|
fax | string |
O número do fax. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Atenção
|
attention | string |
O nome da atenção. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
Endereço 2
|
street2 | string |
O endereço 2. |
|
|
Estado
|
state_code | string |
A abreviação de estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Zip
|
zip | string |
O cep. |
|
|
País
|
country | string |
O país. |
|
|
Fac-símile
|
fax | string |
O número do fax. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Saudação
|
salutation | string |
A saudação. |
|
|
Primeiro Nome
|
first_name | string |
O nome. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
|
|
Email
|
string |
O endereço de email. |
||
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Telemóvel
|
mobile | string |
O número do celular. |
|
|
É o contato primário
|
is_primary_contact | boolean |
Se é o contato primário. |
|
|
ID do modelo de fatura
|
invoice_template_id | string |
O identificador do modelo de fatura. |
|
|
Nome do modelo de fatura
|
invoice_template_name | string |
O nome do modelo de fatura. |
|
|
Estimar ID do modelo
|
estimate_template_id | string |
O identificador do modelo de estimativa. |
|
|
Estimar nome do modelo
|
estimate_template_name | string |
O nome do modelo de estimativa. |
|
|
ID do modelo de nota de crédito
|
creditnote_template_id | string |
O identificador do modelo de anotação de crédito. |
|
|
Nome do modelo de anotação de crédito
|
creditnote_template_name | string |
O nome do modelo de anotação de crédito. |
|
|
ID do modelo de email da fatura
|
invoice_email_template_id | string |
O identificador do modelo de email da fatura. |
|
|
Nome do modelo de email da fatura
|
invoice_email_template_name | string |
O nome do modelo de email da fatura. |
|
|
Estimar a ID do modelo de email
|
estimate_email_template_id | string |
O identificador do modelo de email de estimativa. |
|
|
Estimar o nome do modelo de email
|
estimate_email_template_name | string |
O nome do modelo de email de estimativa. |
|
|
ID do modelo de email da Nota de Crédito
|
creditnote_email_template_id | string |
O identificador do modelo de email de anotação de crédito. |
|
|
Nome do modelo de email da nota de crédito
|
creditnote_email_template_name | string |
O nome do modelo de email da nota de crédito. |
|
|
Código de idioma
|
language_code | string |
O código do idioma. |
|
|
Anotações
|
notes | string |
As anotações. |
|
|
Registro de IVA
|
vat_reg_no | string |
O número de registro do IVA. |
|
|
Registro de Imposto
|
tax_reg_no | string |
O número do registro do imposto. |
|
|
Código do país
|
country_code | string |
O código do país. |
|
|
Tratamento de IVA
|
vat_treatment | string |
O tipo de tratamento de IVA. |
|
|
Tratamento Tributário
|
tax_treatment | string |
O tipo de tratamento tributário. |
|
|
Regime Tributário
|
tax_regime | string |
O regime tributário. |
|
|
Nome Legal
|
legal_name | string |
O nome legal. |
|
|
O TDS está registrado
|
is_tds_registered | boolean |
Se o TDS está registrado. |
|
|
Local de contato
|
place_of_contact | string |
O local de contato. |
|
|
Número do GST
|
gst_no | string |
O número do GST. |
|
|
Tratamento GST
|
gst_treatment | string |
O tipo de tratamento GST. |
|
|
Nome da Autoridade Fiscal
|
tax_authority_name | string |
O nome da autoridade fiscal. |
|
|
Código de isenção de impostos
|
tax_exemption_code | string |
O código de isenção de impostos. |
|
|
Isenção do AvaTax
|
avatax_exempt_no | string |
O número isento do AvaTax. |
|
|
Código de uso do AvaTax
|
avatax_use_code | string |
O código de uso do AvaTax. |
|
|
ID de isenção de impostos
|
tax_exemption_id | string |
O identificador de isenção fiscal. |
|
|
ID da Autoridade Fiscal
|
tax_authority_id | string |
O identificador da autoridade fiscal. |
|
|
NIF
|
tax_id | string |
O identificador de imposto. |
|
|
ID do imposto TDS
|
tds_tax_id | string |
O identificador de imposto do TDS. |
|
|
É tributável
|
is_taxable | boolean |
Se é tributável. |
|
|
Facebook
|
string |
O nome de usuário do Facebook. |
||
|
Twitter
|
string |
O identificador do Twitter. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
|
ID de contato
|
contact.contact_id | string |
O identificador de contato. |
|
Nome do contato
|
contact.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
contact.company_name | string |
O nome da empresa. |
|
Tem transação
|
contact.has_transaction | boolean |
Se tem transação. |
|
Tipo de contato
|
contact.contact_type | string |
O tipo de contato. |
|
É tributável
|
contact.is_taxable | boolean |
Se é tributável. |
|
NIF
|
contact.tax_id | string |
O identificador de imposto. |
|
ID do imposto TDS
|
contact.tds_tax_id | string |
O identificador de imposto do TDS. |
|
Nome do Imposto
|
contact.tax_name | string |
O nome do imposto. |
|
Percentual de Impostos
|
contact.tax_percentage | integer |
O percentual de imposto. |
|
ID da Autoridade Fiscal
|
contact.tax_authority_id | string |
O identificador da autoridade fiscal. |
|
ID de isenção de impostos
|
contact.tax_exemption_id | string |
O identificador de isenção fiscal. |
|
Nome da Autoridade Fiscal
|
contact.tax_authority_name | string |
O nome da autoridade fiscal. |
|
Código de isenção de impostos
|
contact.tax_exemption_code | string |
O código de isenção de impostos. |
|
Local de contato
|
contact.place_of_contact | string |
O local de contato. |
|
Número do GST
|
contact.gst_no | string |
O número do GST. |
|
Tratamento de IVA
|
contact.vat_treatment | string |
O tratamento do IVA. |
|
Tratamento Tributário
|
contact.tax_treatment | string |
O tratamento tributário. |
|
Regime Tributário
|
contact.tax_regime | string |
O regime tributário. |
|
Nome Legal
|
contact.legal_name | string |
O nome legal. |
|
O TDS está registrado
|
contact.is_tds_registered | boolean |
Se o TSD está registrado. |
|
Tratamento GST
|
contact.gst_treatment | string |
O tratamento GST. |
|
Está vinculado ao Zoho CRM
|
contact.is_linked_with_zohocrm | boolean |
Se está vinculado ao Zoho CRM. |
|
Site
|
contact.website | string |
O site. |
|
ID do contato primário
|
contact.primary_contact_id | string |
O identificador de contato primário. |
|
Condições de Pagamento
|
contact.payment_terms | integer |
As condições de pagamento. |
|
Rótulo de Termos de Pagamento
|
contact.payment_terms_label | string |
O rótulo de termos de pagamento. |
|
ID da moeda
|
contact.currency_id | string |
O identificador de moeda. |
|
Código de moeda
|
contact.currency_code | string |
O código de moeda. |
|
Símbolo de moeda
|
contact.currency_symbol | string |
O símbolo de moeda. |
|
Código de idioma
|
contact.language_code | string |
O código do idioma. |
|
Valor de recebimento pendente
|
contact.outstanding_receivable_amount | double |
O valor a receber pendente. |
|
Bcy de valor a receber pendente
|
contact.outstanding_receivable_amount_bcy | double |
O valor de recebimento pendente do BCY. |
|
Valor a receber créditos não utilizados
|
contact.unused_credits_receivable_amount | double |
O valor a receber de créditos não utilizados. |
|
Valor a receber créditos não utilizados BCY
|
contact.unused_credits_receivable_amount_bcy | double |
O valor a receber de créditos não utilizados do BCY. |
|
Situação
|
contact.status | string |
O status. |
|
Lembrete de pagamento habilitado
|
contact.payment_reminder_enabled | boolean |
Se o lembrete de pagamento está habilitado. |
|
Campo Personalizado
|
contact.custom_fields | array of object | |
|
Value
|
contact.custom_fields.value | string |
O valor do campo personalizado. |
|
Index
|
contact.custom_fields.index | integer |
O número do índice. |
|
Etiqueta
|
contact.custom_fields.label | string |
O rótulo. |
|
Atenção
|
contact.billing_address.attention | string |
O nome da atenção. |
|
Endereço
|
contact.billing_address.address | string |
O endereço. |
|
Rua
|
contact.billing_address.street2 | string |
O endereço da rua. |
|
Código de estado
|
contact.billing_address.state_code | string |
O código de estado. |
|
City
|
contact.billing_address.city | string |
A cidade. |
|
Estado
|
contact.billing_address.state | string |
O estado. |
|
Zip
|
contact.billing_address.zip | string |
O cep. |
|
País
|
contact.billing_address.country | string |
O país. |
|
Fac-símile
|
contact.billing_address.fax | string |
O número do fax. |
|
Telefone
|
contact.billing_address.phone | string |
O número de telefone. |
|
Atenção
|
contact.shipping_address.attention | string |
O nome da atenção. |
|
Endereço
|
contact.shipping_address.address | string |
O endereço. |
|
Rua
|
contact.shipping_address.street2 | string |
O endereço da rua. |
|
Código de estado
|
contact.shipping_address.state_code | string |
O código de estado. |
|
City
|
contact.shipping_address.city | string |
A cidade. |
|
Estado
|
contact.shipping_address.state | string |
O estado. |
|
Zip
|
contact.shipping_address.zip | string |
O cep. |
|
País
|
contact.shipping_address.country | string |
O país. |
|
Fac-símile
|
contact.shipping_address.fax | string |
O número do fax. |
|
Telefone
|
contact.shipping_address.phone | string |
O número de telefone. |
|
Facebook
|
contact.facebook | string |
A conta do Facebook. |
|
Twitter
|
contact.twitter | string |
O identificador do Twitter. |
|
Pessoas de Contato
|
contact.contact_persons | array of object | |
|
Saudação
|
contact.contact_persons.salutation | string |
A saudação. |
|
Primeiro Nome
|
contact.contact_persons.first_name | string |
O nome. |
|
Apelido
|
contact.contact_persons.last_name | string |
O sobrenome. |
|
Email
|
contact.contact_persons.email | string |
O endereço de email. |
|
Telefone
|
contact.contact_persons.phone | string |
O número de telefone. |
|
Telemóvel
|
contact.contact_persons.mobile | string |
O número do celular. |
|
É o contato primário
|
contact.contact_persons.is_primary_contact | boolean |
Se é o contato primário. |
|
ID do modelo de fatura
|
contact.default_templates.invoice_template_id | string |
O identificador do modelo de fatura. |
|
Nome do modelo de fatura
|
contact.default_templates.invoice_template_name | string |
O nome do modelo de fatura. |
|
Estimar ID do modelo
|
contact.default_templates.estimate_template_id | string |
O identificador do modelo de estimativa. |
|
Estimar nome do modelo
|
contact.default_templates.estimate_template_name | string |
O nome do modelo de estimativa. |
|
ID do modelo de nota de crédito
|
contact.default_templates.creditnote_template_id | string |
O identificador do modelo de anotação de crédito. |
|
Nome do modelo de anotação de crédito
|
contact.default_templates.creditnote_template_name | string |
O nome do modelo de anotação de crédito. |
|
ID do modelo de email da fatura
|
contact.default_templates.invoice_email_template_id | string |
O identificador do modelo de email da fatura. |
|
Nome do modelo de email da fatura
|
contact.default_templates.invoice_email_template_name | string |
O nome do modelo de email da fatura. |
|
Estimar a ID do modelo de email
|
contact.default_templates.estimate_email_template_id | string |
O identificador do modelo de email de estimativa. |
|
Estimar o nome do modelo de email
|
contact.default_templates.estimate_email_template_name | string |
O nome do modelo de email de estimativa. |
|
ID do modelo de email da Nota de Crédito
|
contact.default_templates.creditnote_email_template_id | string |
O identificador do modelo de email de anotação de crédito. |
|
Nome do modelo de email da nota de crédito
|
contact.default_templates.creditnote_email_template_name | string |
O nome do modelo de email da nota de crédito. |
|
Anotações
|
contact.notes | string |
As anotações. |
|
Hora de Criação
|
contact.created_time | string |
A hora criada. |
|
Hora da Última Modificação
|
contact.last_modified_time | string |
A hora da última modificação. |
Criar uma fatura
Cria uma fatura para um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Enviar
|
send | boolean |
Se deseja enviar a fatura. |
|
|
Ignorar geração de número automático
|
ignore_auto_number_generation | boolean |
Se deve ignorar a geração de número automático. |
|
|
ID do cliente
|
customer_id | string |
O identificador do cliente. |
|
|
Pessoa de Contato
|
contact_persons | array of integer |
A pessoa de contato. |
|
|
Número da fatura
|
invoice_number | string |
O número da fatura. |
|
|
Número de referência
|
reference_number | string |
O número de referência. |
|
|
Local de fornecimento
|
place_of_supply | string |
O local de fornecimento. |
|
|
Tratamento de IVA
|
vat_treatment | string |
O tratamento do IVA. |
|
|
Tratamento GST
|
gst_treatment | string |
O tratamento GST. |
|
|
Tratamento Tributário
|
tax_treatment | string |
O tratamento tributário. |
|
|
Uso do CFDI
|
cfdi_usage | string |
O uso do CFDI. |
|
|
Número do GST
|
gst_no | string |
O número do GST. |
|
|
ID do Modelo
|
template_id | string |
O identificador de modelo. |
|
|
Date
|
date | string |
A data. |
|
|
Condições de Pagamento
|
payment_terms | integer |
As condições de pagamento. |
|
|
Rótulo de Termos de Pagamento
|
payment_terms_label | string |
O rótulo de termos de pagamento. |
|
|
Data de vencimento
|
due_date | string |
A data de conclusão. |
|
|
Desconto
|
discount | float |
O desconto. |
|
|
É desconto antes do imposto
|
is_discount_before_tax | boolean |
Se o desconto é antes do imposto. |
|
|
Tipo de desconto
|
discount_type | string |
O tipo de desconto. |
|
|
Is Inclusive Tax
|
is_inclusive_tax | boolean |
Se é inclusivo de impostos. |
|
|
Taxa de câmbio
|
exchange_rate | float |
A taxa de câmbio. |
|
|
ID da fatura recorrente
|
recurring_invoice_id | string |
O identificador de fatura recorrente. |
|
|
ID da estimativa de fatura
|
invoiced_estimate_id | string |
O identificador de estimativa faturado. |
|
|
Nome do vendedor
|
salesperson_name | string |
O nome do vendedor. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Value
|
value | float |
O valor. |
|
|
ID do projeto
|
project_id | string |
O identificador do projeto. |
|
|
ID
|
item_id | string |
O identificador do item. |
|
|
ID do projeto
|
project_id | string |
O identificador do projeto. |
|
|
IDs de entrada de tempo
|
time_entry_ids | array of integer |
Os identificadores de entrada de hora. |
|
|
ID de despesas
|
expense_id | string |
O identificador de despesas. |
|
|
Nome
|
name | string |
O nome. |
|
|
Tipo de Produto
|
product_type | string |
O tipo de produto. |
|
|
HSN ou SAC
|
hsn_or_sac | integer |
O número HSN ou SAC. |
|
|
Código da chave do item SAT
|
sat_item_key_code | integer |
O código de chave do item SAT. |
|
|
Código da chave de unidade
|
unitkey_code | string |
O código da chave de unidade. |
|
|
Description
|
description | string |
A descrição. |
|
|
Pedido
|
item_order | integer |
A ordem do item. |
|
|
Rate
|
rate | float |
A taxa. |
|
|
Quantidade
|
quantity | double |
A quantidade. |
|
|
Unidade
|
unit | string |
A unidade. |
|
|
Desconto
|
discount | float |
O desconto. |
|
|
NIF
|
tax_id | string |
O identificador de imposto. |
|
|
ID do imposto TDS
|
tds_tax_id | string |
O identificador de imposto do TDS. |
|
|
ID de isenção de impostos
|
tax_exemption_id | string |
O identificador de isenção fiscal. |
|
|
Código de uso do AvaTax
|
avatax_use_code | string |
O código de uso do AvaTax. |
|
|
AvaTax Exempt No
|
avatax_exempt_no | string |
O número isento do AvaTax. |
|
|
Nome do Imposto
|
tax_name | string |
O nome do imposto. |
|
|
Tipo de imposto
|
tax_type | string |
O tipo de imposto. |
|
|
Percentual de Impostos
|
tax_percentage | float |
O percentual de imposto. |
|
|
Total
|
item_total | float |
O total do item. |
|
|
Configurado
|
configured | boolean |
Se configurado. |
|
|
Campo Adicional
|
additional_field1 | string |
O campo adicional. |
|
|
Nome
|
gateway_name | string |
O nome. |
|
|
Permitir pagamentos parciais
|
allow_partial_payments | boolean |
Se deseja permitir pagamentos parciais. |
|
|
Corpo Personalizado
|
custom_body | string |
O corpo personalizado. |
|
|
Assunto Personalizado
|
custom_subject | string |
O assunto personalizado. |
|
|
Anotações
|
notes | string |
As anotações. |
|
|
Termos
|
terms | string |
Os termos. |
|
|
Encargo de envio
|
shipping_charge | float |
A carga de envio. |
|
|
Ajuste
|
adjustment | float |
O ajuste. |
|
|
Descrição do ajuste
|
adjustment_description | string |
A descrição do ajuste. |
|
|
Reason
|
reason | string |
O motivo. |
|
|
ID da Autoridade Fiscal
|
tax_authority_id | string |
O identificador da autoridade fiscal. |
|
|
ID de isenção de impostos
|
tax_exemption_id | string |
O identificador de isenção fiscal. |
|
|
Código de uso do AvaTax
|
avatax_use_code | string |
O código de uso do AvaTax. |
|
|
Código fiscal do AvaTax
|
avatax_tax_code | string |
O código fiscal do AvaTax. |
|
|
Número isento do AvaTax
|
avatax_exempt_no | string |
O número isento do AvaTax. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
|
ID
|
invoice.invoice_id | string |
O identificador da fatura. |
|
Pagamento iniciado pela ACH
|
invoice.ach_payment_initiated | boolean |
Se o pagamento da ACH foi iniciado. |
|
Número
|
invoice.invoice_number | string |
O número da fatura. |
|
É pré-GST
|
invoice.is_pre_gst | boolean |
Se é pré-GST. |
|
Local de fornecimento
|
invoice.place_of_supply | string |
O local de fornecimento. |
|
Número do GST
|
invoice.gst_no | string |
O número do GST. |
|
Tratamento GST
|
invoice.gst_treatment | string |
O tratamento GST. |
|
Tratamento Tributário
|
invoice.tax_treatment | string |
O tratamento tributário. |
|
Uso do CFDI
|
invoice.cfdi_usage | string |
O uso do CFDI. |
|
Tratamento de IVA
|
invoice.vat_treatment | string |
O tratamento do IVA. |
|
Registro de IVA
|
invoice.vat_reg_no | string |
O número de registro do IVA. |
|
Date
|
invoice.date | string |
A data. |
|
Situação
|
invoice.status | string |
O status. |
|
Condições de Pagamento
|
invoice.payment_terms | integer |
As condições de pagamento. |
|
Rótulo de Termos de Pagamento
|
invoice.payment_terms_label | string |
O rótulo de termos de pagamento. |
|
Data de vencimento
|
invoice.due_date | string |
A data de conclusão. |
|
Data de pagamento esperada
|
invoice.payment_expected_date | string |
A data de pagamento esperada. |
|
Data do último pagamento
|
invoice.last_payment_date | string |
A última data de pagamento. |
|
Número de referência
|
invoice.reference_number | string |
O número de referência. |
|
ID do cliente
|
invoice.customer_id | string |
O identificador do cliente. |
|
Nome do cliente
|
invoice.customer_name | string |
O nome do cliente. |
|
Pessoas de Contato
|
invoice.contact_persons | array of string |
As pessoas de contato. |
|
ID da moeda
|
invoice.currency_id | string |
O identificador de moeda. |
|
Código de moeda
|
invoice.currency_code | string |
O código de moeda. |
|
Taxa de câmbio
|
invoice.exchange_rate | double |
A taxa de câmbio. |
|
Desconto
|
invoice.discount | double |
O desconto. |
|
É desconto antes do imposto
|
invoice.is_discount_before_tax | boolean |
Se o desconto é antes do imposto. |
|
Tipo de desconto
|
invoice.discount_type | string |
O tipo de desconto. |
|
É Tax Inclusive
|
invoice.is_inclusive_tax | boolean |
Se é inclusivo de impostos. |
|
ID da fatura recorrente
|
invoice.recurring_invoice_id | string |
O identificador de fatura recorrente. |
|
É exibido pelo cliente
|
invoice.is_viewed_by_client | boolean |
Se é exibido pelo cliente. |
|
Tem Anexo
|
invoice.has_attachment | boolean |
Se tem anexo. |
|
Tempo exibido pelo cliente
|
invoice.client_viewed_time | string |
O tempo exibido pelo cliente. |
|
Item de Linha
|
invoice.line_items | array of object | |
|
ID
|
invoice.line_items.line_item_id | string |
O identificador do item de linha. |
|
ID
|
invoice.line_items.item_id | string |
O identificador do item. |
|
ID do projeto
|
invoice.line_items.project_id | string |
O identificador do projeto. |
|
Nome do Projeto
|
invoice.line_items.project_name | string |
O nome do projeto. |
|
Tipo de Item
|
invoice.line_items.item_type | string |
O tipo de item. |
|
Tipo de Produto
|
invoice.line_items.product_type | string |
O tipo de produto. |
|
time_entry_ids
|
invoice.line_items.time_entry_ids | array of integer |
time_entry_ids |
|
ID de despesas
|
invoice.line_items.expense_id | string |
O identificador de despesas. |
|
Nome do Recibo de Despesa
|
invoice.line_items.expense_receipt_name | string |
O nome do recibo da despesa. |
|
Nome
|
invoice.line_items.name | string |
O nome. |
|
Description
|
invoice.line_items.description | string |
A descrição. |
|
Ordem do Item
|
invoice.line_items.item_order | integer |
A ordem do item. |
|
Taxa BCY
|
invoice.line_items.bcy_rate | double |
A taxa BCY. |
|
Rate
|
invoice.line_items.rate | double |
A taxa. |
|
Quantidade
|
invoice.line_items.quantity | double |
A quantidade. |
|
Unidade
|
invoice.line_items.unit | string |
A unidade. |
|
Valor do desconto
|
invoice.line_items.discount_amount | double |
O valor do desconto. |
|
Desconto
|
invoice.line_items.discount | double |
O desconto. |
|
ID
|
invoice.line_items.tax_id | string |
O identificador de imposto. |
|
ID do imposto TDS
|
invoice.line_items.tds_tax_id | string |
O identificador de imposto do TDS. |
|
Nome
|
invoice.line_items.tax_name | string |
O nome do imposto. |
|
Tipo de imposto
|
invoice.line_items.tax_type | string |
O tipo de imposto. |
|
Percentual de Impostos
|
invoice.line_items.tax_percentage | double |
O percentual de imposto. |
|
Total de Itens
|
invoice.line_items.item_total | double |
O total do item. |
|
Código da chave do item SAT
|
invoice.line_items.sat_item_key_code | integer |
O código de chave do item SAT. |
|
Código da chave de unidade
|
invoice.line_items.unitkey_code | string |
O código da chave de unidade. |
|
Encargo de envio
|
invoice.shipping_charge | double |
A carga de envio. |
|
Ajuste
|
invoice.adjustment | double |
O ajuste. |
|
Descrição do ajuste
|
invoice.adjustment_description | string |
A descrição do ajuste. |
|
Subtotal
|
invoice.sub_total | double |
O subtotal. |
|
Total de Impostos
|
invoice.tax_total | double |
O total de impostos. |
|
Total
|
invoice.total | double |
O total. |
|
Imposto
|
invoice.taxes | array of object | |
|
Nome
|
invoice.taxes.tax_name | string |
O nome do imposto. |
|
Quantidade
|
invoice.taxes.tax_amount | double |
O valor do imposto. |
|
Lembrete de pagamento habilitado
|
invoice.payment_reminder_enabled | boolean |
Se o lembrete de pagamento está habilitado. |
|
Pagamento Feito
|
invoice.payment_made | double |
O pagamento feito. |
|
Créditos aplicados
|
invoice.credits_applied | double |
Os créditos aplicados. |
|
Valor do imposto retido
|
invoice.tax_amount_withheld | double |
O valor do imposto retido. |
|
Saldo
|
invoice.balance | double |
O equilíbrio. |
|
Valor de desativação
|
invoice.write_off_amount | double |
A quantidade de desativação. |
|
Permitir pagamentos parciais
|
invoice.allow_partial_payments | boolean |
Se deseja permitir pagamentos parciais. |
|
Precisão de preço
|
invoice.price_precision | integer |
A precisão do preço. |
|
Gateway
|
invoice.payment_options.payment_gateways | array of object | |
|
Configurado
|
invoice.payment_options.payment_gateways.configured | boolean |
Se configurado. |
|
Campo Adicional
|
invoice.payment_options.payment_gateways.additional_field1 | string |
O campo adicional. |
|
Nome
|
invoice.payment_options.payment_gateways.gateway_name | string |
O nome do gateway. |
|
É enviado por email
|
invoice.is_emailed | boolean |
Se foi enviado por e-mail. |
|
Lembretes enviados
|
invoice.reminders_sent | integer |
O número de lembretes enviados. |
|
Data do Último Lembrete Enviado
|
invoice.last_reminder_sent_date | string |
A data do último lembrete enviado. |
|
Endereço
|
invoice.billing_address.address | string |
O endereço. |
|
City
|
invoice.billing_address.city | string |
A cidade. |
|
Estado
|
invoice.billing_address.state | string |
O estado. |
|
Zip
|
invoice.billing_address.zip | string |
O cep. |
|
País
|
invoice.billing_address.country | string |
O país. |
|
Fac-símile
|
invoice.billing_address.fax | string |
O número do fax. |
|
Endereço
|
invoice.shipping_address.address | string |
O endereço. |
|
City
|
invoice.shipping_address.city | string |
A cidade. |
|
Estado
|
invoice.shipping_address.state | string |
O estado. |
|
Zip
|
invoice.shipping_address.zip | string |
O cep. |
|
País
|
invoice.shipping_address.country | string |
O país. |
|
Fac-símile
|
invoice.shipping_address.fax | string |
O número do fax. |
|
Anotações
|
invoice.notes | string |
As anotações. |
|
Termos
|
invoice.terms | string |
Os termos. |
|
Campo Personalizado
|
invoice.custom_fields | array of object | |
|
ID
|
invoice.custom_fields.customfield_id | string |
O identificador de campo personalizado. |
|
Tipo de Dados
|
invoice.custom_fields.data_type | string |
O tipo de dados. |
|
Index
|
invoice.custom_fields.index | integer |
O número do índice. |
|
Etiqueta
|
invoice.custom_fields.label | string |
O rótulo. |
|
Mostrar em PDF
|
invoice.custom_fields.show_on_pdf | boolean |
Se deve ser exibido em PDF. |
|
Mostrar em todos os PDFs
|
invoice.custom_fields.show_in_all_pdf | boolean |
Se deve ser exibido em todos os PDFs. |
|
Value
|
invoice.custom_fields.value | double |
O valor do campo personalizado. |
|
ID do Modelo
|
invoice.template_id | string |
O identificador de modelo. |
|
Nome do Modelo
|
invoice.template_name | string |
O nome do modelo. |
|
Hora de Criação
|
invoice.created_time | string |
A hora criada. |
|
Hora da Última Modificação
|
invoice.last_modified_time | string |
A hora da última modificação. |
|
Nome do anexo
|
invoice.attachment_name | string |
O nome do anexo. |
|
Pode enviar emails
|
invoice.can_send_in_mail | boolean |
Se pode enviar emails. |
|
ID do vendedor
|
invoice.salesperson_id | string |
O identificador do vendedor. |
|
Nome do vendedor
|
invoice.salesperson_name | string |
O nome do vendedor. |
|
URL
|
invoice.invoice_url | string |
O endereço da URL da fatura. |
Excluir um contato
Exclui um contato existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contact_id | True | string |
O identificador de contato. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
Excluir uma fatura
Exclui uma fatura existente. As faturas que têm a anotação de pagamento ou créditos aplicadas não podem ser excluídas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de fatura
|
invoice_id | True | string |
O identificador da fatura. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
Obter contatos
Recupere uma lista de todos os contatos com paginação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do contato
|
contact_name | string |
O nome do contato. |
|
|
ID da Empresa
|
company_name | string |
O identificador da empresa. |
|
|
Primeiro Nome
|
first_name | string |
O nome. |
|
|
Último Nam
|
last_name | string |
O sobrenome. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
Email
|
string |
O endereço de email. |
||
|
Telefone
|
phone | string |
O endereço do telefone. |
|
|
Filtrar por
|
filter_by | string |
O filtro por. |
|
|
Pesquisar Texto
|
search_text | string |
O texto da pesquisa. |
|
|
Classificar Coluna
|
sort_column | string |
A coluna de classificação. |
|
|
ID de contato do Zoho CRM
|
zcrm_contact_id | integer |
O identificador de contato do Zoho CRM. |
|
|
ID da conta do Zoho CRM
|
zcrm_account_id | integer |
O identificador da conta do Zoho CRM. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Por Página
|
per_page | integer |
O número por página. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
|
contato
|
contact | array of object | |
|
ID de contato
|
contact.contact_id | string |
O identificador de contato. |
|
Nome do contato
|
contact.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
contact.company_name | string |
O nome da empresa. |
|
Tipo de contato
|
contact.contact_type | string |
O tipo de contato. |
|
Condições de Pagamento
|
contact.payment_terms | integer |
As condições de pagamento. |
|
Rótulo de Termos de Pagamento
|
contact.payment_terms_label | string |
O rótulo de termos de pagamento. |
|
ID da moeda
|
contact.currency_id | string |
O identificador de moeda. |
|
Código de moeda
|
contact.currency_code | string |
O código de moeda. |
|
Valor de recebimento pendente
|
contact.outstanding_receivable_amount | double |
O valor a receber pendente. |
|
Valor a receber créditos não utilizados
|
contact.unused_credits_receivable_amount | double |
O valor a receber de créditos não utilizados. |
|
Situação
|
contact.status | string |
O status. |
|
Hora de Criação
|
contact.created_time | string |
A hora criada. |
|
Hora da Última Modificação
|
contact.last_modified_time | string |
A hora da última modificação. |
Obter faturas
Recupere uma lista de faturas com paginação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número da fatura
|
invoice_number | string |
O número da fatura. |
|
|
Nome do Item
|
item_name | string |
O nome do item. |
|
|
Item ID
|
item_id | string |
O identificador do item. |
|
|
Descrição do item
|
item_description | string |
A descrição do item. |
|
|
Número de referência
|
reference_number | string |
O número de referência. |
|
|
Nome do cliente
|
customer_name | string |
O nome do cliente. |
|
|
ID da fatura recorrente
|
recurring_invoice_id | string |
O identificador de fatura recorrente. |
|
|
Email
|
string |
O endereço de email. |
||
|
Total
|
total | string |
O total. |
|
|
Saldo
|
balance | string |
O equilíbrio. |
|
|
Campo Personalizado
|
custom_field | string |
O campo personalizado. |
|
|
Date
|
date | string |
A data. |
|
|
Data de vencimento
|
due_date | string |
A data de conclusão. |
|
|
Situação
|
status | string |
O status. |
|
|
ID personalizada
|
customer_id | string |
O identificador personalizado. |
|
|
Filtrar por
|
filter_by | string |
O filtro por. |
|
|
Pesquisar Texto
|
search_text | string |
O texto da pesquisa. |
|
|
Classificar Coluna
|
sort_column | string |
A coluna de classificação. |
|
|
ID potencial do Zoho CRM
|
zcrm_potential_id | string |
O identificador potencial do Zoho CRM. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Por Página
|
per_page | integer |
O número por página. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
|
invoices
|
invoices | array of object | |
|
ID
|
invoices.invoice_id | string |
O identificador da fatura. |
|
Pagamento iniciado pela ACH
|
invoices.ach_payment_initiated | boolean |
Se o pagamento da ACH foi iniciado. |
|
Número
|
invoices.invoice_number | string |
O número da fatura. |
|
É pré-GST
|
invoices.is_pre_gst | boolean |
Se é pré-GST. |
|
Local de fornecimento
|
invoices.place_of_supply | string |
O local de fornecimento. |
|
Número do GST
|
invoices.gst_no | string |
O número do GST. |
|
Tratamento GST
|
invoices.gst_treatment | string |
O tratamento GST. |
|
Tratamento Tributário
|
invoices.tax_treatment | string |
O tratamento tributário. |
|
Uso do CFDI
|
invoices.cfdi_usage | string |
O uso do CFDI. |
|
Tratamento de IVA
|
invoices.vat_treatment | string |
O tratamento do IVA. |
|
Registro de IVA
|
invoices.vat_reg_no | string |
O número de registro do IVA. |
|
Date
|
invoices.date | string |
A data. |
|
Situação
|
invoices.status | string |
O status. |
|
Condições de Pagamento
|
invoices.payment_terms | integer |
As condições de pagamento. |
|
Rótulo de Termos de Pagamento
|
invoices.payment_terms_label | string |
O rótulo de termos de pagamento. |
|
Data de vencimento
|
invoices.due_date | string |
A data de conclusão. |
|
Data de pagamento esperada
|
invoices.payment_expected_date | string |
A data de pagamento esperada. |
|
Data do último pagamento
|
invoices.last_payment_date | string |
A última data de pagamento. |
|
Número de referência
|
invoices.reference_number | string |
O número de referência. |
|
ID do cliente
|
invoices.customer_id | string |
O identificador do cliente. |
|
Nome do cliente
|
invoices.customer_name | string |
O nome do cliente. |
|
Pessoas de Contato
|
invoices.contact_persons | array of string |
As pessoas de contato. |
|
ID da moeda
|
invoices.currency_id | string |
O identificador de moeda. |
|
Código de moeda
|
invoices.currency_code | string |
O código de moeda. |
|
Taxa de câmbio
|
invoices.exchange_rate | double |
A taxa de câmbio. |
|
Desconto
|
invoices.discount | double |
O desconto. |
|
É desconto antes do imposto
|
invoices.is_discount_before_tax | boolean |
Se o desconto é antes do imposto. |
|
Tipo de desconto
|
invoices.discount_type | string |
O tipo de desconto. |
|
É Tax Inclusive
|
invoices.is_inclusive_tax | boolean |
Se é inclusivo de impostos. |
|
ID da fatura recorrente
|
invoices.recurring_invoice_id | string |
O identificador de fatura recorrente. |
|
É exibido pelo cliente
|
invoices.is_viewed_by_client | boolean |
Se é exibido pelo cliente. |
|
Tem Anexo
|
invoices.has_attachment | boolean |
Se tem anexo. |
|
Tempo exibido pelo cliente
|
invoices.client_viewed_time | string |
O tempo exibido pelo cliente. |
|
Item de Linha
|
invoices.line_items | array of object | |
|
ID
|
invoices.line_items.line_item_id | string |
O identificador do item de linha. |
|
ID
|
invoices.line_items.item_id | string |
O identificador do item. |
|
ID do projeto
|
invoices.line_items.project_id | string |
O identificador do projeto. |
|
Nome do Projeto
|
invoices.line_items.project_name | string |
O nome do projeto. |
|
Tipo de Item
|
invoices.line_items.item_type | string |
O tipo de item. |
|
Tipo de Produto
|
invoices.line_items.product_type | string |
O tipo de produto. |
|
time_entry_ids
|
invoices.line_items.time_entry_ids | array of integer |
time_entry_ids |
|
ID de despesas
|
invoices.line_items.expense_id | string |
O identificador de despesas. |
|
Nome do Recibo de Despesa
|
invoices.line_items.expense_receipt_name | string |
O nome do recibo da despesa. |
|
Nome
|
invoices.line_items.name | string |
O nome. |
|
Description
|
invoices.line_items.description | string |
A descrição. |
|
Ordem do Item
|
invoices.line_items.item_order | integer |
A ordem do item. |
|
Taxa BCY
|
invoices.line_items.bcy_rate | double |
A taxa BCY. |
|
Rate
|
invoices.line_items.rate | double |
A taxa. |
|
Quantidade
|
invoices.line_items.quantity | double |
A quantidade. |
|
Unidade
|
invoices.line_items.unit | string |
A unidade. |
|
Valor do desconto
|
invoices.line_items.discount_amount | double |
O valor do desconto. |
|
Desconto
|
invoices.line_items.discount | double |
O desconto. |
|
ID
|
invoices.line_items.tax_id | string |
O identificador de imposto. |
|
ID do imposto TDS
|
invoices.line_items.tds_tax_id | string |
O identificador de imposto do TDS. |
|
Nome
|
invoices.line_items.tax_name | string |
O nome do imposto. |
|
Tipo de imposto
|
invoices.line_items.tax_type | string |
O tipo de imposto. |
|
Percentual de Impostos
|
invoices.line_items.tax_percentage | double |
O percentual de imposto. |
|
Total de Itens
|
invoices.line_items.item_total | double |
O total do item. |
|
Código da chave do item SAT
|
invoices.line_items.sat_item_key_code | integer |
O código de chave do item SAT. |
|
Código da chave de unidade
|
invoices.line_items.unitkey_code | string |
O código da chave de unidade. |
|
Encargo de envio
|
invoices.shipping_charge | double |
A carga de envio. |
|
Ajuste
|
invoices.adjustment | double |
O ajuste. |
|
Descrição do ajuste
|
invoices.adjustment_description | string |
A descrição do ajuste. |
|
Subtotal
|
invoices.sub_total | double |
O subtotal. |
|
Total de Impostos
|
invoices.tax_total | double |
O total de impostos. |
|
Total
|
invoices.total | double |
O total. |
|
Imposto
|
invoices.taxes | array of object | |
|
Nome
|
invoices.taxes.tax_name | string |
O nome do imposto. |
|
Quantidade
|
invoices.taxes.tax_amount | double |
O valor do imposto. |
|
Lembrete de pagamento habilitado
|
invoices.payment_reminder_enabled | boolean |
Se o lembrete de pagamento está habilitado. |
|
Pagamento Feito
|
invoices.payment_made | double |
O pagamento feito. |
|
Créditos aplicados
|
invoices.credits_applied | double |
Os créditos aplicados. |
|
Valor do imposto retido
|
invoices.tax_amount_withheld | double |
O valor do imposto retido. |
|
Saldo
|
invoices.balance | double |
O equilíbrio. |
|
Valor de desativação
|
invoices.write_off_amount | double |
A quantidade de desativação. |
|
Permitir pagamentos parciais
|
invoices.allow_partial_payments | boolean |
Se deseja permitir pagamentos parciais. |
|
Precisão de preço
|
invoices.price_precision | integer |
A precisão do preço. |
|
Gateway
|
invoices.payment_options.payment_gateways | array of object | |
|
Configurado
|
invoices.payment_options.payment_gateways.configured | boolean |
Se configurado. |
|
Campo Adicional
|
invoices.payment_options.payment_gateways.additional_field1 | string |
O campo adicional. |
|
Nome
|
invoices.payment_options.payment_gateways.gateway_name | string |
O nome do gateway. |
|
É enviado por email
|
invoices.is_emailed | boolean |
Se foi enviado por e-mail. |
|
Lembretes enviados
|
invoices.reminders_sent | integer |
O número de lembretes enviados. |
|
Data do Último Lembrete Enviado
|
invoices.last_reminder_sent_date | string |
A data do último lembrete enviado. |
|
Endereço
|
invoices.billing_address.address | string |
O endereço. |
|
City
|
invoices.billing_address.city | string |
A cidade. |
|
Estado
|
invoices.billing_address.state | string |
O estado. |
|
Zip
|
invoices.billing_address.zip | string |
O cep. |
|
País
|
invoices.billing_address.country | string |
O país. |
|
Fac-símile
|
invoices.billing_address.fax | string |
O número do fax. |
|
Endereço
|
invoices.shipping_address.address | string |
O endereço. |
|
City
|
invoices.shipping_address.city | string |
A cidade. |
|
Estado
|
invoices.shipping_address.state | string |
O estado. |
|
Zip
|
invoices.shipping_address.zip | string |
O cep. |
|
País
|
invoices.shipping_address.country | string |
O país. |
|
Fac-símile
|
invoices.shipping_address.fax | string |
O número do fax. |
|
Anotações
|
invoices.notes | string |
As anotações. |
|
Termos
|
invoices.terms | string |
Os termos. |
|
Campo Personalizado
|
invoices.custom_fields | array of object | |
|
ID
|
invoices.custom_fields.customfield_id | string |
O identificador de campo personalizado. |
|
Tipo de Dados
|
invoices.custom_fields.data_type | string |
O tipo de dados. |
|
Index
|
invoices.custom_fields.index | integer |
O número do índice. |
|
Etiqueta
|
invoices.custom_fields.label | string |
O rótulo. |
|
Mostrar em PDF
|
invoices.custom_fields.show_on_pdf | boolean |
Se deve ser exibido em PDF. |
|
Mostrar em todos os PDFs
|
invoices.custom_fields.show_in_all_pdf | boolean |
Se deve ser exibido em todos os PDFs. |
|
Value
|
invoices.custom_fields.value | double |
O valor do campo personalizado. |
|
ID do Modelo
|
invoices.template_id | string |
O identificador de modelo. |
|
Nome do Modelo
|
invoices.template_name | string |
O nome do modelo. |
|
Hora de Criação
|
invoices.created_time | string |
A hora criada. |
|
Hora da Última Modificação
|
invoices.last_modified_time | string |
A hora da última modificação. |
|
Nome do anexo
|
invoices.attachment_name | string |
O nome do anexo. |
|
Pode enviar emails
|
invoices.can_send_in_mail | boolean |
Se pode enviar emails. |
|
ID do vendedor
|
invoices.salesperson_id | string |
O identificador do vendedor. |
|
Nome do vendedor
|
invoices.salesperson_name | string |
O nome do vendedor. |
|
URL
|
invoices.invoice_url | string |
O endereço da URL da fatura. |
Obter um contato
Recupere os detalhes de um contato existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contact_id | True | string |
O identificador de contato. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
|
ID de contato
|
contact.contact_id | string |
O identificador de contato. |
|
Nome do contato
|
contact.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
contact.company_name | string |
O nome da empresa. |
|
Tem transação
|
contact.has_transaction | boolean |
Se tem transação. |
|
Tipo de contato
|
contact.contact_type | string |
O tipo de contato. |
|
É tributável
|
contact.is_taxable | boolean |
Se é tributável. |
|
NIF
|
contact.tax_id | string |
O identificador de imposto. |
|
Nome do Imposto
|
contact.tax_name | string |
O nome do imposto. |
|
Percentual de Impostos
|
contact.tax_percentage | integer |
O percentual de imposto. |
|
ID da Autoridade Fiscal
|
contact.tax_authority_id | string |
O identificador da autoridade fiscal. |
|
ID de isenção de impostos
|
contact.tax_exemption_id | string |
O identificador de isenção fiscal. |
|
Nome da Autoridade Fiscal
|
contact.tax_authority_name | string |
O nome da autoridade fiscal. |
|
Código de isenção de impostos
|
contact.tax_exemption_code | string |
O código de isenção de impostos. |
|
Local de contato
|
contact.place_of_contact | string |
O local de contato. |
|
Número do GST
|
contact.gst_no | string |
O número do GST. |
|
Tratamento de IVA
|
contact.vat_treatment | string |
O tratamento do IVA. |
|
Tratamento GST
|
contact.gst_treatment | string |
O tratamento GST. |
|
Está vinculado ao Zoho CRM
|
contact.is_linked_with_zohocrm | boolean |
Se está vinculado ao Zoho CRM. |
|
Site
|
contact.website | string |
O site. |
|
ID do contato primário
|
contact.primary_contact_id | string |
O identificador de contato primário. |
|
Condições de Pagamento
|
contact.payment_terms | integer |
As condições de pagamento. |
|
Rótulo de Termos de Pagamento
|
contact.payment_terms_label | string |
O rótulo de termos de pagamento. |
|
ID da moeda
|
contact.currency_id | string |
O identificador de moeda. |
|
Código de moeda
|
contact.currency_code | string |
O código de moeda. |
|
Símbolo de moeda
|
contact.currency_symbol | string |
O símbolo de moeda. |
|
Valor de recebimento pendente
|
contact.outstanding_receivable_amount | double |
O valor a receber pendente. |
|
Bcy de valor a receber pendente
|
contact.outstanding_receivable_amount_bcy | double |
O valor de recebimento pendente do BCY. |
|
Valor a receber créditos não utilizados
|
contact.unused_credits_receivable_amount | double |
O valor a receber de créditos não utilizados. |
|
Valor a receber créditos não utilizados BCY
|
contact.unused_credits_receivable_amount_bcy | double |
O valor a receber de créditos não utilizados do BCY. |
|
Situação
|
contact.status | string |
O status. |
|
Facebook
|
contact.facebook | string |
A conta do Facebook. |
|
Twitter
|
contact.twitter | string |
O identificador do Twitter. |
|
Lembrete de pagamento habilitado
|
contact.payment_reminder_enabled | boolean |
Se o lembrete de pagamento está habilitado. |
|
Campo Personalizado
|
contact.custom_fields | array of object | |
|
Value
|
contact.custom_fields.value | string |
O valor do campo personalizado. |
|
Index
|
contact.custom_fields.index | integer |
O número do índice. |
|
Etiqueta
|
contact.custom_fields.label | string |
O rótulo. |
|
Atenção
|
contact.billing_address.attention | string |
O nome da atenção. |
|
Endereço
|
contact.billing_address.address | string |
O endereço. |
|
Rua
|
contact.billing_address.street2 | string |
O endereço da rua. |
|
Código de estado
|
contact.billing_address.state_code | string |
O código de estado. |
|
City
|
contact.billing_address.city | string |
A cidade. |
|
Estado
|
contact.billing_address.state | string |
O estado. |
|
Zip
|
contact.billing_address.zip | string |
O cep. |
|
País
|
contact.billing_address.country | string |
O país. |
|
Fac-símile
|
contact.billing_address.fax | string |
O número do fax. |
|
Telefone
|
contact.billing_address.phone | string |
O número de telefone. |
|
Atenção
|
contact.shipping_address.attention | string |
O nome da atenção. |
|
Endereço
|
contact.shipping_address.address | string |
O endereço. |
|
Rua
|
contact.shipping_address.street2 | string |
O endereço da rua. |
|
Código de estado
|
contact.shipping_address.state_code | string |
O código de estado. |
|
City
|
contact.shipping_address.city | string |
A cidade. |
|
Estado
|
contact.shipping_address.state | string |
O estado. |
|
Zip
|
contact.shipping_address.zip | string |
O cep. |
|
País
|
contact.shipping_address.country | string |
O país. |
|
Fac-símile
|
contact.shipping_address.fax | string |
O número do fax. |
|
Telefone
|
contact.shipping_address.phone | string |
O número de telefone. |
|
Pessoas de Contato
|
contact.contact_persons | array of object | |
|
Saudação
|
contact.contact_persons.salutation | string |
A saudação. |
|
Primeiro Nome
|
contact.contact_persons.first_name | string |
O nome. |
|
Apelido
|
contact.contact_persons.last_name | string |
O sobrenome. |
|
Email
|
contact.contact_persons.email | string |
O endereço de email. |
|
Telefone
|
contact.contact_persons.phone | string |
O número de telefone. |
|
Telemóvel
|
contact.contact_persons.mobile | string |
O número do celular. |
|
É o contato primário
|
contact.contact_persons.is_primary_contact | boolean |
Se é o contato primário. |
|
ID do modelo de fatura
|
contact.default_templates.invoice_template_id | string |
O identificador do modelo de fatura. |
|
Nome do modelo de fatura
|
contact.default_templates.invoice_template_name | string |
O nome do modelo de fatura. |
|
Estimar ID do modelo
|
contact.default_templates.estimate_template_id | string |
O identificador do modelo de estimativa. |
|
Estimar nome do modelo
|
contact.default_templates.estimate_template_name | string |
O nome do modelo de estimativa. |
|
ID do modelo de nota de crédito
|
contact.default_templates.creditnote_template_id | string |
O identificador do modelo de anotação de crédito. |
|
Nome do modelo de anotação de crédito
|
contact.default_templates.creditnote_template_name | string |
O nome do modelo de anotação de crédito. |
|
ID do modelo de email da fatura
|
contact.default_templates.invoice_email_template_id | string |
O identificador do modelo de email da fatura. |
|
Nome do modelo de email da fatura
|
contact.default_templates.invoice_email_template_name | string |
O nome do modelo de email da fatura. |
|
Estimar a ID do modelo de email
|
contact.default_templates.estimate_email_template_id | string |
O identificador do modelo de email de estimativa. |
|
Estimar o nome do modelo de email
|
contact.default_templates.estimate_email_template_name | string |
O nome do modelo de email de estimativa. |
|
ID do modelo de email da Nota de Crédito
|
contact.default_templates.creditnote_email_template_id | string |
O identificador do modelo de email de anotação de crédito. |
|
Nome do modelo de email da nota de crédito
|
contact.default_templates.creditnote_email_template_name | string |
O nome do modelo de email da nota de crédito. |
|
Anotações
|
contact.notes | string |
As anotações. |
|
Hora de Criação
|
contact.created_time | string |
A hora criada. |
|
Hora da Última Modificação
|
contact.last_modified_time | string |
A hora da última modificação. |
Obter uma fatura
Recuperar os detalhes de uma fatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de fatura
|
invoice_id | True | string |
O identificador da fatura. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
code | integer |
O código de status. |
|
Mensagem de status
|
message | string |
A mensagem de status. |
|
ID
|
invoice.invoice_id | string |
O identificador da fatura. |
|
Pagamento iniciado pela ACH
|
invoice.ach_payment_initiated | boolean |
Se o pagamento da ACH foi iniciado. |
|
Número
|
invoice.invoice_number | string |
O número da fatura. |
|
É pré-GST
|
invoice.is_pre_gst | boolean |
Se é pré-GST. |
|
Local de fornecimento
|
invoice.place_of_supply | string |
O local de fornecimento. |
|
Número do GST
|
invoice.gst_no | string |
O número do GST. |
|
Tratamento GST
|
invoice.gst_treatment | string |
O tratamento GST. |
|
Tratamento Tributário
|
invoice.tax_treatment | string |
O tratamento tributário. |
|
Uso do CFDI
|
invoice.cfdi_usage | string |
O uso do CFDI. |
|
Tratamento de IVA
|
invoice.vat_treatment | string |
O tratamento do IVA. |
|
Registro de IVA
|
invoice.vat_reg_no | string |
O número de registro do IVA. |
|
Date
|
invoice.date | string |
A data. |
|
Situação
|
invoice.status | string |
O status. |
|
Condições de Pagamento
|
invoice.payment_terms | integer |
As condições de pagamento. |
|
Rótulo de Termos de Pagamento
|
invoice.payment_terms_label | string |
O rótulo de termos de pagamento. |
|
Data de vencimento
|
invoice.due_date | string |
A data de conclusão. |
|
Data de pagamento esperada
|
invoice.payment_expected_date | string |
A data de pagamento esperada. |
|
Data do último pagamento
|
invoice.last_payment_date | string |
A última data de pagamento. |
|
Número de referência
|
invoice.reference_number | string |
O número de referência. |
|
ID do cliente
|
invoice.customer_id | string |
O identificador do cliente. |
|
Nome do cliente
|
invoice.customer_name | string |
O nome do cliente. |
|
Pessoas de Contato
|
invoice.contact_persons | array of string |
As pessoas de contato. |
|
ID da moeda
|
invoice.currency_id | string |
O identificador de moeda. |
|
Código de moeda
|
invoice.currency_code | string |
O código de moeda. |
|
Taxa de câmbio
|
invoice.exchange_rate | double |
A taxa de câmbio. |
|
Desconto
|
invoice.discount | double |
O desconto. |
|
É desconto antes do imposto
|
invoice.is_discount_before_tax | boolean |
Se o desconto é antes do imposto. |
|
Tipo de desconto
|
invoice.discount_type | string |
O tipo de desconto. |
|
É Tax Inclusive
|
invoice.is_inclusive_tax | boolean |
Se é inclusivo de impostos. |
|
ID da fatura recorrente
|
invoice.recurring_invoice_id | string |
O identificador de fatura recorrente. |
|
É exibido pelo cliente
|
invoice.is_viewed_by_client | boolean |
Se é exibido pelo cliente. |
|
Tem Anexo
|
invoice.has_attachment | boolean |
Se tem anexo. |
|
Tempo exibido pelo cliente
|
invoice.client_viewed_time | string |
O tempo exibido pelo cliente. |
|
Item de Linha
|
invoice.line_items | array of object | |
|
ID
|
invoice.line_items.line_item_id | string |
O identificador do item de linha. |
|
ID
|
invoice.line_items.item_id | string |
O identificador do item. |
|
ID do projeto
|
invoice.line_items.project_id | string |
O identificador do projeto. |
|
Nome do Projeto
|
invoice.line_items.project_name | string |
O nome do projeto. |
|
Tipo de Item
|
invoice.line_items.item_type | string |
O tipo de item. |
|
Tipo de Produto
|
invoice.line_items.product_type | string |
O tipo de produto. |
|
time_entry_ids
|
invoice.line_items.time_entry_ids | array of integer |
time_entry_ids |
|
ID de despesas
|
invoice.line_items.expense_id | string |
O identificador de despesas. |
|
Nome do Recibo de Despesa
|
invoice.line_items.expense_receipt_name | string |
O nome do recibo da despesa. |
|
Nome
|
invoice.line_items.name | string |
O nome. |
|
Description
|
invoice.line_items.description | string |
A descrição. |
|
Ordem do Item
|
invoice.line_items.item_order | integer |
A ordem do item. |
|
Taxa BCY
|
invoice.line_items.bcy_rate | double |
A taxa BCY. |
|
Rate
|
invoice.line_items.rate | double |
A taxa. |
|
Quantidade
|
invoice.line_items.quantity | double |
A quantidade. |
|
Unidade
|
invoice.line_items.unit | string |
A unidade. |
|
Valor do desconto
|
invoice.line_items.discount_amount | double |
O valor do desconto. |
|
Desconto
|
invoice.line_items.discount | double |
O desconto. |
|
ID
|
invoice.line_items.tax_id | string |
O identificador de imposto. |
|
ID do imposto TDS
|
invoice.line_items.tds_tax_id | string |
O identificador de imposto do TDS. |
|
Nome
|
invoice.line_items.tax_name | string |
O nome do imposto. |
|
Tipo de imposto
|
invoice.line_items.tax_type | string |
O tipo de imposto. |
|
Percentual de Impostos
|
invoice.line_items.tax_percentage | double |
O percentual de imposto. |
|
Total de Itens
|
invoice.line_items.item_total | double |
O total do item. |
|
Código da chave do item SAT
|
invoice.line_items.sat_item_key_code | integer |
O código de chave do item SAT. |
|
Código da chave de unidade
|
invoice.line_items.unitkey_code | string |
O código da chave de unidade. |
|
Encargo de envio
|
invoice.shipping_charge | double |
A carga de envio. |
|
Ajuste
|
invoice.adjustment | double |
O ajuste. |
|
Descrição do ajuste
|
invoice.adjustment_description | string |
A descrição do ajuste. |
|
Subtotal
|
invoice.sub_total | double |
O subtotal. |
|
Total de Impostos
|
invoice.tax_total | double |
O total de impostos. |
|
Total
|
invoice.total | double |
O total. |
|
Imposto
|
invoice.taxes | array of object | |
|
Nome
|
invoice.taxes.tax_name | string |
O nome do imposto. |
|
Quantidade
|
invoice.taxes.tax_amount | double |
O valor do imposto. |
|
Lembrete de pagamento habilitado
|
invoice.payment_reminder_enabled | boolean |
Se o lembrete de pagamento está habilitado. |
|
Pagamento Feito
|
invoice.payment_made | double |
O pagamento feito. |
|
Créditos aplicados
|
invoice.credits_applied | double |
Os créditos aplicados. |
|
Valor do imposto retido
|
invoice.tax_amount_withheld | double |
O valor do imposto retido. |
|
Saldo
|
invoice.balance | double |
O equilíbrio. |
|
Valor de desativação
|
invoice.write_off_amount | double |
A quantidade de desativação. |
|
Permitir pagamentos parciais
|
invoice.allow_partial_payments | boolean |
Se deseja permitir pagamentos parciais. |
|
Precisão de preço
|
invoice.price_precision | integer |
A precisão do preço. |
|
Gateway
|
invoice.payment_options.payment_gateways | array of object | |
|
Configurado
|
invoice.payment_options.payment_gateways.configured | boolean |
Se configurado. |
|
Campo Adicional
|
invoice.payment_options.payment_gateways.additional_field1 | string |
O campo adicional. |
|
Nome
|
invoice.payment_options.payment_gateways.gateway_name | string |
O nome do gateway. |
|
É enviado por email
|
invoice.is_emailed | boolean |
Se foi enviado por e-mail. |
|
Lembretes enviados
|
invoice.reminders_sent | integer |
O número de lembretes enviados. |
|
Data do Último Lembrete Enviado
|
invoice.last_reminder_sent_date | string |
A data do último lembrete enviado. |
|
Endereço
|
invoice.billing_address.address | string |
O endereço. |
|
City
|
invoice.billing_address.city | string |
A cidade. |
|
Estado
|
invoice.billing_address.state | string |
O estado. |
|
Zip
|
invoice.billing_address.zip | string |
O cep. |
|
País
|
invoice.billing_address.country | string |
O país. |
|
Fac-símile
|
invoice.billing_address.fax | string |
O número do fax. |
|
Endereço
|
invoice.shipping_address.address | string |
O endereço. |
|
City
|
invoice.shipping_address.city | string |
A cidade. |
|
Estado
|
invoice.shipping_address.state | string |
O estado. |
|
Zip
|
invoice.shipping_address.zip | string |
O cep. |
|
País
|
invoice.shipping_address.country | string |
O país. |
|
Fac-símile
|
invoice.shipping_address.fax | string |
O número do fax. |
|
Anotações
|
invoice.notes | string |
As anotações. |
|
Termos
|
invoice.terms | string |
Os termos. |
|
Campo Personalizado
|
invoice.custom_fields | array of object | |
|
ID
|
invoice.custom_fields.customfield_id | string |
O identificador de campo personalizado. |
|
Tipo de Dados
|
invoice.custom_fields.data_type | string |
O tipo de dados. |
|
Index
|
invoice.custom_fields.index | integer |
O número do índice. |
|
Etiqueta
|
invoice.custom_fields.label | string |
O rótulo. |
|
Mostrar em PDF
|
invoice.custom_fields.show_on_pdf | boolean |
Se deve ser exibido em PDF. |
|
Mostrar em todos os PDFs
|
invoice.custom_fields.show_in_all_pdf | boolean |
Se deve ser exibido em todos os PDFs. |
|
Value
|
invoice.custom_fields.value | double |
O valor do campo personalizado. |
|
ID do Modelo
|
invoice.template_id | string |
O identificador de modelo. |
|
Nome do Modelo
|
invoice.template_name | string |
O nome do modelo. |
|
Hora de Criação
|
invoice.created_time | string |
A hora criada. |
|
Hora da Última Modificação
|
invoice.last_modified_time | string |
A hora da última modificação. |
|
Nome do anexo
|
invoice.attachment_name | string |
O nome do anexo. |
|
Pode enviar emails
|
invoice.can_send_in_mail | boolean |
Se pode enviar emails. |
|
ID do vendedor
|
invoice.salesperson_id | string |
O identificador do vendedor. |
|
Nome do vendedor
|
invoice.salesperson_name | string |
O nome do vendedor. |
|
URL
|
invoice.invoice_url | string |
O endereço da URL da fatura. |