Create

Criar Documento

Cria um novo documento.

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

Request Body

Name	Type	Description
document_id	integer	ID do Tipo de Documento. Consulte a tabela Tipos de Documentos para saber mais.
document_nature_id*	integer	Natureza do Documento. ⚠️ Apenas obrigatório se o campodocument_id não for fornecido. Consulte a tabela Apêndice para saber mais.
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	ID da Série de Documentos. Consulte a tabela Séries para saber mais. ⚠️ Apenas surtirá efeito quando submetido em simultâneo com o campodocument_id.
document_date	date [yyyy-mm-dd]	Data de Emissão ⚠️ Documentos de relevância fiscal (assinados) poderão ignorar este valor.
document_time	time [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 para saber mais.
party_id	integer	ID da Entidade. Consulte a tabela Clientes para saber mais.
party_fiscal_number	string	NIF da Entidade
warehouse_id	integer	ID do Armazém.
price_line_id	integer	ID da Linha de Preços. Consulte a tabela Linhas de Preços para saber mais.
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. 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 objectos, sendo que cada objecto 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 -0.99 a 0.99. ⚠️ Os acertos estão disponíveis apenas em Documentos de Compra
payments	array	Pagamentos do Documento. Deverá conter uma lista de objectos, sendo que cada objecto 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 o Documento é considerado 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. Apenas pode imprimir documentos finalizados. Consulte os parâmetros disponíveis para impressão no Apêndice.
email	boolean	Enviar por E-mail após criação. Apenas pode enviar por e-mail documentos finalizados. Consulte os parâmetros disponíveis para impressão no Apêndice.

201: Created Devolve ficha completa do novo documento

400: Bad Request Lista de erros detectados

401 (Sem Resposta)

{
    // Response
}

403: Forbidden (Sem Resposta)

{
    // Response
}

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

{
    "id": 7641,
    "doc_key": "FSI A2023-1/214",
    "document_date": "2023-01-11",
    "document_time": "13:32:36",
    "document_number": 214,
    "document_reference": "",
    "our_reference": "",
    "module_origin": 1,
    "party_id": 1,
    "line_details_count": 2,
    "lines_total_quantity": 3.0,
    "is_valued": true,
    "is_tax_included": true,
    "total_gross_amount": 5.23,
    "global_discount1": 0.0,
    "total_global_discount": 0.0,
    "total_line_discount": 0.0,
    "total_net_amount": 4.2520325203,
    "total_taxes_amount": 0.9779674797,
    "total_amount": 5.23,
    "total_document_amount": 5.23,
    "total_round_amount": 0.0,
    "total_due_amount": 0.0,
    "due_date": "2023-01-11",
    "is_converted": false,
    "header_text": "",
    "footer_text": "",
    "number_of_prints": 0,
    "is_transport_document": false,
    "obs": "",
    "document_nature_id": 302,
    "document_id": 2,
    "document": {
        "code": "FSI", 
        "document_name": "Factura Simplificada", 
        "ask_payment_onclose": true
    },
    "document_serie_id": 6,
    "document_serie": {
        "code": "A2023-1", 
        "description": "Série A2023-1"
    },
    "document_status_id": 1202,
    "warehouse_id": 1,
    "warehouse": {
        "code": 1, 
        "description": "Armazém 1"
    },
    "salesman_id": 1,
    "salesman": {
        "code": 1, 
        "salesman_name": "Empregado 1"
    },
    "payment_term_id": 1,
    "payment_term": {
        "code": 1,
        "description": "Pronto Pagamento"
    },
    "payment_method_id": 1,
    "payment_method": {
        "code": 1,
        "description": "Dinheiro"
    },
    "origin_document_header_id": null,
    "origin_document_header": null,
    "document_nature": {
        "code": "FS", 
        "description": "Factura Simplificada"
    },
    "document_status": {
        "code": "F",
        "description": "Finalizado"
    },
    "party": {
        "class": 1601,
        "code": 1,
        "name": "Consumidor Final",
        "commercial_name": "",
        "fiscal_number": "999999990",
        "street1": "",
        "street2": "",
        "zip_code": "",
        "zip_locale": ""
    },
    "print":{
        "filename": "FS__FSI_A2023_1_219__2023_01_11_1673450093.pdf",
        "url": "https://app.cloudinvoice/downloads/xxxxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxx/download_file/?direct=true&compressed=false"
    }
}

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