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.
date
Format: yyyy-mm-dd
Data de Emissão
⚠️ Documentos de relevância fiscal (assinados) poderão ignorar este valor.
time
Format: hh:mm:ss
Hora de Emissão
⚠️ Documentos de relevância fiscal (assinados) poderão ignorar este valor.
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.
Entidade
Consulte a tabela Clientes.
| | party\_fiscal\_number | string | NIF da Entidade | | warehouse\_id | integer |Armazém
Consulte Tabela Armazéns no Backoffice.
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
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.
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.
| {% tabs %} {% tab title="Exemplo de Pedido" %} ```shell 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 }' ``` {% endtab %} {% tab title="Exemplo de Resposta" %} ```json { "id": 1, "doc_key": "FSI A01/1", "document_date": "2023-01-11", "document_time": "13:32:36", "document_number": 1, "document_reference": "", "our_reference": "", "module_origin": 1, "party_id": 1, "party": { "class": 1601, "code": 1, "name": "Consumidor Final", "commercial_name": "", "fiscal_number": "999999990", "street1": "", "street2": "", "zip_code": "", "zip_locale": "" }, "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_nature": { "code": "FS", "description": "Factura Simplificada" }, "document_id": 2, "document": { "code": "FSI", "document_name": "Factura Simplificada", "ask_payment_onclose": true }, "document_serie_id": 1, "document_serie": { "code": "A01", "description": "Série A01" }, "document_status_id": 1202, "document_status": { "code": "F", "description": "Finalizado" }, "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 } ``` {% endtab %} {% endtabs %} Para ver exemplos de pedidos nas várias linguagens, consulte a página[ Exemplos de Pedidos.](/introducao/exemplos-de-pedidos.md) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://apidocs.cloudinvoice.net/documentacao-api/documentos/create.md?ask=