Partilhar via


Zoho Invoice Basic (Editora independente) (Visualização)

Personalize e crie faturas profissionais e seja pago pelo seu trabalho árduo. O Zoho Invoice é um software de gestão de faturas online para pequenas empresas que é fácil de usar e totalmente gratuito, para sempre.

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 Troia Taylor
URL https://www.troystaylor.com
Email troy@troystaylor.com
Metadados do conector
Editora Troia Taylor
Sítio Web https://www.zoho.com/us/invoice/
Política de privacidade https://www.zoho.com/privacy.html
Categorias Finanças; Vendas e CRM

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 Zoho cadeia (de caracteres) O identificador da organização Zoho para esta api Verdade
ID do Cliente cadeia (de caracteres) A ID do cliente para esta api Verdade
Segredo do Cliente securestring O segredo do cliente para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Atualizar um contacto

Atualiza um contato existente.

Atualizar uma fatura

Atualizar uma fatura existente. Para excluir um item de linha, basta removê-lo da lista de line_items.

Criar um contacto

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 tenham nota de pagamento ou de crédito aplicada não podem ser eliminadas.

Obter contactos

Recupere uma lista de todos os contatos com paginação.

Obter faturas

Recupere uma lista de faturas com paginação.

Obter um contacto

Recupere os detalhes de um contato existente.

Obter uma fatura

Recuperar os detalhes de uma fatura

Atualizar um contacto

Atualiza um contato existente.

Parâmetros

Name Chave Necessá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.

Sítio Web
website string

O sítio Web.

Valor
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.

Address
address string

O endereço.

Endereço 2
street2 string

O endereço 2.

Estado
state_code string

A abreviatura do estado.

City
city string

A cidade.

Estado
state string

O Estado.

Código Postal
zip string

O código postal.

Country
country string

O país.

Fax
fax string

O número de fax.

Telemóvel
phone string

O número de telefone.

Atenção
attention string

O nome da atenção.

Address
address string

O endereço.

Endereço 2
street2 string

O endereço 2.

Estado
state_code string

A abreviatura do estado.

City
city string

A cidade.

Estado
state string

O Estado.

Código Postal
zip string

O código postal.

Country
country string

O país.

Fax
fax string

O número de fax.

Telemóvel
phone string

O número de telefone.

Saudação
salutation string

A saudação.

Nome Próprio
first_name string

O primeiro nome.

Apelido
last_name string

O sobrenome.

Email
email string

O endereço de e-mail.

Telemóvel
phone string

O número de telefone.

Telemóvel
mobile string

O número de telemóvel.

É o contato principal
is_primary_contact boolean

Se é contato principal.

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.

ID do modelo de estimativa
estimate_template_id string

O identificador do modelo de estimativa.

Nome do modelo de estimativa
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 nota de crédito.

Nome do modelo de nota de crédito
creditnote_template_name string

O nome do modelo de nota de crédito.

ID do modelo de e-mail da fatura
invoice_email_template_id string

O identificador do modelo de e-mail da fatura.

Nome do modelo de e-mail da fatura
invoice_email_template_name string

O nome do modelo de e-mail da fatura.

Estimar ID do modelo de e-mail
estimate_email_template_id string

O identificador de modelo de e-mail estimado.

Estimar o nome do modelo de e-mail
estimate_email_template_name string

O nome do modelo de e-mail estimado.

ID do modelo de e-mail da nota de crédito
creditnote_email_template_id string

O identificador de modelo de e-mail da nota de crédito.

Nome do modelo de e-mail da nota de crédito
creditnote_email_template_name string

O nome do modelo de e-mail da nota de crédito.

Código do Idioma
language_code string

O código do idioma.

Observações
notes string

As notas.

Registo para efeitos de IVA
vat_reg_no string

O número de registo para efeitos de IVA.

Registo Fiscal
tax_reg_no string

O número de identificação fiscal.

Código do país
country_code string

O código do país.

Tratamento em sede de IVA
vat_treatment string

O tipo de tratamento em sede de IVA.

Tratamento fiscal
tax_treatment string

O tipo de tratamento fiscal.

Regime Fiscal
tax_regime string

O regime fiscal.

Denominação Legal
legal_name string

O nome legal.

A TDS está registada
is_tds_registered boolean

Se o TDS está registado.

Local De Contacto
place_of_contact string

O local de contacto.

Número do ICMS
gst_no string

O número do ICMS.

Tratamento de GST
gst_treatment string

O tipo de tratamento GST.

Nome da Autoridade Tributária
tax_authority_name string

O nome da autoridade fiscal.

Código de Isenção Fiscal
tax_exemption_code string

O código de isenção fiscal.

AvaTax Isento
avatax_exempt_no string

O número de isenção da AvaTax.

Código de Uso AvaTax
avatax_use_code string

O código de uso AvaTax.

ID de isenção fiscal
tax_exemption_id string

O identificador de isenção fiscal.

ID da Autoridade Tributária
tax_authority_id string

O identificador da autoridade fiscal.

NIF
tax_id string

O identificador de imposto.

CNPJ TDS
tds_tax_id string

O identificador de imposto TDS.

É tributável
is_taxable boolean

Se é tributável.

Facebook
facebook string

O nome de utilizador do Facebook.

Twitter
twitter string

O identificador do Twitter.

Devoluções

Name Caminho Tipo Description
Código de estado
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 Contacto
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.

CNPJ TDS
contact.tds_tax_id string

O identificador de imposto TDS.

Nome Fiscal
contact.tax_name string

O nome do imposto.

Percentagem de Imposto
contact.tax_percentage integer

A percentagem do imposto.

ID da Autoridade Tributária
contact.tax_authority_id string

O identificador da autoridade fiscal.

ID de isenção fiscal
contact.tax_exemption_id string

O identificador de isenção fiscal.

Nome da Autoridade Tributária
contact.tax_authority_name string

O nome da autoridade fiscal.

Código de Isenção Fiscal
contact.tax_exemption_code string

O código de isenção fiscal.

Local De Contacto
contact.place_of_contact string

O local de contacto.

Número do ICMS
contact.gst_no string

O número do ICMS.

Tratamento em sede de IVA
contact.vat_treatment string

O tratamento do IVA.

Tratamento fiscal
contact.tax_treatment string

O tratamento fiscal.

Regime Fiscal
contact.tax_regime string

O regime fiscal.

Denominação Legal
contact.legal_name string

O nome legal.

A TDS está registada
contact.is_tds_registered boolean

Se o TSD está registado.

Tratamento de GST
contact.gst_treatment string

O tratamento do GST.

Está vinculado ao Zoho CRM
contact.is_linked_with_zohocrm boolean

Se está vinculado ao Zoho CRM.

Sítio Web
contact.website string

O sítio Web.

ID de contato principal
contact.primary_contact_id string

O identificador de contato primário.

Condições de Pagamento
contact.payment_terms integer

As condições de pagamento.

Etiqueta de Condições de Pagamento
contact.payment_terms_label string

A etiqueta de condições de pagamento.

ID da moeda
contact.currency_id string

O identificador de moeda.

Código de Moeda
contact.currency_code string

O código da moeda.

Símbolo da moeda
contact.currency_symbol string

O símbolo da moeda.

Código do Idioma
contact.language_code string

O código do idioma.

Valor a Receber
contact.outstanding_receivable_amount double

O montante a receber pendente.

Valor a Receber BCY
contact.outstanding_receivable_amount_bcy double

O montante a receber pendente do BCY.

Créditos não utilizados Montante a receber
contact.unused_credits_receivable_amount double

O montante a receber dos créditos não utilizados.

Créditos não utilizados Montante a receber BCY
contact.unused_credits_receivable_amount_bcy double

O montante a receber dos créditos não utilizados do BCY.

Situação
contact.status string

O status.

Lembrete de pagamento ativado
contact.payment_reminder_enabled boolean

Se o lembrete de pagamento está ativado.

Campo Personalizado
contact.custom_fields array of object
Valor
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.

Address
contact.billing_address.address string

O endereço.

Rua
contact.billing_address.street2 string

O endereço.

Código do Estado
contact.billing_address.state_code string

O código do estado.

City
contact.billing_address.city string

A cidade.

Estado
contact.billing_address.state string

O Estado.

Código Postal
contact.billing_address.zip string

O código postal.

Country
contact.billing_address.country string

O país.

Fax
contact.billing_address.fax string

O número de fax.

Telemóvel
contact.billing_address.phone string

O número de telefone.

Atenção
contact.shipping_address.attention string

O nome da atenção.

Address
contact.shipping_address.address string

O endereço.

Rua
contact.shipping_address.street2 string

O endereço.

Código do Estado
contact.shipping_address.state_code string

O código do estado.

City
contact.shipping_address.city string

A cidade.

Estado
contact.shipping_address.state string

O Estado.

Código Postal
contact.shipping_address.zip string

O código postal.

Country
contact.shipping_address.country string

O país.

Fax
contact.shipping_address.fax string

O número de fax.

Telemóvel
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 Contacto
contact.contact_persons array of object
Saudação
contact.contact_persons.salutation string

A saudação.

Nome Próprio
contact.contact_persons.first_name string

O primeiro nome.

Apelido
contact.contact_persons.last_name string

O sobrenome.

Email
contact.contact_persons.email string

O endereço de e-mail.

Telemóvel
contact.contact_persons.phone string

O número de telefone.

Telemóvel
contact.contact_persons.mobile string

O número de telemóvel.

É o contato principal
contact.contact_persons.is_primary_contact boolean

Se é contato principal.

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.

ID do modelo de estimativa
contact.default_templates.estimate_template_id string

O identificador do modelo de estimativa.

Nome do modelo de estimativa
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 nota de crédito.

Nome do modelo de nota de crédito
contact.default_templates.creditnote_template_name string

O nome do modelo de nota de crédito.

ID do modelo de e-mail da fatura
contact.default_templates.invoice_email_template_id string

O identificador do modelo de e-mail da fatura.

Nome do modelo de e-mail da fatura
contact.default_templates.invoice_email_template_name string

O nome do modelo de e-mail da fatura.

Estimar ID do modelo de e-mail
contact.default_templates.estimate_email_template_id string

O identificador de modelo de e-mail estimado.

Estimar o nome do modelo de e-mail
contact.default_templates.estimate_email_template_name string

O nome do modelo de e-mail estimado.

ID do modelo de e-mail da nota de crédito
contact.default_templates.creditnote_email_template_id string

O identificador de modelo de e-mail da nota de crédito.

Nome do modelo de e-mail da nota de crédito
contact.default_templates.creditnote_email_template_name string

O nome do modelo de e-mail da nota de crédito.

Observações
contact.notes string

As notas.

Tempo de Criação
contact.created_time string

O tempo criado.

Hora da última modificação
contact.last_modified_time string

A última hora modificada.

Atualizar uma fatura

Atualizar uma fatura existente. Para excluir um item de linha, basta removê-lo da lista de line_items.

Parâmetros

Name Chave Necessário Tipo Description
Identificador da fatura
invoice_id True string

O identificador da fatura.

ID do Cliente
customer_id string

O identificador do cliente.

Pessoa de Contacto
contact_persons array of integer

A pessoa de contacto.

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 lugar da prestação.

Tratamento do IVA
vat_treatment string

O tratamento do IVA.

Tratamento de GST
gst_treatment string

O tratamento do GST.

Tratamento fiscal
tax_treatment string

O tratamento fiscal.

Uso de CFDI
cfdi_usage string

O uso de CFDI.

Número do ICMS
gst_no string

O número do ICMS.

ID do modelo
template_id string

O identificador do modelo.

Date
date string

A data.

Condições de Pagamento
payment_terms integer

As condições de pagamento.

Etiqueta de Condições de Pagamento
payment_terms_label string

A etiqueta de condições de pagamento.

Data Para Conclusão
due_date string

A data de vencimento.

Discount
discount float

O desconto.

É desconto antes de impostos
is_discount_before_tax boolean

Se o desconto é antes de impostos.

Tipo de desconto
discount_type string

O tipo de desconto.

É um imposto inclusivo
is_inclusive_tax boolean

Se inclui 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 do orçamento faturado
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.

Valor
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 tempo.

ID da despesa
expense_id string

O identificador de despesa.

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 de chave de item SAT
sat_item_key_code integer

O código de chave do item SAT.

Código da chave da unidade
unitkey_code string

O código da chave da unidade.

Description
description string

A descrição.

Encomenda
item_order integer

A ordem dos itens.

Tarifa
rate float

A taxa.

Quantidade
quantity double

A quantidade.

Unidade
unit string

A unidade.

Discount
discount float

O desconto.

NIF
tax_id string

O identificador de imposto.

CNPJ TDS
tds_tax_id string

O identificador de imposto TDS.

ID de isenção fiscal
tax_exemption_id string

O identificador de isenção fiscal.

Código de Uso AvaTax
avatax_use_code string

O código de uso AvaTax.

AvaTax Isenta Não
avatax_exempt_no string

O número de isenção da AvaTax.

Nome Fiscal
tax_name string

O nome do imposto.

Tipo de Imposto
tax_type string

O tipo de imposto.

Percentagem de Imposto
tax_percentage float

A percentagem do 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

Permitir ou não pagamentos parciais.

Corpo personalizado
custom_body string

O corpo personalizado.

Assunto personalizado
custom_subject string

O assunto personalizado.

Observações
notes string

As notas.

Terms
terms string

Os termos.

Taxa de envio
shipping_charge float

O custo de envio.

Ajustamento
adjustment float

O ajuste.

Descrição do ajuste
adjustment_description string

A descrição do ajuste.

Reason
reason string

O motivo.

ID da Autoridade Tributária
tax_authority_id string

O identificador da autoridade fiscal.

ID de isenção fiscal
tax_exemption_id string

O identificador de isenção fiscal.

Código de Uso AvaTax
avatax_use_code string

O código de uso AvaTax.

Código AvaTax
avatax_tax_code string

O código AvaTax .

Número de isenção AvaTax
avatax_exempt_no string

O número de isenção da AvaTax.

Devoluções

Name Caminho Tipo Description
Código de estado
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 ACH Iniciado
invoice.ach_payment_initiated boolean

Se o pagamento 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 lugar da prestação.

Número do ICMS
invoice.gst_no string

O número do ICMS.

Tratamento de GST
invoice.gst_treatment string

O tratamento do GST.

Tratamento fiscal
invoice.tax_treatment string

O tratamento fiscal.

Uso de CFDI
invoice.cfdi_usage string

O uso de CFDI.

Tratamento em sede de IVA
invoice.vat_treatment string

O tratamento do IVA.

Registo para efeitos de IVA
invoice.vat_reg_no string

O número de registo para efeitos de 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.

Etiqueta de Condições de Pagamento
invoice.payment_terms_label string

A etiqueta de condições de pagamento.

Data Para Conclusão
invoice.due_date string

A data de vencimento.

Data prevista de pagamento
invoice.payment_expected_date string

A data prevista para o pagamento.

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 Contacto
invoice.contact_persons array of string

As pessoas de contacto.

ID da moeda
invoice.currency_id string

O identificador de moeda.

Código de Moeda
invoice.currency_code string

O código da moeda.

Taxa de Câmbio
invoice.exchange_rate double

A taxa de câmbio.

Discount
invoice.discount double

O desconto.

É desconto antes de impostos
invoice.is_discount_before_tax boolean

Se o desconto é antes de impostos.

Tipo de desconto
invoice.discount_type string

O tipo de desconto.

É Fiscal Inclusivo
invoice.is_inclusive_tax boolean

Se inclui impostos.

ID da fatura recorrente
invoice.recurring_invoice_id string

O identificador de fatura recorrente.

É visualizado pelo cliente
invoice.is_viewed_by_client boolean

Se é visualizado pelo cliente.

Tem Acessório
invoice.has_attachment boolean

Se tem apego.

Tempo de visualização do cliente
invoice.client_viewed_time string

O cliente visualizou o tempo.

Item de linha
invoice.line_items array of object
ID
invoice.line_items.line_item_id string

O identificador de 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 da despesa
invoice.line_items.expense_id string

O identificador de despesa.

Nome do recibo de despesa
invoice.line_items.expense_receipt_name string

O nome do recibo de 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 dos itens.

Taxa BCY
invoice.line_items.bcy_rate double

A taxa BCY.

Tarifa
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.

Discount
invoice.line_items.discount double

O desconto.

ID
invoice.line_items.tax_id string

O identificador de imposto.

CNPJ TDS
invoice.line_items.tds_tax_id string

O identificador de imposto 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.

Percentagem de Imposto
invoice.line_items.tax_percentage double

A percentagem do imposto.

Item Total
invoice.line_items.item_total double

O total do item.

Código de chave de item SAT
invoice.line_items.sat_item_key_code integer

O código de chave do item SAT.

Código da chave da unidade
invoice.line_items.unitkey_code string

O código da chave da unidade.

Taxa de envio
invoice.shipping_charge double

O custo de envio.

Ajustamento
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 do imposto.

Total
invoice.total double

O total.

Imposto
invoice.taxes array of object
Nome
invoice.taxes.tax_name string

O nome do imposto.

Montante
invoice.taxes.tax_amount double

O valor do imposto.

Lembrete de pagamento ativado
invoice.payment_reminder_enabled boolean

Se o lembrete de pagamento está ativado.

Pagamento Efetuado
invoice.payment_made double

O pagamento efetuado.

Créditos Aplicados
invoice.credits_applied double

Os créditos aplicados.

Valor do imposto retido na fonte
invoice.tax_amount_withheld double

O valor do imposto retido na fonte.

Equilíbrio
invoice.balance double

O equilíbrio.

Valor de amortização
invoice.write_off_amount double

O valor da amortização.

Permitir pagamentos parciais
invoice.allow_partial_payments boolean

Permitir ou não 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 e-mail
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.

Address
invoice.billing_address.address string

O endereço.

City
invoice.billing_address.city string

A cidade.

Estado
invoice.billing_address.state string

O Estado.

Código Postal
invoice.billing_address.zip string

O código postal.

Country
invoice.billing_address.country string

O país.

Fax
invoice.billing_address.fax string

O número de fax.

Address
invoice.shipping_address.address string

O endereço.

City
invoice.shipping_address.city string

A cidade.

Estado
invoice.shipping_address.state string

O Estado.

Código Postal
invoice.shipping_address.zip string

O código postal.

Country
invoice.shipping_address.country string

O país.

Fax
invoice.shipping_address.fax string

O número de fax.

Observações
invoice.notes string

As notas.

Terms
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 deseja ser exibido em PDF.

Mostrar em todos os PDFs
invoice.custom_fields.show_in_all_pdf boolean

Se deseja ser exibido em todos os PDFs.

Valor
invoice.custom_fields.value double

O valor do campo personalizado.

ID do modelo
invoice.template_id string

O identificador do modelo.

Nome do Modelo
invoice.template_name string

O nome do modelo.

Tempo de Criação
invoice.created_time string

O tempo criado.

Hora da última modificação
invoice.last_modified_time string

A última hora modificada.

Nome do anexo
invoice.attachment_name string

O nome do anexo.

Pode enviar por correio
invoice.can_send_in_mail boolean

Se pode enviar por correio.

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 URL da fatura.

Criar um contacto

Cria um novo contato.

Parâmetros

Name Chave Necessá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.

Sítio Web
website string

O sítio Web.

Valor
value string

O valor do campo personalizado.

Index
index integer

O número do índice.

Atenção
attention string

O nome da atenção.

Address
address string

O endereço.

Endereço 2
street2 string

O endereço 2.

Estado
state_code string

A abreviatura do estado.

City
city string

A cidade.

Estado
state string

O Estado.

Código Postal
zip string

O código postal.

Country
country string

O país.

Fax
fax string

O número de fax.

Telemóvel
phone string

O número de telefone.

Atenção
attention string

O nome da atenção.

Address
address string

O endereço.

Endereço 2
street2 string

O endereço 2.

Estado
state_code string

A abreviatura do estado.

City
city string

A cidade.

Estado
state string

O Estado.

Código Postal
zip string

O código postal.

Country
country string

O país.

Fax
fax string

O número de fax.

Telemóvel
phone string

O número de telefone.

Saudação
salutation string

A saudação.

Nome Próprio
first_name string

O primeiro nome.

Apelido
last_name string

O sobrenome.

Email
email string

O endereço de e-mail.

Telemóvel
phone string

O número de telefone.

Telemóvel
mobile string

O número de telemóvel.

É o contato principal
is_primary_contact boolean

Se é contato principal.

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.

ID do modelo de estimativa
estimate_template_id string

O identificador do modelo de estimativa.

Nome do modelo de estimativa
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 nota de crédito.

Nome do modelo de nota de crédito
creditnote_template_name string

O nome do modelo de nota de crédito.

ID do modelo de e-mail da fatura
invoice_email_template_id string

O identificador do modelo de e-mail da fatura.

Nome do modelo de e-mail da fatura
invoice_email_template_name string

O nome do modelo de e-mail da fatura.

Estimar ID do modelo de e-mail
estimate_email_template_id string

O identificador de modelo de e-mail estimado.

Estimar o nome do modelo de e-mail
estimate_email_template_name string

O nome do modelo de e-mail estimado.

ID do modelo de e-mail da nota de crédito
creditnote_email_template_id string

O identificador de modelo de e-mail da nota de crédito.

Nome do modelo de e-mail da nota de crédito
creditnote_email_template_name string

O nome do modelo de e-mail da nota de crédito.

Código do Idioma
language_code string

O código do idioma.

Observações
notes string

As notas.

Registo para efeitos de IVA
vat_reg_no string

O número de registo para efeitos de IVA.

Registo Fiscal
tax_reg_no string

O número de identificação fiscal.

Código do país
country_code string

O código do país.

Tratamento em sede de IVA
vat_treatment string

O tipo de tratamento em sede de IVA.

Tratamento fiscal
tax_treatment string

O tipo de tratamento fiscal.

Regime Fiscal
tax_regime string

O regime fiscal.

Denominação Legal
legal_name string

O nome legal.

A TDS está registada
is_tds_registered boolean

Se o TDS está registado.

Local De Contacto
place_of_contact string

O local de contacto.

Número do ICMS
gst_no string

O número do ICMS.

Tratamento de GST
gst_treatment string

O tipo de tratamento GST.

Nome da Autoridade Tributária
tax_authority_name string

O nome da autoridade fiscal.

Código de Isenção Fiscal
tax_exemption_code string

O código de isenção fiscal.

AvaTax Isento
avatax_exempt_no string

O número de isenção da AvaTax.

Código de Uso AvaTax
avatax_use_code string

O código de uso AvaTax.

ID de isenção fiscal
tax_exemption_id string

O identificador de isenção fiscal.

ID da Autoridade Tributária
tax_authority_id string

O identificador da autoridade fiscal.

NIF
tax_id string

O identificador de imposto.

CNPJ TDS
tds_tax_id string

O identificador de imposto TDS.

É tributável
is_taxable boolean

Se é tributável.

Facebook
facebook string

O nome de utilizador do Facebook.

Twitter
twitter string

O identificador do Twitter.

Devoluções

Name Caminho Tipo Description
Código de estado
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 Contacto
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.

CNPJ TDS
contact.tds_tax_id string

O identificador de imposto TDS.

Nome Fiscal
contact.tax_name string

O nome do imposto.

Percentagem de Imposto
contact.tax_percentage integer

A percentagem do imposto.

ID da Autoridade Tributária
contact.tax_authority_id string

O identificador da autoridade fiscal.

ID de isenção fiscal
contact.tax_exemption_id string

O identificador de isenção fiscal.

Nome da Autoridade Tributária
contact.tax_authority_name string

O nome da autoridade fiscal.

Código de Isenção Fiscal
contact.tax_exemption_code string

O código de isenção fiscal.

Local De Contacto
contact.place_of_contact string

O local de contacto.

Número do ICMS
contact.gst_no string

O número do ICMS.

Tratamento em sede de IVA
contact.vat_treatment string

O tratamento do IVA.

Tratamento fiscal
contact.tax_treatment string

O tratamento fiscal.

Regime Fiscal
contact.tax_regime string

O regime fiscal.

Denominação Legal
contact.legal_name string

O nome legal.

A TDS está registada
contact.is_tds_registered boolean

Se o TSD está registado.

Tratamento de GST
contact.gst_treatment string

O tratamento do GST.

Está vinculado ao Zoho CRM
contact.is_linked_with_zohocrm boolean

Se está vinculado ao Zoho CRM.

Sítio Web
contact.website string

O sítio Web.

ID de contato principal
contact.primary_contact_id string

O identificador de contato primário.

Condições de Pagamento
contact.payment_terms integer

As condições de pagamento.

Etiqueta de Condições de Pagamento
contact.payment_terms_label string

A etiqueta de condições de pagamento.

ID da moeda
contact.currency_id string

O identificador de moeda.

Código de Moeda
contact.currency_code string

O código da moeda.

Símbolo da moeda
contact.currency_symbol string

O símbolo da moeda.

Código do Idioma
contact.language_code string

O código do idioma.

Valor a Receber
contact.outstanding_receivable_amount double

O montante a receber pendente.

Valor a Receber BCY
contact.outstanding_receivable_amount_bcy double

O montante a receber pendente do BCY.

Créditos não utilizados Montante a receber
contact.unused_credits_receivable_amount double

O montante a receber dos créditos não utilizados.

Créditos não utilizados Montante a receber BCY
contact.unused_credits_receivable_amount_bcy double

O montante a receber dos créditos não utilizados do BCY.

Situação
contact.status string

O status.

Lembrete de pagamento ativado
contact.payment_reminder_enabled boolean

Se o lembrete de pagamento está ativado.

Campo Personalizado
contact.custom_fields array of object
Valor
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.

Address
contact.billing_address.address string

O endereço.

Rua
contact.billing_address.street2 string

O endereço.

Código do Estado
contact.billing_address.state_code string

O código do estado.

City
contact.billing_address.city string

A cidade.

Estado
contact.billing_address.state string

O Estado.

Código Postal
contact.billing_address.zip string

O código postal.

Country
contact.billing_address.country string

O país.

Fax
contact.billing_address.fax string

O número de fax.

Telemóvel
contact.billing_address.phone string

O número de telefone.

Atenção
contact.shipping_address.attention string

O nome da atenção.

Address
contact.shipping_address.address string

O endereço.

Rua
contact.shipping_address.street2 string

O endereço.

Código do Estado
contact.shipping_address.state_code string

O código do estado.

City
contact.shipping_address.city string

A cidade.

Estado
contact.shipping_address.state string

O Estado.

Código Postal
contact.shipping_address.zip string

O código postal.

Country
contact.shipping_address.country string

O país.

Fax
contact.shipping_address.fax string

O número de fax.

Telemóvel
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 Contacto
contact.contact_persons array of object
Saudação
contact.contact_persons.salutation string

A saudação.

Nome Próprio
contact.contact_persons.first_name string

O primeiro nome.

Apelido
contact.contact_persons.last_name string

O sobrenome.

Email
contact.contact_persons.email string

O endereço de e-mail.

Telemóvel
contact.contact_persons.phone string

O número de telefone.

Telemóvel
contact.contact_persons.mobile string

O número de telemóvel.

É o contato principal
contact.contact_persons.is_primary_contact boolean

Se é contato principal.

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.

ID do modelo de estimativa
contact.default_templates.estimate_template_id string

O identificador do modelo de estimativa.

Nome do modelo de estimativa
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 nota de crédito.

Nome do modelo de nota de crédito
contact.default_templates.creditnote_template_name string

O nome do modelo de nota de crédito.

ID do modelo de e-mail da fatura
contact.default_templates.invoice_email_template_id string

O identificador do modelo de e-mail da fatura.

Nome do modelo de e-mail da fatura
contact.default_templates.invoice_email_template_name string

O nome do modelo de e-mail da fatura.

Estimar ID do modelo de e-mail
contact.default_templates.estimate_email_template_id string

O identificador de modelo de e-mail estimado.

Estimar o nome do modelo de e-mail
contact.default_templates.estimate_email_template_name string

O nome do modelo de e-mail estimado.

ID do modelo de e-mail da nota de crédito
contact.default_templates.creditnote_email_template_id string

O identificador de modelo de e-mail da nota de crédito.

Nome do modelo de e-mail da nota de crédito
contact.default_templates.creditnote_email_template_name string

O nome do modelo de e-mail da nota de crédito.

Observações
contact.notes string

As notas.

Tempo de Criação
contact.created_time string

O tempo criado.

Hora da última modificação
contact.last_modified_time string

A última hora modificada.

Criar uma fatura

Cria uma fatura para um cliente.

Parâmetros

Name Chave Necessário Tipo Description
Enviar
send boolean

Se deseja enviar a fatura.

Ignorar a geração automática de números
ignore_auto_number_generation boolean

Se deve ignorar a geração automática de números.

ID do Cliente
customer_id string

O identificador do cliente.

Pessoa de Contacto
contact_persons array of integer

A pessoa de contacto.

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 lugar da prestação.

Tratamento do IVA
vat_treatment string

O tratamento do IVA.

Tratamento de GST
gst_treatment string

O tratamento do GST.

Tratamento fiscal
tax_treatment string

O tratamento fiscal.

Uso de CFDI
cfdi_usage string

O uso de CFDI.

Número do ICMS
gst_no string

O número do ICMS.

ID do modelo
template_id string

O identificador do modelo.

Date
date string

A data.

Condições de Pagamento
payment_terms integer

As condições de pagamento.

Etiqueta de Condições de Pagamento
payment_terms_label string

A etiqueta de condições de pagamento.

Data Para Conclusão
due_date string

A data de vencimento.

Discount
discount float

O desconto.

É desconto antes de impostos
is_discount_before_tax boolean

Se o desconto é antes de impostos.

Tipo de desconto
discount_type string

O tipo de desconto.

É um imposto inclusivo
is_inclusive_tax boolean

Se inclui 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 do orçamento faturado
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.

Valor
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 tempo.

ID da despesa
expense_id string

O identificador de despesa.

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 de chave de item SAT
sat_item_key_code integer

O código de chave do item SAT.

Código da chave da unidade
unitkey_code string

O código da chave da unidade.

Description
description string

A descrição.

Encomenda
item_order integer

A ordem dos itens.

Tarifa
rate float

A taxa.

Quantidade
quantity double

A quantidade.

Unidade
unit string

A unidade.

Discount
discount float

O desconto.

NIF
tax_id string

O identificador de imposto.

CNPJ TDS
tds_tax_id string

O identificador de imposto TDS.

ID de isenção fiscal
tax_exemption_id string

O identificador de isenção fiscal.

Código de Uso AvaTax
avatax_use_code string

O código de uso AvaTax.

AvaTax Isenta Não
avatax_exempt_no string

O número de isenção da AvaTax.

Nome Fiscal
tax_name string

O nome do imposto.

Tipo de Imposto
tax_type string

O tipo de imposto.

Percentagem de Imposto
tax_percentage float

A percentagem do 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

Permitir ou não pagamentos parciais.

Corpo personalizado
custom_body string

O corpo personalizado.

Assunto personalizado
custom_subject string

O assunto personalizado.

Observações
notes string

As notas.

Terms
terms string

Os termos.

Taxa de envio
shipping_charge float

O custo de envio.

Ajustamento
adjustment float

O ajuste.

Descrição do ajuste
adjustment_description string

A descrição do ajuste.

Reason
reason string

O motivo.

ID da Autoridade Tributária
tax_authority_id string

O identificador da autoridade fiscal.

ID de isenção fiscal
tax_exemption_id string

O identificador de isenção fiscal.

Código de Uso AvaTax
avatax_use_code string

O código de uso AvaTax.

Código AvaTax
avatax_tax_code string

O código AvaTax .

Número de isenção AvaTax
avatax_exempt_no string

O número de isenção da AvaTax.

Devoluções

Name Caminho Tipo Description
Código de estado
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 ACH Iniciado
invoice.ach_payment_initiated boolean

Se o pagamento 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 lugar da prestação.

Número do ICMS
invoice.gst_no string

O número do ICMS.

Tratamento de GST
invoice.gst_treatment string

O tratamento do GST.

Tratamento fiscal
invoice.tax_treatment string

O tratamento fiscal.

Uso de CFDI
invoice.cfdi_usage string

O uso de CFDI.

Tratamento em sede de IVA
invoice.vat_treatment string

O tratamento do IVA.

Registo para efeitos de IVA
invoice.vat_reg_no string

O número de registo para efeitos de 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.

Etiqueta de Condições de Pagamento
invoice.payment_terms_label string

A etiqueta de condições de pagamento.

Data Para Conclusão
invoice.due_date string

A data de vencimento.

Data prevista de pagamento
invoice.payment_expected_date string

A data prevista para o pagamento.

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 Contacto
invoice.contact_persons array of string

As pessoas de contacto.

ID da moeda
invoice.currency_id string

O identificador de moeda.

Código de Moeda
invoice.currency_code string

O código da moeda.

Taxa de Câmbio
invoice.exchange_rate double

A taxa de câmbio.

Discount
invoice.discount double

O desconto.

É desconto antes de impostos
invoice.is_discount_before_tax boolean

Se o desconto é antes de impostos.

Tipo de desconto
invoice.discount_type string

O tipo de desconto.

É Fiscal Inclusivo
invoice.is_inclusive_tax boolean

Se inclui impostos.

ID da fatura recorrente
invoice.recurring_invoice_id string

O identificador de fatura recorrente.

É visualizado pelo cliente
invoice.is_viewed_by_client boolean

Se é visualizado pelo cliente.

Tem Acessório
invoice.has_attachment boolean

Se tem apego.

Tempo de visualização do cliente
invoice.client_viewed_time string

O cliente visualizou o tempo.

Item de linha
invoice.line_items array of object
ID
invoice.line_items.line_item_id string

O identificador de 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 da despesa
invoice.line_items.expense_id string

O identificador de despesa.

Nome do recibo de despesa
invoice.line_items.expense_receipt_name string

O nome do recibo de 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 dos itens.

Taxa BCY
invoice.line_items.bcy_rate double

A taxa BCY.

Tarifa
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.

Discount
invoice.line_items.discount double

O desconto.

ID
invoice.line_items.tax_id string

O identificador de imposto.

CNPJ TDS
invoice.line_items.tds_tax_id string

O identificador de imposto 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.

Percentagem de Imposto
invoice.line_items.tax_percentage double

A percentagem do imposto.

Item Total
invoice.line_items.item_total double

O total do item.

Código de chave de item SAT
invoice.line_items.sat_item_key_code integer

O código de chave do item SAT.

Código da chave da unidade
invoice.line_items.unitkey_code string

O código da chave da unidade.

Taxa de envio
invoice.shipping_charge double

O custo de envio.

Ajustamento
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 do imposto.

Total
invoice.total double

O total.

Imposto
invoice.taxes array of object
Nome
invoice.taxes.tax_name string

O nome do imposto.

Montante
invoice.taxes.tax_amount double

O valor do imposto.

Lembrete de pagamento ativado
invoice.payment_reminder_enabled boolean

Se o lembrete de pagamento está ativado.

Pagamento Efetuado
invoice.payment_made double

O pagamento efetuado.

Créditos Aplicados
invoice.credits_applied double

Os créditos aplicados.

Valor do imposto retido na fonte
invoice.tax_amount_withheld double

O valor do imposto retido na fonte.

Equilíbrio
invoice.balance double

O equilíbrio.

Valor de amortização
invoice.write_off_amount double

O valor da amortização.

Permitir pagamentos parciais
invoice.allow_partial_payments boolean

Permitir ou não 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 e-mail
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.

Address
invoice.billing_address.address string

O endereço.

City
invoice.billing_address.city string

A cidade.

Estado
invoice.billing_address.state string

O Estado.

Código Postal
invoice.billing_address.zip string

O código postal.

Country
invoice.billing_address.country string

O país.

Fax
invoice.billing_address.fax string

O número de fax.

Address
invoice.shipping_address.address string

O endereço.

City
invoice.shipping_address.city string

A cidade.

Estado
invoice.shipping_address.state string

O Estado.

Código Postal
invoice.shipping_address.zip string

O código postal.

Country
invoice.shipping_address.country string

O país.

Fax
invoice.shipping_address.fax string

O número de fax.

Observações
invoice.notes string

As notas.

Terms
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 deseja ser exibido em PDF.

Mostrar em todos os PDFs
invoice.custom_fields.show_in_all_pdf boolean

Se deseja ser exibido em todos os PDFs.

Valor
invoice.custom_fields.value double

O valor do campo personalizado.

ID do modelo
invoice.template_id string

O identificador do modelo.

Nome do Modelo
invoice.template_name string

O nome do modelo.

Tempo de Criação
invoice.created_time string

O tempo criado.

Hora da última modificação
invoice.last_modified_time string

A última hora modificada.

Nome do anexo
invoice.attachment_name string

O nome do anexo.

Pode enviar por correio
invoice.can_send_in_mail boolean

Se pode enviar por correio.

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 URL da fatura.

Excluir um contato

Exclui um contato existente.

Parâmetros

Name Chave Necessário Tipo Description
ID de contato
contact_id True string

O identificador de contato.

Devoluções

Name Caminho Tipo Description
Código de estado
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 tenham nota de pagamento ou de crédito aplicada não podem ser eliminadas.

Parâmetros

Name Chave Necessário Tipo Description
Identificador da fatura
invoice_id True string

O identificador da fatura.

Devoluções

Name Caminho Tipo Description
Código de estado
code integer

O código de status.

Mensagem de status
message string

A mensagem de status.

Obter contactos

Recupere uma lista de todos os contatos com paginação.

Parâmetros

Name Chave Necessário Tipo Description
Nome do contato
contact_name string

O nome do contato.

ID da Empresa
company_name string

O identificador da empresa.

Nome Próprio
first_name string

O primeiro nome.

Último Nam
last_name string

O sobrenome.

Address
address string

O endereço.

Email
email string

O endereço de e-mail.

Telemóvel
phone string

O endereço telefónico.

Filtrar por
filter_by string

O filtro por.

Pesquisar Texto
search_text string

O texto da pesquisa.

Coluna Ordenar
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 de 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.

Devoluções

Name Caminho Tipo Description
Código de estado
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 Contacto
contact.contact_type string

O tipo de contato.

Condições de Pagamento
contact.payment_terms integer

As condições de pagamento.

Etiqueta de Condições de Pagamento
contact.payment_terms_label string

A etiqueta de condições de pagamento.

ID da moeda
contact.currency_id string

O identificador de moeda.

Código de Moeda
contact.currency_code string

O código da moeda.

Valor a Receber
contact.outstanding_receivable_amount double

O montante a receber pendente.

Créditos não utilizados Montante a receber
contact.unused_credits_receivable_amount double

O montante a receber dos créditos não utilizados.

Situação
contact.status string

O status.

Tempo de Criação
contact.created_time string

O tempo criado.

Hora da última modificação
contact.last_modified_time string

A última hora modificada.

Obter faturas

Recupere uma lista de faturas com paginação.

Parâmetros

Name Chave Necessá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
email string

O endereço de e-mail.

Total
total string

O total.

Equilíbrio
balance string

O equilíbrio.

Campo Personalizado
custom_field string

O campo personalizado.

Date
date string

A data.

Data Para Conclusão
due_date string

A data de vencimento.

Situação
status string

O status.

ID personalizado
customer_id string

O identificador personalizado.

Filtrar por
filter_by string

O filtro por.

Pesquisar Texto
search_text string

O texto da pesquisa.

Coluna Ordenar
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.

Devoluções

Name Caminho Tipo Description
Código de estado
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 ACH Iniciado
invoices.ach_payment_initiated boolean

Se o pagamento 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 lugar da prestação.

Número do ICMS
invoices.gst_no string

O número do ICMS.

Tratamento de GST
invoices.gst_treatment string

O tratamento do GST.

Tratamento fiscal
invoices.tax_treatment string

O tratamento fiscal.

Uso de CFDI
invoices.cfdi_usage string

O uso de CFDI.

Tratamento em sede de IVA
invoices.vat_treatment string

O tratamento do IVA.

Registo para efeitos de IVA
invoices.vat_reg_no string

O número de registo para efeitos de 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.

Etiqueta de Condições de Pagamento
invoices.payment_terms_label string

A etiqueta de condições de pagamento.

Data Para Conclusão
invoices.due_date string

A data de vencimento.

Data prevista de pagamento
invoices.payment_expected_date string

A data prevista para o pagamento.

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 Contacto
invoices.contact_persons array of string

As pessoas de contacto.

ID da moeda
invoices.currency_id string

O identificador de moeda.

Código de Moeda
invoices.currency_code string

O código da moeda.

Taxa de Câmbio
invoices.exchange_rate double

A taxa de câmbio.

Discount
invoices.discount double

O desconto.

É desconto antes de impostos
invoices.is_discount_before_tax boolean

Se o desconto é antes de impostos.

Tipo de desconto
invoices.discount_type string

O tipo de desconto.

É Fiscal Inclusivo
invoices.is_inclusive_tax boolean

Se inclui impostos.

ID da fatura recorrente
invoices.recurring_invoice_id string

O identificador de fatura recorrente.

É visualizado pelo cliente
invoices.is_viewed_by_client boolean

Se é visualizado pelo cliente.

Tem Acessório
invoices.has_attachment boolean

Se tem apego.

Tempo de visualização do cliente
invoices.client_viewed_time string

O cliente visualizou o tempo.

Item de linha
invoices.line_items array of object
ID
invoices.line_items.line_item_id string

O identificador de 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 da despesa
invoices.line_items.expense_id string

O identificador de despesa.

Nome do recibo de despesa
invoices.line_items.expense_receipt_name string

O nome do recibo de 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 dos itens.

Taxa BCY
invoices.line_items.bcy_rate double

A taxa BCY.

Tarifa
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.

Discount
invoices.line_items.discount double

O desconto.

ID
invoices.line_items.tax_id string

O identificador de imposto.

CNPJ TDS
invoices.line_items.tds_tax_id string

O identificador de imposto 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.

Percentagem de Imposto
invoices.line_items.tax_percentage double

A percentagem do imposto.

Item Total
invoices.line_items.item_total double

O total do item.

Código de chave de item SAT
invoices.line_items.sat_item_key_code integer

O código de chave do item SAT.

Código da chave da unidade
invoices.line_items.unitkey_code string

O código da chave da unidade.

Taxa de envio
invoices.shipping_charge double

O custo de envio.

Ajustamento
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 do imposto.

Total
invoices.total double

O total.

Imposto
invoices.taxes array of object
Nome
invoices.taxes.tax_name string

O nome do imposto.

Montante
invoices.taxes.tax_amount double

O valor do imposto.

Lembrete de pagamento ativado
invoices.payment_reminder_enabled boolean

Se o lembrete de pagamento está ativado.

Pagamento Efetuado
invoices.payment_made double

O pagamento efetuado.

Créditos Aplicados
invoices.credits_applied double

Os créditos aplicados.

Valor do imposto retido na fonte
invoices.tax_amount_withheld double

O valor do imposto retido na fonte.

Equilíbrio
invoices.balance double

O equilíbrio.

Valor de amortização
invoices.write_off_amount double

O valor da amortização.

Permitir pagamentos parciais
invoices.allow_partial_payments boolean

Permitir ou não 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 e-mail
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.

Address
invoices.billing_address.address string

O endereço.

City
invoices.billing_address.city string

A cidade.

Estado
invoices.billing_address.state string

O Estado.

Código Postal
invoices.billing_address.zip string

O código postal.

Country
invoices.billing_address.country string

O país.

Fax
invoices.billing_address.fax string

O número de fax.

Address
invoices.shipping_address.address string

O endereço.

City
invoices.shipping_address.city string

A cidade.

Estado
invoices.shipping_address.state string

O Estado.

Código Postal
invoices.shipping_address.zip string

O código postal.

Country
invoices.shipping_address.country string

O país.

Fax
invoices.shipping_address.fax string

O número de fax.

Observações
invoices.notes string

As notas.

Terms
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 deseja ser exibido em PDF.

Mostrar em todos os PDFs
invoices.custom_fields.show_in_all_pdf boolean

Se deseja ser exibido em todos os PDFs.

Valor
invoices.custom_fields.value double

O valor do campo personalizado.

ID do modelo
invoices.template_id string

O identificador do modelo.

Nome do Modelo
invoices.template_name string

O nome do modelo.

Tempo de Criação
invoices.created_time string

O tempo criado.

Hora da última modificação
invoices.last_modified_time string

A última hora modificada.

Nome do anexo
invoices.attachment_name string

O nome do anexo.

Pode enviar por correio
invoices.can_send_in_mail boolean

Se pode enviar por correio.

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 URL da fatura.

Obter um contacto

Recupere os detalhes de um contato existente.

Parâmetros

Name Chave Necessário Tipo Description
ID de contato
contact_id True string

O identificador de contato.

Devoluções

Name Caminho Tipo Description
Código de estado
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 Contacto
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 Fiscal
contact.tax_name string

O nome do imposto.

Percentagem de Imposto
contact.tax_percentage integer

A percentagem do imposto.

ID da Autoridade Tributária
contact.tax_authority_id string

O identificador da autoridade fiscal.

ID de isenção fiscal
contact.tax_exemption_id string

O identificador de isenção fiscal.

Nome da Autoridade Tributária
contact.tax_authority_name string

O nome da autoridade fiscal.

Código de Isenção Fiscal
contact.tax_exemption_code string

O código de isenção fiscal.

Local De Contacto
contact.place_of_contact string

O local de contacto.

Número do ICMS
contact.gst_no string

O número do ICMS.

Tratamento em sede de IVA
contact.vat_treatment string

O tratamento do IVA.

Tratamento de GST
contact.gst_treatment string

O tratamento do GST.

Está vinculado ao Zoho CRM
contact.is_linked_with_zohocrm boolean

Se está vinculado ao Zoho CRM.

Sítio Web
contact.website string

O sítio Web.

ID de contato principal
contact.primary_contact_id string

O identificador de contato primário.

Condições de Pagamento
contact.payment_terms integer

As condições de pagamento.

Etiqueta de Condições de Pagamento
contact.payment_terms_label string

A etiqueta de condições de pagamento.

ID da moeda
contact.currency_id string

O identificador de moeda.

Código de Moeda
contact.currency_code string

O código da moeda.

Símbolo da moeda
contact.currency_symbol string

O símbolo da moeda.

Valor a Receber
contact.outstanding_receivable_amount double

O montante a receber pendente.

Valor a Receber BCY
contact.outstanding_receivable_amount_bcy double

O montante a receber pendente do BCY.

Créditos não utilizados Montante a receber
contact.unused_credits_receivable_amount double

O montante a receber dos créditos não utilizados.

Créditos não utilizados Montante a receber BCY
contact.unused_credits_receivable_amount_bcy double

O montante a receber dos 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 ativado
contact.payment_reminder_enabled boolean

Se o lembrete de pagamento está ativado.

Campo Personalizado
contact.custom_fields array of object
Valor
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.

Address
contact.billing_address.address string

O endereço.

Rua
contact.billing_address.street2 string

O endereço.

Código do Estado
contact.billing_address.state_code string

O código do estado.

City
contact.billing_address.city string

A cidade.

Estado
contact.billing_address.state string

O Estado.

Código Postal
contact.billing_address.zip string

O código postal.

Country
contact.billing_address.country string

O país.

Fax
contact.billing_address.fax string

O número de fax.

Telemóvel
contact.billing_address.phone string

O número de telefone.

Atenção
contact.shipping_address.attention string

O nome da atenção.

Address
contact.shipping_address.address string

O endereço.

Rua
contact.shipping_address.street2 string

O endereço.

Código do Estado
contact.shipping_address.state_code string

O código do estado.

City
contact.shipping_address.city string

A cidade.

Estado
contact.shipping_address.state string

O Estado.

Código Postal
contact.shipping_address.zip string

O código postal.

Country
contact.shipping_address.country string

O país.

Fax
contact.shipping_address.fax string

O número de fax.

Telemóvel
contact.shipping_address.phone string

O número de telefone.

Pessoas de Contacto
contact.contact_persons array of object
Saudação
contact.contact_persons.salutation string

A saudação.

Nome Próprio
contact.contact_persons.first_name string

O primeiro nome.

Apelido
contact.contact_persons.last_name string

O sobrenome.

Email
contact.contact_persons.email string

O endereço de e-mail.

Telemóvel
contact.contact_persons.phone string

O número de telefone.

Telemóvel
contact.contact_persons.mobile string

O número de telemóvel.

É o contato principal
contact.contact_persons.is_primary_contact boolean

Se é contato principal.

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.

ID do modelo de estimativa
contact.default_templates.estimate_template_id string

O identificador do modelo de estimativa.

Nome do modelo de estimativa
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 nota de crédito.

Nome do modelo de nota de crédito
contact.default_templates.creditnote_template_name string

O nome do modelo de nota de crédito.

ID do modelo de e-mail da fatura
contact.default_templates.invoice_email_template_id string

O identificador do modelo de e-mail da fatura.

Nome do modelo de e-mail da fatura
contact.default_templates.invoice_email_template_name string

O nome do modelo de e-mail da fatura.

Estimar ID do modelo de e-mail
contact.default_templates.estimate_email_template_id string

O identificador de modelo de e-mail estimado.

Estimar o nome do modelo de e-mail
contact.default_templates.estimate_email_template_name string

O nome do modelo de e-mail estimado.

ID do modelo de e-mail da nota de crédito
contact.default_templates.creditnote_email_template_id string

O identificador de modelo de e-mail da nota de crédito.

Nome do modelo de e-mail da nota de crédito
contact.default_templates.creditnote_email_template_name string

O nome do modelo de e-mail da nota de crédito.

Observações
contact.notes string

As notas.

Tempo de Criação
contact.created_time string

O tempo criado.

Hora da última modificação
contact.last_modified_time string

A última hora modificada.

Obter uma fatura

Recuperar os detalhes de uma fatura

Parâmetros

Name Chave Necessário Tipo Description
Identificador da fatura
invoice_id True string

O identificador da fatura.

Devoluções

Name Caminho Tipo Description
Código de estado
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 ACH Iniciado
invoice.ach_payment_initiated boolean

Se o pagamento 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 lugar da prestação.

Número do ICMS
invoice.gst_no string

O número do ICMS.

Tratamento de GST
invoice.gst_treatment string

O tratamento do GST.

Tratamento fiscal
invoice.tax_treatment string

O tratamento fiscal.

Uso de CFDI
invoice.cfdi_usage string

O uso de CFDI.

Tratamento em sede de IVA
invoice.vat_treatment string

O tratamento do IVA.

Registo para efeitos de IVA
invoice.vat_reg_no string

O número de registo para efeitos de 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.

Etiqueta de Condições de Pagamento
invoice.payment_terms_label string

A etiqueta de condições de pagamento.

Data Para Conclusão
invoice.due_date string

A data de vencimento.

Data prevista de pagamento
invoice.payment_expected_date string

A data prevista para o pagamento.

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 Contacto
invoice.contact_persons array of string

As pessoas de contacto.

ID da moeda
invoice.currency_id string

O identificador de moeda.

Código de Moeda
invoice.currency_code string

O código da moeda.

Taxa de Câmbio
invoice.exchange_rate double

A taxa de câmbio.

Discount
invoice.discount double

O desconto.

É desconto antes de impostos
invoice.is_discount_before_tax boolean

Se o desconto é antes de impostos.

Tipo de desconto
invoice.discount_type string

O tipo de desconto.

É Fiscal Inclusivo
invoice.is_inclusive_tax boolean

Se inclui impostos.

ID da fatura recorrente
invoice.recurring_invoice_id string

O identificador de fatura recorrente.

É visualizado pelo cliente
invoice.is_viewed_by_client boolean

Se é visualizado pelo cliente.

Tem Acessório
invoice.has_attachment boolean

Se tem apego.

Tempo de visualização do cliente
invoice.client_viewed_time string

O cliente visualizou o tempo.

Item de linha
invoice.line_items array of object
ID
invoice.line_items.line_item_id string

O identificador de 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 da despesa
invoice.line_items.expense_id string

O identificador de despesa.

Nome do recibo de despesa
invoice.line_items.expense_receipt_name string

O nome do recibo de 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 dos itens.

Taxa BCY
invoice.line_items.bcy_rate double

A taxa BCY.

Tarifa
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.

Discount
invoice.line_items.discount double

O desconto.

ID
invoice.line_items.tax_id string

O identificador de imposto.

CNPJ TDS
invoice.line_items.tds_tax_id string

O identificador de imposto 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.

Percentagem de Imposto
invoice.line_items.tax_percentage double

A percentagem do imposto.

Item Total
invoice.line_items.item_total double

O total do item.

Código de chave de item SAT
invoice.line_items.sat_item_key_code integer

O código de chave do item SAT.

Código da chave da unidade
invoice.line_items.unitkey_code string

O código da chave da unidade.

Taxa de envio
invoice.shipping_charge double

O custo de envio.

Ajustamento
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 do imposto.

Total
invoice.total double

O total.

Imposto
invoice.taxes array of object
Nome
invoice.taxes.tax_name string

O nome do imposto.

Montante
invoice.taxes.tax_amount double

O valor do imposto.

Lembrete de pagamento ativado
invoice.payment_reminder_enabled boolean

Se o lembrete de pagamento está ativado.

Pagamento Efetuado
invoice.payment_made double

O pagamento efetuado.

Créditos Aplicados
invoice.credits_applied double

Os créditos aplicados.

Valor do imposto retido na fonte
invoice.tax_amount_withheld double

O valor do imposto retido na fonte.

Equilíbrio
invoice.balance double

O equilíbrio.

Valor de amortização
invoice.write_off_amount double

O valor da amortização.

Permitir pagamentos parciais
invoice.allow_partial_payments boolean

Permitir ou não 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 e-mail
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.

Address
invoice.billing_address.address string

O endereço.

City
invoice.billing_address.city string

A cidade.

Estado
invoice.billing_address.state string

O Estado.

Código Postal
invoice.billing_address.zip string

O código postal.

Country
invoice.billing_address.country string

O país.

Fax
invoice.billing_address.fax string

O número de fax.

Address
invoice.shipping_address.address string

O endereço.

City
invoice.shipping_address.city string

A cidade.

Estado
invoice.shipping_address.state string

O Estado.

Código Postal
invoice.shipping_address.zip string

O código postal.

Country
invoice.shipping_address.country string

O país.

Fax
invoice.shipping_address.fax string

O número de fax.

Observações
invoice.notes string

As notas.

Terms
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 deseja ser exibido em PDF.

Mostrar em todos os PDFs
invoice.custom_fields.show_in_all_pdf boolean

Se deseja ser exibido em todos os PDFs.

Valor
invoice.custom_fields.value double

O valor do campo personalizado.

ID do modelo
invoice.template_id string

O identificador do modelo.

Nome do Modelo
invoice.template_name string

O nome do modelo.

Tempo de Criação
invoice.created_time string

O tempo criado.

Hora da última modificação
invoice.last_modified_time string

A última hora modificada.

Nome do anexo
invoice.attachment_name string

O nome do anexo.

Pode enviar por correio
invoice.can_send_in_mail boolean

Se pode enviar por correio.

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 URL da fatura.