Facturalusa - Software de Facturação Online

Recibos

Este endpoint visa gerir a emissão de recibos.

Os pedidos de criação de um recibo em estado Terminado devem ser realizados de forma síncrona para garantir que a numeração do documento, na respectiva série, é a correcta.

Recibos - Criar

issue_date date required

Data de emissão do documento

receipt_date date required

Data de recebimento do documento

document_type mixed required

Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Recibo de Cliente.

serie mixed

Série. Pode ser enviado o ID ou o descritivo, exemplo: 2021, 2021A, etc. No caso de não preenchimento será assumido a série pré-definida.

customer integer required

ID do cliente

vat_number string

Contribuinte do cliente. No caso de não preenchimento será assumido o valor 999999990.

address string required

Morada do cliente

city string required

Localidade do cliente

postal_code string required

Código postal do cliente

country string required

País do cliente

payment_method mixed

Forma de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.

currency mixed

Moeda utilizada. Pode ser enviado o ID, símbolo ou descritivo, exemplo: , $, Euro, Dólar. No caso de não preenchimento será assumido a moeda pré-definida.

currency_exchange double

Câmbio da moeda. Caso não seja enviado será assumido 1.

observations string

Observações do documento

location_origin mixed

Local de origem. Pode ser enviado o ID ou nome do local. No caso de não preenchimento será assumido o local de origem pré-definido.

sales json array required

Lista de vendas que constam no documento.

id integer required

ID da venda

percentage_discount double

Desconto percentual

unit_discount double

Desconto unitário

total_paid double required

Valor pago

language string

Idioma a ser impresso caso o estado do documento seja Terminado. Preencher com PT ou EN. No caso de não preenchimento será assumido o idioma pré-definido.

format string

Formato a ser impresso caso o estado do documento seja Terminado. Preencher com A4 ou POS. No caso de não preenchimento será assumido o valor definido no tipo de documento (que por norma é A4).

paper_size integer

Tamanho / largura do documento em milímetros. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.

paper_left_margin integer

Margem à esquerda do documento. No caso de não preenchimento será assumido o valor definido no tipo de documento.

paper_right_margin integer

Margem à direita do documento. No caso de não preenchimento será assumido o valor definido no tipo de documento.

paper_top_margin integer

Margem em cima do documento. No caso de não preenchimento será assumido o valor definido no tipo de documento.

paper_bottom_margin integer

Margem em baixo do documento. No caso de não preenchimento será assumido o valor definido no tipo de documento.

force_print boolean

Determina se deve ou não gerar a impressão do documento caso o estado do mesmo seja Terminado. Se preenchido com true o documento será impresso; se preenchido com false o documento não será impresso; se não for preenchido, irá assumir o valor definido no tipo de documento.

force_send_email boolean

Determina se deve ou não enviar via email o documento para o cliente caso o estado do mesmo seja Terminado. Se preenchido com true o documento será enviado; se preenchido com false o documento não será enviado; se não for preenchido, irá assumir o valor definido no tipo de documento.

force_send_sms boolean

Determina se deve ou não enviar SMS para o cliente caso o estado do documento seja Terminado. Se preenchido com true a SMS será enviada; se preenchido com false a SMS não será enviada; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver SMS disponíveis.

force_sign boolean

Determina se deve ou não assinar o documento caso o estado do documento seja Terminado e caso o mesmo seja impresso. Se preenchido com true o documento será assinado; se preenchido com false o documento não será assinado; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver a Assinatura Digital activada e bem configurada.

status string required

Estado do documento. Deve ser enviado um dos seguintes valores: Rascunho ou Terminado.

🍪 Usamos cookies no nosso site para melhorar a sua experiência. Ao continuar, declara aceitar a nossa Política de Cookies.