@epilot/sdk 2.11.5 → 2.11.7

package/docs/metering.md

@@ -1,5 +1,6 @@
 # Metering API
 
+- **Base URL:** `https://metering.sls.epilot.io`
 - **Full API Docs:** [https://docs.epilot.io/api/metering](https://docs.epilot.io/api/metering)
 
 ## Usage
@@ -581,6 +582,7 @@ const { data } = await client.createMeterReadings(
     activity_id: 'example',
     skip_validation: true,
     direct: true,
+    create_ticket: true,
   },
   {
     readings: [
@@ -726,6 +728,7 @@ const { data } = await client.batchWriteMeterReadings(
     skip_validation: true,
     activity_id: 'example',
     direct: true,
+    create_ticket: true,
   },
   {
     identifiers: ['string'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.11.5",
+  "version": "2.11.7",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -322,6 +322,16 @@
     },
     "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
   },
+  "scripts": {
+    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check src --fix",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
     "epilot",
     "sdk",
@@ -515,14 +525,5 @@
         "./dist/apis/workflow-definition.d.ts"
       ]
     }
-  },
-  "scripts": {
-    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "biome check src",
-    "lint:fix": "biome check src --fix"
   }
-}
+}

package/dist/billing-DUWDISHP.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/billing.json
-var billing_default = '# Billing API\n\n- **Base URL:** `https://billing.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/billing](https://docs.epilot.io/api/billing)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.billing.getBillingEvents(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/billing\'\n\nconst billingClient = getClient()\nauthorize(billingClient, () => \'<token>\')\nconst { data } = await billingClient.getBillingEvents(...)\n```\n\n## Operations\n\n**Billing Events**\n- [`getBillingEvents`](#getbillingevents)\n- [`createBillingEvent`](#createbillingevent)\n- [`getBillingEvent`](#getbillingevent)\n- [`updateBillingEvent`](#updatebillingevent)\n- [`deleteBillingEvent`](#deletebillingevent)\n- [`getBillingEventByExternalId`](#getbillingeventbyexternalid)\n\n**Contracts**\n- [`createContractEntity`](#createcontractentity)\n- [`updateContractEntity`](#updatecontractentity)\n- [`deleteContractEntity`](#deletecontractentity)\n\n**Balance**\n- [`getCustomerBalance`](#getcustomerbalance)\n\n**Schemas**\n- [`BaseEntity`](#baseentity)\n- [`EntityId`](#entityid)\n- [`EntitySlug`](#entityslug)\n- [`EntityRelationItem`](#entityrelationitem)\n- [`BaseBillingEvent`](#basebillingevent)\n- [`InstallmentEvent`](#installmentevent)\n- [`ReimbursementEvent`](#reimbursementevent)\n- [`BillingEvent`](#billingevent)\n- [`Contract`](#contract)\n- [`ContractItem`](#contractitem)\n- [`Balance`](#balance)\n- [`Currency`](#currency)\n\n### `getBillingEvents`\n\nGet and filter billing events such as installments and reimbursements.\n\n`GET /v1/billing/events`\n\n```ts\nconst { data } = await client.getBillingEvents({\n  from: 1,\n  size: 1,\n  entity_id: [\'...\'],\n  event_type: \'example\',\n  date_after: \'example\',\n  date_before: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "billing_amount": 10050,\n      "billing_amount_decimal": "100.50",\n      "billing_currency": "EUR",\n      "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n      "contract": {\n        "$relation": [\n          {\n            "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n          }\n        ]\n      },\n      "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n      "_title": "string",\n      "_org": "string",\n      "_schema": "contact",\n      "_tags": ["string"],\n      "_created_at": "string",\n      "_updated_at": "string",\n      "type": "installment",\n      "due_date": "1970-01-01T00:00:00.000Z",\n      "paid_date": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createBillingEvent`\n\nCreate a new billing event.\n\n`POST /v1/billing/events`\n\n```ts\nconst { data } = await client.createBillingEvent(\n  null,\n  {\n    billing_amount: 10050,\n    billing_amount_decimal: \'100.50\',\n    billing_currency: \'EUR\',\n    external_id: \'d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e\',\n    contract: {\n      $relation: [\n        {\n          entity_id: \'f589786b-3024-43cd-9cb3-5a3c953f2896\'\n        }\n      ]\n    },\n    _id: \'5da0a718-c822-403d-9f5d-20d4584e0528\',\n    _title: \'string\',\n    _org: \'string\',\n    _schema: \'contact\',\n    _tags: [\'string\'],\n    _created_at: \'string\',\n    _updated_at: \'string\',\n    type: \'installment\',\n    due_date: \'1970-01-01T00:00:00.000Z\',\n    paid_date: \'1970-01-01T00:00:00.000Z\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "billing_amount": 10050,\n  "billing_amount_decimal": "100.50",\n  "billing_currency": "EUR",\n  "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n  "contract": {\n    "$relation": [\n      {\n        "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n      }\n    ]\n  },\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "type": "installment",\n  "due_date": "1970-01-01T00:00:00.000Z",\n  "paid_date": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getBillingEvent`\n\nGet a single billing event by ID.\n\n`GET /v1/billing/events/{id}`\n\n```ts\nconst { data } = await client.getBillingEvent({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "billing_amount": 10050,\n  "billing_amount_decimal": "100.50",\n  "billing_currency": "EUR",\n  "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n  "contract": {\n    "$relation": [\n      {\n        "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n      }\n    ]\n  },\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "type": "installment",\n  "due_date": "1970-01-01T00:00:00.000Z",\n  "paid_date": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateBillingEvent`\n\nUpdate an existing billing event.\n\n`PATCH /v1/billing/events/{id}`\n\n```ts\nconst { data } = await client.updateBillingEvent(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    billing_amount: 10050,\n    billing_amount_decimal: \'100.50\',\n    billing_currency: \'EUR\',\n    external_id: \'d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e\',\n    contract: {\n      $relation: [\n        {\n          entity_id: \'f589786b-3024-43cd-9cb3-5a3c953f2896\'\n        }\n      ]\n    },\n    _id: \'5da0a718-c822-403d-9f5d-20d4584e0528\',\n    _title: \'string\',\n    _org: \'string\',\n    _schema: \'contact\',\n    _tags: [\'string\'],\n    _created_at: \'string\',\n    _updated_at: \'string\',\n    type: \'installment\',\n    due_date: \'1970-01-01T00:00:00.000Z\',\n    paid_date: \'1970-01-01T00:00:00.000Z\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "billing_amount": 10050,\n  "billing_amount_decimal": "100.50",\n  "billing_currency": "EUR",\n  "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n  "contract": {\n    "$relation": [\n      {\n        "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n      }\n    ]\n  },\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "type": "installment",\n  "due_date": "1970-01-01T00:00:00.000Z",\n  "paid_date": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteBillingEvent`\n\nDelete an existing billing event.\n\n`DELETE /v1/billing/events/{id}`\n\n```ts\nconst { data } = await client.deleteBillingEvent({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getBillingEventByExternalId`\n\nGet a single billing event by External ID.\n\n`GET /v1/billing/external/{external_id}`\n\n```ts\nconst { data } = await client.getBillingEventByExternalId({\n  external_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "billing_amount": 10050,\n  "billing_amount_decimal": "100.50",\n  "billing_currency": "EUR",\n  "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n  "contract": {\n    "$relation": [\n      {\n        "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n      }\n    ]\n  },\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "type": "installment",\n  "due_date": "1970-01-01T00:00:00.000Z",\n  "paid_date": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createContractEntity`\n\nCreate a new contract entity.\n\n`POST /v1/billing/contracts`\n\n```ts\nconst { data } = await client.createContractEntity(\n  null,\n  {\n    _id: \'5da0a718-c822-403d-9f5d-20d4584e0528\',\n    _title: \'string\',\n    _org: \'string\',\n    _schema: \'contact\',\n    _tags: [\'string\'],\n    _created_at: \'string\',\n    _updated_at: \'string\',\n    contract_name: \'Grid Contract\',\n    contract_number: \'12345\',\n    status: \'approved\',\n    description: \'This contract is for the supply of widgets.\',\n    account_number: \'67890\',\n    branch: \'power\',\n    billing_address: \'123 Main St, Anytown\',\n    delivery_address: \'456 Elm St, Anytown\',\n    additional_addresses: \'789 Oak St, Anytown\',\n    termination_date: \'2022-01-01\',\n    termination_reason: \'Non-payment\',\n    billing_period: \'monthly\',\n    billing_duration_amount: 30,\n    renewal_duration_amount: 365,\n    renewal_duration_unit: \'years\',\n    notice_time_amount: 30,\n    notice_time_unit: \'months\',\n    start_date: \'2021-01-01\',\n    billing_due_day: 2,\n    installment_amount: 10050,\n    balance: 8990,\n    balance_currency: \'EUR\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "contract_name": "Grid Contract",\n  "contract_number": "12345",\n  "status": "approved",\n  "description": "This contract is for the supply of widgets.",\n  "account_number": "67890",\n  "branch": "power",\n  "billing_address": "123 Main St, Anytown",\n  "delivery_address": "456 Elm St, Anytown",\n  "additional_addresses": "789 Oak St, Anytown",\n  "termination_date": "2022-01-01",\n  "termination_reason": "Non-payment",\n  "billing_period": "monthly",\n  "billing_duration_amount": 30,\n  "renewal_duration_amount": 365,\n  "renewal_duration_unit": "years",\n  "notice_time_amount": 30,\n  "notice_time_unit": "months",\n  "start_date": "2021-01-01",\n  "billing_due_day": 2,\n  "installment_amount": 10050,\n  "balance": 8990,\n  "balance_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `updateContractEntity`\n\nUpdate an existing contract entity.\n\n`PATCH /v1/billing/contracts/{id}`\n\n```ts\nconst { data } = await client.updateContractEntity(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    _id: \'5da0a718-c822-403d-9f5d-20d4584e0528\',\n    _title: \'string\',\n    _org: \'string\',\n    _schema: \'contact\',\n    _tags: [\'string\'],\n    _created_at: \'string\',\n    _updated_at: \'string\',\n    contract_name: \'Grid Contract\',\n    contract_number: \'12345\',\n    status: \'approved\',\n    description: \'This contract is for the supply of widgets.\',\n    account_number: \'67890\',\n    branch: \'power\',\n    billing_address: \'123 Main St, Anytown\',\n    delivery_address: \'456 Elm St, Anytown\',\n    additional_addresses: \'789 Oak St, Anytown\',\n    termination_date: \'2022-01-01\',\n    termination_reason: \'Non-payment\',\n    billing_period: \'monthly\',\n    billing_duration_amount: 30,\n    renewal_duration_amount: 365,\n    renewal_duration_unit: \'years\',\n    notice_time_amount: 30,\n    notice_time_unit: \'months\',\n    start_date: \'2021-01-01\',\n    billing_due_day: 2,\n    installment_amount: 10050,\n    balance: 8990,\n    balance_currency: \'EUR\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "contract_name": "Grid Contract",\n  "contract_number": "12345",\n  "status": "approved",\n  "description": "This contract is for the supply of widgets.",\n  "account_number": "67890",\n  "branch": "power",\n  "billing_address": "123 Main St, Anytown",\n  "delivery_address": "456 Elm St, Anytown",\n  "additional_addresses": "789 Oak St, Anytown",\n  "termination_date": "2022-01-01",\n  "termination_reason": "Non-payment",\n  "billing_period": "monthly",\n  "billing_duration_amount": 30,\n  "renewal_duration_amount": 365,\n  "renewal_duration_unit": "years",\n  "notice_time_amount": 30,\n  "notice_time_unit": "months",\n  "start_date": "2021-01-01",\n  "billing_due_day": 2,\n  "installment_amount": 10050,\n  "balance": 8990,\n  "balance_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `deleteContractEntity`\n\nDelete an existing contract entity.\n\n`DELETE /v1/billing/contracts/{id}`\n\n```ts\nconst { data } = await client.deleteContractEntity({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getCustomerBalance`\n\nGet total balance across all contracts and orders of a customer entity.\n\n`GET /v1/billing/customers/{id}/balance`\n\n```ts\nconst { data } = await client.getCustomerBalance({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "balance": 8990,\n  "balance_decimal": "89.90",\n  "balance_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id?: string\n  _title?: string\n  _org?: string\n  _schema?: "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n  _tags?: string[]\n  _created_at?: string\n  _updated_at?: string\n}\n```\n\n### `EntityId`\n\nEntity ID\n\n```ts\ntype EntityId = string\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n```\n\n### `EntityRelationItem`\n\n```ts\ntype EntityRelationItem = {\n  entity_id?: string\n}\n```\n\n### `BaseBillingEvent`\n\nA base billing event to be inherited by all billing events.\n\n```ts\ntype BaseBillingEvent = {\n  _id?: string\n  _title?: string\n  _org?: string\n  _schema?: "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n  _tags?: string[]\n  _created_at?: string\n  _updated_at?: string\n}\n```\n\n### `InstallmentEvent`\n\nAn entity that describes an installment billing event.\n\n```ts\ntype InstallmentEvent = {\n  billing_amount: number\n  billing_amount_decimal: string\n  billing_currency: string\n  external_id?: string\n  contract: {\n    $relation?: Array<{\n      entity_id?: { ... }\n    }>\n  }\n  type: "installment"\n  due_date: string // date-time\n  paid_date?: string // date-time\n}\n```\n\n### `ReimbursementEvent`\n\nAn entity that describes a reimbursement billing event.\n\n```ts\ntype ReimbursementEvent = {\n  billing_amount: number\n  billing_amount_decimal: string\n  billing_currency: string\n  external_id?: string\n  contract: {\n    $relation?: Array<{\n      entity_id?: { ... }\n    }>\n  }\n  type: "reimbursement"\n  paid_date?: string // date-time\n}\n```\n\n### `BillingEvent`\n\nAn entity that describes a billing event such as a future installment or a reimbursement back to the customer.\n\n```ts\ntype BillingEvent = {\n  billing_amount: number\n  billing_amount_decimal: string\n  billing_currency: string\n  external_id?: string\n  contract: {\n    $relation?: Array<{\n      entity_id?: { ... }\n    }>\n  }\n  type: "installment"\n  due_date: string // date-time\n  paid_date?: string // date-time\n} | {\n  billing_amount: number\n  billing_amount_decimal: string\n  billing_currency: string\n  external_id?: string\n  contract: {\n    $relation?: Array<{\n      entity_id?: { ... }\n    }>\n  }\n  type: "reimbursement"\n  paid_date?: string // date-time\n}\n```\n\n### `Contract`\n\n```ts\ntype Contract = {\n  _id?: string\n  _title?: string\n  _org?: string\n  _schema?: "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n  _tags?: string[]\n  _created_at?: string\n  _updated_at?: string\n  contract_name?: string\n  contract_number?: string\n  status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired"\n  description?: string\n  account_number?: string\n  branch?: "power" | "gas" | "water" | "waste_water" | "district_heating"\n  billing_address?: string\n  delivery_address?: string\n  additional_addresses?: string\n  termination_date?: string\n  termination_reason?: string\n  billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly"\n  billing_duration_amount?: number\n  renewal_duration_amount?: number\n  renewal_duration_unit?: "weeks" | "months" | "years"\n  notice_time_amount?: number\n  notice_time_unit?: "weeks" | "months" | "years"\n  start_date?: string\n  billing_due_day?: number\n  installment_amount?: number\n  balance?: number\n  balance_currency?: string\n}\n```\n\n### `ContractItem`\n\n```ts\ntype ContractItem = {\n  _id?: string\n  _title?: string\n  _org?: string\n  _schema?: "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n  _tags?: string[]\n  _created_at?: string\n  _updated_at?: string\n  contract_name?: string\n  contract_number?: string\n  status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired"\n  description?: string\n  account_number?: string\n  branch?: "power" | "gas" | "water" | "waste_water" | "district_heating"\n  billing_address?: string\n  delivery_address?: string\n  additional_addresses?: string\n  termination_date?: string\n  termination_reason?: string\n  billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly"\n  billing_duration_amount?: number\n  renewal_duration_amount?: number\n  renewal_duration_unit?: "weeks" | "months" | "years"\n  notice_time_amount?: number\n  notice_time_unit?: "weeks" | "months" | "years"\n  start_date?: string\n  billing_due_day?: number\n  installment_amount?: number\n  balance?: number\n  balance_currency?: string\n}\n```\n\n### `Balance`\n\n```ts\ntype Balance = {\n  balance?: number\n  balance_decimal?: string\n  balance_currency?: string\n}\n```\n\n### `Currency`\n\nCurrency code in ISO 4217 format\n\n```ts\ntype Currency = string\n```\n';
-
-
-exports.default = billing_default;

package/dist/billing-IPALEAG2.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/billing.json
-var billing_default = '# Billing API\n\n- **Base URL:** `https://billing.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/billing](https://docs.epilot.io/api/billing)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.billing.getBillingEvents(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/billing\'\n\nconst billingClient = getClient()\nauthorize(billingClient, () => \'<token>\')\nconst { data } = await billingClient.getBillingEvents(...)\n```\n\n## Operations\n\n**Billing Events**\n- [`getBillingEvents`](#getbillingevents)\n- [`createBillingEvent`](#createbillingevent)\n- [`getBillingEvent`](#getbillingevent)\n- [`updateBillingEvent`](#updatebillingevent)\n- [`deleteBillingEvent`](#deletebillingevent)\n- [`getBillingEventByExternalId`](#getbillingeventbyexternalid)\n\n**Contracts**\n- [`createContractEntity`](#createcontractentity)\n- [`updateContractEntity`](#updatecontractentity)\n- [`deleteContractEntity`](#deletecontractentity)\n\n**Balance**\n- [`getCustomerBalance`](#getcustomerbalance)\n\n**Schemas**\n- [`BaseEntity`](#baseentity)\n- [`EntityId`](#entityid)\n- [`EntitySlug`](#entityslug)\n- [`EntityRelationItem`](#entityrelationitem)\n- [`BaseBillingEvent`](#basebillingevent)\n- [`InstallmentEvent`](#installmentevent)\n- [`ReimbursementEvent`](#reimbursementevent)\n- [`BillingEvent`](#billingevent)\n- [`Contract`](#contract)\n- [`ContractItem`](#contractitem)\n- [`Balance`](#balance)\n- [`Currency`](#currency)\n\n### `getBillingEvents`\n\nGet and filter billing events such as installments and reimbursements.\n\n`GET /v1/billing/events`\n\n```ts\nconst { data } = await client.getBillingEvents({\n  from: 1,\n  size: 1,\n  entity_id: [\'...\'],\n  event_type: \'example\',\n  date_after: \'example\',\n  date_before: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "billing_amount": 10050,\n      "billing_amount_decimal": "100.50",\n      "billing_currency": "EUR",\n      "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n      "contract": {\n        "$relation": [\n          {\n            "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n          }\n        ]\n      },\n      "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n      "_title": "string",\n      "_org": "string",\n      "_schema": "contact",\n      "_tags": ["string"],\n      "_created_at": "string",\n      "_updated_at": "string",\n      "type": "installment",\n      "due_date": "1970-01-01T00:00:00.000Z",\n      "paid_date": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createBillingEvent`\n\nCreate a new billing event.\n\n`POST /v1/billing/events`\n\n```ts\nconst { data } = await client.createBillingEvent(\n  null,\n  {\n    billing_amount: 10050,\n    billing_amount_decimal: \'100.50\',\n    billing_currency: \'EUR\',\n    external_id: \'d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e\',\n    contract: {\n      $relation: [\n        {\n          entity_id: \'f589786b-3024-43cd-9cb3-5a3c953f2896\'\n        }\n      ]\n    },\n    _id: \'5da0a718-c822-403d-9f5d-20d4584e0528\',\n    _title: \'string\',\n    _org: \'string\',\n    _schema: \'contact\',\n    _tags: [\'string\'],\n    _created_at: \'string\',\n    _updated_at: \'string\',\n    type: \'installment\',\n    due_date: \'1970-01-01T00:00:00.000Z\',\n    paid_date: \'1970-01-01T00:00:00.000Z\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "billing_amount": 10050,\n  "billing_amount_decimal": "100.50",\n  "billing_currency": "EUR",\n  "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n  "contract": {\n    "$relation": [\n      {\n        "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n      }\n    ]\n  },\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "type": "installment",\n  "due_date": "1970-01-01T00:00:00.000Z",\n  "paid_date": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getBillingEvent`\n\nGet a single billing event by ID.\n\n`GET /v1/billing/events/{id}`\n\n```ts\nconst { data } = await client.getBillingEvent({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "billing_amount": 10050,\n  "billing_amount_decimal": "100.50",\n  "billing_currency": "EUR",\n  "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n  "contract": {\n    "$relation": [\n      {\n        "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n      }\n    ]\n  },\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "type": "installment",\n  "due_date": "1970-01-01T00:00:00.000Z",\n  "paid_date": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateBillingEvent`\n\nUpdate an existing billing event.\n\n`PATCH /v1/billing/events/{id}`\n\n```ts\nconst { data } = await client.updateBillingEvent(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    billing_amount: 10050,\n    billing_amount_decimal: \'100.50\',\n    billing_currency: \'EUR\',\n    external_id: \'d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e\',\n    contract: {\n      $relation: [\n        {\n          entity_id: \'f589786b-3024-43cd-9cb3-5a3c953f2896\'\n        }\n      ]\n    },\n    _id: \'5da0a718-c822-403d-9f5d-20d4584e0528\',\n    _title: \'string\',\n    _org: \'string\',\n    _schema: \'contact\',\n    _tags: [\'string\'],\n    _created_at: \'string\',\n    _updated_at: \'string\',\n    type: \'installment\',\n    due_date: \'1970-01-01T00:00:00.000Z\',\n    paid_date: \'1970-01-01T00:00:00.000Z\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "billing_amount": 10050,\n  "billing_amount_decimal": "100.50",\n  "billing_currency": "EUR",\n  "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n  "contract": {\n    "$relation": [\n      {\n        "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n      }\n    ]\n  },\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "type": "installment",\n  "due_date": "1970-01-01T00:00:00.000Z",\n  "paid_date": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteBillingEvent`\n\nDelete an existing billing event.\n\n`DELETE /v1/billing/events/{id}`\n\n```ts\nconst { data } = await client.deleteBillingEvent({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getBillingEventByExternalId`\n\nGet a single billing event by External ID.\n\n`GET /v1/billing/external/{external_id}`\n\n```ts\nconst { data } = await client.getBillingEventByExternalId({\n  external_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "billing_amount": 10050,\n  "billing_amount_decimal": "100.50",\n  "billing_currency": "EUR",\n  "external_id": "d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e",\n  "contract": {\n    "$relation": [\n      {\n        "entity_id": "f589786b-3024-43cd-9cb3-5a3c953f2896"\n      }\n    ]\n  },\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "type": "installment",\n  "due_date": "1970-01-01T00:00:00.000Z",\n  "paid_date": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createContractEntity`\n\nCreate a new contract entity.\n\n`POST /v1/billing/contracts`\n\n```ts\nconst { data } = await client.createContractEntity(\n  null,\n  {\n    _id: \'5da0a718-c822-403d-9f5d-20d4584e0528\',\n    _title: \'string\',\n    _org: \'string\',\n    _schema: \'contact\',\n    _tags: [\'string\'],\n    _created_at: \'string\',\n    _updated_at: \'string\',\n    contract_name: \'Grid Contract\',\n    contract_number: \'12345\',\n    status: \'approved\',\n    description: \'This contract is for the supply of widgets.\',\n    account_number: \'67890\',\n    branch: \'power\',\n    billing_address: \'123 Main St, Anytown\',\n    delivery_address: \'456 Elm St, Anytown\',\n    additional_addresses: \'789 Oak St, Anytown\',\n    termination_date: \'2022-01-01\',\n    termination_reason: \'Non-payment\',\n    billing_period: \'monthly\',\n    billing_duration_amount: 30,\n    renewal_duration_amount: 365,\n    renewal_duration_unit: \'years\',\n    notice_time_amount: 30,\n    notice_time_unit: \'months\',\n    start_date: \'2021-01-01\',\n    billing_due_day: 2,\n    installment_amount: 10050,\n    balance: 8990,\n    balance_currency: \'EUR\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "contract_name": "Grid Contract",\n  "contract_number": "12345",\n  "status": "approved",\n  "description": "This contract is for the supply of widgets.",\n  "account_number": "67890",\n  "branch": "power",\n  "billing_address": "123 Main St, Anytown",\n  "delivery_address": "456 Elm St, Anytown",\n  "additional_addresses": "789 Oak St, Anytown",\n  "termination_date": "2022-01-01",\n  "termination_reason": "Non-payment",\n  "billing_period": "monthly",\n  "billing_duration_amount": 30,\n  "renewal_duration_amount": 365,\n  "renewal_duration_unit": "years",\n  "notice_time_amount": 30,\n  "notice_time_unit": "months",\n  "start_date": "2021-01-01",\n  "billing_due_day": 2,\n  "installment_amount": 10050,\n  "balance": 8990,\n  "balance_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `updateContractEntity`\n\nUpdate an existing contract entity.\n\n`PATCH /v1/billing/contracts/{id}`\n\n```ts\nconst { data } = await client.updateContractEntity(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    _id: \'5da0a718-c822-403d-9f5d-20d4584e0528\',\n    _title: \'string\',\n    _org: \'string\',\n    _schema: \'contact\',\n    _tags: [\'string\'],\n    _created_at: \'string\',\n    _updated_at: \'string\',\n    contract_name: \'Grid Contract\',\n    contract_number: \'12345\',\n    status: \'approved\',\n    description: \'This contract is for the supply of widgets.\',\n    account_number: \'67890\',\n    branch: \'power\',\n    billing_address: \'123 Main St, Anytown\',\n    delivery_address: \'456 Elm St, Anytown\',\n    additional_addresses: \'789 Oak St, Anytown\',\n    termination_date: \'2022-01-01\',\n    termination_reason: \'Non-payment\',\n    billing_period: \'monthly\',\n    billing_duration_amount: 30,\n    renewal_duration_amount: 365,\n    renewal_duration_unit: \'years\',\n    notice_time_amount: 30,\n    notice_time_unit: \'months\',\n    start_date: \'2021-01-01\',\n    billing_due_day: 2,\n    installment_amount: 10050,\n    balance: 8990,\n    balance_currency: \'EUR\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",\n  "_title": "string",\n  "_org": "string",\n  "_schema": "contact",\n  "_tags": ["string"],\n  "_created_at": "string",\n  "_updated_at": "string",\n  "contract_name": "Grid Contract",\n  "contract_number": "12345",\n  "status": "approved",\n  "description": "This contract is for the supply of widgets.",\n  "account_number": "67890",\n  "branch": "power",\n  "billing_address": "123 Main St, Anytown",\n  "delivery_address": "456 Elm St, Anytown",\n  "additional_addresses": "789 Oak St, Anytown",\n  "termination_date": "2022-01-01",\n  "termination_reason": "Non-payment",\n  "billing_period": "monthly",\n  "billing_duration_amount": 30,\n  "renewal_duration_amount": 365,\n  "renewal_duration_unit": "years",\n  "notice_time_amount": 30,\n  "notice_time_unit": "months",\n  "start_date": "2021-01-01",\n  "billing_due_day": 2,\n  "installment_amount": 10050,\n  "balance": 8990,\n  "balance_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `deleteContractEntity`\n\nDelete an existing contract entity.\n\n`DELETE /v1/billing/contracts/{id}`\n\n```ts\nconst { data } = await client.deleteContractEntity({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getCustomerBalance`\n\nGet total balance across all contracts and orders of a customer entity.\n\n`GET /v1/billing/customers/{id}/balance`\n\n```ts\nconst { data } = await client.getCustomerBalance({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "balance": 8990,\n  "balance_decimal": "89.90",\n  "balance_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id?: string\n  _title?: string\n  _org?: string\n  _schema?: "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n  _tags?: string[]\n  _created_at?: string\n  _updated_at?: string\n}\n```\n\n### `EntityId`\n\nEntity ID\n\n```ts\ntype EntityId = string\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n```\n\n### `EntityRelationItem`\n\n```ts\ntype EntityRelationItem = {\n  entity_id?: string\n}\n```\n\n### `BaseBillingEvent`\n\nA base billing event to be inherited by all billing events.\n\n```ts\ntype BaseBillingEvent = {\n  _id?: string\n  _title?: string\n  _org?: string\n  _schema?: "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n  _tags?: string[]\n  _created_at?: string\n  _updated_at?: string\n}\n```\n\n### `InstallmentEvent`\n\nAn entity that describes an installment billing event.\n\n```ts\ntype InstallmentEvent = {\n  billing_amount: number\n  billing_amount_decimal: string\n  billing_currency: string\n  external_id?: string\n  contract: {\n    $relation?: Array<{\n      entity_id?: { ... }\n    }>\n  }\n  type: "installment"\n  due_date: string // date-time\n  paid_date?: string // date-time\n}\n```\n\n### `ReimbursementEvent`\n\nAn entity that describes a reimbursement billing event.\n\n```ts\ntype ReimbursementEvent = {\n  billing_amount: number\n  billing_amount_decimal: string\n  billing_currency: string\n  external_id?: string\n  contract: {\n    $relation?: Array<{\n      entity_id?: { ... }\n    }>\n  }\n  type: "reimbursement"\n  paid_date?: string // date-time\n}\n```\n\n### `BillingEvent`\n\nAn entity that describes a billing event such as a future installment or a reimbursement back to the customer.\n\n```ts\ntype BillingEvent = {\n  billing_amount: number\n  billing_amount_decimal: string\n  billing_currency: string\n  external_id?: string\n  contract: {\n    $relation?: Array<{\n      entity_id?: { ... }\n    }>\n  }\n  type: "installment"\n  due_date: string // date-time\n  paid_date?: string // date-time\n} | {\n  billing_amount: number\n  billing_amount_decimal: string\n  billing_currency: string\n  external_id?: string\n  contract: {\n    $relation?: Array<{\n      entity_id?: { ... }\n    }>\n  }\n  type: "reimbursement"\n  paid_date?: string // date-time\n}\n```\n\n### `Contract`\n\n```ts\ntype Contract = {\n  _id?: string\n  _title?: string\n  _org?: string\n  _schema?: "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n  _tags?: string[]\n  _created_at?: string\n  _updated_at?: string\n  contract_name?: string\n  contract_number?: string\n  status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired"\n  description?: string\n  account_number?: string\n  branch?: "power" | "gas" | "water" | "waste_water" | "district_heating"\n  billing_address?: string\n  delivery_address?: string\n  additional_addresses?: string\n  termination_date?: string\n  termination_reason?: string\n  billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly"\n  billing_duration_amount?: number\n  renewal_duration_amount?: number\n  renewal_duration_unit?: "weeks" | "months" | "years"\n  notice_time_amount?: number\n  notice_time_unit?: "weeks" | "months" | "years"\n  start_date?: string\n  billing_due_day?: number\n  installment_amount?: number\n  balance?: number\n  balance_currency?: string\n}\n```\n\n### `ContractItem`\n\n```ts\ntype ContractItem = {\n  _id?: string\n  _title?: string\n  _org?: string\n  _schema?: "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event"\n  _tags?: string[]\n  _created_at?: string\n  _updated_at?: string\n  contract_name?: string\n  contract_number?: string\n  status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired"\n  description?: string\n  account_number?: string\n  branch?: "power" | "gas" | "water" | "waste_water" | "district_heating"\n  billing_address?: string\n  delivery_address?: string\n  additional_addresses?: string\n  termination_date?: string\n  termination_reason?: string\n  billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly"\n  billing_duration_amount?: number\n  renewal_duration_amount?: number\n  renewal_duration_unit?: "weeks" | "months" | "years"\n  notice_time_amount?: number\n  notice_time_unit?: "weeks" | "months" | "years"\n  start_date?: string\n  billing_due_day?: number\n  installment_amount?: number\n  balance?: number\n  balance_currency?: string\n}\n```\n\n### `Balance`\n\n```ts\ntype Balance = {\n  balance?: number\n  balance_decimal?: string\n  balance_currency?: string\n}\n```\n\n### `Currency`\n\nCurrency code in ISO 4217 format\n\n```ts\ntype Currency = string\n```\n';
-export {
-  billing_default as default
-};