gobl 0.24.1 → 0.24.3

data/data/schemas/bill/invoice.json

@@ -0,0 +1,423 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/bill/invoice",
+  "$ref": "#/$defs/Invoice",
+  "$defs": {
+    "Invoice": {
+      "properties": {
+        "$regime": {
+          "$ref": "https://gobl.org/draft-0/l10n/tax-country-code",
+          "oneOf": [
+            {
+              "const": "AE",
+              "title": "United Arab Emirates"
+            },
+            {
+              "const": "AT",
+              "title": "Austria"
+            },
+            {
+              "const": "BE",
+              "title": "Belgium"
+            },
+            {
+              "const": "BR",
+              "title": "Brazil"
+            },
+            {
+              "const": "CA",
+              "title": "Canada"
+            },
+            {
+              "const": "CH",
+              "title": "Switzerland"
+            },
+            {
+              "const": "CO",
+              "title": "Colombia"
+            },
+            {
+              "const": "DE",
+              "title": "Germany"
+            },
+            {
+              "const": "EL",
+              "title": "Greece"
+            },
+            {
+              "const": "ES",
+              "title": "Spain"
+            },
+            {
+              "const": "FR",
+              "title": "France"
+            },
+            {
+              "const": "GB",
+              "title": "United Kingdom"
+            },
+            {
+              "const": "IE",
+              "title": "Ireland"
+            },
+            {
+              "const": "IN",
+              "title": "India"
+            },
+            {
+              "const": "IT",
+              "title": "Italy"
+            },
+            {
+              "const": "MX",
+              "title": "Mexico"
+            },
+            {
+              "const": "NL",
+              "title": "The Netherlands"
+            },
+            {
+              "const": "PL",
+              "title": "Poland"
+            },
+            {
+              "const": "PT",
+              "title": "Portugal"
+            },
+            {
+              "const": "SE",
+              "title": "Sweden"
+            },
+            {
+              "const": "SG",
+              "title": "Singapore"
+            },
+            {
+              "const": "US",
+              "title": "United States of America"
+            }
+          ],
+          "title": "Tax Regime"
+        },
+        "$addons": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key",
+            "oneOf": [
+              {
+                "const": "br-nfe-v4",
+                "title": "Brazil NF-e 4.00"
+              },
+              {
+                "const": "br-nfse-v1",
+                "title": "Brazil NFS-e 1.X"
+              },
+              {
+                "const": "co-dian-v2",
+                "title": "Colombia DIAN UBL 2.X"
+              },
+              {
+                "const": "de-xrechnung-v3",
+                "title": "German XRechnung 3.X"
+              },
+              {
+                "const": "de-zugferd-v2",
+                "title": "German ZUGFeRD 2.X"
+              },
+              {
+                "const": "es-facturae-v3",
+                "title": "Spain FacturaE"
+              },
+              {
+                "const": "es-tbai-v1",
+                "title": "Spain TicketBAI"
+              },
+              {
+                "const": "es-verifactu-v1",
+                "title": "Spain VERI*FACTU V1"
+              },
+              {
+                "const": "eu-en16931-v2017",
+                "title": "EN 16931-1:2017"
+              },
+              {
+                "const": "fr-choruspro-v1",
+                "title": "Chorus Pro"
+              },
+              {
+                "const": "fr-facturx-v1",
+                "title": "French Factur-X v1"
+              },
+              {
+                "const": "gr-mydata-v1",
+                "title": "Greece MyData v1.x"
+              },
+              {
+                "const": "it-sdi-v1",
+                "title": "Italy SDI FatturaPA v1.x"
+              },
+              {
+                "const": "it-ticket-v1",
+                "title": "Italy AdE ticket v1.x"
+              },
+              {
+                "const": "mx-cfdi-v4",
+                "title": "Mexican SAT CFDI v4.X"
+              },
+              {
+                "const": "pl-favat-v2",
+                "title": "Polish KSeF FA_VAT v2.x"
+              },
+              {
+                "const": "pt-saft-v1",
+                "title": "Portugal SAF-T"
+              }
+            ]
+          },
+          "type": "array",
+          "title": "Addons",
+          "description": "Addons defines a list of keys used to identify tax addons that apply special\nnormalization, scenarios, and validation rules to a document."
+        },
+        "$tags": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key",
+            "anyOf": [
+              {
+                "const": "simplified",
+                "title": "Simplified Invoice"
+              },
+              {
+                "const": "reverse-charge",
+                "title": "Reverse Charge"
+              },
+              {
+                "const": "self-billed",
+                "title": "Self-billed"
+              },
+              {
+                "const": "customer-rates",
+                "title": "Customer rates"
+              },
+              {
+                "const": "partial",
+                "title": "Partial"
+              },
+              {
+                "const": "bypass",
+                "title": "Bypass"
+              },
+              {
+                "pattern": "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$",
+                "title": "Any"
+              }
+            ]
+          },
+          "type": "array",
+          "title": "Tags",
+          "description": "Tags are used to help identify specific tax scenarios or requirements that may\napply changes to the contents of the document or imply a specific meaning.\nConverters may use tags to help identify specific situations that do not have\na specific extension, for example; self-billed or partial invoices may be\nidentified by their respective tags."
+        },
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "type": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "oneOf": [
+            {
+              "const": "standard",
+              "title": "Standard",
+              "description": "A regular commercial invoice document between a supplier and customer."
+            },
+            {
+              "const": "proforma",
+              "title": "Proforma",
+              "description": "For a clients validation before sending a final invoice."
+            },
+            {
+              "const": "corrective",
+              "title": "Corrective",
+              "description": "Corrected invoice that completely *replaces* the preceding document."
+            },
+            {
+              "const": "credit-note",
+              "title": "Credit Note",
+              "description": "Reflects a refund either partial or complete of the preceding document. A \ncredit note effectively *extends* the previous document."
+            },
+            {
+              "const": "debit-note",
+              "title": "Debit Note",
+              "description": "An additional set of charges to be added to the preceding document."
+            },
+            {
+              "const": "other",
+              "title": "Other",
+              "description": "Any other type of invoice that does not fit into the standard categories and implies\nthat any scenarios defined in tax regimes or addons will not be applied.\n\nThis is useful for being able to create invoices with custom types in extensions,\nbut is not recommend for general use."
+            }
+          ],
+          "title": "Type",
+          "description": "Type of invoice document. May be restricted by local tax regime requirements.",
+          "calculated": true
+        },
+        "series": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Series",
+          "description": "Series is used to identify groups of invoices by date, business area, project,\ntype of document, customer type, a combination of any or other company specific data.\nIf the output format does not support the series as a separate field, it will be\nprepended to the code for presentation with a dash (`-`) for separation."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Code is a sequential identifier that uniquely identifies the invoice. The code can\nbe left empty initially, but is **required** to **sign** the invoice."
+        },
+        "issue_date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Issue Date",
+          "description": "Issue date for when the invoice was created and issued. Todays date is used if\nnone is set. There are often legal restrictions on how far back or in the future an\ninvoice can be issued.",
+          "calculated": true
+        },
+        "issue_time": {
+          "$ref": "https://gobl.org/draft-0/cal/time",
+          "title": "Issue Time",
+          "description": "IssueTime is an optional field that may be useful to indicate the time of day when\nthe invoice was issued. Some regions and formats may require this field to be set.\nAn empty string will be automatically updated to reflect the current time, otherwise\nthe field can be left with a nil value.",
+          "calculated": true
+        },
+        "op_date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Operation Date",
+          "description": "Date when the operation defined by the invoice became effective."
+        },
+        "value_date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Value Date",
+          "description": "When the taxes of this invoice become accountable, if none set, the issue date is used."
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency",
+          "description": "Currency for all invoice amounts and totals, unless explicitly stated otherwise.",
+          "calculated": true
+        },
+        "exchange_rates": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/currency/exchange-rate"
+          },
+          "type": "array",
+          "title": "Exchange Rates",
+          "description": "Exchange rates to be used when converting the invoices monetary values into other currencies."
+        },
+        "preceding": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/document-ref"
+          },
+          "type": "array",
+          "title": "Preceding Details",
+          "description": "Document references for previous invoices that this document replaces or extends."
+        },
+        "tax": {
+          "$ref": "https://gobl.org/draft-0/bill/tax",
+          "title": "Tax",
+          "description": "Special billing tax configuration options."
+        },
+        "supplier": {
+          "$ref": "https://gobl.org/draft-0/org/party",
+          "title": "Supplier",
+          "description": "The entity supplying the goods or services and usually responsible for paying taxes."
+        },
+        "customer": {
+          "$ref": "https://gobl.org/draft-0/org/party",
+          "title": "Customer",
+          "description": "Legal entity receiving the goods or services, may be nil in certain circumstances\nsuch as simplified invoices."
+        },
+        "lines": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/bill/line"
+          },
+          "type": "array",
+          "title": "Lines",
+          "description": "List of invoice lines representing each of the items sold to the customer."
+        },
+        "discounts": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/bill/discount"
+          },
+          "type": "array",
+          "title": "Discounts",
+          "description": "Discounts or allowances applied to the complete invoice"
+        },
+        "charges": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/bill/charge"
+          },
+          "type": "array",
+          "title": "Charges",
+          "description": "Charges or surcharges applied to the complete invoice"
+        },
+        "ordering": {
+          "$ref": "https://gobl.org/draft-0/bill/ordering",
+          "title": "Ordering Details",
+          "description": "Ordering details including document references and buyer or seller parties."
+        },
+        "payment": {
+          "$ref": "https://gobl.org/draft-0/bill/payment-details",
+          "title": "Payment Details",
+          "description": "Information on when, how, and to whom the invoice should be paid."
+        },
+        "delivery": {
+          "$ref": "https://gobl.org/draft-0/bill/delivery-details",
+          "title": "Delivery Details",
+          "description": "Specific details on delivery of the goods referenced in the invoice."
+        },
+        "totals": {
+          "$ref": "https://gobl.org/draft-0/bill/totals",
+          "title": "Totals",
+          "description": "Summary of all the invoice totals, including taxes (calculated).",
+          "calculated": true
+        },
+        "notes": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/note"
+          },
+          "type": "array",
+          "title": "Notes",
+          "description": "Unstructured information that is relevant to the invoice, such as correction or additional\nlegal details."
+        },
+        "complements": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/schema/object"
+          },
+          "type": "array",
+          "title": "Complements",
+          "description": "Additional complementary objects that add relevant information to the invoice."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Additional semi-structured data that doesn't fit into the body of the invoice."
+        },
+        "attachments": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/attachment"
+          },
+          "type": "array",
+          "title": "Attachments",
+          "description": "Attachments provide additional information or supporting documents that are not included\nin the main document. It is important that attachments are not used for alternative\nversions of the PDF, for that, see \"links\" inside the envelope headers."
+        }
+      },
+      "type": "object",
+      "required": [
+        "type",
+        "issue_date",
+        "currency",
+        "supplier",
+        "totals"
+      ],
+      "description": "Invoice represents a payment claim for goods or services supplied under conditions agreed between the supplier and the customer.",
+      "recommended": [
+        "$regime",
+        "series",
+        "code",
+        "lines"
+      ]
+    }
+  }
+}