gobl 0.24.1 → 0.24.3

data/data/schemas/pay/instructions.json

@@ -0,0 +1,245 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/pay/instructions",
+  "$ref": "#/$defs/Instructions",
+  "$defs": {
+    "Card": {
+      "properties": {
+        "first6": {
+          "type": "string",
+          "title": "First 6",
+          "description": "First 6 digits of the card's Primary Account Number (PAN)."
+        },
+        "last4": {
+          "type": "string",
+          "title": "Last 4",
+          "description": "Last 4 digits of the card's Primary Account Number (PAN)."
+        },
+        "holder": {
+          "type": "string",
+          "title": "Holder Name",
+          "description": "Name of the person whom the card belongs to."
+        }
+      },
+      "type": "object",
+      "description": "Card contains simplified card holder data as a reference for the customer."
+    },
+    "CreditTransfer": {
+      "properties": {
+        "iban": {
+          "type": "string",
+          "title": "IBAN",
+          "description": "International Bank Account Number"
+        },
+        "bic": {
+          "type": "string",
+          "title": "BIC",
+          "description": "Bank Identifier Code used for international transfers."
+        },
+        "number": {
+          "type": "string",
+          "title": "Number",
+          "description": "Account number, if IBAN not available."
+        },
+        "name": {
+          "type": "string",
+          "title": "Name",
+          "description": "Name of the bank."
+        },
+        "branch": {
+          "$ref": "https://gobl.org/draft-0/org/address",
+          "title": "Branch",
+          "description": "Bank office branch address, not normally required."
+        }
+      },
+      "type": "object",
+      "description": "CreditTransfer contains fields that can be used for making payments via a bank transfer or wire."
+    },
+    "DirectDebit": {
+      "properties": {
+        "ref": {
+          "type": "string",
+          "title": "Mandate Reference",
+          "description": "Unique identifier assigned by the payee for referencing the direct debit."
+        },
+        "creditor": {
+          "type": "string",
+          "title": "Creditor ID",
+          "description": "Unique banking reference that identifies the payee or seller assigned by the bank."
+        },
+        "account": {
+          "type": "string",
+          "title": "Account",
+          "description": "Account identifier to be debited by the direct debit."
+        }
+      },
+      "type": "object",
+      "description": "DirectDebit defines the data that will be used to make the direct debit."
+    },
+    "Instructions": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "anyOf": [
+            {
+              "const": "any",
+              "title": "Any",
+              "description": "Any method available, no preference."
+            },
+            {
+              "const": "card",
+              "title": "Card",
+              "description": "Payment card."
+            },
+            {
+              "const": "credit-transfer",
+              "title": "Credit Transfer",
+              "description": "Sender initiated bank or wire transfer."
+            },
+            {
+              "const": "credit-transfer+sepa",
+              "title": "SEPA Credit Transfer",
+              "description": "Sender initiated bank or wire transfer via SEPA."
+            },
+            {
+              "const": "debit-transfer",
+              "title": "Debit Transfer",
+              "description": "Receiver initiated bank or wire transfer."
+            },
+            {
+              "const": "cash",
+              "title": "Cash",
+              "description": "Cash in hand."
+            },
+            {
+              "const": "cheque",
+              "title": "Cheque",
+              "description": "Cheque from bank."
+            },
+            {
+              "const": "bank-draft",
+              "title": "Draft",
+              "description": "Bankers Draft or Bank Cheque."
+            },
+            {
+              "const": "direct-debit",
+              "title": "Direct Debit",
+              "description": "Direct debit from the customers bank account."
+            },
+            {
+              "const": "direct-debit+sepa",
+              "title": "SEPA Direct Debit",
+              "description": "Direct debit from the customers bank account via SEPA."
+            },
+            {
+              "const": "online",
+              "title": "Online",
+              "description": "Online or web payment."
+            },
+            {
+              "const": "promissory-note",
+              "title": "Promissory Note",
+              "description": "Promissory note contract."
+            },
+            {
+              "const": "netting",
+              "title": "Netting",
+              "description": "Intercompany clearing or clearing between partners."
+            },
+            {
+              "const": "other",
+              "title": "Other",
+              "description": "Other or mutually defined means of payment."
+            },
+            {
+              "pattern": "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$",
+              "title": "Regime Specific Key"
+            }
+          ],
+          "title": "Key",
+          "description": "The payment means expected or that have been arranged to be used to make the payment."
+        },
+        "detail": {
+          "type": "string",
+          "title": "Detail",
+          "description": "Optional text description of the payment method"
+        },
+        "ref": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Reference",
+          "description": "Remittance information or concept, a code value used to link the payment with the invoice."
+        },
+        "credit_transfer": {
+          "items": {
+            "$ref": "#/$defs/CreditTransfer"
+          },
+          "type": "array",
+          "title": "Credit Transfer",
+          "description": "Instructions for sending payment via a bank transfer."
+        },
+        "card": {
+          "$ref": "#/$defs/Card",
+          "title": "Card",
+          "description": "Details of the payment that will be made via a credit or debit card."
+        },
+        "direct_debit": {
+          "$ref": "#/$defs/DirectDebit",
+          "title": "Direct Debit",
+          "description": "A group of terms that can be used by the customer or payer to consolidate direct debit payments."
+        },
+        "online": {
+          "items": {
+            "$ref": "#/$defs/Online"
+          },
+          "type": "array",
+          "title": "Online",
+          "description": "Array of online payment options"
+        },
+        "notes": {
+          "type": "string",
+          "title": "Notes",
+          "description": "Any additional instructions that may be required to make the payment."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension key-pairs values defined by a tax regime."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Non-structured additional data that may be useful."
+        }
+      },
+      "type": "object",
+      "required": [
+        "key"
+      ],
+      "description": "Instructions determine how the payment has or should be made."
+    },
+    "Online": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Key identifier for this online payment method."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Descriptive label for the online provider."
+        },
+        "url": {
+          "type": "string",
+          "title": "URL",
+          "description": "URL to be used for payment."
+        }
+      },
+      "type": "object",
+      "required": [
+        "url"
+      ],
+      "description": "Online provides the details required to make a payment online using a website"
+    }
+  }
+}

data/data/schemas/pay/terms.json

@@ -0,0 +1,128 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/pay/terms",
+  "$ref": "#/$defs/Terms",
+  "$defs": {
+    "DueDate": {
+      "properties": {
+        "date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Date",
+          "description": "When the payment is due."
+        },
+        "notes": {
+          "type": "string",
+          "title": "Notes",
+          "description": "Other details to take into account for the due date."
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "How much needs to be paid by the date."
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percentage of the total that should be paid by the date."
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency",
+          "description": "If different from the parent document's base currency."
+        }
+      },
+      "type": "object",
+      "required": [
+        "date",
+        "amount"
+      ],
+      "description": "DueDate contains an amount that should be paid by the given date."
+    },
+    "Terms": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "oneOf": [
+            {
+              "const": "end-of-month",
+              "title": "End of Month",
+              "description": "End of month"
+            },
+            {
+              "const": "due-date",
+              "title": "Due Date",
+              "description": "Due on a specific date"
+            },
+            {
+              "const": "deferred",
+              "title": "Deferred",
+              "description": "Deferred until after the due date"
+            },
+            {
+              "const": "proximo",
+              "title": "Proximo",
+              "description": "Month after the present"
+            },
+            {
+              "const": "instant",
+              "title": "Instant",
+              "description": "On receipt of invoice"
+            },
+            {
+              "const": "elective",
+              "title": "Elective",
+              "description": "Chosen by the buyer"
+            },
+            {
+              "const": "pending",
+              "title": "Pending",
+              "description": "Seller to advise buyer in separate transaction"
+            },
+            {
+              "const": "advanced",
+              "title": "Advanced",
+              "description": "Payment made in advance"
+            },
+            {
+              "const": "delivery",
+              "title": "Delivery",
+              "description": "Payment on Delivery"
+            },
+            {
+              "const": "undefined",
+              "title": "Undefined",
+              "description": "Not yet defined"
+            }
+          ],
+          "title": "Key",
+          "description": "Type of terms to be applied."
+        },
+        "detail": {
+          "type": "string",
+          "title": "Detail",
+          "description": "Text detail of the chosen payment terms."
+        },
+        "due_dates": {
+          "items": {
+            "$ref": "#/$defs/DueDate"
+          },
+          "type": "array",
+          "title": "Due Dates",
+          "description": "Set of dates for agreed payments."
+        },
+        "notes": {
+          "type": "string",
+          "title": "Notes",
+          "description": "Description of the conditions for payment."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extensions to the terms for local codes."
+        }
+      },
+      "type": "object",
+      "description": "Terms defines when we expect the customer to pay, or have paid, for the contents of the document."
+    }
+  }
+}

data/data/schemas/regimes/mx/food-vouchers.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/regimes/mx/food-vouchers",
+  "$ref": "#/$defs/FoodVouchers",
+  "$defs": {
+    "FoodVouchers": {
+      "properties": {
+        "employer_registration": {
+          "type": "string",
+          "title": "Employer Registration",
+          "description": "Customer's employer registration number (maps to `registroPatronal`)."
+        },
+        "account_number": {
+          "type": "string",
+          "title": "Account Number",
+          "description": "Customer's account number (maps to `numeroDeCuenta`)."
+        },
+        "total": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Total",
+          "description": "Sum of all line amounts (calculated, maps to `total`).",
+          "calculated": true
+        },
+        "lines": {
+          "items": {
+            "$ref": "#/$defs/FoodVouchersLine"
+          },
+          "type": "array",
+          "title": "Lines",
+          "description": "List of food vouchers issued to the customer's employees (maps to `Conceptos`)."
+        }
+      },
+      "type": "object",
+      "required": [
+        "account_number",
+        "total",
+        "lines"
+      ],
+      "description": "FoodVouchers carries the data to produce a CFDI's \"Complemento de Vales de Despensa\" (version 1.0) providing detailed information about food vouchers issued by an e-wallet supplier to its customer's employees."
+    },
+    "FoodVouchersEmployee": {
+      "properties": {
+        "tax_code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Employee's Tax Identity Code",
+          "description": "Employee's tax identity code (maps to `rfc`)."
+        },
+        "curp": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Employee's CURP",
+          "description": "Employee's CURP (\"Clave Única de Registro de Población\", maps to `curp`)."
+        },
+        "name": {
+          "type": "string",
+          "title": "Employee's Name",
+          "description": "Employee's name (maps to `nombre`)."
+        },
+        "social_security": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Employee's Social Security Number",
+          "description": "Employee's Social Security Number (maps to `numSeguridadSocial`)."
+        }
+      },
+      "type": "object",
+      "required": [
+        "tax_code",
+        "curp",
+        "name"
+      ],
+      "description": "FoodVouchersEmployee represents an employee that received a food voucher."
+    },
+    "FoodVouchersLine": {
+      "properties": {
+        "i": {
+          "type": "integer",
+          "title": "Index",
+          "description": "Line number starting from 1 (calculated).",
+          "calculated": true
+        },
+        "e_wallet_id": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "E-wallet Identifier",
+          "description": "Identifier of the e-wallet that received the food voucher (maps to `Identificador`)."
+        },
+        "issue_date_time": {
+          "$ref": "https://gobl.org/draft-0/cal/date-time",
+          "title": "Issue Date and Time",
+          "description": "Date and time of the food voucher's issue (maps to `Fecha`)."
+        },
+        "employee": {
+          "$ref": "#/$defs/FoodVouchersEmployee",
+          "title": "Employee",
+          "description": "Employee that received the food voucher."
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "Amount of the food voucher (maps to `importe`)."
+        }
+      },
+      "type": "object",
+      "required": [
+        "i",
+        "e_wallet_id",
+        "issue_date_time",
+        "amount"
+      ],
+      "description": "FoodVouchersLine represents a single food voucher issued to the e-wallet of one of the customer's employees."
+    }
+  }
+}

data/data/schemas/regimes/mx/fuel-account-balance.json

@@ -0,0 +1,179 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/regimes/mx/fuel-account-balance",
+  "$ref": "#/$defs/FuelAccountBalance",
+  "$defs": {
+    "FuelAccountBalance": {
+      "properties": {
+        "account_number": {
+          "type": "string",
+          "title": "Account Number",
+          "description": "Customer's account number (maps to `NumeroDeCuenta`)."
+        },
+        "subtotal": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Subtotal",
+          "description": "Sum of all line totals (i.e. taxes not included) (calculated, maps to `SubTotal`).",
+          "calculated": true
+        },
+        "total": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Total",
+          "description": "Grand total after taxes have been applied (calculated, maps to `Total`).",
+          "calculated": true
+        },
+        "lines": {
+          "items": {
+            "$ref": "#/$defs/FuelAccountLine"
+          },
+          "type": "array",
+          "title": "Lines",
+          "description": "List of fuel purchases made with the customer's e-wallets (maps to `Conceptos`)."
+        }
+      },
+      "type": "object",
+      "required": [
+        "account_number",
+        "subtotal",
+        "total",
+        "lines"
+      ],
+      "description": "FuelAccountBalance carries the data to produce a CFDI's \"Complemento de Estado de Cuenta de Combustibles para Monederos Electrónicos\" (version 1.2 revision B) providing detailed information about fuel purchases made with electronic wallets."
+    },
+    "FuelAccountItem": {
+      "properties": {
+        "type": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Type",
+          "description": "Type of fuel (one of `c_ClaveTipoCombustible` codes, maps to `TipoCombustible`)."
+        },
+        "unit": {
+          "$ref": "https://gobl.org/draft-0/org/unit",
+          "title": "Unit",
+          "description": "Reference unit of measure used in the price and the quantity (maps to `Unidad`)."
+        },
+        "name": {
+          "type": "string",
+          "title": "Name",
+          "description": "Name of the fuel (maps to `NombreCombustible`)."
+        },
+        "price": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Price",
+          "description": "Base price of a single unit of the fuel without taxes (maps to `ValorUnitario`)."
+        }
+      },
+      "type": "object",
+      "required": [
+        "type",
+        "name",
+        "price"
+      ],
+      "description": "FuelAccountItem provides the details of a fuel purchase."
+    },
+    "FuelAccountLine": {
+      "properties": {
+        "i": {
+          "type": "integer",
+          "title": "Index",
+          "description": "Index of the line starting from 1 (calculated)",
+          "calculated": true
+        },
+        "e_wallet_id": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "E-wallet Identifier",
+          "description": "Identifier of the e-wallet used to make the purchase (maps to `Identificador`)."
+        },
+        "purchase_date_time": {
+          "$ref": "https://gobl.org/draft-0/cal/date-time",
+          "title": "Purchase Date and Time",
+          "description": "Date and time of the purchase (maps to `Fecha`)."
+        },
+        "vendor_tax_code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Vendor's Tax Identity Code",
+          "description": "Tax Identity Code of the fuel's vendor (maps to `Rfc`)"
+        },
+        "service_station_code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Service Station Code",
+          "description": "Code of the service station where the purchase was made (maps to `ClaveEstacion`)."
+        },
+        "quantity": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Quantity",
+          "description": "Amount of fuel units purchased (maps to `Cantidad`)"
+        },
+        "item": {
+          "$ref": "#/$defs/FuelAccountItem",
+          "title": "Item",
+          "description": "Details of the fuel purchased."
+        },
+        "purchase_code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Purchase Code",
+          "description": "Identifier of the purchase (maps to `FolioOperacion`)."
+        },
+        "total": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Total",
+          "description": "Result of quantity multiplied by the unit price (maps to `Importe`).",
+          "calculated": true
+        },
+        "taxes": {
+          "items": {
+            "$ref": "#/$defs/FuelAccountTax"
+          },
+          "type": "array",
+          "title": "Taxes",
+          "description": "Map of taxes applied to the purchase (maps to `Traslados`)."
+        }
+      },
+      "type": "object",
+      "required": [
+        "i",
+        "e_wallet_id",
+        "purchase_date_time",
+        "vendor_tax_code",
+        "service_station_code",
+        "quantity",
+        "item",
+        "purchase_code",
+        "total",
+        "taxes"
+      ],
+      "description": "FuelAccountLine represents a single fuel purchase made with an e-wallet issued by the invoice's supplier."
+    },
+    "FuelAccountTax": {
+      "properties": {
+        "cat": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Category",
+          "description": "Category that identifies the tax (\"VAT\" or \"IEPS\", maps to `Impuesto`)"
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percent applicable to the line total (tasa) to use instead of Rate (maps to `TasaoCuota`)"
+        },
+        "rate": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Rate",
+          "description": "Rate is a fixed fee to apply to the line quantity (cuota) (maps to `TasaOCuota`)"
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "Total amount of the tax once the percent or rate has been applied (maps to `Importe`).",
+          "calculated": true
+        }
+      },
+      "type": "object",
+      "required": [
+        "cat",
+        "amount"
+      ],
+      "description": "FuelAccountTax represents a single tax applied to a fuel purchase."
+    }
+  }
+}

data/data/schemas/schema/object.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/schema/object",
+  "$ref": "#/$defs/Object",
+  "$defs": {
+    "Object": {
+      "type": "object",
+      "title": "Object",
+      "description": "Data object whose type is determined from the \u003ccode\u003e$schema\u003c/code\u003e property."
+    }
+  }
+}