Notas de compra

As rotas aqui descritas permitem gerir todos os processos relativos a notas de compra, tanto a débito como a crédito.

As notas têm a mesma estrutura que os restantes documentos de compra. Na versão v1 da API têm a mesma estrutura anteriormente descrita para a v0: são compostas por um cabeçalho e uma ou mais linhas. Nesta nova versão, é possível criar ambos num só pedido, descrito de seguida.

Todos os pedidos descritos são formalmente semelhantes aos pedidos correspondentes dos restantes documentos de compra: as rotas utilizados são as mesmas, e os payloads JSON a enviar são estruturalmente semelhantes, partilhando os mesmos atributos.

Criação da nota

post

Body

document_typestringRequiredExample: FC|DSP

datestringOptionalExample: 2023-01-01

document_series_idintegerOptionalExample: 1

document_series_prefixstringOptionalExample: Prefixo da série

supplier_idintegerOptionalExample: 1

supplier_tax_registration_numberstringOptionalExample: 999999990

supplier_business_namestringOptionalExample: Nome do fornecedor

supplier_address_detailstringOptionalExample: Morada do fornecedor

supplier_postcodestringOptionalExample: 0000-000

supplier_citystringOptionalExample: Cidade/Localidade do fornecedor

supplier_countrystringOptionalExample: PT

due_datestringOptionalExample: 2023-02-01

settlement_expressionstringOptionalExample: 7.5

vat_included_pricesbooleanOptionalExample: false

tax_exemption_reason_idintegerOptionalExample: 1

currency_idintegerOptionalExample: 1

currency_iso_codestringOptionalExample: USD

currency_conversion_ratenumberOptionalExample: 1.21

retention_totalnumberOptionalExample: 9.99

retention_typestringOptionalExample: TD|TI|C|P|CPS|O

notesstringOptionalExample: Notas ao documento

external_referencestringOptionalExample: Referência do documento externo

finalizebooleanOptionalExample: true

return_pdfbooleanOptionalExample: true

Responses

200

OK

application/json

idintegerOptionalExample: 1

document_typestringOptionalExample: FC|DSP

datestringOptionalExample: 2023-01-01

document_series_idintegerOptionalExample: 1

document_series_prefixstringOptionalExample: Prefixo da série

supplier_idintegerOptionalExample: 1

supplier_tax_registration_numberstringOptionalExample: 999999990

supplier_business_namestringOptionalExample: Nome do fornecedor

supplier_address_detailstringOptionalExample: Morada do fornecedor

supplier_postcodestringOptionalExample: 0000-000

supplier_citystringOptionalExample: Cidade/Localidade do fornecedor

supplier_countrystringOptionalExample: PT

due_datestringOptionalExample: 2023-02-01

settlement_expressionstringOptionalExample: 7.5

vat_included_pricesbooleanOptionalExample: false

tax_exemption_reason_idintegerOptionalExample: 1

currency_idintegerOptionalExample: 1

currency_iso_codestringOptionalExample: USD

currency_conversion_ratenumberOptionalExample: 1.21

retention_totalnumberOptionalExample: 9.99

retention_typestringOptionalExample: TD|TI|C|P|CPS|O

notesstringOptionalExample: Notas ao documento

external_referencestringOptionalExample: Referência do documento externo

urlstringOptionalExample: https://app.cloudware.pt/path_to_file

post/v1/commercial_purchases_documents

POST /v1/commercial_purchases_documents HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1112

{
  "document_type": "FC|DSP",
  "date": "2023-01-01",
  "document_series_id": 1,
  "document_series_prefix": "Prefixo da série",
  "supplier_id": 1,
  "supplier_tax_registration_number": "999999990",
  "supplier_business_name": "Nome do fornecedor",
  "supplier_address_detail": "Morada do fornecedor",
  "supplier_postcode": "0000-000",
  "supplier_city": "Cidade/Localidade do fornecedor",
  "supplier_country": "PT",
  "due_date": "2023-02-01",
  "settlement_expression": "7.5",
  "vat_included_prices": false,
  "tax_exemption_reason_id": 1,
  "currency_id": 1,
  "currency_iso_code": "USD",
  "currency_conversion_rate": 1.21,
  "retention_total": 9.99,
  "retention_type": "TD|TI|C|P|CPS|O",
  "notes": "Notas ao documento",
  "external_reference": "Referência do documento externo",
  "finalize": true,
  "return_pdf": true,
  "lines": [
    {
      "item_type": "Product|Purchases::ExpenseCategory",
      "item_id": 1,
      "item_code": "Código do produto/categoria de despesas",
      "description": "Descrição da linha",
      "unit_of_measure_id": 1,
      "unit_of_measure": "Unidade de medida",
      "quantity": 1,
      "unit_price": 9.99,
      "settlement_expression": "3",
      "tax_id": 1,
      "tax_code": "NOR|INT|RED|ISE",
      "tax_percentage": 22,
      "tax_country_region": "PT-MA"
    }
  ]
}

200

OK

{
  "id": 1,
  "document_type": "FC|DSP",
  "date": "2023-01-01",
  "document_series_id": 1,
  "document_series_prefix": "Prefixo da série",
  "supplier_id": 1,
  "supplier_tax_registration_number": "999999990",
  "supplier_business_name": "Nome do fornecedor",
  "supplier_address_detail": "Morada do fornecedor",
  "supplier_postcode": "0000-000",
  "supplier_city": "Cidade/Localidade do fornecedor",
  "supplier_country": "PT",
  "due_date": "2023-02-01",
  "settlement_expression": "7.5",
  "vat_included_prices": false,
  "tax_exemption_reason_id": 1,
  "currency_id": 1,
  "currency_iso_code": "USD",
  "currency_conversion_rate": 1.21,
  "retention_total": 9.99,
  "retention_type": "TD|TI|C|P|CPS|O",
  "notes": "Notas ao documento",
  "external_reference": "Referência do documento externo",
  "url": "https://app.cloudware.pt/path_to_file",
  "lines": [
    {
      "id": 1,
      "item_type": "Product|Purchases::ExpenseCategory",
      "item_id": 1,
      "item_code": "Código do produto/categoria de despesas",
      "description": "Descrição da linha",
      "unit_of_measure_id": 1,
      "unit_of_measure": "Unidade de medida",
      "quantity": 1,
      "unit_price": 9.99,
      "settlement_expression": "3",
      "tax_id": 1,
      "tax_code": "NOR|INT|RED|ISE",
      "tax_percentage": 22,
      "tax_country_region": "PT-MA"
    }
  ]
}

curl -v -X POST -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer <access_token>' -d '<payload JSON>' '<API_URL>/v1/commercial_purchases_documents'

O payload JSON a enviar contém a seguinte informação:

{
  // Identificação do documento
  "document_type": "NCF|NDF",                                     // [OBRIGATÓRIO] Tipo de documento. "NCF": nota de crédito, "NDF": nota de débito.
  "date": "2023-01-01",                                           // [OPCIONAL] Data do documento; por omissão, a data do pedido.

  // [OPCIONAL] Identificação da série do documento. Por omissão, aplicam-se as regras configuradas na empresa para escolha da série.
  // Se a série for indicada, usar apenas um dos dois campos seguintes (o "id" ou o prefixo). Se se indicarem os dois, então devem ser consistentes.
  "document_series_id": 1,                                        // [OPCIONAL] Identificador interno da série. Ver NOTA 1 abaixo.
  "document_series_prefix": "Prefixo da série",                   // [OPCIONAL] Em alternativa ao campo "document_series_id".

  // [OPCIONAL] Identificação do fornecedor. Por omissão, é o fornecedor indiferenciado (NIF "999999990").
  // Se o fornecedor for indicado, usar apenas um dos dois campos seguintes (o "id" ou o NIF). Se se indicarem os dois, então devem ser consistentes.
  "supplier_id": 1,                                               // [OPCIONAL] Identificador interno do fornecedor. Ver NOTA 2.
  "supplier_tax_registration_number": "999999990",                // [OPCIONAL] NIF do fornecedor. se o fornecedor com o NIF indicado não existir, será criado automaticamente. Se o país ("supplier_country") for Portugal ("PT", "PT-AC" ou "PT-MA"), deve ser um NIF português válido.
  // [OPCIONAL] Os atributos seguintes são usados na criação do fornecedor, se não existir ainda.
  // Se o fornecedor já existir, são guardados no documento, mas a ficha do fornecedor não é actualizada.
  "supplier_business_name": "Nome do fornecedor",                 // [OBRIGATÓRIO] caso o fornecedor ainda não exista e tenha que ser criado. [OPCIONAL] nos outros casos, a não ser que exista mais do que um fornecedor com o NIF indicado, usando-se então o nome para o identificar.
  "supplier_address_detail": "Morada do fornecedor",              // [OPCIONAL]
  "supplier_postcode": "0000-000",                                // [OPCIONAL] Código postal do fornecedor, no formato 0000-000.
  "supplier_city": "Cidade/Localidade do fornecedor",             // [OPCIONAL]
  "supplier_country": "PT",                                       // [OPCIONAL] País do fornecedor. Por omissão, "PT"; é o código ISO alpha-2 do país do fornecedor (vd. https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2; ver também a NOTA 3.

  // [OPCIONAL] Condições de pagamento
  "due_date": "2023-02-01",                                       // [OPCIONAL] Data de vencimento; por omissão, a data do documento, ou a referente ao prazo de pagamento configurado no fornecedor, se o fornecedor tiver configurado um prazo de pagamento.
  "settlement_expression": "7.5",                                 // [OPCIONAL] Desconto no cabeçalho, em percentagem; são suportados descontos compostos, como "3+5"

  // [OPCIONAL] IVA
  "vat_included_prices": false,                                   // [OPCIONAL] Os preços nas linhas são com IVA incluído? Por omissão, não (false).
  "tax_exemption_reason_id": 1,                                   // Motivo de isenção de IVA. [OBRIGATÓRIO] apenas se o documento tiver pelo menos uma linha isenta de IVA. Não deve ser indicado nos restantes casos. Ver NOTA 4.

  // [OPCIONAL] Moeda. Por omissão, "EUR".
  // Se a moeda for indicada, usar apenas um dos dois campos seguintes (o "id" ou o código ISO). Se se indicarem os dois, então devem ser consistentes.
  "currency_id": 1,                                               // [OPCIONAL] Identificador interno da moeda. Ver NOTA 5.
  "currency_iso_code": "USD",                                     // [OPCIONAL] É o código ISO da moeda do documento (vd. https://en.wikipedia.org/wiki/ISO_4217).
  "currency_conversion_rate": 1.21,                               // [OMITIDO] se a moeda for "EUR". [OBRIGATÓRIO] nos restantes casos; é a taxa de conversão para EUR (1 EUR = n USD|...).

  // [OPCIONAL] Identificação do documento sobre o qual a nota está a ser emitida. Por omissão, a nota não ficará associada a nenhum documento.
  "parent_documents_ids": "{1}",                                  // [OPCIONAL] Identificador interno do documento ao qual a nota está associada.

  // [OPCIONAL] Retenção
  "retention_total": 9.99,                                        // [OPCIONAL] Valor total de retenção.
  "retention_type": "TD|TI|C|P|CPS|O",                            // [OPCIONAL] Tipo de retenção. TD: Trabalho dependente, TI: Trabalho independente, C: Capitais, P: Prediais, CPS: Comissões e Prestações de Serviços, O: Outros. Por omissão, "TD".

  // [OPCIONAL] Outras informações
  "notes": "Notas ao documento",                                  // [OPCIONAL]
  "external_reference": "Referência do documento externo",        // [OPCIONAL]

  // [OPCIONAL] Instruções de processamento do documento 
  "finalize": true,                                               // [OPCIONAL] O documento deve ser imediatamente finalizado (true) ou deixado em preparação (false)? Por omissão, o documento é deixado em preparação.
  "return_pdf": false,                                            // [OPCIONAL] O documento deve ser imediatamente materializado (true), ou não (false)? Caso se opte pela materialização do documento, será devolvido um link para o respectivo PDF. Por omissão, o documento não é materializado.

  // [OBRIGATÓRIO] Linhas do documento

  "lines": [
      {
          // [OPCIONAL] Identificação do item. Se nada for indicado, assume-se uma linha apenas de descrição.
          "item_type": "Product|Purchases::ExpenseCategory",      // [OPCIONAL] Tipo de item: "Product": produto, "Purchases::ExpenseCategory": categoria de despesas. Por omissão fica vazio (linha de descrição).
          // Se o item for indicado, usar apenas um dos dois campos seguintes (o "id" ou o código). Se se indicarem os dois, então devem ser consistentes entre si, e consistentes com o "item_type".
          "item_id": 1,                                           // [OPCIONAL] Identificador interno do item. Ver NOTA 6.
          "item_code": "Código do produto/categoria de despesas", // [OPCIONAL] Já tem que existir o produto/categoria de despesas com este código. Por omissão, é usado o item identificado pelo campo "item_id". Se nada for indicado, assume-se uma linha apenas de descrição.
          "description": "Descrição da linha",                    // [OPCIONAL] Por omissão é usada a descrição associada ao item, se este for indicado. [OBRIGATÓRIO] Para uma linha apenas de descrição.

          // [OPCIONAL] Unidade de medida. Por omissão é a configurada no item (se for produto), ou a por omissão na empresa.
          // Se a unidade de medida for indicada, usar apenas um dos dois campos seguintes (o "id" ou o código). Se se indicarem os dois, então devem ser consistentes entre si.
          "unit_of_measure_id": 1,                                // [OPCIONAL] Identificador interno da unidade de medida. Ver NOTA 7.
          "unit_of_measure": "Unidade de medida",                 // [OPCIONAL] Por omissão é a configurada no item (se for produto), ou a por omissão na empresa.
          // Quantidades e valores. [OBRIGATÓRIO] Para linhas de descrição valorizadas.
          "quantity": 1,                                          // [OPCIONAL] Por omissão 1, se não for uma linha de descrição valorizada. [OBRIGATÓRIO] Para uma linha de descrição valorizada.
          "unit_price": 9.99,                                     // [OPCIONAL] Se for indicado um produto. Por omissão é usado o PVP associado ao produto. [OBRIGATÓRIO] Para uma linha de categoria de despesas ou de descrição valorizada.
          "settlement_expression": "3",                           // [OPCIONAL] Desconto de linha, em percentagem; são suportados descontos compostos, como "3+5".

          // [OPCIONAL] IVA. Por omissão é aplicado o IVA associado ao item, ou à taxa normal, na região onde a empresa está localizada.
          // Se a taxa de IVA for indicada, usar apenas ou o campo "id" ou um ou mais dos três campos seguintes. Se se indicarem todos os campos, então devem ser consistentes entre si.
          "tax_id": 1,                                            // [OPCIONAL] Identificador interno da taxa de IVA. Ver NOTA 8.
          "tax_code": "NOR|INT|RED|ISE",                          // [OPCIONAL] Por omissão é usado o tipo de IVA associado ao item, ou "NOR" se nenhum associado. Os tipos de IVA suportados são "NOR" (normal), "INT" (intermédio), "RED" (reduzido), "ISE" (isento).
          "tax_percentage": 22,                                   // [OPCIONAL] Percentagem de IVA a usar: serve para indicar uma taxa de outra região (se o campo "tax_country_region" não for indicado) ou uma taxa antiga, já não em vigor.
          "tax_country_region": "PT-MA"                           // [OPCIONAL] Região do IVA. Por omissão (e se o campo "tax_percentage" não for indicado) aplica-se a taxa de IVA da região onde a empresa está localizada.
    },
      // Outras linhas, se existirem
      ...
  ]
}

• 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]=FC|<o tipo de documento>&filter[prefix]=2020|<o prefixo da série a usar> 

• NOTA 2: Se o fornecedor for identificado pelo seu "id" interno tem já que existir, e o seu "id" interno pode ser obtido por um

GET /suppliers?filter[tax_registration_number]=<o NIF do fornecedor>

• 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]=PT|<o código do país>

• NOTA 4: O "id" interno do motivo de isenção deve ser obtido por um

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

• NOTA 5: O "id" interno da moeda deve ser obtido por um

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

• NOTA 6: O item (produto ou categoria de despesas) tem já que existir, e o seu "id" interno pode ser obtido por um

GET /products?filter[item_code]=<o código do produto> 
ou
GET /expense_categories?filter[accounting_number]=331|<o código da categoria de despesas> 

• NOTA 7: A unidade de medida tem já que existir, e o seu "id" interno pode ser obtido por um

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

• NOTA 8: O "id" interno da taxa de IVA deve ser obtido por um

GET /taxes?filter[tax_code]=NOR|<o tipo de IVA>&filter[tax_country_region]=PT|<a região do IVA>
ou
GET /taxes?filter[tax_code]=NOR|<o tipo de IVA>&filter[tax_country_region]=PT|<a região do IVA>&filter[tax_percentage]=22|<a percentagem IVA>

Eliminação da nota

Ver Eliminação do documento.

Finalização da nota

Ver Finalização do documento.

Anulação da nota

Ver Anulação do documento.

Alteração da nota

Ver Alteração do documento.

Eliminação de uma linha

Ver Eliminação de uma linha.

Consulta da nota

Ver Consulta do documento.