Apêndice

Linha do Documento

Parâmetros	Tipo	Descrição	Obrigatório
code	string	Identificador do produto a usar na linha. Pode referir-se tanto ao 'código' como ao 'código de barras' de um produto, ou ainda a um 'código alternativo' por este usado.
description	string	Este valor, se preenchido, vai sobrepor-se à descrição na ficha do produto apenas na presente linha.
long_description	string	Descrição Alargada Nota: A utilização deste campo pode estar limitada por opções de configuração do CloudInvoice. Tamanho: 10000
base_qty	float	Quantidade Default: 1
line_discount1	float	Desconto de Linha #1 Valores entre 0 e 100
line_discount2	float	Desconto de Linha #2 Valores entre 0 e 100
line_unit_value	float	Preço Unitário. O valor fornecido deverá ser o Preço Unitário sem IVA se o documento estiver definido como contendo valores sem IVA. Deverá já incluir IVA caso contrário.

Exemplo de Linha

{
    "code": "PROD1",
    "description": "Produto 1",
    "base_qty": 1,
    "line_unit_value": 100,
    "line_discount1": 10,
    "line_discount2": 5
}

Linhas do Documento de Origem

Estes objectos são usados nas emissões/conversões de Documentos. Contêm a identificação da linha de origem, assim como alguns valores opcionais que possam ser alterados durante o processo.

Parâmetros	Tipo	Descrição	Obrigatório
id	integer	ID da Linha do Documento de origem.
base_qty	float	Quantidade Se não definida, tomará, na maior parte dos casos, o valor da Quantidade da linha de origem.
line_unit_value	float	Preço Unitário. Se não definido, tomará, na maior parte dos casos, o valor do Preço Unitário da linha de origem.

Pagamento do Documento

Parâmetros	Tipo	Descrição	Obrigatório
payment_method	integer	Método de Pagamento Consulte a tabela Métodos de Pagamento.
amount_received_currency	float	Valor do Pagamento Default: Valor em Dívida
payment_doc_reference	string	Referência do Pagamento. O preenchimento deste campo é obrigatório em alguns métodos de pagamento.
payment_doc_date	date	Data do Documento de Pagamento (Ex: Data do Cheque bancário)

Impressão do Documento

Parâmetros	Tipo	Descrição	Obrigatório
print	boolean	Imprimir Documento. Apenas pode imprimir documentos finalizados/anulados.
format	string	Formato de Impressão: Opções: [a4/a5/ticket]. Caso não indique, será usado o formato configurado no documento.
print_copies	number	Número de cópias. Opções: [1-6] / 2via. Caso não indique, será impresso o número de cópias configurado no documento.
print_copy	number	Indica o número da cópia a imprimir. Opções: [1-6] / 2via. Caso pretenda imprimir apenas uma cópia específica (Ex: Imprimir apenas triplicado)
layout_id	integer	ID do Layout de Impressão. Caso não indique, será usado o layout configurado no documento de acordo com o formato de impressão.

Envio por E-mail do Documento

Parâmetros	Tipo	Descrição	Obrigatório
email	boolean	Enviar por E-mail. Apenas pode imprimir documentos finalizados/anulados.
email_address	email	Endereço de Destino
email_subject	string	Assunto do E-mail
email_message	string	Mensagem do E-mail
email_cc	email	Endereço cc
email_bcc	email	Endereço bcc

Dados para Transporte

Parâmetros	Tipo	Descrição	Obrigatório
is_transport_document	boolean	É Doc. de Transporte.
load_date	datetime	Data de Carga. Formato: "YYYY-MM-DD hh:mm:ss"
load_shipment_id	integer	Local de Carga Consulte Tabela Shipments para saber mais
ship_from_warehouse_id	integer	Armazém de Origem Consulte Tabela Armazéns para saber mais
ship_from_street1	string	Morada de Carga
ship_from_street2	string	Morada de Carga Linha 2
ship_from_zip_code	string	Código Postal (Origem)
ship_from_zip_locale	string	Localidade (Origem)
ship_from_city	email	Cidade (Origem)
vehicle_plate	string	Matrícula da Viatura
unload_date	datetime	Data de Descarga. Formato: "YYYY-MM-DD hh:mm:ss"
unload_shipment_id	integer	Local de Descarga Consulte Tabela Shipments para saber mais
ship_to_street1	string	Morada de Descarga
ship_to_street2	string	Morada de Descarga Linha 2
ship_to_zip_code	string	Código Postal (Destino)
ship_to_zip_locale	string	Localidade (Destino)
ship_to_city	string	Cidade (Destino)
ship_to_country_id	integer	País de Destino Consulte Tabela Países para saber mais

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.