gobl 0.24.1 → 0.24.3

data/data/schemas/bill/payment.json

@@ -0,0 +1,424 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/bill/payment",
+  "$ref": "#/$defs/Payment",
+  "$defs": {
+    "Payment": {
+      "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"
+          },
+          "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": "request",
+              "title": "Request",
+              "description": "A payment request sent from the supplier to a customer indicating that they are\nrequesting a transfer of funds from the customer directly or a payer.\nThis is used to request payment for specific documents and invoices."
+            },
+            {
+              "const": "advice",
+              "title": "Advice",
+              "description": "A remittance advice sent from the customer to the supplier reflecting that payment for\nthe referenced documents has been made."
+            },
+            {
+              "const": "receipt",
+              "title": "Receipt",
+              "description": "A payment receipt sent from the supplier to a customer indicating that they have\nreceived a transfer of funds from the customer directly or a payer.\nThis is the default payment type and may be required by some tax\nregimes in order to communicate the payment of specific documents and invoices."
+            }
+          ],
+          "title": "Type",
+          "description": "Type of payment document being issued.",
+          "calculated": true
+        },
+        "method": {
+          "$ref": "https://gobl.org/draft-0/pay/instructions",
+          "title": "Method",
+          "description": "Details on how the payment was made based on the original instructions."
+        },
+        "series": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Series",
+          "description": "Series is used to identify groups of payments by date, business area, project,\ntype, customer, 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 payment. The code can\nbe left empty initially, but is **required** to **sign** the document."
+        },
+        "issue_date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Issue Date",
+          "description": "When the payment was 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 payment was issued.",
+          "calculated": true
+        },
+        "value_date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Value Date",
+          "description": "When the taxes of this payment become accountable, if none set, the issue date is assumed."
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency",
+          "description": "Currency for all payment totals.",
+          "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 payment's monetary values into other currencies."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extensions for additional codes that may be required."
+        },
+        "preceding": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/document-ref"
+          },
+          "type": "array",
+          "title": "Preceding Details",
+          "description": "Key information regarding previous versions of this document."
+        },
+        "supplier": {
+          "$ref": "https://gobl.org/draft-0/org/party",
+          "title": "Supplier",
+          "description": "The taxable entity who is responsible for supplying goods or services."
+        },
+        "customer": {
+          "$ref": "https://gobl.org/draft-0/org/party",
+          "title": "Customer",
+          "description": "Legal entity that receives the goods or services."
+        },
+        "payee": {
+          "$ref": "https://gobl.org/draft-0/org/party",
+          "title": "Payee",
+          "description": "Legal entity that receives the payment if not the supplier."
+        },
+        "lines": {
+          "items": {
+            "$ref": "#/$defs/PaymentLine"
+          },
+          "type": "array",
+          "title": "Lines",
+          "description": "List of documents that are being paid for."
+        },
+        "ordering": {
+          "$ref": "https://gobl.org/draft-0/bill/ordering",
+          "title": "Ordering",
+          "description": "Ordering allows for additional information about the ordering process including references\nto other documents and alternative parties involved in the order-to-delivery process."
+        },
+        "total": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Total",
+          "description": "Total amount to be paid in this payment, either positive or negative according to the\nline types and totals. Calculated automatically."
+        },
+        "notes": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/note"
+          },
+          "type": "array",
+          "title": "Notes",
+          "description": "Unstructured information that is relevant to the payment, 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 payment."
+        },
+        "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."
+        }
+      },
+      "type": "object",
+      "required": [
+        "type",
+        "issue_date",
+        "currency",
+        "supplier",
+        "lines",
+        "total"
+      ],
+      "description": "A Payment is used to link an invoice or invoices with a payment transaction.",
+      "recommended": [
+        "$regime",
+        "series",
+        "code",
+        "lines"
+      ]
+    },
+    "PaymentLine": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "i": {
+          "type": "integer",
+          "title": "Index",
+          "description": "Line number within the parent document (automatically calculated)",
+          "calculated": true
+        },
+        "refund": {
+          "type": "boolean",
+          "title": "Refund",
+          "description": "Indicates whether this payment is a refund of a previous payment, effectively reversing\nthe flow of funds between the supplier and customer or their representatives."
+        },
+        "document": {
+          "$ref": "https://gobl.org/draft-0/org/document-ref",
+          "title": "Document",
+          "description": "Reference to the document being paid"
+        },
+        "installment": {
+          "type": "integer",
+          "title": "Installment",
+          "description": "When making multiple payments for a single document, this specifies the\ninstallment number for this payment line."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "Additional human readable description of the payment line which may be useful for\nexplaining the purpose or special conditions. Notes should be used for more\nformal comments."
+        },
+        "payable": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Payable",
+          "description": "Payable reflects the amount of the document that is payable. This will be\ncalculated from the embedded document's amount automatically and converted\nto the currency of the document."
+        },
+        "advances": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Advances",
+          "description": "Amount already paid in previous installments, which may be required\nby some tax regimes or specific use cases."
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "Amount of the total payment allocated to the referenced document."
+        },
+        "due": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Due",
+          "description": "Due reflects how much still needs to be paid"
+        },
+        "tax": {
+          "$ref": "https://gobl.org/draft-0/tax/total",
+          "title": "Tax",
+          "description": "Tax contains a breakdown of the taxes that will be applied to this payment line\nafter taking into account currency conversion and the relative amounts."
+        },
+        "notes": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/note"
+          },
+          "type": "array",
+          "title": "Notes",
+          "description": "Additional notes specific to this line item for clarification purposes"
+        }
+      },
+      "type": "object",
+      "required": [
+        "i",
+        "amount"
+      ],
+      "description": "PaymentLine defines the details of a line item in a payment document."
+    }
+  }
+}

data/data/schemas/bill/tax.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/bill/tax",
+  "$ref": "#/$defs/Tax",
+  "$defs": {
+    "Tax": {
+      "properties": {
+        "prices_include": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Prices Include",
+          "description": "Category of the tax already included in the line item prices, especially\nuseful for B2C retailers with customers who prefer final prices inclusive of\ntax."
+        },
+        "rounding": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "oneOf": [
+            {
+              "const": "precise",
+              "title": "Precise",
+              "description": "The default method of calculating the totals in GOBL, and provides the best results\nfor most cases as the precision is maintained to the maximum amount possible. The\ntradeoff however is that sometimes the totals may not sum exactly based on what is visible."
+            },
+            {
+              "const": "currency",
+              "title": "Currency",
+              "description": "The alternative method of calculating the totals that will first round all the amounts\nto the currency's precision before making the sums. Totals using this approach can always\nbe recalculated using the amounts presented, but can lead to rounding errors in the case\nof pre-payments and when line item prices include tax."
+            }
+          ],
+          "title": "Rounding Model",
+          "description": "Rounding model used to perform tax calculations on the invoice. This\nwill be configured automatically based on the tax regime, or\n`sum-then-round` by default, but you can override here if needed.\nUse with caution, as some conversion tools may make assumptions about\nthe rounding model used."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Additional extensions that are applied to the invoice as a whole as opposed to specific\nsections."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Any additional data that may be required for processing, but should never\nbe relied upon by recipients."
+        }
+      },
+      "type": "object",
+      "description": "Tax defines a summary of the taxes which may be applied to an invoice."
+    }
+  }
+}

data/data/schemas/bill/totals.json

@@ -0,0 +1,84 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/bill/totals",
+  "$ref": "#/$defs/Totals",
+  "$defs": {
+    "Totals": {
+      "properties": {
+        "sum": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Sum",
+          "description": "Total of all line item amounts."
+        },
+        "discount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Discount",
+          "description": "Total of all discounts applied at the document level."
+        },
+        "charge": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Charge",
+          "description": "Total of all charges applied at the document level."
+        },
+        "tax_included": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Tax Included",
+          "description": "Total tax amount included in the prices, if prices are tax-inclusive."
+        },
+        "total": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Total",
+          "description": "Net total amount after subtracting discounts and adding charges, excluding tax."
+        },
+        "taxes": {
+          "$ref": "https://gobl.org/draft-0/tax/total",
+          "title": "Tax Totals",
+          "description": "Detailed breakdown of all taxes applied to the invoice."
+        },
+        "tax": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Tax",
+          "description": "Total indirect tax amount to be applied to the invoice."
+        },
+        "total_with_tax": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Total with Tax",
+          "description": "Final total amount after applying indirect taxes."
+        },
+        "retained_tax": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Retained Tax",
+          "description": "Total tax amount retained or withheld by the customer to be paid to the tax authority."
+        },
+        "rounding": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Rounding",
+          "description": "Adjustment amount applied to the invoice totals to meet rounding rules or expectations."
+        },
+        "payable": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Payable",
+          "description": "Final amount to be paid after retained taxes and rounding adjustments."
+        },
+        "advance": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Advance",
+          "description": "Total amount already paid in advance by the customer."
+        },
+        "due": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Due",
+          "description": "Remaining amount that needs to be paid."
+        }
+      },
+      "type": "object",
+      "required": [
+        "sum",
+        "total",
+        "total_with_tax",
+        "payable"
+      ],
+      "description": "Totals contains the summaries of all calculations for the invoice."
+    }
+  }
+}

data/data/schemas/cal/date-time.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cal/date-time",
+  "$ref": "#/$defs/DateTime",
+  "$defs": {
+    "DateTime": {
+      "type": "string",
+      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$",
+      "title": "Date Time",
+      "description": "Civil date time in simplified ISO format with no time zone\nnor location information, for example: 2021-05-26T13:45:00"
+    }
+  }
+}

data/data/schemas/cal/date.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cal/date",
+  "$ref": "#/$defs/Date",
+  "$defs": {
+    "Date": {
+      "type": "string",
+      "format": "date",
+      "title": "Date",
+      "description": "Civil date in simplified ISO format, like 2021-05-26"
+    }
+  }
+}

data/data/schemas/cal/period.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cal/period",
+  "$ref": "#/$defs/Period",
+  "$defs": {
+    "Period": {
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Label is a short description of the period."
+        },
+        "start": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Start",
+          "description": "Start indicates when this period starts."
+        },
+        "end": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "End",
+          "description": "End indicates when the period ends, and must be after the start date."
+        }
+      },
+      "type": "object",
+      "required": [
+        "start",
+        "end"
+      ],
+      "description": "Period represents two dates with a start and finish."
+    }
+  }
+}

data/data/schemas/cal/time.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cal/time",
+  "$ref": "#/$defs/Time",
+  "$defs": {
+    "Time": {
+      "type": "string",
+      "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$",
+      "title": "Time",
+      "description": "Civil time in simplified ISO format, like 13:45:30"
+    }
+  }
+}

data/data/schemas/cbc/code-map.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cbc/code-map",
+  "$ref": "#/$defs/CodeMap",
+  "$defs": {
+    "CodeMap": {
+      "patternProperties": {
+        "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$": {
+          "$ref": "https://gobl.org/draft-0/cbc/code"
+        }
+      },
+      "type": "object",
+      "description": "CodeMap is a map of keys to specific codes, useful to determine regime specific codes from their key counterparts."
+    }
+  }
+}

data/data/schemas/cbc/code.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cbc/code",
+  "$ref": "#/$defs/Code",
+  "$defs": {
+    "Code": {
+      "type": "string",
+      "maxLength": 64,
+      "minLength": 1,
+      "pattern": "^[A-Za-z0-9]+([\\.\\-\\:/,_ ]?[A-Za-z0-9]+)*$",
+      "title": "Code",
+      "description": "Alphanumerical text identifier with upper-case letters and limits on using\nspecial characters or whitespace to separate blocks."
+    }
+  }
+}