@fleetless/contracts 6.2.0 → 6.3.0-next.1

package/artifacts/schema/billing-details-update.schema.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "invoice_email": {
+      "description": "Replaces the invoice email. Omitted leaves it as it is.",
+      "type": "string",
+      "format": "email",
+      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+    },
+    "vat_id": {
+      "description": "Replaces the VAT ID; `null` clears it. Omitted leaves it as it is. A new ID is re-checked through VIES.",
+      "anyOf": [
+        {
+          "type": "string",
+          "maxLength": 20
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "additionalProperties": false
+}

package/artifacts/schema/billing-details.schema.json

@@ -0,0 +1,176 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "company",
+          "description": "Billed as a company."
+        },
+        "company_name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200,
+          "description": "The company's legal name, printed on the invoice."
+        },
+        "vat_id": {
+          "anyOf": [
+            {
+              "type": "string",
+              "maxLength": 20
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The company's VAT ID, or `null` for none. Required, and must check out through VIES, for a company outside Germany."
+        },
+        "address": {
+          "type": "object",
+          "properties": {
+            "line1": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 200,
+              "description": "Street and number, or the first address line."
+            },
+            "line2": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "maxLength": 200
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "A second address line, or `null` when there is none."
+            },
+            "postal_code": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 20,
+              "description": "Postal or ZIP code."
+            },
+            "city": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 100,
+              "description": "City or town."
+            },
+            "country": {
+              "type": "string",
+              "pattern": "^[A-Z]{2}$",
+              "description": "The billing country. Decides VAT (`vatFor`) and currency (`currencyForCountry`)."
+            }
+          },
+          "required": [
+            "line1",
+            "line2",
+            "postal_code",
+            "city",
+            "country"
+          ],
+          "additionalProperties": false,
+          "description": "The billing address."
+        },
+        "invoice_email": {
+          "type": "string",
+          "format": "email",
+          "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+          "description": "Where invoices and billing mail are sent."
+        }
+      },
+      "required": [
+        "kind",
+        "company_name",
+        "vat_id",
+        "address",
+        "invoice_email"
+      ],
+      "additionalProperties": false,
+      "description": "A company: name and an optional VAT ID, never 'full name'."
+    },
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "person",
+          "description": "Billed as a person."
+        },
+        "full_name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200,
+          "description": "The person's full name, printed on the invoice."
+        },
+        "address": {
+          "type": "object",
+          "properties": {
+            "line1": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 200,
+              "description": "Street and number, or the first address line."
+            },
+            "line2": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "maxLength": 200
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "A second address line, or `null` when there is none."
+            },
+            "postal_code": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 20,
+              "description": "Postal or ZIP code."
+            },
+            "city": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 100,
+              "description": "City or town."
+            },
+            "country": {
+              "type": "string",
+              "pattern": "^[A-Z]{2}$",
+              "description": "The billing country. Decides VAT (`vatFor`) and currency (`currencyForCountry`)."
+            }
+          },
+          "required": [
+            "line1",
+            "line2",
+            "postal_code",
+            "city",
+            "country"
+          ],
+          "additionalProperties": false,
+          "description": "The billing address."
+        },
+        "invoice_email": {
+          "type": "string",
+          "format": "email",
+          "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+          "description": "Where invoices and billing mail are sent."
+        }
+      },
+      "required": [
+        "kind",
+        "full_name",
+        "address",
+        "invoice_email"
+      ],
+      "additionalProperties": false,
+      "description": "A person: a full name, never a VAT ID — only a company can be VAT-registered."
+    }
+  ]
+}

package/artifacts/schema/billing-invoice.schema.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "format": "uuid",
+      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
+      "description": "The invoice's id."
+    },
+    "number": {
+      "type": "string",
+      "pattern": "^FL-\\d{4}-\\d{4,}$",
+      "description": "The invoice number: `FL-<year>-<seq>`, `seq` zero-padded to four digits, gapless per calendar year in `Europe/Berlin`."
+    },
+    "issued_at": {
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+      "description": "When the invoice was issued."
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "open",
+        "paid",
+        "uncollectible"
+      ],
+      "description": "This invoice's own status."
+    },
+    "currency": {
+      "type": "string",
+      "enum": [
+        "eur",
+        "usd"
+      ],
+      "description": "The org's billing currency."
+    },
+    "net_cents": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "The charge, excluding VAT, in integer cents."
+    },
+    "vat_rate_percent": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 100,
+      "description": "The VAT rate applied, in whole percent."
+    },
+    "vat_cents": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "VAT, in integer cents (`vatCents`)."
+    },
+    "gross_cents": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "Net plus VAT, in integer cents."
+    }
+  },
+  "required": [
+    "id",
+    "number",
+    "issued_at",
+    "status",
+    "currency",
+    "net_cents",
+    "vat_rate_percent",
+    "vat_cents",
+    "gross_cents"
+  ],
+  "additionalProperties": false
+}