latestOpenAPI 3.0.32026-08-101200629.5 KB

2c51a28d0f48

Versões Anteriores

Vendas1

Documentos de Venda1

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

Request body

Example request

{
  "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"
    },
    "type": "commercial_sales_documents"
  }
}

Response

Sucesso

Example response

{
  "data": {
    "attributes": {
      "apply_retention_when_paid": true,
      "communication_code_source": "webservice",
      "communication_status": "unsent",
      "created_at": "2024-03-05 14:24:53.318028",
      "currency_conversion_rate": 1,
      "currency_iso_code": "EUR",
      "customer_business_name": "Gabriel",
      "customer_country": "PT",
      "customer_tax_country_region": "PT",
      "customer_tax_registration_number": "123456789",
      "date": "2023-01-01",
      "document_area": "FT",
      "document_series_prefix": "2023",
      "document_type": "FT",
      "due_date": "2023-02-01",
      "external_reference": "Referência do documento externo",
      "made_available_to": true,
      "notes": "Notas ao documento",
      "operation_country": "PT-MA",
      "payment_mechanism": "MO",
      "retention": 7.5,
      "retention_type": "IRS",
      "settlement_expression": "7.5",
      "settlement_percentage": 7.5,
      "updated_at": "2024-03-05 14:24:53.318028"
    },
    "id": "66",
    "relationships": {
      "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": []
      },
      "user": {
        "data": {
          "id": "800000863",
          "type": "current_company_users"
        }
      }
    },
    "type": "commercial_sales_documents"
  },
  "meta": {
    "observed": {
      "scalar": 1
    }
  }
}