gobl 0.24.1 → 0.24.3

data/data/schemas/bill/line.json

@@ -0,0 +1,433 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/bill/line",
+  "$ref": "#/$defs/Line",
+  "$defs": {
+    "Line": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "i": {
+          "type": "integer",
+          "title": "Index",
+          "description": "Line number inside the parent (calculated)",
+          "calculated": true
+        },
+        "quantity": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Quantity",
+          "description": "Number of items"
+        },
+        "identifier": {
+          "$ref": "https://gobl.org/draft-0/org/identity",
+          "title": "Identifier",
+          "description": "Single identifier provided by the supplier for an object on which the\nline item is based and is not considered a universal identity. Examples\ninclude a subscription number, telephone number, meter point, etc.\nUtilize the label property to provide a description of the identifier."
+        },
+        "period": {
+          "$ref": "https://gobl.org/draft-0/cal/period",
+          "title": "Period",
+          "description": "A period of time relevant to when the service or item is delivered."
+        },
+        "order": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Order Reference",
+          "description": "Order reference for a specific line within a purchase order provided by the buyer."
+        },
+        "cost": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Cost Reference",
+          "description": "Buyer accounting reference cost code to associate with the line."
+        },
+        "item": {
+          "$ref": "https://gobl.org/draft-0/org/item",
+          "title": "Item",
+          "description": "Details about the item, service or good, that is being sold"
+        },
+        "breakdown": {
+          "items": {
+            "$ref": "#/$defs/SubLine"
+          },
+          "type": "array",
+          "title": "Breakdown",
+          "description": "Breakdown of the line item for more detailed information. The sum of all lines\nwill be used for the item price."
+        },
+        "sum": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Sum",
+          "description": "Result of quantity multiplied by the item's price (calculated)",
+          "calculated": true
+        },
+        "discounts": {
+          "items": {
+            "$ref": "#/$defs/LineDiscount"
+          },
+          "type": "array",
+          "title": "Discounts",
+          "description": "Discounts applied to this line"
+        },
+        "charges": {
+          "items": {
+            "$ref": "#/$defs/LineCharge"
+          },
+          "type": "array",
+          "title": "Charges",
+          "description": "Charges applied to this line"
+        },
+        "taxes": {
+          "$ref": "https://gobl.org/draft-0/tax/set",
+          "title": "Taxes",
+          "description": "Map of taxes to be applied and used in the invoice totals"
+        },
+        "total": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Total",
+          "description": "Total line amount after applying discounts to the sum (calculated).",
+          "calculated": true
+        },
+        "substituted": {
+          "items": {
+            "$ref": "#/$defs/SubLine"
+          },
+          "type": "array",
+          "title": "Substituted",
+          "description": "List of substituted lines. Useful for deliveries or corrective documents in order\nto indicate to the recipient which of the requested lines are being replaced.\nThis is for purely informative purposes, and will not be used for calculations."
+        },
+        "seller": {
+          "$ref": "https://gobl.org/draft-0/org/party",
+          "title": "Seller",
+          "description": "Seller of the item if different from the supplier or ordering seller. This can be\nuseful for marketplace or drop-ship scenarios in locations that require the\noriginal seller to be indicated."
+        },
+        "notes": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/note"
+          },
+          "type": "array",
+          "title": "Notes",
+          "description": "Set of specific notes for this line that may be required for\nclarification."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension codes that apply to the line"
+        }
+      },
+      "type": "object",
+      "required": [
+        "i",
+        "quantity",
+        "item"
+      ],
+      "description": "Line is a single row in an invoice."
+    },
+    "LineCharge": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "anyOf": [
+            {
+              "const": "stamp-duty",
+              "title": "Stamp Duty"
+            },
+            {
+              "const": "outlay",
+              "title": "Outlay"
+            },
+            {
+              "const": "tax",
+              "title": "Tax"
+            },
+            {
+              "const": "customs",
+              "title": "Customs"
+            },
+            {
+              "const": "delivery",
+              "title": "Delivery"
+            },
+            {
+              "const": "packing",
+              "title": "Packing"
+            },
+            {
+              "const": "handling",
+              "title": "Handling"
+            },
+            {
+              "const": "insurance",
+              "title": "Insurance"
+            },
+            {
+              "const": "storage",
+              "title": "Storage"
+            },
+            {
+              "const": "admin",
+              "title": "Administration"
+            },
+            {
+              "const": "cleaning",
+              "title": "Cleaning"
+            },
+            {
+              "pattern": "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$",
+              "title": "Other"
+            }
+          ],
+          "title": "Key",
+          "description": "Key for grouping or identifying charges for tax purposes. A suggested list of\nkeys is provided, but these are for reference only and may be extended by\nthe issuer."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Reference or ID for this charge defined by the issuer"
+        },
+        "reason": {
+          "type": "string",
+          "title": "Reason",
+          "description": "Text description as to why the charge was applied"
+        },
+        "base": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Base",
+          "description": "Base for percent calculations instead of the line's sum"
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percentage of base or parent line's sum"
+        },
+        "quantity": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Quantity",
+          "description": "Quantity of units to apply the charge to when using the rate instead of\nthe line's quantity."
+        },
+        "unit": {
+          "$ref": "https://gobl.org/draft-0/org/unit",
+          "title": "Unit",
+          "description": "Unit to associate with the quantity when using the rate."
+        },
+        "rate": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Rate",
+          "description": "Rate defines a price per unit to use instead of the percentage."
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "Fixed or resulting charge amount to apply (calculated if percent present).",
+          "calculated": true
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension codes that apply to the charge"
+        }
+      },
+      "type": "object",
+      "required": [
+        "amount"
+      ],
+      "description": "LineCharge represents an amount added to the line, and will be applied before taxes."
+    },
+    "LineDiscount": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "anyOf": [
+            {
+              "const": "early-completion",
+              "title": "Bonus for works ahead of schedule"
+            },
+            {
+              "const": "military",
+              "title": "Military Discount"
+            },
+            {
+              "const": "work-accident",
+              "title": "Work Accident Discount"
+            },
+            {
+              "const": "special-agreement",
+              "title": "Special Agreement Discount"
+            },
+            {
+              "const": "production-error",
+              "title": "Production Error Discount"
+            },
+            {
+              "const": "new-outlet",
+              "title": "New Outlet Discount"
+            },
+            {
+              "const": "sample",
+              "title": "Sample Discount"
+            },
+            {
+              "const": "end-of-range",
+              "title": "End of Range Discount"
+            },
+            {
+              "const": "incoterm",
+              "title": "Incoterm Discount"
+            },
+            {
+              "const": "pos-threshold",
+              "title": "Point of Sale Threshold Discount"
+            },
+            {
+              "const": "special-rebate",
+              "title": "Special Rebate"
+            },
+            {
+              "const": "temporary",
+              "title": "Temporary"
+            },
+            {
+              "const": "standard",
+              "title": "Standard"
+            },
+            {
+              "const": "yearly-turnover",
+              "title": "Yearly Turnover"
+            },
+            {
+              "pattern": "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$",
+              "title": "Other"
+            }
+          ],
+          "title": "Key",
+          "description": "Key for identifying the type of discount being applied."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Code or reference for this discount defined by the issuer"
+        },
+        "reason": {
+          "type": "string",
+          "title": "Reason",
+          "description": "Text description as to why the discount was applied"
+        },
+        "base": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Base",
+          "description": "Base for percent calculations instead of the line's sum."
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percentage to apply to the base or line sum to calculate the discount amount"
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "Fixed discount amount to apply (calculated if percent present)",
+          "calculated": true
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension codes that apply to the discount"
+        }
+      },
+      "type": "object",
+      "required": [
+        "amount"
+      ],
+      "description": "LineDiscount represents an amount deducted from the line, and will be applied before taxes."
+    },
+    "SubLine": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "i": {
+          "type": "integer",
+          "title": "Index",
+          "description": "Line number inside the parent (calculated)",
+          "calculated": true
+        },
+        "quantity": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Quantity",
+          "description": "Number of items"
+        },
+        "identifier": {
+          "$ref": "https://gobl.org/draft-0/org/identity",
+          "title": "Identifier",
+          "description": "Single identifier provided by the supplier for an object on which the\nline item is based and is not considered a universal identity. Examples\ninclude a subscription number, telephone number, meter point, etc.\nUtilize the label property to provide a description of the identifier."
+        },
+        "period": {
+          "$ref": "https://gobl.org/draft-0/cal/period",
+          "title": "Period",
+          "description": "A period of time relevant to when the service or item is delivered."
+        },
+        "order": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Order Reference",
+          "description": "Order reference for a specific line within a purchase order provided by the buyer."
+        },
+        "cost": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Cost Reference",
+          "description": "Buyer accounting reference cost code to associate with the line."
+        },
+        "item": {
+          "$ref": "https://gobl.org/draft-0/org/item",
+          "title": "Item",
+          "description": "Details about the item, service or good, that is being sold"
+        },
+        "sum": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Sum",
+          "description": "Result of quantity multiplied by the item's price (calculated)",
+          "calculated": true
+        },
+        "discounts": {
+          "items": {
+            "$ref": "#/$defs/LineDiscount"
+          },
+          "type": "array",
+          "title": "Discounts",
+          "description": "Discounts applied to this sub-line"
+        },
+        "charges": {
+          "items": {
+            "$ref": "#/$defs/LineCharge"
+          },
+          "type": "array",
+          "title": "Charges",
+          "description": "Charges applied to this sub-line"
+        },
+        "total": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Total",
+          "description": "Total sub-line amount after applying discounts to the sum (calculated).",
+          "calculated": true
+        },
+        "notes": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/note"
+          },
+          "type": "array",
+          "title": "Notes",
+          "description": "Set of specific notes for this sub-line that may be required for\nclarification."
+        }
+      },
+      "type": "object",
+      "required": [
+        "i",
+        "quantity",
+        "item"
+      ],
+      "description": "SubLine provides a simplified line that can be embedded inside other lines to provide a more detailed breakdown of the items being sold or substituted."
+    }
+  }
+}