As notas de liquidação têm a mesma estrutura que os restantes . Na versão v1 da API têm a mesma estrutura anteriormente descrita para a v0: são compostas por um cabeçalho e uma ou mais linhas. Nesta nova versão, é possível criar ambos num só pedido, descrito de seguida.
Todos os pedidos descritos são formalmente semelhantes aos pedidos correspondentes dos restantes : as rotas utilizados são as mesmas, e os payloads JSON a enviar são estruturalmente semelhantes, partilhando os mesmos atributos.
O payload JSON a enviar contém a seguinte informação:
{
// Identificação do documento
"document_type": "NLCF|NLDF", // [OBRIGATÓRIO] Tipo de documento. "NLCF": nota de liquidação a crédito; "NLDF": nota de liquidação a débito.
"date": "2023-01-01", // [OPCIONAL] Data do documento; por omissão, a data do pedido.
// [OPCIONAL] Identificação do fornecedor. Por omissão, é o fornecedor indiferenciado (NIF "999999990").
// Se o fornecedor for indicado, usar apenas um dos dois campos seguintes (o "id" ou o NIF). Se se indicarem os dois, então devem ser consistentes.
"supplier_id": 1, // [OPCIONAL] Identificador interno do fornecedor. Ver NOTA 1.
"supplier_tax_registration_number": "999999990", // [OPCIONAL] NIF do fornecedor. O fornecedor com o NIF indicado deverá já existir Se for um fornecedor português ("PT", "PT-AC" ou "PT-MA"), deve ser um NIF português válido.
// [OPCIONAL] Moeda. Por omissão, "EUR".
// Se a moeda for indicada, usar apenas um dos dois campos seguintes (o "id" ou o código ISO). Se se indicarem os dois, então devem ser consistentes.
"currency_id": 1, // [OPCIONAL] Identificador interno da moeda. Ver NOTA 2.
"currency_iso_code": "USD", // [OPCIONAL] É o código ISO da moeda do documento (vd. https://en.wikipedia.org/wiki/ISO_4217).
"currency_conversion_rate": 1.21, // [OMITIDO] se a moeda for "EUR". [OBRIGATÓRIO] nos restantes casos; é a taxa de conversão para EUR (1 EUR = n USD|...).
// [OPCIONAL] Identificação do documento sobre o qual a nota está a ser emitida. Por omissão, a nota não ficará associada a nenhum documento.
"parent_documents_ids": "{1}", // [OPCIONAL] Identificador interno do documento ao qual a nota está associada.
// [OPCIONAL] Outras informações
"notes": "Notas ao documento", // [OPCIONAL]
// [OPCIONAL] Instruções de processamento do documento
"finalize": true, // [OPCIONAL] O documento deve ser imediatamente finalizado (true) ou deixado em preparação (false)? Por omissão, o documento é deixado em preparação.
"return_pdf": false, // [OPCIONAL] O documento deve ser imediatamente materializado (true), ou não (false)? Caso se opte pela materialização do documento, será devolvido um link para o respectivo PDF. Por omissão, o documento não é materializado.
// [OBRIGATÓRIO] Linhas do documento
"lines": [
{
"description": "Descrição da linha", // [OBRIGATÓRIO] A descrição do valor a liquidar.
"amount": 100.50 // [OBRIGATÓRIO] O valor a liquidar.
},
// Outras linhas, se existirem
...
]
}
NOTA 1: Se o fornecedor for identificado pelo seu "id" interno tem já que existir, e o seu "id" interno pode ser obtido por um
GET /suppliers?filter[tax_registration_number]=<o NIF do fornecedor>
NOTA 2: O "id" interno da moeda deve ser obtido por um
GET /currencies?filter[iso_code]=USD|<o código ISO da moeda>