Documentos de Venda

As rotas aqui descritas permitem gerir todos os processos relativos a documentos de venda: orçamentos, faturas-proforma, guias, faturas e notas.

Criação do Documento de Venda

1. Criação do cabeçalho

Para dar início à criação de um documento comercial, começa-se pelo cabeçalho. Isto é realizado através de uma solicitação POST usando cURL, onde é necessário incluir um token de acesso (access_token), e o conteúdo (payload JSON) que detalha as especificações do documento, incluindo o tipo de documento (fatura, fatura simplificada, fatura-recibo), informação sobre o cliente (novo ou existente), condições de pagamento, detalhes sobre o IVA, entre outros atributos opcionais.

2. Adição de Linhas

Após a criação do cabeçalho, é possível adicionar uma ou mais linhas ao documento. Este passo permite detalhar os produtos ou serviços que estão sendo transacionados.

3. Finalização do Documento

O documento pode ser finalizado após a adição de todas as informações necessárias. Uma vez finalizado, o documento não pode ser alterado ou eliminado, apenas anulado se necessário.

Cada passo é crucial para assegurar que o documento comercial seja criado de forma precisa e conforme as necessidades do usuário. A atenção aos detalhes durante o processo de criação e finalização é fundamental para a integridade do documento.

---

1. Criar Cabeçalho de Documento de Venda

Criar Cabeçalho de Documentos de Venda

Atributo	Descrição	Opcional
document_type	Tipo de documento. "FT": fatura, "FS": fatura simplificada, "FR": fatura-recibo.	Não
date	Data do documento; por omissão, a data do pedido.	Sim
document_series_prefix	Em alternativa ao campo "document_series_id".	Sim
customer_tax_registration_number	NIF do cliente. se o cliente com o NIF indicado não existir, será criado automaticamente.	Sim
customer_business_name	Nome do cliente.	Não
customer_address_detail	Morada do cliente.	Sim
customer_postcode	Código postal do cliente, no formato 0000-000.	Sim
customer_city	Cidade/Localidade do cliente.	Sim
customer_country	País do cliente. Por omissão, "PT"; é o código ISO alpha-2 do país do cliente.	Sim
customer_id	No caso do cliente já existir e não pretender criar um novo.	Sim
due_date	Data de vencimento; por omissão, a data do documento, ou a referente ao prazo de pagamento configurado no cliente.	Sim
settlement_expression	Desconto no cabeçalho, em percentagem; são suportados descontos compostos, como "3+5"	Sim
payment_mechanism	Modos de pagamento aceites.	Sim
vat_included_prices	Os preços nas linhas são com IVA incluído? Por omissão, não (false).	Sim
operation_country	A região de operação para efeitos de IVA.	Sim
currency_iso_code	É o código ISO da moeda do documento.	Sim
currency_conversion_rate	É a taxa de conversão para EUR.	Sim
retention	Percentagem de retenção a aplicar sobre os serviços.	Sim
retention_type	Tipo de retenção ("IRS" ou "IRC"). Por omissão, "IRS".	Sim
apply_retention_when_paid	A retenção é feita logo no documento (false) ou apenas no recebimento (true). Por omissão, false.	Sim
notes	Notas ao documento.	Sim
external_reference	Referência do documento externo.	Sim

POST/api/commercial_sales_documents

Body

application/json

dataobject

Response

200

Sucesso

Headers

Body

application/json

dataobject

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/commercial_sales_documents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "attributes": {
          "apply_retention_when_paid": true,
          "currency_conversion_rate": 1.21,
          "currency_iso_code": "EUR",
          "customer_id": 2,
          "date": "2023-01-01",
          "document_type": "FT",
          "due_date": "2023-02-01",
          "external_reference": "Referência do documento externo",
          "notes": "Notas ao documento",
          "operation_country": "PT-MA",
          "payment_mechanism": "MO",
          "retention": 7.5,
          "retention_type": "IRS",
          "settlement_expression": "7.5",
          "vat_included_prices": false
        },
        "type": "commercial_sales_documents"
      }
    }),
});
const data = await response.json();

Response

{
  "data": {
    "attributes": {
      "acts_as_shipment_document": false,
      "apply_retention_when_paid": true,
      "base_currency_conversion_difference": null,
      "base_currency_gross_total": null,
      "base_currency_net_total": null,
      "base_currency_other_retentions": null,
      "base_currency_other_taxes_total": null,
      "base_currency_pending_total": null,
      "base_currency_retention_aware_gross_total": null,
      "base_currency_retention_total": null,
      "base_currency_settlement_total": null,
      "base_currency_tax_payable": null,
      "base_currency_vat_incidence_int": null,
      "base_currency_vat_incidence_ise": null,
      "base_currency_vat_incidence_nor": null,
      "base_currency_vat_incidence_red": null,
      "base_currency_vat_total_int": null,
      "base_currency_vat_total_nor": null,
      "base_currency_vat_total_red": null,
      "cashed_vat": false,
      "child_documents_ids": null,
      "communication_code": null,
      "communication_code_source": "webservice",
      "communication_status": "unsent",
      "created_at": "2024-03-05 14:24:53.318028",
      "currency_amount": null,
      "currency_conversion_rate": 1,
      "currency_iso_code": "EUR",
      "customer_address_detail": "",
      "customer_business_name": "Gabriel",
      "customer_city": "",
      "customer_country": "PT",
      "customer_postcode": "",
      "customer_tax_country_region": "PT",
      "customer_tax_registration_number": "123456789",
      "date": "2023-01-01",
      "description": null,
      "document_area": "FT",
      "document_hash_sum": null,
      "document_no": null,
      "document_series_no": null,
      "document_series_prefix": "2023",
      "document_type": "FT",
      "due_date": "2023-02-01",
      "due_days": null,
      "email_readed": false,
      "emailed": null,
      "end_date": null,
      "expected_shipment_unloading_time": null,
      "expired": null,
      "external_reference": "Referência do documento externo",
      "fulfilled_mask": 0,
      "gross_total": 0,
      "hash_control": null,
      "invoice_counter": null,
      "is_active": null,
      "is_document_to_self": false,
      "is_invoice_receipt": null,
      "is_receipt": null,
      "is_third_party": false,
      "issue_finalized": null,
      "line_settlement_with_tax": 0,
      "line_settlement_with_tax_unrounded": 0,
      "line_settlement_without_tax": 0,
      "line_settlement_without_tax_unrounded": 0,
      "made_available_to": true,
      "manual_registration_number": "",
      "manual_registration_series": "",
      "manual_registration_type": null,
      "net_settlement_total": null,
      "net_total": 0,
      "notes": "Notas ao documento",
      "operation_country": "PT-MA",
      "other_retentions": 0,
      "other_taxes_total": 0,
      "parent_document_area": null,
      "parent_document_reference": "",
      "parent_document_type": null,
      "parent_documents_ids": null,
      "payment_mechanism": "MO",
      "pending_retention_value": 0,
      "pending_total": 0,
      "periodicity": null,
      "periodicity_type": null,
      "printed": null,
      "public_link": "",
      "receipts_ids": null,
      "reference": null,
      "reference_document_type": null,
      "required_mask": 0,
      "retention": 7.5,
      "retention_aware_gross_total": 0,
      "retention_type": "IRS",
      "retention_value": 0,
      "retention_value_unrounded": 0,
      "scheduled_description": null,
      "scheduled_end_date": null,
      "scheduled_interval": null,
      "scheduled_invoice_id": null,
      "scheduled_start_date": null,
      "send_email": null,
      "settlement": null,
      "settlement_expression": "7.5",
      "settlement_percentage": 7.5,
      "settlement_total": 0,
      "settlement_with_tax": 0,
      "settlement_with_tax_unrounded": 0,
      "settlement_without_tax": 0,
      "settlement_without_tax_unrounded": 0,
      "shipment_address_detail": null,
      "shipment_city": null,
      "shipment_country": null,
      "shipment_from_address_detail": null,
      "shipment_from_city": null,
      "shipment_from_country": null,
      "shipment_from_postcode": null,
      "shipment_loading_time": null,
      "shipment_postcode": null,
      "sort_status": 0,
      "start_date": null,
      "status": 0,
      "system_entry_date": null,
      "tax_payable": 0,
      "third_party_type": 0,
      "total_pending_quantity": null,
      "updated_at": "2024-03-05 14:24:53.318028",
      "vat_incidence_int": 0,
      "vat_incidence_int_unrounded": 0,
      "vat_incidence_ise": 0,
      "vat_incidence_ise_unrounded": 0,
      "vat_incidence_nor": 0,
      "vat_incidence_nor_unrounded": 0,
      "vat_incidence_red": 0,
      "vat_incidence_red_unrounded": 0,
      "vat_included_prices": false,
      "vat_percentage_int": null,
      "vat_percentage_nor": null,
      "vat_percentage_red": null,
      "vat_total_int": 0,
      "vat_total_int_unrounded": 0,
      "vat_total_nor": 0,
      "vat_total_nor_unrounded": 0,
      "vat_total_red": 0,
      "vat_total_red_unrounded": 0,
      "vehicle_registration": null,
      "voided_reason": null
    },
    "id": "66",
    "relationships": {
      "bank_accounts": {
        "data": null
      },
      "cash_accounts": {
        "data": null
      },
      "commercial_document_series": {
        "data": {
          "id": "72",
          "type": "commercial_document_series"
        }
      },
      "company": {
        "data": {
          "id": "800000046",
          "type": "current_company"
        }
      },
      "currency": {
        "data": {
          "id": "1",
          "type": "currencies"
        }
      },
      "customer": {
        "data": {
          "id": "2",
          "type": "customers"
        }
      },
      "lines": {
        "data": []
      },
      "tax_exemption_reasons": {
        "data": null
      },
      "user": {
        "data": {
          "id": "800000863",
          "type": "current_company_users"
        }
      }
    },
    "type": "commercial_sales_documents"
  },
  "meta": {
    "observed": {
      "scalar": 1
    }
  }
}

No pedido acima, o access_token é o token de acesso válido devolvido pelo serviço de OAuth. O payload JSON a enviar contém a seguinte informação:

Atributo	Descrição	Obrigatório
document_type	Tipo de documento. "FT": fatura, "FS": fatura simplificada, "FR": fatura-recibo.	Sim
date	Data do documento; por omissão, a data do pedido.	Não
document_series_prefix	Em alternativa ao campo "document_series_id".	Não
customer_tax_registration_number	NIF do cliente. Se o cliente com o NIF indicado não existir, será criado automaticamente.	Não
customer_business_name	Nome do cliente.	Sim
customer_address_detail	Morada do cliente.	Não
customer_postcode	Código postal do cliente, no formato 0000-000.	Não
customer_city	Cidade/Localidade do cliente.	Não
customer_country	País do cliente. Por omissão, "PT"; é o código ISO alpha-2 do país do cliente.	Não
customer_id	No caso do cliente já existir e não pretender criar um novo.	Não
due_date	Data de vencimento; por omissão, a data do documento, ou a referente ao prazo de pagamento configurado no cliente.	Não
settlement_expression	Desconto no cabeçalho, em percentagem; são suportados descontos compostos, como "3+5"	Não
payment_mechanism	Modos de pagamento aceites.	Não
vat_included_prices	Os preços nas linhas são com IVA incluído? Por omissão, não (false).	Não
operation_country	A região de operação para efeitos de IVA.	Não
currency_iso_code	É o código ISO da moeda do documento.	Não
currency_conversion_rate	É a taxa de conversão para EUR.	Não
retention	Percentagem de retenção a aplicar sobre os serviços.	Não
retention_type	Tipo de retenção ("IRS" ou "IRC"). Por omissão, "IRS".	Não
apply_retention_when_paid	A retenção é feita logo no documento (false) ou apenas no recebimento (true). Por omissão, false.	Não
notes	Notas ao documento.	Não
external_reference	Referência do documento externo.	Não

Nota 1 - A série associada ao documento tem já que existir, e o seu "id" interno pode ser obtido por um:

GET /commercial_document_series?filter[document_type]=<o tipo de documento>&filter[prefix]=<o prefixo da série a usar> 

Nota 2 - Se o cliente for identificado pelo seu "id" interno tem já que existir, e o seu "id" interno pode ser obtido por um:

GET /customers?filter[tax_registration_number]=<o NIF do cliente>

Nota 3 - São também suportados dois "países" adicionais: "PT-AC" (Portugal, Açores) e "PT-MA" (Portugal, Madeira). Os países disponíveis podem ser consultados por um GET /countries, ou um em particular por um:

GET /countries?filter[iso_alpha_2]=<o código do país>

Nota 4 - O "id" interno da conta bancária da empresa deve ser obtido por um:

GET /company_bank_accounts?filter[iban]=<IBAN da conta> 
ou 
GET /company_bank_accounts?filter[name]=<nome da conta>

Nota 5 - O "id" interno da conta de caixa da empresa deve ser obtido por um

GET /cash_accounts?filter[name]=<nome da conta>

Nota 6 - O "id" interno do motivo de isenção deve ser obtido por um

GET /tax_exemption_reasons?filter[code]=<o código legal do motivo de isenção>  

Nota 7 - O "id" interno da moeda deve ser obtido por um

GET /currencies?filter[iso_code]=<o código ISO da moeda>

2. Criação da(s) linha(s)

Após a criação do documento, é possível personalizar as linhas do mesmo para detalhar produtos, serviços, ou outros descritores específicos. As linhas podem ser configuradas para refletir várias especificidades fiscais e comerciais, incluindo a opção de adicionar linhas apenas descritivas, com ou sem valor associado.

As linhas podem referenciar três tipos de itens: produtos, serviços ou descritores (juros, imobilizado, impostos especiais...). Para cada um destes o payload é ligeiramente diferente, e cada um será descrito de seguida.

Adicionar Linha a Recibo de Venda

Adicionar Linha a Recibo de Venda

POST/api/commercial_sales_receipt_lines

Body

application/json

dataobject

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/commercial_sales_receipt_lines', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "attributes": {
          "cashed_vat_amount": null,
          "gross_total": 10.69,
          "net_total": 9.27,
          "receipt_id": 13,
          "receivable_id": 12,
          "receivable_type": "Document",
          "received_value": 10.69,
          "retention_total": 0.72,
          "settlement_amount": 0,
          "settlement_percentage": 0
        },
        "type": "commercial_sales_receipt_lines"
      }
    }),
});
const data = await response.json();

No pedido mencionado acima, o access_token representa o token de acesso validado pelo serviço de OAuth. O payload JSON a ser enviado contém informações distintas para um produto, um serviço ou um descritor, conforme será detalhado nas etapas seguintes.ccc

2.1. Criar Linha de Documento de Venda para um Produto

Atributo	Descrição	Obrigatório
document_id	ID do documento ao qual esta linha está associada.	Sim
item_type	Tipo de item: "Product" para produto.	Sim
quantity	Quantidade do item. Por omissão, 1.	Não
unit_price	Preço unitário do item. Por omissão, é usado o PVP associado ao produto.	Não
settlement_expression	Desconto de linha, em percentagem; são suportados descontos compostos, como "3+5".	Não
item_id	ID do produto.	Não
unit_of_measure_id	ID da unidade de medida. Por omissão, é a configurada no produto ou a padrão da empresa.	Não
tax_id	ID do imposto associado ao item. Por omissão, é aplicado o IVA associado ao produto ou a taxa normal da empresa.	Não

2.2. Criar Linha de Documento de Venda para um Serviço

Já deve ter um Serviço criado previamente. Pode consultar mais informação em Criar Serviços

Atributo	Descrição	Obrigatório
type	Tipo de linha de documento.	Sim
document_id	ID do documento ao qual esta linha está associada.	Sim
item_type	Tipo de item: "Service" (serviço).	Sim
quantity	Quantidade do serviço.	Não
unit_price	Preço unitário do serviço.	Não
settlement_expression	Expressão de liquidação, em percentagem.	Não
item_id	ID do serviço associado à linha.	Não
unit_of_measure_id	ID da unidade de medida.	Não
tax_id	ID do imposto sobre o valor acrescentado (IVA) aplicado ao serviço.	Não

2.3. Criar Linha de Documento de Venda para um Descritor

Já deve ter um Descritor criado previamente. Pode consultar mais informação em Criar Descritores

Atributo	Descrição	Obrigatório
document_id	ID do documento ao qual esta linha está associada.	Sim
item_type	Tipo de item: "Service" para serviço.	Sim
quantity	Quantidade do serviço. Por omissão, 1.	Não
unit_price	Preço unitário do serviço. Por omissão, é usado o PVP associado ao serviço.	Não
settlement_expression	Desconto de linha, em percentagem; são suportados descontos compostos, como "3+5".	Não
item_id	ID do serviço.	Não
unit_of_measure_id	ID da unidade de medida. Por omissão, é a configurada no serviço ou a padrão da empresa.	Não
tax_id	ID do imposto associado ao serviço. Por omissão, é aplicado o IVA associado ao serviço ou a taxa normal da empresa.	Não

2.5. Criar Linha de Documento de Venda para uma Descrição Sem Valor

Para o caso particular de uma linha de descrição sem valor, este payload contém a seguinte informação:

Atributo	Descrição	Obrigatório
description	Descrição da linha do documento.	Sim
document_id	ID do documento ao qual a linha pertence.	Sim

3. Finalização do documento

Após todas as linhas criadas, e se não houver mais nenhuma alteração ao documento, este pode ser finalizado.

Após a finalização, a alteração ou eliminação do cabeçalho e das linhas deixa de ser possível, assim como a criação de linhas adicionais.

No pedido acima, o access_token é o token de acesso válido devolvido pelo serviço de OAuth e o id do documento é o "id" interno do documento (cabeçalho) é o devolvido no campo "id" da resposta ao seu pedido de criação (ver ponto 1. Criação do cabeçalho). O payload JSON a enviar contém a seguinte informação:

Atributo	Descrição	Obrigatório
type	Tipo de documento.	Sim
id	Identificador interno do documento (cabeçalho). Este "id" é devolvido na resposta ao pedido de criação do cabeçalho.	Sim
status	Identificação do estado do documento. 1: documento finalizado.	Sim

Exemplo de Response

{
    "meta": {
        "observed": {
            "scalar": 1
        }
    },
    "data": {
        "type": "commercial_sales_documents",
        "id": "12",
        "attributes": {
            "document_no": "FT 2023/3",
            "status": 1,
            "date": "2023-01-01",
            "payment_mechanism": null,
            "gross_total": 11.38,
            "notes": "Notas ao documento",
            "document_type": "FT",
            "pending_total": 11.38,
            "retention": 7.5,
            "settlement": null,
            "settlement_total": 0.75,
            "due_date": "2023-01-01",
            "emailed": null,
            "tax_payable": 2.13,
            "net_total": 9.25,
            "document_hash_sum": "k8FEN8/xf+GErWsPiATVpAWd5jM64132yWVldc6qg7XNxpjt+JCJTwgqQ5fswUsXw0MbbtBzHpN/aZozPiiiRHiHAR+TM4hJ8u5XnAe5hiss2Tn//QiCxbvolLywCqRw4cIt1UcbhMEP97YYj0FdLgzrPTF1amU+Xk81EkBzq54=",
            "hash_control": "1",
            "reference": null,
            "customer_tax_registration_number": "229659179",
            "customer_business_name": "Ricardo Ribeiro",
            "customer_address_detail": "Praceta da Liberdade n5",
            "customer_postcode": "1000-101",
            "customer_city": "Lisboa",
            "created_at": "2024-02-21 16:41:50.588385",
            "updated_at": "2024-02-22 18:21:13.512872",
            "is_receipt": null,
            "vehicle_registration": null,
            "shipment_address_detail": null,
            "shipment_postcode": null,
            "shipment_city": null,
            "vat_incidence_ise": 0,
            "vat_incidence_red": 0,
            "vat_incidence_int": 0,
            "vat_incidence_nor": 9.25,
            "vat_total_red": 0,
            "vat_total_int": 0,
            "vat_total_nor": 2.13,
            "customer_tax_country_region": "PT",
            "currency_amount": null,
            "customer_country": "PT",
            "printed": null,
            "currency_conversion_rate": 1,
            "currency_iso_code": "EUR",
            "system_entry_date": "2024-02-22 18:21:13.512872",
            "retention_value": 0.69,
            "parent_document_reference": "",
            "acts_as_shipment_document": false,
            "manual_registration_series": "",
            "manual_registration_number": "",
            "shipment_loading_time": null,
            "expected_shipment_unloading_time": null,
            "apply_retention_when_paid": true,
            "retention_aware_gross_total": 10.69,
            "pending_retention_value": 0.69,
            "communication_status": "unsent",
            "shipment_country": null,
            "is_invoice_receipt": null,
            "due_days": null,
            "scheduled_start_date": null,
            "scheduled_end_date": null,
            "scheduled_description": null,
            "scheduled_interval": null,
            "base_currency_gross_total": null,
            "base_currency_net_total": null,
            "base_currency_pending_total": null,
            "base_currency_settlement_total": null,
            "base_currency_retention_total": null,
            "base_currency_retention_aware_gross_total": null,
            "base_currency_tax_payable": null,
            "base_currency_vat_incidence_nor": null,
            "base_currency_vat_total_nor": null,
            "base_currency_vat_incidence_int": null,
            "base_currency_vat_total_int": null,
            "base_currency_vat_incidence_red": null,
            "base_currency_vat_total_red": null,
            "base_currency_vat_incidence_ise": null,
            "base_currency_conversion_difference": null,
            "start_date": null,
            "end_date": null,
            "periodicity": null,
            "description": null,
            "reference_document_type": null,
            "is_active": null,
            "scheduled_invoice_id": null,
            "issue_finalized": null,
            "periodicity_type": null,
            "invoice_counter": null,
            "expired": null,
            "send_email": null,
            "communication_code": null,
            "shipment_from_address_detail": null,
            "shipment_from_postcode": null,
            "shipment_from_city": null,
            "shipment_from_country": null,
            "is_third_party": false,
            "is_document_to_self": false,
            "manual_registration_type": null,
            "third_party_type": 0,
            "document_area": "FT",
            "parent_document_type": null,
            "parent_document_area": null,
            "communication_code_source": "webservice",
            "cashed_vat": false,
            "made_available_to": true,
            "other_taxes_total": 0,
            "base_currency_other_taxes_total": null,
            "other_retentions": 0,
            "base_currency_other_retentions": null,
            "retention_type": null,
            "net_settlement_total": null,
            "external_reference": "Referência do documento externo",
            "document_series_prefix": "2023",
            "document_series_no": 3,
            "email_readed": false,
            "vat_included_prices": false,
            "voided_reason": null,
            "settlement_with_tax": 0.92,
            "settlement_without_tax": 0.75,
            "line_settlement_with_tax": 0,
            "line_settlement_without_tax": 0,
            "total_pending_quantity": null,
            "child_documents_ids": null,
            "parent_documents_ids": null,
            "receipts_ids": null,
            "operation_country": "PT",
            "sort_status": 1,
            "settlement_percentage": 7.500000000000000000000,
            "settlement_expression": "7.5",
            "vat_percentage_red": null,
            "vat_percentage_int": null,
            "vat_percentage_nor": 23.0,
            "vat_incidence_ise_unrounded": 0,
            "vat_incidence_red_unrounded": 0,
            "vat_incidence_int_unrounded": 0,
            "vat_incidence_nor_unrounded": 0,
            "vat_total_red_unrounded": 0,
            "vat_total_int_unrounded": 0,
            "vat_total_nor_unrounded": 0,
            "settlement_with_tax_unrounded": 0,
            "settlement_without_tax_unrounded": 0,
            "line_settlement_with_tax_unrounded": 0,
            "line_settlement_without_tax_unrounded": 0,
            "retention_value_unrounded": 0,
            "required_mask": 10,
            "fulfilled_mask": 0,
            "public_link": "https://app.toconline.pt/public_links/link/uDdZazxttzBsJwrne83w6kSUwkbM2a8vlYIiXztqKlYhRRdNIR8hFfDLi0sxw98g-0CWzNyMJ0RlBfRMbjBomsK-QOysT0Gm3D7poBTOivqjzCsRTIPTbcs3s3lN3LyGQoILoexjjctqpvK6CBSjOA"
        },
        "relationships": {
            "bank_accounts": {
                "data": null
            },
            "cash_accounts": {
                "data": null
            },
            "commercial_document_series": {
                "data": {
                    "type": "commercial_document_series",
                    "id": "72"
                }
            },
            "company": {
                "data": {
                    "type": "current_company",
                    "id": "800000046"
                }
            },
            "currency": {
                "data": {
                    "type": "currencies",
                    "id": "1"
                }
            },
            "customer": {
                "data": {
                    "type": "customers",
                    "id": "57"
                }
            },
            "lines": {
                "data": []
            },
            "tax_exemption_reasons": {
                "data": null
            },
            "user": {
                "data": {
                    "type": "current_company_users",
                    "id": "800000863"
                }
            }
        }
    }
}

Este pedido é equivalente ao pedido de alteração do cabeçalho do documento (ver Alteração do cabeçalho do documento). Por isso, a finalização do documento — que é a alteração do atributo "status" do cabeçalho — pode ser realizada juntamente com a alteração de outros atributos ou relações do cabeçalho, num único pedido.

---

Alteração do Documento de Venda

Enquanto o documento não for finalizado, tanto o seu cabeçalho como qualquer uma das suas linhas podem ser alteradas a qualquer momento. Além disso, qualquer uma das linhas pode ser eliminada (ver Eliminação de uma linha), e novas linhas criadas e adicionadas (ver 2. Criação da(s) linha(s)).

Atualizar Linha de Documento de Venda

Atualizar Linha de Documentos de Venda

Atualizar Linha de Documentos de Venda

PATCH/api/commercial_sales_document_lines

Body

application/json

dataobject

Response

200

Sucesso

Headers

Body

application/json

dataobject

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/commercial_sales_document_lines', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "attributes": {
          "amount": 0,
          "amount_with_header_settlement": 0,
          "base_currency_amount": null,
          "base_currency_net_amount": null,
          "base_currency_net_unit_price": null,
          "base_currency_settlement_with_tax": null,
          "base_currency_settlement_without_tax": null,
          "base_currency_tax_amount": null,
          "base_currency_unit_price": null,
          "created_at": "2024-03-05 14:25:28.275949",
          "date": null,
          "description": "<p>Isto é uma NOVA breve descrição</p>",
          "exemption_reason": null,
          "imported_quantity": null,
          "item_code": "1000",
          "item_id": 2,
          "item_type": "Product",
          "item_unit_price_includes_vat": false,
          "locked": null,
          "net_amount": 0,
          "net_amount_with_header_settlement": 0,
          "net_settlement_amount": null,
          "net_tax_amount": null,
          "net_unit_price": 2,
          "original_document_no": null,
          "pending_quantity": null,
          "pending_retention_value": null,
          "pending_total": null,
          "quantity": null,
          "retention_value": null,
          "settlement_amount": null,
          "settlement_expression": null,
          "settlement_percentage": 0,
          "settlement_with_tax": 0,
          "settlement_without_tax": 0,
          "tax_amount": 0,
          "tax_code": "INT",
          "tax_country_region": "PT",
          "tax_descriptor_id": null,
          "tax_percentage": 13,
          "unit_price": 2,
          "updated_at": "2024-03-05 14:25:28.275949",
          "__$markdownParsed": true
        },
        "id": "131",
        "type": "commercial_sales_document_lines"
      }
    }),
});
const data = await response.json();

Response

{
  "data": {
    "attributes": {
      "amount": 2.09,
      "amount_with_header_settlement": 2.26,
      "base_currency_amount": null,
      "base_currency_net_amount": null,
      "base_currency_net_unit_price": null,
      "base_currency_settlement_with_tax": null,
      "base_currency_settlement_without_tax": null,
      "base_currency_tax_amount": null,
      "base_currency_unit_price": null,
      "created_at": "2024-03-05 14:25:28.275949",
      "date": null,
      "description": "Isto é uma NOVA breve descrição",
      "exemption_reason": null,
      "imported_quantity": null,
      "item_code": "1000",
      "item_id": 2,
      "item_type": "Product",
      "item_unit_price_includes_vat": false,
      "locked": null,
      "net_amount": 1.85,
      "net_amount_with_header_settlement": 2,
      "net_settlement_amount": null,
      "net_tax_amount": null,
      "net_unit_price": 1.85,
      "original_document_no": null,
      "pending_quantity": null,
      "pending_retention_value": null,
      "pending_total": null,
      "quantity": 1,
      "retention_value": null,
      "settlement_amount": null,
      "settlement_expression": null,
      "settlement_percentage": 0,
      "settlement_with_tax": 0,
      "settlement_without_tax": 0,
      "tax_amount": 0.24,
      "tax_code": "INT",
      "tax_country_region": "PT",
      "tax_descriptor_id": null,
      "tax_percentage": 13,
      "unit_price": 2,
      "updated_at": "2024-03-05 14:43:46.935053"
    },
    "id": "131",
    "relationships": {
      "document": {
        "data": {
          "id": "66",
          "type": "commercial_sales_documents"
        }
      },
      "product": {
        "data": null
      },
      "service": {
        "data": null
      },
      "tax": {
        "data": {
          "id": "2",
          "type": "taxes"
        }
      },
      "tax_descriptor": {
        "data": null
      },
      "unit_of_measure": {
        "data": {
          "id": "5",
          "type": "units_of_measure"
        }
      }
    },
    "type": "commercial_sales_document_lines"
  },
  "meta": {
    "observed": {
      "lines": 1,
      "scalar": 1
    }
  }
}

O exemplo de payload acima deve por isso ser ajustado consoante se trate da alteração duma linha de produto, de serviço, de descritor ou de descrição. É ainda possível alterar o tipo de linha (de uma linha de serviço para uma de produto, por exemplo).

O access_token é o token de acesso válido devolvido pelo serviço de OAuth.

O id da linha é o "id" interno da linha do documento, devolvido no campo "id" da resposta ao seu pedido de criação (ver ponto 2. Criação da(s) linha(s) )

A informação que pode ser enviada no pedido de alteração da linha do documento é equivalente à que é obtida após criação ou obtenção de Documentos de Venda.

Atributo	Descrição
type	Tipo de linha de documento.
id	Identificador interno da linha do documento.
item_id	ID do item associado à linha.
item_code	Código do item.
description	Descrição da linha.
amount	Valor total da linha.
unit_price	Preço unitário do item.
quantity	Quantidade do item.
tax_code	Tipo de IVA aplicado.
tax_percentage	Percentagem de IVA.
tax_amount	Valor do IVA aplicado.
settlement_amount	Valor de liquidação da linha.
settlement_percentage	Percentagem de liquidação da linha.
exemption_reason	Motivo da isenção de imposto.
created_at	Data e hora de criação da linha.
updated_at	Data e hora da última atualização da linha.
tax_country_region	Região do IVA aplicado.
item_unit_price_includes_vat	Indica se o preço unitário do item inclui IVA.
net_amount	Valor líquido da linha.
net_unit_price	Preço unitário líquido do item.
net_tax_amount	Valor líquido do IVA.
date	Data associada à linha.
retention_value	Valor de retenção.
pending_total	Total pendente.
pending_retention_value	Valor de retenção pendente.
locked	Indica se a linha está bloqueada.
base_currency_amount	Valor total da linha na moeda base.
base_currency_unit_price	Preço unitário do item na moeda base.
base_currency_tax_amount	Valor do IVA na moeda base.
base_currency_net_unit_price	Preço unitário líquido do item na moeda base.
base_currency_net_amount	Valor líquido da linha na moeda base.
base_currency_settlement_without_tax	Valor de liquidação sem IVA na moeda base.
original_document_no	Número do documento original associado à linha.
net_settlement_amount	Valor líquido de liquidação.
net_amount_with_header_settlement	Valor líquido da linha com liquidação no cabeçalho.
amount_with_header_settlement	Valor total da linha com liquidação no cabeçalho.
settlement_with_tax	Valor de liquidação com IVA.
settlement_without_tax	Valor de liquidação sem IVA.
base_currency_settlement_with_tax	Valor de liquidação com IVA na moeda base.
item_type	Tipo de item: "Product" (produto), "Service" (serviço) ou "TaxDescriptor" (descritor de imposto).
pending_quantity	Quantidade pendente.
imported_quantity	Quantidade importada.
settlement_expression	Expressão de liquidação.
tax_descriptor_id	ID do descritor de imposto associado à linha.

Por favor, note que alguns atributos podem estar marcados como null, o que significa que não foram fornecidos valores para esses atributos no JSON.

Nota 1 - O "id" interno do documento, associado ao cabeçalho, corresponde ao "id" fornecido na resposta ao pedido de criação desse cabeçalho. Consulte a secção #id-1.-criacao-do-cabecalho para mais detalhes.

Nota 2 - O item (serviço, produto ou descritor) já deve existir, e o seu "id" interno pode ser obtido por um

GET /services?filter[item_code]=<o código do serviço> 
ou 
GET /products?filter[item_code]=<o código do produto> 
ou 
GET /tax_descriptors?filter[notation]=<o código do descritor>

Nota 3 - Além de "PT" (Portugal Continental), são também suportadas as regiões autónomas de IVA "PT-AC" (Açores) e "PT-MA" (Madeira).

Para consultar os regimes de IVA no âmbito do OSS, é importante notar que os códigos de região correspondem aos códigos dos países. Estes códigos podem ser obtidos através do seguinte pedido:

GET /countries?filter[iso_alpha_2]=<o código do país OSS>

Nota 4 - A unidade de medida deve existir previamente, e seu identificador "id" interno pode ser obtido através de um

GET /units_of_measure?filter[unit_of_measure]=<o código da unidade de medida>

Nota 5 - O "id" interno da taxa de IVA deve ser obtido por um

GET /taxes?filter[tax_code]=&filter[tax_country_region]=<a região do IVA>
ou
GET /taxes?filter[tax_code]=&filter[tax_country_region]=<a região do IVA>&filter[tax_percentage]=<a percentagem IVA>

Remover Linha de Documento de Venda

Remover Linhas de Documentos de Venda

Remover Linhas de Documentos de Venda

DELETE/api/commercial_sales_document_lines/{salesDocumentLineId}

Path parameters

salesDocumentLineId*string

Id da Linha do Documento de Venda

Example: "131"

Response

200404

Sucesso

Headers

Body

application/json

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/commercial_sales_document_lines/{salesDocumentLineId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "meta": {
    "observed": {
      "lines": 5,
      "scalar": 1
    }
  }
}

No pedido acima, o access_token é o token de acesso válido devolvido pelo serviço de OAuth e o id da linha é o "id" interno da linha do documento, devolvido no campo "id" da resposta ao seu pedido de criação (ver ponto 2. Criação da(s) linha(s)).

---

Anulação do documento

Após a sua finalização, o documento deixa de poder ser eliminado, podendo apenas ser anulado.

Anular Recibo de Venda

Anular Recibo de Venda

PATCH/api/v1/commercial_sales_receipts/{salesReceiptId}/void

Path parameters

salesReceiptId*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/commercial_sales_receipts/{salesReceiptId}/void', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

No pedido acima, o access_token é o token de acesso válido devolvido pelo serviço de OAuth e o id do documento é o "id" interno do documento (cabeçalho) é o devolvido no campo "id" da resposta ao seu pedido de criação (ver ponto 1. Criação do cabeçalho). O payload JSON a enviar contém a seguinte informação:

{
  "data": {
    "type": "commercial_sales_documents",                             // [OBRIGATÓRIO]
    "id": "1",                                                        // [OBRIGATÓRIO] Identificador interno do documento (cabeçalho). Este "id" é o devolvido na resposta ao pedido de criação do cabeçalho, ver acima.
    "attributes": {                                                   // [OBRIGATÓRIO] Os atributos do documento
      "status": 4,                                                    // [OBRIGATÓRIO] Identificação do estado do documento. 4: documento anulado.
      "voided_reason": "Motivo pelo qual se anula o documento"        // [OBRIGATÓRIO]
    }
  }
}

Após a sua anulação, o documento deixa de poder ser alterado. Esta operação é irreversível.

---

Remover Documento de Venda

Enquanto estiver em preparação, o documento pode ser eliminado.

Após a finalização, a sua eliminação — assim como a sua alteração — deixa de ser possível. Para saber mais consulte: 3. Finalização do documento

Remover Documentos de Venda

Remover Documentos de Venda

DELETE/api/commercial_sales_documents/{id}

Path parameters

id*string

Example: "66"

Response

200403

Remover Documentos de Venda

Headers

Body

application/json

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/commercial_sales_documents/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "meta": {
    "observed": {
      "scalar": 1
    }
  }
}

No pedido acima, o access_token é o token de acesso válido devolvido pelo serviço de OAuth e o id do documento é o "id" interno do documento (cabeçalho) é o devolvido no campo "id" da resposta ao seu pedido de criação (ver ponto 1. Criação do cabeçalho).

Esta operação é irreversível.