Create
Criar Documento
Cria um novo documento.
POST
https://api.cloudinvoice.net/documents/new/
Request Body
document_id
integer
ID do Tipo de Documento.
document_nature_id*
integer
Natureza do Documento.
document_nature_code
string
Código da Natureza do Documento.
document_serie_id
integer
ID da Série de Documentos.
document_date
date [yyyy-mm-dd]
document_time
time [hh:mm:ss]
is_tax_included
boolean
Definir valores c/IVA Incluído.
Caso não defina, será usado de acordo com a configuração do documento.
party_class
integer
Classe de Entidade
Apenas em casos muito especííficos poderá ser necessário fornecer este valor. Por norma, este é deduzido da natureza do Documento usado.
party_id
integer
ID da Entidade.
party_fiscal_number
string
NIF da Entidade
warehouse_id
integer
ID do Armazém.
price_line_id
integer
ID da Linha de Preços.
our_reference
string
Nossa Referência.
document_reference
string
Referência do Documento
Este campo poderá ser de preenchimento obrigatório (ex: doc. de compra).
salesman_id
integer
ID do Vendedor.
Consulte a tabela de Vendedores para saber mais.
payment_term_id
integer
ID da Condição de Pagamento.
global_discount1
float
Desconto Global
Valores entre 0 e 100.
details*
array
Linhas do Documento.
total_round_amount
float
Valor de Acerto
payments
array
Pagamentos do Documento.
finalize
boolean Default: false
Finalizar após criação.
Se pretender finalizar de imediato um documento de pagamento imediato (ex: Factura-Recibo), deverá fornecer dados relativos ao(s) pagamento(s) no campo payments
.
is_transport_document
boolean
Indica se o Documento é considerado Documento de Transporte.
force_communication
boolean
Força comunicação do documento à AT.
Caso não indique, o documento será comunicado em automático se assim for necessário.
generate_mb_reference
boolean
Gerar Referência Multibanco.
Esta opção apenas será considerada caso esteja configurada para a sua empresa.
header_text
string
Informação no Cabeçalho do Documento.
footer_text
string
Informação no Rodapé do Documento.
boolean
Imprimir Documento após criação.
Apenas pode imprimir documentos finalizados.
boolean
Enviar por E-mail após criação.
Apenas pode enviar por e-mail documentos finalizados.
Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.
Last updated