Insere um novo recibo.
Caso a empresa só tenha um CAE e o eac_id
não for enviado, ou o que tenha sido enviado seja inválido, o eac_id
será automaticamente preenchido com o único CAE existente. Caso a empresa tenha mais do que um CAE, este será mantido em branco.
Todos os campos *_id
apenas aceitam valores válidos. Esses valores podem ser consultados nos respectivos endpoints da API. No caso dos associated_id
dos elementos do conjunto associated_documents
, têm de pertencer a documentos cujo tipo possa ser associado com recibos, isto é, faturas, notas de crédito e faturas de saldos migrados. Podem também ser associadas notas de crédito, onde o valor será usado como crédito no recibo, a abater no valor dos restantes documentos associados.
O campo status
aceita os valores 0 (por defeito, caso não seja preenchido) e 1, que correspondem, respectivamente, aos estados de rascunho e fechado. Ao inserir um recibo com o estado fechado, os documentos associados, caso existam, serão conciliados com os valores definidos.
Se a empresa tiver aderido ao regime de IVA de caixa, só podem ser usados document_set_id
de séries criadas para esse regime. Será emitido um erro caso seja escolhida outra série.
Para criar documentos noutras moedas, os campos exchange_currency_id
e exchange_rate
devem ser preenchidos. O campo exchange_currency_id
deverá ser preenchido com um id de moeda válido, que pode consultar no endpoint currencies/getAll. O campo
exchange_rate
deverá ser preenchido com o valor monetário apropriado. Pode consultar as tabelas de conversão que actualizamos todos os dias, no endpoint currencyExchange/getAll
.
O parâmetro payments
deverá ser preenchido com os detalhes do pagamento. Caso não seja enviado, será adicionado um pagamento automático no valor total do documento, usando como método de pagamento o que estiver pré-definido para o cliente ou para a empresa. Caso não tenha nenhum método de pagamento pré-definido, será usado o primeiro método de pagamento criado.