Create

Criar Documento

Cria um novo documento.

POST https://api.cloudinvoice.net/documents/new/

Request Body

Name	Type	Description
document_id	integer	Tipo de Documento Consulte a tabela Tipos de Documentos.
document_nature_id	integer	Natureza do Documento ⚠️ obrigatório se o campo document_id não for fornecido. Consulte a tabela Apêndice.
document_nature_code	string	Código da Natureza do Documento ⚠️ Este parâmetro substitui document_nature_id Consulte a tabela Apêndice para saber mais.
document_serie_id	integer	Série de Documentos Consulte a tabela Séries. ⚠️ Apenas surtirá efeito quando submetido em simultâneo com o campo document_id.
document_date	date Format: yyyy-mm-dd	Data de Emissão ⚠️ Documentos de relevância fiscal (assinados) poderão ignorar este valor.
document_time	time Format: hh:mm:ss	Hora de Emissão ⚠️ Documentos de relevância fiscal (assinados) poderão ignorar este valor.
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. Consulte a tabela Apêndice.
party_id	integer	Entidade Consulte a tabela Clientes.
party_fiscal_number	string	NIF da Entidade
warehouse_id	integer	Armazém Consulte Tabela Armazéns no Backoffice.
price_line_id	integer	Linha de Preços Consulte a tabela Linhas 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	Vendedor Consulte a tabela de Vendedores.
payment_term_id	integer	Condição de Pagamento Consulte a tabela Condições de Pagamento para saber mais.
global_discount1	float	Desconto Global Valores entre 0 e 100.
details	array	Linhas do Documento Deverá conter uma lista de objetos, sendo que cada objeto poderá conter os parâmetros de uma linha conforme descritos no Apêndice
total_round_amount	float	Valor de Acerto Poderá tomar valores no intervalo de -9.99 a 9.99. ⚠️ Os acertos estão disponíveis apenas em Documentos de Compra
payments	array	Pagamentos do Documento Deverá conter uma lista de objetos, sendo que cada objeto poderá conter os parâmetros de um pagamento conforme descritos no Apêndice
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 é Documento de Transporte Consulte os parâmetros disponíveis para transporte no Apêndice.
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
print	boolean	Imprimir Documento após Criação O ficheiro PDF do Documento é gerado ao finalizar. ⚠️ O Documento deverá ser finalizado. Consulte os parâmetros disponíveis para impressão no Apêndice.
email	boolean	Enviar por E-mail após Criação ⚠️ O Documento deverá estar finalizado. Consulte os parâmetros disponíveis para impressão no Apêndice.

Exemplo de Pedido

curl -X POST https://api.cloudinvoice.net/documents/new/
    -d '{
        "document_nature_id": "302",
        "party_id": "1",
        "details": [
            {
                "code": "PROD1",
                "base_qty": 1
            },
            {
                "code": "PROD2",
                "base_qty": 2,
                "line_unit_value": 2.00
            }
        ],
        "payments": [
            {
                "payment_method_id": 1
            }
        ],
        "finalize": true
    }'

Exemplo de Resposta

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