Improve BR regime examples and docs

addons/br/nfse/extensions.go

@@ -38,6 +38,15 @@ var extensions = []*cbc.KeyDefinition{
 				},
 			},
 		},
+		Desc: i18n.String{
+			i18n.EN: here.Doc(`
+				Indicates whether a party benefits from a fiscal incentive.
+
+				List of codes taken from the national NFSe standard:
+				https://abrasf.org.br/biblioteca/arquivos-publicos/nfs-e-manual-de-orientacao-do-contribuinte-2-04/download
+				(Section 10.2, Field B-68)
+			`),
+		},
 	},
 	{
 		Key: ExtKeyMunicipality,
@@ -96,6 +105,15 @@ var extensions = []*cbc.KeyDefinition{
 				},
 			},
 		},
+		Desc: i18n.String{
+			i18n.EN: here.Doc(`
+				Indicates whether a party is opting for the “Simples Nacional” tax regime.
+
+				List of codes taken from the national NFSe standard:
+				https://abrasf.org.br/biblioteca/arquivos-publicos/nfs-e-manual-de-orientacao-do-contribuinte-2-04/download
+				(Section 10.2, Field B-67)
+			`),
+		},
 	},
 	{
 		Key: ExtKeySpecialRegime,
@@ -147,5 +165,14 @@ var extensions = []*cbc.KeyDefinition{
 				},
 			},
 		},
+		Desc: i18n.String{
+			i18n.EN: here.Doc(`
+				Indicates a special tax regime that the party is subject to.
+
+				List of codes taken from the national NFSe standard:
+				https://abrasf.org.br/biblioteca/arquivos-publicos/nfs-e-manual-de-orientacao-do-contribuinte-2-04/download
+				(Section 10.2, Field B-66)
+			`),
+		},
 	},
 }

data/addons/br-nfse-v1.json

@@ -5,6 +5,43 @@
     "en": "Brazil NFS-e 1.X"
   },
   "extensions": [
+    {
+      "key": "br-nfse-fiscal-incentive",
+      "name": {
+        "en": "Fiscal Incentive",
+        "pt": "Incentivo Fiscal"
+      },
+      "desc": {
+        "en": "Indicates whether a party benefits from a fiscal incentive.\n\nList of codes taken from the national NFSe standard:\nhttps://abrasf.org.br/biblioteca/arquivos-publicos/nfs-e-manual-de-orientacao-do-contribuinte-2-04/download\n(Section 10.2, Field B-68)"
+      },
+      "values": [
+        {
+          "value": "1",
+          "name": {
+            "en": "Has incentive",
+            "pt": "Possui incentivo"
+          }
+        },
+        {
+          "value": "2",
+          "name": {
+            "en": "Does not have incentive",
+            "pt": "Não possui incentivo"
+          }
+        }
+      ]
+    },
+    {
+      "key": "br-nfse-municipality",
+      "name": {
+        "en": "IGBE Municipality Code",
+        "pt": "Código do Município do IBGE"
+      },
+      "desc": {
+        "en": "The municipality code as defined by the IGBE (Brazilian Institute of Geography and\nStatistics).\n\nFor further details on the list of possible codes, see:\n\n* https://www.ibge.gov.br/explica/codigos-dos-municipios.php"
+      },
+      "pattern": "^\\d{7}$"
+    },
     {
       "key": "br-nfse-service",
       "name": {
@@ -14,8 +51,104 @@
       "desc": {
         "en": "The service code as defined by the municipality. Typically, one of the codes listed\nin the Lei Complementar 116/2003, but municipalities can make their own changes.\n\nFor further details on the list of possible codes, see:\n\n* https://www.planalto.gov.br/ccivil_03/leis/lcp/lcp116.htm"
       }
+    },
+    {
+      "key": "br-nfse-simples-nacional",
+      "name": {
+        "en": "Opting for “Simples Nacional”",
+        "pt": "Optante pelo Simples Nacional"
+      },
+      "desc": {
+        "en": "Indicates whether a party is opting for the “Simples Nacional” tax regime.\n\nList of codes taken from the national NFSe standard:\nhttps://abrasf.org.br/biblioteca/arquivos-publicos/nfs-e-manual-de-orientacao-do-contribuinte-2-04/download\n(Section 10.2, Field B-67)"
+      },
+      "values": [
+        {
+          "value": "1",
+          "name": {
+            "en": "Opt-in",
+            "pt": "Optante"
+          }
+        },
+        {
+          "value": "2",
+          "name": {
+            "en": "Opt-out",
+            "pt": "Não optante"
+          }
+        }
+      ]
+    },
+    {
+      "key": "br-nfse-special-regime",
+      "name": {
+        "en": "Special Tax Regime",
+        "pt": "Regime Especial de Tributação"
+      },
+      "desc": {
+        "en": "Indicates a special tax regime that the party is subject to.\n\nList of codes taken from the national NFSe standard:\nhttps://abrasf.org.br/biblioteca/arquivos-publicos/nfs-e-manual-de-orientacao-do-contribuinte-2-04/download\n(Section 10.2, Field B-66)"
+      },
+      "values": [
+        {
+          "value": "1",
+          "name": {
+            "en": "Municipal micro-enterprise",
+            "pt": "Microempresa municipal"
+          }
+        },
+        {
+          "value": "2",
+          "name": {
+            "en": "Estimated",
+            "pt": "Estimativa"
+          }
+        },
+        {
+          "value": "3",
+          "name": {
+            "en": "Professional Society",
+            "pt": "Sociedade de profissionais"
+          }
+        },
+        {
+          "value": "4",
+          "name": {
+            "en": "Cooperative",
+            "pt": "Cooperativa"
+          }
+        },
+        {
+          "value": "5",
+          "name": {
+            "en": "Single micro-entrepreneur (MEI)",
+            "pt": "Microempreendedor individual (MEI)"
+          }
+        },
+        {
+          "value": "6",
+          "name": {
+            "en": "Micro-enterprise or Small Business (ME EPP)",
+            "pt": "Microempresa ou Empresa de Pequeno Porte (ME EPP)."
+          }
+        }
+      ]
     }
   ],
   "scenarios": null,
+  "identities": [
+    {
+      "key": "br-nfse-municipal-reg",
+      "name": {
+        "en": "Company Municipal Registration",
+        "pt": "Inscrição Municipal da Empresa"
+      }
+    },
+    {
+      "key": "br-nfse-national-reg",
+      "name": {
+        "en": "Company National Registration",
+        "pt": "Inscrição Nacional da Empresa"
+      }
+    }
+  ],
   "corrections": null
 }

examples/br/invoice-services.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "https://gobl.org/draft-0/bill/invoice",
+  "uuid": "0193305c-a7be-730d-b552-2093f0df2df7",
+  "series": "SAMPLE",
+  "code": "1",
+  "issue_date": "2024-11-15",
+  "currency": "BRL",
+  "supplier": {
+    "name": "SaúdeMais Serviços Médicos Ltda.",
+    "tax_id": {
+      "country": "BR",
+      "code": "55263640000186"
+    },
+    "identities": [
+      {
+        "key": "br-nfse-municipal-reg",
+        "code": "45678901234567"
+      },
+      {
+        "key": "br-nfse-national-reg",
+        "code": "12345012345678"
+      }
+    ],
+    "addresses": [
+      {
+        "num": "200",
+        "street": "Rua Primeiro de Março",
+        "street_extra": "Torre A",
+        "locality": "Centro",
+        "region": "Rio de Janeiro",
+        "state": "RJ",
+        "code": "20010-000",
+        "country": "BR"
+      }
+    ],
+    "emails": [
+      {
+        "addr": "[email protected]"
+      }
+    ],
+    "ext": {
+      "br-nfse-municipality": "3304557",
+      "br-nfse-fiscal-incentive": "1",
+      "br-nfse-simples-nacional": "1",
+      "br-nfse-special-regime": "4"
+    }
+  },
+  "customer": {
+    "name": "Construforte Engenharia Ltda.",
+    "tax_id": {
+      "country": "BR",
+      "code": "46602178000103"
+    },
+    "addresses": [
+      {
+        "num": "75",
+        "street": "Avenida Sete de Setembro",
+        "street_extra": "Bloco C",
+        "locality": "Centro",
+        "region": "Salvador",
+        "state": "BA",
+        "code": "40060-000",
+        "country": "BR"
+      }
+    ],
+  },
+  "lines": [
+    {
+      "i": 1,
+      "quantity": "15",
+      "item": {
+        "name": "Consultancy Services",
+        "price": "100.00",
+        "ext": {
+          "br-nfse-service": "10.5"
+        }
+      },
+      "taxes": [
+        {
+          "cat": "ISS",
+          "percent": "15%"
+        }
+      ]
+    }
+  ]
+}