gobl 0.24.1 → 0.24.3

data/data/addons/pt-saft-v1.json

@@ -0,0 +1,950 @@
+{
+  "$schema": "https://gobl.org/draft-0/tax/addon-def",
+  "key": "pt-saft-v1",
+  "name": {
+    "en": "Portugal SAF-T"
+  },
+  "description": {
+    "en": "Portugal doesn't have an e-invoicing format per se. Tax information is reported\nelectronically to the AT (Autoridade Tributária e Aduaneira) either periodically in\nbatches via a SAF-T (PT) report or individually in real time via a web service. This addon\nensures that the GOBL documents have all the required fields to be able to be reported to\nthe AT."
+  },
+  "sources": [
+    {
+      "title": {
+        "en": "Portaria n.o 302/2016 – SAF-T Data Structure \u0026 Taxonomies"
+      },
+      "url": "https://info.portaldasfinancas.gov.pt/pt/informacao_fiscal/legislacao/diplomas_legislativos/Documents/Portaria_302_2016.pdf",
+      "content_type": "application/pdf"
+    },
+    {
+      "title": {
+        "en": "Portaria n.o 195/2020 – Comunicação de Séries Documentais, Aspetos Específicos"
+      },
+      "url": "https://info.portaldasfinancas.gov.pt/pt/apoio_contribuinte/Faturacao/Comunicacao_Series_ATCUD/Documents/Comunicacao_de_Series_Documentais_Manual_de_Integracao_de_SW_Aspetos_Genericos.pdf",
+      "content_type": "application/pdf"
+    },
+    {
+      "title": {
+        "en": "Portaria n.o 195/2020 – Especificações Técnicas Código QR"
+      },
+      "url": "https://info.portaldasfinancas.gov.pt/pt/apoio_contribuinte/Novas_regras_faturacao/Documents/Especificacoes_Tecnicas_Codigo_QR.pdf",
+      "content_type": "application/pdf"
+    },
+    {
+      "title": {
+        "en": "Comunicação dos elementos dos documentos de faturação à AT, por webservice"
+      },
+      "url": "https://info.portaldasfinancas.gov.pt/pt/apoio_contribuinte/Faturacao/Fatcorews/Documents/Comunicacao_dos_elementos_dos_documentos_de_faturacao.pdf",
+      "content_type": "application/pdf"
+    }
+  ],
+  "extensions": [
+    {
+      "key": "pt-saft-invoice-type",
+      "name": {
+        "en": "Invoice Type",
+        "pt": "Tipo de Fatura"
+      },
+      "desc": {
+        "en": "SAF-T's `InvoiceType` (Tipo de documento) specifies the type of a sales invoice. In GOBL,\nthis type can be set using the `pt-saft-invoice-type` extension in the tax section. GOBL\nwill set the extension for you based on the type and the tax tags you set in your invoice.\n\nThe table below shows how this mapping is done:\n\n| Code | Name                | GOBL Type     | GOBL Tax Tag    |\n| ---- | ------------------- | ------------- | --------------- |\n| `FT` | Standard Invoice    | `standard`    |                 |\n| `FS` | Simplified Invoice  | `standard`    | `simplified`    |\n| `FR` | Invoice-Receipt     | `standard`    | `invoice-receipt` |\n| `ND` | Debit Note          | `debit-note`  |                 |\n| `NC` | Credit Note         | `credit-note` |                 |\n\nExample:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/invoice\",\n\t\"$tags\": [\n\t\t\"invoice-receipt\"\n\t],\n\t// ...\n\t\"type\": \"standard\",\n\t// ...\n\t\"tax\": {\n\t\t\"ext\": {\n\t\t\t\"pt-saft-invoice-type\": \"FR\"\n\t\t}\n\t},\n\t// ...\n```"
+      },
+      "values": [
+        {
+          "code": "FT",
+          "name": {
+            "en": "Standard Invoice",
+            "pt": "Fatura"
+          },
+          "desc": {
+            "en": "Invoice issued under article 36 of the VAT code.",
+            "pt": "Fatura, emitida nos termos do artigo 36.o do Código do IVA"
+          }
+        },
+        {
+          "code": "FS",
+          "name": {
+            "en": "Simplified Invoice",
+            "pt": "Fatura Simplificada"
+          },
+          "desc": {
+            "en": "Simplified invoice issued under article 40 of the VAT code.",
+            "pt": "Fatura simplificada, emitida nos termos do artigo 40.o do Código do IVA"
+          }
+        },
+        {
+          "code": "FR",
+          "name": {
+            "en": "Invoice-Receipt",
+            "pt": "Fatura-Recibo"
+          },
+          "desc": {
+            "en": "Invoice issued after payment.",
+            "pt": "Fatura-recibo"
+          }
+        },
+        {
+          "code": "ND",
+          "name": {
+            "en": "Debit Note",
+            "pt": "Nota de Débito"
+          }
+        },
+        {
+          "code": "NC",
+          "name": {
+            "en": "Credit Note",
+            "pt": "Nota de Crédito"
+          }
+        }
+      ]
+    },
+    {
+      "key": "pt-saft-payment-type",
+      "name": {
+        "en": "Payment Type",
+        "pt": "Tipo de Pagamento"
+      },
+      "desc": {
+        "en": "To report payment receipts to the AT, GOBL provides conversion from `bill.Payment`\ndocuments. In a payment, the SAF-T's `PaymentType` (Tipo de documento) field specifies its\ntype. In GOBL, this type can be set using the `pt-saft-payment-type` extension. GOBL will\nset the extension automatically based on the type and the tax tags you set. The table\nbelow shows how this mapping is done:\n\n| Code | Name                                       | GOBL Type | GOBL Tax Tag |\n| ---- | ------------------------------------------ | --------- | ------------ |\n| RG   | Outro Recibo                               | `receipt` |              |\n| RC   | Recibo no âmbito do regime de IVA de Caixa | `receipt` | `vat-cash`   |\n\nFor example:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/payment\",\n\t// ...\n\t\"type\": \"receipt\",\n\t// ...\n\t\"ext\": {\n\t\t\"pt-saft-receipt-type\": \"RG\"\n\t},\n\t// ...\n```"
+      },
+      "values": [
+        {
+          "code": "RC",
+          "name": {
+            "en": "Receipt under the VAT Cash scheme",
+            "pt": "Recibo no âmbito do regime de IVA de Caixa"
+          }
+        },
+        {
+          "code": "RG",
+          "name": {
+            "en": "Other Receipt",
+            "pt": "Outro Recibo"
+          }
+        }
+      ]
+    },
+    {
+      "key": "pt-saft-tax-rate",
+      "name": {
+        "en": "Tax Rate Code",
+        "pt": "Código da Taxa de Imposto"
+      },
+      "desc": {
+        "en": "The SAF-T's `TaxCode` (Código do imposto) is required for invoice items that apply VAT.\nGOBL provides the `pt-saft-tax-rate` extension to set this code at line tax level. It also\ndetermines it automatically this code using the `rate` field (when present). The following\ntable lists the supported tax codes and how GOBL will map them:\n\n| Code   | Name            | GOBL Tax Rate  |\n| ------ | --------------- | -------------- |\n| `NOR`  | Tipo Geral      | `standard`     |\n| `INT`  | Taxa Intermédia | `intermediate` |\n| `RED`  | Taxa Reduzida   | `reduced`      |\n| `ISE`  | Isenta          | `exempt`       |"
+      },
+      "values": [
+        {
+          "code": "RED",
+          "name": {
+            "en": "Reduced",
+            "pt": "Redução"
+          }
+        },
+        {
+          "code": "INT",
+          "name": {
+            "en": "Intermediate",
+            "pt": "Intermédio"
+          }
+        },
+        {
+          "code": "NOR",
+          "name": {
+            "en": "Normal",
+            "pt": "Normal"
+          }
+        },
+        {
+          "code": "ISE",
+          "name": {
+            "en": "Exempt",
+            "pt": "Isento"
+          }
+        },
+        {
+          "code": "OUT",
+          "name": {
+            "en": "Other",
+            "pt": "Outro"
+          }
+        }
+      ]
+    },
+    {
+      "key": "pt-saft-exemption",
+      "name": {
+        "en": "Tax exemption reason code",
+        "pt": "Código do motivo de isenção de imposto"
+      },
+      "desc": {
+        "en": "The SAF-T's `TaxExemptionCode` (Código do motivo de isenção de imposto) is a code that\nspecifies the reason the VAT tax is exempt in a Portuguese invoice. When the `exempt` tag\nis used in a tax combo, the `ext` map's `pt-saft-exemption` property is required.\n\nThe SAF-T's `TaxExemptionReason` (Motivo da isenção de imposto) is a text that justifies\nthe exemption referencing the relevant legislation. In GOBL, this is provided with a\nspecial line-level `note`.\n\nBy default, if no note is provided, GOBL will automatically assign a default one\nconsistent with the exemption code. However, note that default texts are generic and not\nalways sufficiently precise to comply with the regulations. The invoice issuer should be\ngiven the option to provide a custom note with the appropriate descriptive text.\n\nFor example, you could define an invoice line exempt of tax with the exemption code and\nthe reason as follows:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/invoice\",\n\t// ...\n\t\"lines\": [\n\t\t{\n\t\t\t// ...\n\t\t\"item\": {\n\t\t\t\t\"name\": \"Some service exempt of tax\",\n\t\t\t\t\"price\": \"25.00\"\n\t\t\t},\n\t\t\t\"tax\": [\n\t\t\t\t{\n\t\t\t\t\t\t\"cat\": \"VAT\",\n\t\t\t\t\t\t\"rate\": \"exempt\",\n\t\t\t\t\t\t\"ext\": {\n\t\t\t\t\t\t\t\"pt-saft-tax-rate\": \"ISE\",\n\t\t\t\t\t\t\t\"pt-saft-exemption\": \"M40\"\n\t\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"notes\": [\n\t\t\t{\n\t\t\t\t\"key\": \"legal\",\n\t\t\t\t\"code\": \"M40\",\n\t\t\t\t\"src\": \"pt-saft-exemption\",\n\t\t\t\t\"text\": \"Artigo 6.º n.º 6 alínea a) do CIVA, a contrário\"\n\t\t\t}\n\t\t]\n\t]\n}\n```"
+      },
+      "sources": [
+        {
+          "title": {
+            "en": "AT Tax Exemption Codes",
+            "pt": "Códigos de motivo de isenção"
+          },
+          "url": "https://info.portaldasfinancas.gov.pt/pt/apoio_contribuinte/Faturacao/Fatcorews/Documents/Tabela_Codigos_Motivo_Isencao.pdf",
+          "content_type": "application/pdf"
+        },
+        {
+          "title": {
+            "en": "Art. 2.2.14 of Despacho nº8632/2014",
+            "pt": "Art. 2.2.14 do Despacho nº8632/2014"
+          },
+          "url": "https://files.diariodarepublica.pt/2s/2014/07/126000000/1725517261.pdf",
+          "content_type": "application/pdf"
+        },
+        {
+          "title": {
+            "en": "Field 4.4.19.7 of Portaria nº302/2016",
+            "pt": "Campo 4.4.19.7 da Portaria nº302/2016"
+          },
+          "url": "https://files.diariodarepublica.pt/1s/2016/12/23100/0427304379.pdf",
+          "content_type": "application/pdf"
+        }
+      ],
+      "values": [
+        {
+          "code": "M01",
+          "name": {
+            "en": "Article 16, No. 6, paragraphs a) to d) of the VAT code",
+            "pt": "Artigo 16.º, n.º 6, alíneas a) a d) do CIVA"
+          },
+          "desc": {
+            "en": "Amounts invoiced as being received on behalf of the purchaser\n— e.g. agency sales or third-party collections; supplier records\nfunds in “accounts of third parties”, no VAT is added by the\nsupplier."
+          }
+        },
+        {
+          "code": "M02",
+          "name": {
+            "en": "Article 6 of Decree-Law No. 198/90 of 19th June",
+            "pt": "Artigo 6.º do Decreto-Lei n.º 198/90, de 19 de junho"
+          },
+          "desc": {
+            "en": "B2B deliveries above €1,000 from a domestic supplier to a\ntaxable person in Portugal who exports in the same state — VAT\nzero-rated when export is immediate."
+          }
+        },
+        {
+          "code": "M04",
+          "name": {
+            "en": "Article 13 of the VAT code",
+            "pt": "Artigo 13.º do CIVA"
+          },
+          "desc": {
+            "en": "Certain types of importation or re-importation expressly exempt\nunder Portuguese VAT rules."
+          }
+        },
+        {
+          "code": "M05",
+          "name": {
+            "en": "Article 14 of the VAT code",
+            "pt": "Artigo 14.º do CIVA"
+          },
+          "desc": {
+            "en": "Exports, deemed exports or international transport services\nprovided from Portugal — zero-rated for VAT."
+          }
+        },
+        {
+          "code": "M06",
+          "name": {
+            "en": "Article 15 of the VAT code",
+            "pt": "Artigo 15.º do CIVA"
+          },
+          "desc": {
+            "en": "Goods or services under suspension regimes (e.g. transhipment,\nprocessing), or special transitional exemption schemes."
+          }
+        },
+        {
+          "code": "M07",
+          "name": {
+            "en": "Article 9 of the VAT code",
+            "pt": "Artigo 9.º do CIVA"
+          },
+          "desc": {
+            "en": "Activities such as health, education, culture, insurance,\nrentals, or authorized lotteries — exempt goods and services, but\nwithout VAT recovery rights."
+          }
+        },
+        {
+          "code": "M09",
+          "name": {
+            "en": "Article 62 paragraph b) of the VAT code",
+            "pt": "Artigo 62.º alínea b) do CIVA"
+          },
+          "desc": {
+            "en": "Retailers under the “small trader regime” (volume below threshold)\nwho cannot recover VAT on inputs. The VAT is not levied, but the\ntaxpayer has no deduction rights."
+          }
+        },
+        {
+          "code": "M10",
+          "name": {
+            "en": "Article 57 of the VAT code",
+            "pt": "Artigo 57.º do CIVA"
+          },
+          "desc": {
+            "en": "Flat-rate VAT scheme for small taxpayers (typically individuals\nwith turnover below €15,000 in the preceding year). Exemption\napplies, albeit with a limited VAT recovery regime."
+          }
+        },
+        {
+          "code": "M11",
+          "name": {
+            "en": "Decree-Law No. 346/85 of 23rd August",
+            "pt": "Decreto-Lei n.º 346/85, de 23 de agosto"
+          },
+          "desc": {
+            "en": "Suppliers or resellers of manufactured tobacco or matches taxed\nunder the special tobacco tax regime — VAT is either not due or\ntreated under excise rules."
+          }
+        },
+        {
+          "code": "M12",
+          "name": {
+            "en": "Decree-Law No. 221/85 of 3rd July",
+            "pt": "Decreto-Lei n.º 221/85, de 3 de julho"
+          },
+          "desc": {
+            "en": "Travel agencies selling tours in their own name (even when\nbooking services from others) are taxed only on their margin, not\non the full amount."
+          }
+        },
+        {
+          "code": "M13",
+          "name": {
+            "en": "Decree-Law No. 199/96 of 18th October",
+            "pt": "Decreto-Lei n.º 199/96, de 18 de outubro"
+          },
+          "desc": {
+            "en": "Resale of used goods under the margin scheme — VAT applies solely\nto the profit margin."
+          }
+        },
+        {
+          "code": "M14",
+          "name": {
+            "en": "Decree-Law No. 199/96 of 18th October",
+            "pt": "Decreto-Lei n.º 199/96, de 18 de outubro"
+          },
+          "desc": {
+            "en": "Art pieces sold under the margin taxation rule — VAT calculated\nonly on the dealer's margin."
+          }
+        },
+        {
+          "code": "M15",
+          "name": {
+            "en": "Decree-Law No. 199/96 of 18th October",
+            "pt": "Decreto-Lei n.º 199/96, de 18 de outubro"
+          },
+          "desc": {
+            "en": "Antiques or collectibles treated under a margin-based VAT regime,\nmeaning VAT on margin only."
+          }
+        },
+        {
+          "code": "M16",
+          "name": {
+            "en": "Article 14 of the RITI",
+            "pt": "Artigo 14.º do RITI"
+          },
+          "desc": {
+            "en": "Standard rule for intra-EU goods transfers (Normal\nintra-Community supplies) — zero-VAT, no import VAT regime;\nrecipient accounts for VAT via VAT return."
+          }
+        },
+        {
+          "code": "M19",
+          "name": {
+            "en": "Other exemptions",
+            "pt": "Outras isenções"
+          },
+          "desc": {
+            "en": "Temporary, sector-specific or exceptional exemptions established\nby specific legislation (e.g. emergency relief)."
+          }
+        },
+        {
+          "code": "M20",
+          "name": {
+            "en": "Article 59-D No. 2 of the VAT code",
+            "pt": "Artigo 59.º-D n.º 2 do CIVA"
+          },
+          "desc": {
+            "en": "Flat-rate VAT exemption for certain agricultural activities under\nthe “forfetário” scheme (simplified turnover-based regime)."
+          }
+        },
+        {
+          "code": "M21",
+          "name": {
+            "en": "Article 72 No. 4 of the VAT code",
+            "pt": "Artigo 72.º n.º 4 do CIVA"
+          },
+          "desc": {
+            "en": "Fuel resellers operating on behalf of distributors cannot deduct\nVAT they incur — vendor issues invoice at 0%, no VAT recovery by\nreseller."
+          }
+        },
+        {
+          "code": "M25",
+          "name": {
+            "en": "Article 38 No. 1 paragraph a) of the VAT code",
+            "pt": "Artigo 38.º n.º 1 alínea a) do CIVA"
+          },
+          "desc": {
+            "en": "Consignment stock sales — consignor issues invoice to consignee,\nbut goods remain under consignment; VAT is not yet due until\nfinal sale."
+          }
+        },
+        {
+          "code": "M26",
+          "name": {
+            "en": "Law No. 17/2023 of 14th April",
+            "pt": "Lei n.º 17/2023, de 14 de abril"
+          },
+          "desc": {
+            "en": "“IVA Zero” food-basket scheme allowed VAT exemption with right to\ndeduction. Active 18 Apr 2023 to 4 Jan 2024, now expired. "
+          }
+        },
+        {
+          "code": "M30",
+          "name": {
+            "en": "Article 2 No. 1 paragraph i) of the VAT code",
+            "pt": "Artigo 2.º n.º 1 alínea i) do CIVA"
+          },
+          "desc": {
+            "en": "Reverse-charge on purchase of waste, scrap or recyclable materials\nlisted in Annex E of VAT Code — purchaser self-accounts VAT."
+          }
+        },
+        {
+          "code": "M31",
+          "name": {
+            "en": "Article 2 No. 1 paragraph j) of the VAT code",
+            "pt": "Artigo 2.º n.º 1 alínea j) do CIVA"
+          },
+          "desc": {
+            "en": "Reverse-charge for construction or civil-works services under\nsubcontracting; client self-accounts VAT."
+          }
+        },
+        {
+          "code": "M32",
+          "name": {
+            "en": "Article 2 No. 1 paragraph l) of the VAT code",
+            "pt": "Artigo 2.º n.º 1 alínea l) do CIVA"
+          },
+          "desc": {
+            "en": "Reverse-charge on services involving emission rights, certified\nreductions or reduction units (environmental credits)."
+          }
+        },
+        {
+          "code": "M33",
+          "name": {
+            "en": "Article 2 No. 1 paragraph m) of the VAT code",
+            "pt": "Artigo 2.º n.º 1 alínea m) do CIVA"
+          },
+          "desc": {
+            "en": "Reverse-charge on raw cork, wood, pine-cones with shell — \npurchaser accounts for VAT."
+          }
+        },
+        {
+          "code": "M34",
+          "name": {
+            "en": "Article 2 No. 1 paragraph n) of the VAT code",
+            "pt": "Artigo 2.º n.º 1 alínea n) do CIVA"
+          },
+          "desc": {
+            "en": "Reverse-charge on electricity sold for self-consumption (≤1MW\ncapacity); the supplier issues invoice at 0% VAT."
+          }
+        },
+        {
+          "code": "M40",
+          "name": {
+            "en": "Article 6 No. 6 paragraph a) of the VAT code, to the contrary",
+            "pt": "Artigo 6.º n.º 6 alínea a) do CIVA, a contrário"
+          },
+          "desc": {
+            "en": "Reverse-charge for cross-border B2B services from suppliers\nwithout a fixed establishment in Portugal — Portuguese client\nself-accounts."
+          }
+        },
+        {
+          "code": "M41",
+          "name": {
+            "en": "Article 8 No. 3 of the RITI",
+            "pt": "Artigo 8.º n.º 3 do RITI"
+          },
+          "desc": {
+            "en": "Reverse-charge for intracommunity triangular transactions (RITI\nart. 8.3) — recipient (third party) must self-liquidate VAT."
+          }
+        },
+        {
+          "code": "M42",
+          "name": {
+            "en": "Decree-Law No. 21/2007 of 29th January",
+            "pt": "Decreto-Lei n.º 21/2007, de 29 de janeiro"
+          },
+          "desc": {
+            "en": "When supplier renounces to VAT exemption on a real-estate sale,\nthe buyer must self-account VAT."
+          }
+        },
+        {
+          "code": "M43",
+          "name": {
+            "en": "Decree-Law No. 362/99 of 16th September",
+            "pt": "Decreto-Lei n.º 362/99, de 16 de setembro"
+          },
+          "desc": {
+            "en": "Reverse-charge on investment gold transactions that are not\nVAT-exempt under special gold regulations; buyer reports VAT."
+          }
+        },
+        {
+          "code": "M99",
+          "name": {
+            "en": "Not subject to tax or not taxed",
+            "pt": "Não sujeito ou não tributado"
+          },
+          "desc": {
+            "en": "Other cases where VAT is legally not due — e.g. not subject due\nto CIVA articles 2, 3, or 4 (outside scope of VAT)."
+          }
+        }
+      ]
+    },
+    {
+      "key": "pt-saft-product-type",
+      "name": {
+        "en": "Product Type",
+        "pt": "Tipo de Produto"
+      },
+      "desc": {
+        "en": "SAF-T's `ProductType` (Indicador de produto ou serviço) indicates the type of each line\nitem in an invoice. The `pt-saft-product-type` extension used at line item level allows to\nset the product type to one of the allowed values.\n\nExample:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/invoice\",\n\t// ...\n\t\"lines\": [\n\t\t{\n\t\t\t// ...\n\t\t\t\"item\": {\n\t\t\t\t\"name\": \"Some service\",\n\t\t\t\t\"price\": \"25.00\",\n\t\t\t\t\"ext\": {\n\t\t\t\t\t\"pt-saft-product-type\": \"S\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t// ...\n\t\t}\n\t]\n}\n```"
+      },
+      "values": [
+        {
+          "code": "P",
+          "name": {
+            "en": "Goods",
+            "pt": "Produtos"
+          }
+        },
+        {
+          "code": "S",
+          "name": {
+            "en": "Services",
+            "pt": "Serviços"
+          }
+        },
+        {
+          "code": "O",
+          "name": {
+            "en": "Other",
+            "pt": "Outros"
+          },
+          "desc": {
+            "en": "Other (e.g., debited postage, advances received or disposal of assets)",
+            "pt": "Outros (ex., portes debitados, adiantamentos recebidos ou alienação de ativos)"
+          }
+        },
+        {
+          "code": "E",
+          "name": {
+            "en": "Excise Duties",
+            "pt": "Impostos Especiais"
+          },
+          "desc": {
+            "en": "Excise Duties (e.g., IABA, ISP, IT)",
+            "pt": "Impostos Especiais de Consumo (ex., IABA, ISP, IT)"
+          }
+        },
+        {
+          "code": "I",
+          "name": {
+            "en": "Taxes/Fees",
+            "pt": "Impostos/Taxas"
+          },
+          "desc": {
+            "en": "Taxes, fees and parafiscal charges (except VAT and IS which should be reflected in table 2.5 - TaxTable and Excise Duties, which should be filled in with code 'E')",
+            "pt": "Impostos, taxas e encargos parafiscais – exceto IVA e IS que deverão ser refletidos na tabela 2.5 – Tabela de impostos (TaxTable) e Impostos Especiais de Consumo, que deverão ser preenchidos com o código 'E'."
+          }
+        }
+      ]
+    },
+    {
+      "key": "pt-saft-work-type",
+      "name": {
+        "en": "Document Type",
+        "pt": "Tipo de documento"
+      },
+      "desc": {
+        "en": "SAF-T's `WorkType` (Tipo de documento de conferência) specifies the type of a working\ndocument. In GOBL, this type can be set using the `pt-saft-work-type` extension in either\n`bill.Invoice` or `bill.Order` documents. GOBL will set the extension for you based on the\ndocument type in some cases.\n\nThe table below shows the supported work type codes and their compatibility with GOBL objects:\n\n| Code   | Name                            | GOBL Doc | GOBL Type  |\n| ------ | ------------------------------- | -------- | ---------- |\n| `PF`   | Pró-forma                       | Invoice  | `proforma` |\n| `FC`   | Fatura de consignação           | Invoice  |            |\n| `CC`   | Credito de consignação          | Invoice  |            |\n| `CM`   | Consultas de mesa               | Order    |            |\n| `FO`   | Folhas de obra                  | Order    |            |\n| `NE`   | Nota de Encomenda               | Order    | `purchase` |\n| `OU`   | Outros                          | Order    |            |\n| `OR`   | Orçamentos                      | Order    | `quote`    |\n| `DC`   | Documentos de conferência       | Order    |            |\n| `RP`   | Prémio ou recibo de prémio      | Order    |            |\n| `RE`   | Estorno ou recibo de estorno    | Order    |            |\n| `CS`   | Imputação a co-seguradoras      | Order    |            |\n| `LD`   | Imputação a co-seguradora líder | Order    |            |\n| `RA`   | Resseguro aceite                | Order    |            |\n\nExample for a proforma invoice:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/invoice\",\n\t\"type\": \"proforma\",\n\t// ...\n\t\"tax\": {\n\t\t\"ext\": {\n\t\t\t\"pt-saft-work-type\": \"PF\"\n\t\t}\n\t},\n\t// ...\n```\n\nExample for a purchase order:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/order\",\n\t\"type\": \"purchase\",\n\t// ...\n\t\"tax\": {\n\t\t\"ext\": {\n\t\t\t\"pt-saft-work-type\": \"NE\"\n\t\t}\n\t},\n\t// ...\n```"
+      },
+      "values": [
+        {
+          "code": "CM",
+          "name": {
+            "en": "Table orders",
+            "pt": "Consultas de mesa"
+          }
+        },
+        {
+          "code": "CC",
+          "name": {
+            "en": "Consignment credit note",
+            "pt": "Credito de consignação"
+          }
+        },
+        {
+          "code": "FC",
+          "name": {
+            "en": "VAT-compliant consignment invoice (Article 38)",
+            "pt": "Fatura de consignação nos termos do art.º 38º do código do IVA"
+          }
+        },
+        {
+          "code": "FO",
+          "name": {
+            "en": "Work orders",
+            "pt": "Folhas de obra"
+          }
+        },
+        {
+          "code": "NE",
+          "name": {
+            "en": "Purchase order",
+            "pt": "Nota de Encomenda"
+          }
+        },
+        {
+          "code": "OU",
+          "name": {
+            "en": "Other documents",
+            "pt": "Outros"
+          }
+        },
+        {
+          "code": "OR",
+          "name": {
+            "en": "Quotations",
+            "pt": "Orçamentos"
+          }
+        },
+        {
+          "code": "PF",
+          "name": {
+            "en": "Pro forma invoice",
+            "pt": "Pró-forma"
+          }
+        },
+        {
+          "code": "DC",
+          "name": {
+            "en": "Delivery verification documents",
+            "pt": "Documentos emitidos que sejam suscetíveis de apresentação ao cliente para conferência de mercadorias ou de prestação de serviços"
+          },
+          "desc": {
+            "en": "For data up to 2017-06-30",
+            "pt": "Para dados até 2017-06-30"
+          }
+        },
+        {
+          "code": "RP",
+          "name": {
+            "en": "Premium Receipt",
+            "pt": "Prémio ou recibo de prémio"
+          }
+        },
+        {
+          "code": "RE",
+          "name": {
+            "en": "Chargeback Receipt",
+            "pt": "Estorno ou recibo de estorno"
+          }
+        },
+        {
+          "code": "CS",
+          "name": {
+            "en": "Co-insurers Allocation",
+            "pt": "Imputação a co-seguradoras"
+          }
+        },
+        {
+          "code": "LD",
+          "name": {
+            "en": "Lead Co-insurer Allocation",
+            "pt": "Imputação a co-seguradora líder"
+          }
+        },
+        {
+          "code": "RA",
+          "name": {
+            "en": "Accepted Reinsurance",
+            "pt": "Resseguro aceite"
+          }
+        }
+      ]
+    },
+    {
+      "key": "pt-saft-payment-means",
+      "name": {
+        "en": "Payment Means",
+        "pt": "Meio de Pagamento"
+      },
+      "desc": {
+        "en": "The SAF-T's `PaymentMechanism` (Meios de pagamento) field specifies the payment means in a\nsales invoice or payment. GOBL provides the `pt-saft-payment-means` extension to set this\nvalue in your `bill.Invoice` advances or in you `bill.Payment` method. GOBL maps certain\npayment mean keys automatically to this extension:\n\n| Code | Name                                               | GOBL Payment Means                                    |\n| ---- | -------------------------------------------------- | ----------------------------------------------------- |\n| `CC` | Cartão crédito                                     | `card`                                                |\n| `CD` | Cartão débito                                      | (*)                                                   |\n| `CH` | Cheque bancário                                    | `cheque`                                              |\n| `CI` | Letter of credit                                   | (*)                                                   |\n| `CO` | Cheque ou cartão oferta                            | (*)                                                   |\n| `CS` | Compensação de saldos em conta corrente            | `netting`                                             |\n| `DE` | Dinheiro eletrónico                                | `online`                                              |\n| `LC` | Letra comercial                                    | `promissory-note`                                     |\n| `MB` | Referências de pagamento para Multibanco           | (*)                                                   |\n| `NU` | Numerário                                          | `cash`                                                |\n| `OU` | Outro                                              | `other`                                               |\n| `PR` | Permuta de bens                                    | (*)                                                   |\n| `TB` | Transferência bancária ou débito direto autorizado | `credit-transfer`, `debit-transfer` or `direct-debit` |\n| `TR` | Títulos de compensação extrassalarial              | (*)                                                   |\n\n(*) For codes not mapped from a GOBL Payment Mean, use `other` and explicitly set the\nextension.\n\nFor example, in an GOBL invoice:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/invoice\",\n\t// ...\n\t\"payment\": {\n\t\t\"advances\": [\n\t\t\t{\n\t\t\t\t\"date\": \"2023-01-30\",\n\t\t\t\t\"key\": \"credit-transfer\",\n\t\t\t\t\"description\": \"Adiantamento\",\n\t\t\t\t\"amount\": \"100.00\",\n\t\t\t\t\"ext\": {\n\t\t\t\t\t\"pt-saft-payment-means\": \"TB\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t},\n\t// ...\n}\n```\n\nFor example, in a GOBL receipt:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/receipt\",\n\t// ...\n\t\"method\": {\n\t\t\"key\": \"other\",\n\t\t\"detail\": \"Compensação extrassalarial\",\n\t\t\"ext\": {\n\t\t\t\"pt-saft-payment-means\": \"TR\"\n\t\t}\n\t},\n\t// ...\n}\n```"
+      },
+      "values": [
+        {
+          "code": "CC",
+          "name": {
+            "en": "Credit card",
+            "pt": "Cartão crédito"
+          }
+        },
+        {
+          "code": "CD",
+          "name": {
+            "en": "Debit card",
+            "pt": "Cartão débito"
+          }
+        },
+        {
+          "code": "CH",
+          "name": {
+            "en": "Bank cheque",
+            "pt": "Cheque bancário"
+          }
+        },
+        {
+          "code": "CI",
+          "name": {
+            "en": "International documentary credit",
+            "pt": "Letter of credit"
+          }
+        },
+        {
+          "code": "CO",
+          "name": {
+            "en": "Gift cheque or card",
+            "pt": "Cheque ou cartão oferta"
+          }
+        },
+        {
+          "code": "CS",
+          "name": {
+            "en": "Settlement of balances in current account",
+            "pt": "Compensação de saldos em conta corrente"
+          }
+        },
+        {
+          "code": "DE",
+          "name": {
+            "en": "Electronic money",
+            "pt": "Dinheiro eletrónico"
+          }
+        },
+        {
+          "code": "LC",
+          "name": {
+            "en": "Commercial bill",
+            "pt": "Letra comercial"
+          }
+        },
+        {
+          "code": "MB",
+          "name": {
+            "en": "Multibanco payment references",
+            "pt": "Referências de pagamento para Multibanco"
+          }
+        },
+        {
+          "code": "NU",
+          "name": {
+            "en": "Cash",
+            "pt": "Numerário"
+          }
+        },
+        {
+          "code": "OU",
+          "name": {
+            "en": "Other",
+            "pt": "Outro"
+          }
+        },
+        {
+          "code": "PR",
+          "name": {
+            "en": "Barter",
+            "pt": "Permuta de bens"
+          }
+        },
+        {
+          "code": "TB",
+          "name": {
+            "en": "Bank transfer or direct debit",
+            "pt": "Transferência bancária ou débito direto autorizado"
+          }
+        },
+        {
+          "code": "TR",
+          "name": {
+            "en": "Supplementary compensation",
+            "pt": "Títulos de compensação extrassalarial"
+          }
+        }
+      ]
+    },
+    {
+      "key": "pt-saft-source",
+      "name": {
+        "en": "Document Source",
+        "pt": "Origem do documento"
+      },
+      "desc": {
+        "en": "SAF-T's `SourceBilling` (Origem do documento) field specifies the source of the document.\nGOBL provides the `pt-saft-source` extension to set this value in your documents.\nBy default, GOBL will set this extension to \"P\" (Produced).\n\nThe table below shows the supported source billing codes:\n\n| Code | Name       | Description                                         |\n| ---- | ---------- | --------------------------------------------------- |\n| `P`  | Produced   | Document produced by the application                |\n| `I`  | Integrated | Integrated document produced by another application |\n| `M`  | Manual     | Document from recovery or issued manually           |\n\nExample:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/invoice\",\n\t// ...\n\t\"ext\": {\n\t\t\"pt-saft-source\": \"P\"\n\t},\n\t// ...\n}\n```"
+      },
+      "values": [
+        {
+          "code": "P",
+          "name": {
+            "en": "Produced",
+            "pt": "Produzido"
+          },
+          "desc": {
+            "en": "Document produced by the application",
+            "pt": "Documento produzido na aplicação"
+          }
+        },
+        {
+          "code": "I",
+          "name": {
+            "en": "Integrated",
+            "pt": "Integrado"
+          },
+          "desc": {
+            "en": "Integrated document produced by another application",
+            "pt": "Documento integrado e produzido noutra aplicação"
+          }
+        },
+        {
+          "code": "M",
+          "name": {
+            "en": "Manual",
+            "pt": "Manual"
+          },
+          "desc": {
+            "en": "Document from recovery or issued manually",
+            "pt": "Documento proveniente de recuperação ou de emissão manual"
+          }
+        }
+      ]
+    },
+    {
+      "key": "pt-saft-source-ref",
+      "name": {
+        "en": "Source Document Reference",
+        "pt": "Referência do documento de origem"
+      },
+      "desc": {
+        "en": "GOBL provides the `pt-saft-source-ref` extension to provide the full reference to a document\nintegrated from another system, recovered or issued manually.\n\nThis extension is required when the document source (`pt-saft-source` extension) is\n\"M\" (manual) or \"I\" (integrated). It must contain the complete document reference to be appended\nto the SAF-T's `HashControl` field as stipulated by Despacho n.o 8632/2014.\n\nExample with a manual document:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/invoice\",\n\t// ...\n\t\"ext\": {\n\t\t\"pt-saft-source\": \"M\",\n\t\t\"pt-saft-source-ref\": \"FTM abc/00001\"\n\t},\n\t// ...\n}\n```\n\nExample with a recovered document:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/invoice\",\n\t// ...\n\t\"ext\": {\n\t\t\"pt-saft-source\": \"M\",\n\t\t\"pt-saft-source-ref\": \"FTD FT SERIESA/123\"\n\t},\n\t// ...\n}\n```"
+      }
+    },
+    {
+      "key": "pt-saft-movement-type",
+      "name": {
+        "en": "Movement Type",
+        "pt": "Tipo de documento"
+      },
+      "desc": {
+        "en": "SAF-T's `MovementType` (Tipo de documento de movimentação de mercadorias) specifies the type of\na delivery document. In GOBL,this type can be set using the `pt-saft-movement-type` extension.\nIf not provided explicitly, GOBL will set the extension for you based on the type of your delivery\ndocument.\n\nThe table below shows how this mapping is done:\n\n| Code | Name                | GOBL Type     |\n| ---- | ------------------- | ------------- |\n| `GR` | Delivery note       | `note`        |\n| `GT` | Waybill             | `waybill`     |\n\nExample:\n\n```js\n{\n\t\"$schema\": \"https://gobl.org/draft-0/bill/delivery\",\n\t// ...\n\t\"type\": \"note\",\n\t// ...\n\t\"ext\": {\n\t\t\"pt-saft-movement-type\": \"GR\"\n\t},\n\t// ...\n```"
+      },
+      "values": [
+        {
+          "code": "GR",
+          "name": {
+            "en": "Delivery note",
+            "pt": "Guia de remessa"
+          }
+        },
+        {
+          "code": "GT",
+          "name": {
+            "en": "Waybill",
+            "pt": "Guia de transporte"
+          },
+          "desc": {
+            "en": "Include global waybills here",
+            "pt": "Incluir aqui as guias globais"
+          }
+        },
+        {
+          "code": "GA",
+          "name": {
+            "en": "Guide to the movement own fixed assets",
+            "pt": "Guia de movimentação de ativos fixos próprios"
+          }
+        },
+        {
+          "code": "GC",
+          "name": {
+            "en": "Consignment note",
+            "pt": "Guia de consignação"
+          }
+        },
+        {
+          "code": "GD",
+          "name": {
+            "en": "Returns slip or note",
+            "pt": "Guia ou nota de devolução"
+          }
+        }
+      ]
+    }
+  ],
+  "scenarios": [
+    {
+      "schema": "bill/invoice",
+      "list": [
+        {
+          "type": [
+            "standard"
+          ],
+          "ext": {
+            "pt-saft-invoice-type": "FT"
+          }
+        },
+        {
+          "type": [
+            "standard"
+          ],
+          "tags": [
+            "simplified"
+          ],
+          "ext": {
+            "pt-saft-invoice-type": "FS"
+          }
+        },
+        {
+          "type": [
+            "standard"
+          ],
+          "ext": {
+            "pt-saft-invoice-type": "FR"
+          }
+        },
+        {
+          "type": [
+            "debit-note"
+          ],
+          "ext": {
+            "pt-saft-invoice-type": "ND"
+          }
+        },
+        {
+          "type": [
+            "credit-note"
+          ],
+          "ext": {
+            "pt-saft-invoice-type": "NC"
+          }
+        },
+        {
+          "type": [
+            "proforma"
+          ],
+          "ext": {
+            "pt-saft-work-type": "PF"
+          }
+        }
+      ]
+    }
+  ],
+  "corrections": null
+}