CloudInvoice API - Docs
Voltar ao InícioPreços e PlanosContacte-nos
  • Introdução
    • Começar a Utilizar
    • Autenticação
    • Exemplos de Pedidos
    • Erros e Respostas
    • Precisa de Ajuda?
    • Change Log
  • Conta / Autenticação
    • Login
    • Login - Sandbox
    • Planos Demo
    • Info do User
    • Empresas
  • Documentação API
    • Documentos
      • List
        • Vendas - List
        • Guias - List
        • Stocks - List
        • Outros Documentos - List
      • Create
      • Get
      • Finalize
      • Annul
      • Print
      • Email
      • Delete
      • Emit - Nota de Crédito
      • Linhas - List
      • Pagamentos - List
      • Apêndice
    • Tipos de Documentos
      • List
      • Get
    • Séries de Documentos
      • List
      • Get
    • Clientes
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Fornecedores
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Produtos
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
      • Stock Geral - List
      • Stock Geral - Get
      • Stocks por Armazém - List
      • Stocks por Armazém - Get
      • Preços de Venda - List
      • Preços de Venda - Get
      • Preços de Venda - Update
      • Códigos Alternativos - List
      • Código Alternativo - Get
      • Código Alternativo - Create
      • Código Alternativo - Update
      • Código Alternativo - Delete
    • Famílias
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Sub-Famílias
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Taxas
      • List
      • Get
    • Motivos de Isenção
      • List
      • Get
    • Linhas de Preços
      • List
      • Get
    • Unidades de Medida
      • List
      • Get
    • Métodos de Pagamento
      • List
      • Get
    • Condições de Pagamento
      • List
      • Get
    • Países
      • List
      • Get
    • Distritos
      • List
      • Create
      • Get
      • Seek
      • Exists
      • Update
      • Delete
    • Concelhos
      • List
      • Create
      • Get
      • Update
      • Delete
    • Relatórios
      • List
      • Create
    • Apêndice
  • Outros Links
    • Ir para /V3 [Deprecated]
Powered by GitBook
On this page
  • Linha do Documento
  • Linhas do Documento de Origem
  • Pagamento do Documento
  • Impressão do Documento
  • Envio por E-mail do Documento
  • Dados para Transporte
  1. Documentação API
  2. Documentos

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.

{
    "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

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

PreviousPagamentos - ListNextTipos de Documentos

Last updated 10 months ago

Método de Pagamento Consulte a tabela .

País de Destino Consulte Tabela para saber mais

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

Exemplos de Pedidos.
Métodos de Pagamento
Países