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.

POST /receipts/create

POST /receipts/:id/update

POST /receipts/:id/delete

POST /receipts/:id/cancel

POST /receipts/:id/download

POST /receipts/:id/send_email

POST /receipts/:id/send_sms

POST /receipts/:id/sign

POST /receipts/summary

POST /receipts/find

POST /receipts/list

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.

Request POST /receipts/create

{
    "issue_date": ..
    "receipt_date": ..
    ...
    "sales": 
    [
        {
        "id": ..
        "percentage_discount": ..
        "unit_discount": ..
        "total_paid": ..
        }
    ],
}

Response 200

{
    "status": true,
    "data": 
    {
        "id": ..
        "number": ..
        "issue_date": ..
        "receipt_date": ..
        "serie_id": ..
        "document_type_id": ..
        "total_discount": ..
        "total_balance": ..
        "total_paid": ..
        "grand_total": ..
        "customer_id": ..
        "customer_code": ..
        "customer_name": ..
        "customer_vat_number": ..
        "customer_country": ..
        "customer_city": ..
        "customer_address": ..
        "customer_postal_code": ..
        "company_name": ..
        "company_vat_number": ..
        "company_country": ..
        "company_address": ..
        "company_city": ..
        "company_postal_code": ..
        "company_vat_scheme": ..
        "payment_method_id": ..
        "currency_id": ..
        "currency_exchange": ..
        "location_origin_id": ..
        "location_origin_name": ..
        "location_origin_country": ..
        "location_origin_address": ..
        "location_origin_city": ..
        "location_origin_postal_code": ..
        "observations": ..
        "url_file": ..
        "file_previewed": ..
        "file_last_generated": ..
        "status": ..
        "status_last_change": ..
        "created_by": ..
        "finished_by": ..
        "canceled_by": ..
        "canceled_at": ..
        "canceled_reason": ..
        "updated_at": ..
        "created_at": ..
        "serie": [],
        "documenttype": [],
        "documenttypeserie": [],
        "paymentmethod": [],
        "currency": [],
        "sales": [],
        "createdby": [],
        "finishedby": [],
        "canceledby": [],
        "customercountry": [],
    }
}

Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.

Não preencheu todos os campos obrigatórios
O tipo de documento não existe ou não se encontra activo
Não preencheu a série ou não existe nenhuma série pré-definida para utilizar
Não preencheu a moeda ou não existe nenhuma moeda pré-definida para utilizar
Não tem permissões para executar esta operação
Seleccione pelo menos um documento
O recibo tem um limite máximo de 100 documentos
O cliente não existe
O cliente não se encontra activo
O contribuinte do cliente já foi averbado, não o pode alterar
O estado do documento não é válido
A série não se encontra atribuída no tipo de documento seleccionado
A série não se encontra activa no tipo de documento seleccionado
A série encontra-se expirada
A série não se encontra comunicada à AT no tipo de documento seleccionado. A partir de 2023 passou a ser um requisito obrigatório
O local não existe ou não se encontra activo
Um ou mais documentos mal preenchidos, na linha: X
O documento não existe
Não preencheu todos os campos obrigatórios nos documentos
Não preencheu correctamente o valor pago (formato aceite: 0,00 ou 0.00)
Não preencheu correctamente a desconto unitário (formato aceite: 0,00 ou 0.00)
Não preencheu correctamente a desconto percentual (formato aceite: 0,00 ou 0.00)
Não pode saldar um documento com um valor superior ao que está em aberto
Formato/valor de câmbio inválido
A data emissão não contêm um formato válido (ano-mês-dia)
A data de recebimento não contêm um formato válido (ano-mês-dia)
Despacho n.º 8632/2014: Quando acontecer uma situação de erro ou anomalia (...) devem ser encerradas as séries em utilização. A série encontra-se bloqueada
Já existe um documento do mesmo tipo e da mesma série emitido com uma data superior à data de emissão escolhida

Vendas - Lista Recibos - Actualizar

Introdução

Autenticação

Resposta e erros

SDKs e plugins

Países

Isenções IVA

Changelog

Vendas

Recibos

Clientes

Clientes - Contas em aberto

Artigos

Artigos - Stock

Artigos - Movimentos stock

Agenda - Marcações

Agenda - Indisponibilidades

Administração

Administração - Armazéns

Administração - Categorias

Administração - Colaboradores

Administração - Condições de pagamento

Administração - Formas de pagamento

Administração - Modos de expedição

Administração - Moedas

Administração - Preços

Administração - Séries

Administração - Taxas de IVA

Administração - Tipos de documento

Administração - Veículos

Administração - Unidades

Subscrição

Subscrição - Locais

Recibos

Recibos - Criar