@epilot/sdk 2.18.18 → 2.18.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/billing-runtime.json +1 -1
- package/definitions/billing.json +195 -19
- package/definitions/calendar.json +18 -4
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +8 -8
- package/dist/apis/billing.d.cts +2 -2
- package/dist/apis/billing.d.ts +2 -2
- package/dist/apis/billing.js +2 -2
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.d.cts +2 -2
- package/dist/apis/calendar.d.ts +2 -2
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/billing-MN36KAKQ.cjs +7 -0
- package/dist/billing-UAVEPNBZ.js +7 -0
- package/dist/{billing-runtime-3OCFZU2K.js → billing-runtime-OSGDEA63.js} +1 -1
- package/dist/{billing-runtime-PKKLWPQY.cjs → billing-runtime-YZEHKRAZ.cjs} +2 -2
- package/dist/{billing.d-N_1F759g.d.cts → billing.d-Blv16_el.d.cts} +205 -34
- package/dist/{billing.d-N_1F759g.d.ts → billing.d-Blv16_el.d.ts} +205 -34
- package/dist/calendar-2H4RGMV3.js +7 -0
- package/dist/calendar-UADWQX7G.cjs +7 -0
- package/dist/{calendar.d-Cz8R-GJ5.d.cts → calendar.d-mk-ltGpk.d.cts} +10 -5
- package/dist/{calendar.d-Cz8R-GJ5.d.ts → calendar.d-mk-ltGpk.d.ts} +10 -5
- package/dist/{chunk-U5XZ4ERL.js → chunk-5SAISAQY.js} +1 -1
- package/dist/{chunk-WCF2QVZE.js → chunk-JH7NETLC.js} +3 -3
- package/dist/{chunk-4XOJVIUQ.cjs → chunk-PNVSKDMV.cjs} +1 -1
- package/dist/{chunk-GZMYWGJR.cjs → chunk-YGOX7IZC.cjs} +3 -3
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/billing.md +553 -171
- package/docs/calendar.md +8 -2
- package/package.json +1 -1
- package/dist/billing-C45UEPBV.cjs +0 -7
- package/dist/billing-IV5ABNW4.js +0 -7
- package/dist/calendar-EMNHW6ME.cjs +0 -7
- package/dist/calendar-PZFEAXYE.js +0 -7
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/billing.json
|
|
4
|
+
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**Pricing Information**\n- [`getContractPricingInformation`](#getcontractpricinginformation)\n- [`getBillingAccountPricingInformation`](#getbillingaccountpricinginformation)\n\n**Configuration History**\n- [`getContractConfigurationHistory`](#getcontractconfigurationhistory)\n- [`getBillingAccountConfigurationHistory`](#getbillingaccountconfigurationhistory)\n\n**Balance**\n- [`getCustomerBalance`](#getcustomerbalance)\n\n**Schemas**\n- [`Error`](#error)\n- [`BaseEntity`](#baseentity)\n- [`EntityId`](#entityid)\n- [`EntitySlug`](#entityslug)\n- [`EntityRelationItem`](#entityrelationitem)\n- [`BaseBillingEvent`](#basebillingevent)\n- [`BillingEvent`](#billingevent)\n- [`BillingEventUpdate`](#billingeventupdate)\n- [`InstallmentEvent`](#installmentevent)\n- [`PaymentEvent`](#paymentevent)\n- [`ReimbursementEvent`](#reimbursementevent)\n- [`DunningFeeEvent`](#dunningfeeevent)\n- [`InvoiceEvent`](#invoiceevent)\n- [`FinalBillEvent`](#finalbillevent)\n- [`BonusEvent`](#bonusevent)\n- [`CorrectionEvent`](#correctionevent)\n- [`CustomEvent`](#customevent)\n- [`Contract`](#contract)\n- [`ContractItem`](#contractitem)\n- [`InstallmentAmountValue`](#installmentamountvalue)\n- [`PriceContext`](#pricecontext)\n- [`DynamicTariffPriceContext`](#dynamictariffpricecontext)\n- [`ConfigurationHistoryContext`](#configurationhistorycontext)\n- [`ContractTariffContext`](#contracttariffcontext)\n- [`ContractPricingContext`](#contractpricingcontext)\n- [`ConfigurationHistoryRowBase`](#configurationhistoryrowbase)\n- [`InstallmentAmountChangedHistoryRow`](#installmentamountchangedhistoryrow)\n- [`ContractPricingChangedHistoryRow`](#contractpricingchangedhistoryrow)\n- [`ConfigurationHistoryRow`](#configurationhistoryrow)\n- [`ConfigurationHistoryResponse`](#configurationhistoryresponse)\n- [`PricingInformationBalance`](#pricinginformationbalance)\n- [`ContractPricingSchedule`](#contractpricingschedule)\n- [`ContractPricingInformation`](#contractpricinginformation)\n- [`BillingAccountPricingInformation`](#billingaccountpricinginformation)\n- [`Balance`](#balance)\n- [`Currency`](#currency)\n\n### `getBillingEvents`\n\nRetrieve and filter billing events (Buchungss\xE4tze) such as installments (Abschlagszahlungen),\npayments (Zahlungseing\xE4nge), and reimbursements (R\xFCckerstattungen).\n\n`GET /v1/billing/events`\n\n```ts\nconst { data } = await client.getBillingEvents({\n from: 1,\n size: 1,\n entity_id: [\'...\'],\n contact_id: \'example\',\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": 42,\n "results": [\n {\n "type": "installment",\n "direction": "debit",\n "note": "July power & gas installment payment",\n "status": "open",\n "booking_date": "2025-07-10",\n "due_date": "2025-07-10",\n "billing_amount": 5000,\n "billing_amount_decimal": "50.00",\n "billing_currency": "EUR"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createBillingEvent`\n\nCreate a new billing event (Buchungssatz) such as an installment (Abschlagszahlung),\npayment (Zahlungseingang), or reimbursement (R\xFCckerstattung).\n\n`POST /v1/billing/events`\n\n```ts\nconst { data } = await client.createBillingEvent(\n null,\n {\n type: \'installment\',\n direction: \'debit\',\n note: \'July power & gas installment payment\',\n status: \'open\',\n booking_date: \'2025-07-10\',\n due_date: \'2025-07-10\',\n billing_amount: 5000,\n billing_amount_decimal: \'50.00\',\n billing_currency: \'EUR\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "type": "installment",\n "direction": "debit",\n "note": "July power & gas installment payment",\n "status": "open",\n "booking_date": "2025-07-10",\n "due_date": "2025-07-10",\n "billing_amount": 5000,\n "billing_amount_decimal": "50.00",\n "billing_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `getBillingEvent`\n\nRetrieve a single billing event (Buchungssatz) by its unique 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 "type": "installment",\n "direction": "debit",\n "note": "July power & gas installment payment",\n "status": "open",\n "booking_date": "2025-07-10",\n "due_date": "2025-07-10",\n "billing_amount": 5000,\n "billing_amount_decimal": "50.00",\n "billing_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `updateBillingEvent`\n\nUpdate an existing billing event (Buchungssatz).\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 type: \'installment\',\n direction: \'debit\',\n billing_amount: 10000,\n billing_amount_decimal: \'100.00\',\n billing_currency: \'EUR\',\n external_id: \'SAP-54321\',\n contract: {\n $relation: [\n {\n entity_id: \'f589786b-3024-43cd-9cb3-5a3c953f2896\'\n }\n ]\n },\n booking_date: \'2025-06-15\',\n due_date: \'2025-06-30\',\n paid_date: \'2025-06-15T10:00:00Z\',\n status: \'closed\',\n related_event: \'d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e\',\n external_link: {\n href: \'https://billing.example.com/invoices/12345\',\n title: \'Invoice 12345\'\n },\n attachments: {\n $relation: [\n {\n entity_id: \'f589786b-3024-43cd-9cb3-5a3c953f2896\'\n }\n ]\n },\n note: \'Teilzahlung f\xFCr Abschlag Juni\',\n internal_note: \'R\xFCckmeldung von SAP: Betrag aus Zahlungsavis 2025-06-14 \xFCbernommen\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "type": "installment",\n "direction": "debit",\n "note": "July power & gas installment payment",\n "status": "open",\n "booking_date": "2025-07-10",\n "due_date": "2025-07-10",\n "billing_amount": 5000,\n "billing_amount_decimal": "50.00",\n "billing_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `deleteBillingEvent`\n\nDelete an existing billing event (Buchungssatz).\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\nRetrieve a billing event (Buchungssatz) by its external system identifier.\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 "type": "installment",\n "direction": "debit",\n "note": "July power & gas installment payment",\n "status": "open",\n "booking_date": "2025-07-10",\n "due_date": "2025-07-10",\n "billing_amount": 5000,\n "billing_amount_decimal": "50.00",\n "billing_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `createContractEntity`\n\nCreate a new contract entity (Vertrag) for billing purposes.\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: \'Abschlagszahlung Juli 2025\',\n _org: \'123456\',\n _schema: \'billing_event\',\n _tags: [\'billing\', \'energy\'],\n _created_at: \'2025-06-15T10:30:00Z\',\n _updated_at: \'2025-06-15T14:45:00Z\',\n contract_name: \'Stromvertrag Haushalt\',\n contract_number: \'STR-2025-001234\',\n status: \'active\',\n description: \'Haushaltsstrom-Tarif mit 24 Monaten Preisgarantie\',\n account_number: \'KD-67890\',\n branch: \'power\',\n billing_address: \'Musterstra\xDFe 123, 50667 K\xF6ln\',\n delivery_address: \'Musterstra\xDFe 123, 50667 K\xF6ln\',\n additional_addresses: \'Postfach 456, 50668 K\xF6ln\',\n termination_date: \'2025-12-31\',\n termination_reason: \'Kundenk\xFCndigung\',\n billing_period: \'monthly\',\n billing_duration_amount: 30,\n renewal_duration_amount: 12,\n renewal_duration_unit: \'months\',\n notice_time_amount: 30,\n notice_time_unit: \'months\',\n start_date: \'2025-01-01\',\n billing_due_day: 15,\n installment_amount: 8500,\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": "Abschlagszahlung Juli 2025",\n "_org": "123456",\n "_schema": "billing_event",\n "_tags": ["billing", "energy"],\n "_created_at": "2025-06-15T10:30:00Z",\n "_updated_at": "2025-06-15T14:45:00Z",\n "contract_name": "Stromvertrag Haushalt",\n "contract_number": "STR-2025-001234",\n "status": "active",\n "description": "Haushaltsstrom-Tarif mit 24 Monaten Preisgarantie",\n "account_number": "KD-67890",\n "branch": "power",\n "billing_address": "Musterstra\xDFe 123, 50667 K\xF6ln",\n "delivery_address": "Musterstra\xDFe 123, 50667 K\xF6ln",\n "additional_addresses": "Postfach 456, 50668 K\xF6ln",\n "termination_date": "2025-12-31",\n "termination_reason": "Kundenk\xFCndigung",\n "billing_period": "monthly",\n "billing_duration_amount": 30,\n "renewal_duration_amount": 12,\n "renewal_duration_unit": "months",\n "notice_time_amount": 30,\n "notice_time_unit": "months",\n "start_date": "2025-01-01",\n "billing_due_day": 15,\n "installment_amount": 8500,\n "balance": 8990,\n "balance_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `updateContractEntity`\n\nUpdate an existing contract entity (Vertrag).\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: \'Abschlagszahlung Juli 2025\',\n _org: \'123456\',\n _schema: \'billing_event\',\n _tags: [\'billing\', \'energy\'],\n _created_at: \'2025-06-15T10:30:00Z\',\n _updated_at: \'2025-06-15T14:45:00Z\',\n contract_name: \'Stromvertrag Haushalt\',\n contract_number: \'STR-2025-001234\',\n status: \'active\',\n description: \'Haushaltsstrom-Tarif mit 24 Monaten Preisgarantie\',\n account_number: \'KD-67890\',\n branch: \'power\',\n billing_address: \'Musterstra\xDFe 123, 50667 K\xF6ln\',\n delivery_address: \'Musterstra\xDFe 123, 50667 K\xF6ln\',\n additional_addresses: \'Postfach 456, 50668 K\xF6ln\',\n termination_date: \'2025-12-31\',\n termination_reason: \'Kundenk\xFCndigung\',\n billing_period: \'monthly\',\n billing_duration_amount: 30,\n renewal_duration_amount: 12,\n renewal_duration_unit: \'months\',\n notice_time_amount: 30,\n notice_time_unit: \'months\',\n start_date: \'2025-01-01\',\n billing_due_day: 15,\n installment_amount: 8500,\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": "Abschlagszahlung Juli 2025",\n "_org": "123456",\n "_schema": "billing_event",\n "_tags": ["billing", "energy"],\n "_created_at": "2025-06-15T10:30:00Z",\n "_updated_at": "2025-06-15T14:45:00Z",\n "contract_name": "Stromvertrag Haushalt",\n "contract_number": "STR-2025-001234",\n "status": "active",\n "description": "Haushaltsstrom-Tarif mit 24 Monaten Preisgarantie",\n "account_number": "KD-67890",\n "branch": "power",\n "billing_address": "Musterstra\xDFe 123, 50667 K\xF6ln",\n "delivery_address": "Musterstra\xDFe 123, 50667 K\xF6ln",\n "additional_addresses": "Postfach 456, 50668 K\xF6ln",\n "termination_date": "2025-12-31",\n "termination_reason": "Kundenk\xFCndigung",\n "billing_period": "monthly",\n "billing_duration_amount": 30,\n "renewal_duration_amount": 12,\n "renewal_duration_unit": "months",\n "notice_time_amount": 30,\n "notice_time_unit": "months",\n "start_date": "2025-01-01",\n "billing_due_day": 15,\n "installment_amount": 8500,\n "balance": 8990,\n "balance_currency": "EUR"\n}\n```\n\n</details>\n\n---\n\n### `deleteContractEntity`\n\nDelete an existing contract entity (Vertrag).\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### `getContractPricingInformation`\n\nGet current pricing information and recent configuration history for a Contract.\n\n`GET /v1/billing/contracts/{id}/pricing_information`\n\n```ts\nconst { data } = await client.getContractPricingInformation({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n history_change_types: \'example\',\n include_history: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_type": "contract",\n "entity_id": "string",\n "title": "string",\n "current_installment_amount": {\n "amount": 10050,\n "amount_decimal": "100.50",\n "currency": "EUR"\n },\n "context": {\n "base_price": {\n "price_id": "string",\n "price_title": "string",\n "tariff_type": "string",\n "pricing_model": "string",\n "unit_amount_gross_decimal": "string",\n "unit_amount_net_decimal": "string",\n "before_discount_unit_amount_gross_decimal": "string",\n "before_discount_unit_amount_net_decimal": "string",\n "unit_discount_amount_decimal": "string",\n "unit_discount_amount_net_decimal": "string",\n "currency": "EUR",\n "billing_period": "string",\n "unit": "string",\n "has_discount": true,\n "is_dynamic_tariff": true,\n "dynamic_tariff": {}\n },\n "base_prices": [\n {}\n ],\n "working_price": {\n "price_id": "string",\n "price_title": "string",\n "tariff_type": "string",\n "pricing_model": "string",\n "unit_amount_gross_decimal": "string",\n "unit_amount_net_decimal": "string",\n "before_discount_unit_amount_gross_decimal": "string",\n "before_discount_unit_amount_net_decimal": "string",\n "unit_discount_amount_decimal": "string",\n "unit_discount_amount_net_decimal": "string",\n "currency": "EUR",\n "billing_period": "string",\n "unit": "string",\n "has_discount": true,\n "is_dynamic_tariff": true,\n "dynamic_tariff": {}\n },\n "working_prices": [\n {}\n ]\n },\n "balance": {\n "amount": 8990,\n "amount_decimal": "89.90",\n "currency": "EUR"\n },\n "schedule": {\n "billing_due_day": 0,\n "billing_period": "weekly",\n "installments_per_year": 0,\n "inferred": true\n },\n "pending_installment_change": true,\n "history": [\n {\n "event_id": "string",\n "org_id": "string",\n "entity_type": "contract",\n "entity_id": "string",\n "schema_version": 1,\n "effective_at": "1970-01-01T00:00:00.000Z",\n "changed_at": "1970-01-01T00:00:00.000Z",\n "created_at": "1970-01-01T00:00:00.000Z",\n "source": "portal",\n "source_label": "string",\n "source_system": "string",\n "source_reference": "string",\n "change_type": "installment_amount_changed",\n "previous_value": {},\n "new_value": {},\n "context": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getBillingAccountPricingInformation`\n\nGet current pricing information for the active Contracts linked to a Billing Account.\n\n`GET /v1/billing/billing_accounts/{id}/pricing_information`\n\n```ts\nconst { data } = await client.getBillingAccountPricingInformation({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n history_change_types: \'example\',\n include_history: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_type": "billing_account",\n "entity_id": "string",\n "title": "string",\n "balance": {\n "amount": 8990,\n "amount_decimal": "89.90",\n "currency": "EUR"\n },\n "contracts": [\n {\n "entity_type": "contract",\n "entity_id": "string",\n "title": "string",\n "current_installment_amount": {},\n "context": {},\n "balance": {},\n "schedule": {},\n "pending_installment_change": true,\n "history": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getContractConfigurationHistory`\n\nGet billing configuration history for a Contract.\n\n`GET /v1/billing/contracts/{id}/configuration_history`\n\n```ts\nconst { data } = await client.getContractConfigurationHistory({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n change_type: \'example\',\n history_change_types: \'example\',\n from: 1,\n size: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "history": [\n {\n "event_id": "string",\n "org_id": "string",\n "entity_type": "contract",\n "entity_id": "string",\n "schema_version": 1,\n "effective_at": "1970-01-01T00:00:00.000Z",\n "changed_at": "1970-01-01T00:00:00.000Z",\n "created_at": "1970-01-01T00:00:00.000Z",\n "source": "portal",\n "source_label": "string",\n "source_system": "string",\n "source_reference": "string",\n "change_type": "installment_amount_changed",\n "previous_value": {},\n "new_value": {},\n "context": {}\n }\n ],\n "total": 0\n}\n```\n\n</details>\n\n---\n\n### `getBillingAccountConfigurationHistory`\n\nGet merged billing configuration history for active Contracts linked to a Billing Account.\n\n`GET /v1/billing/billing_accounts/{id}/configuration_history`\n\n```ts\nconst { data } = await client.getBillingAccountConfigurationHistory({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n change_type: \'example\',\n history_change_types: \'example\',\n from: 1,\n size: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "history": [\n {\n "event_id": "string",\n "org_id": "string",\n "entity_type": "contract",\n "entity_id": "string",\n "schema_version": 1,\n "effective_at": "1970-01-01T00:00:00.000Z",\n "changed_at": "1970-01-01T00:00:00.000Z",\n "created_at": "1970-01-01T00:00:00.000Z",\n "source": "portal",\n "source_label": "string",\n "source_system": "string",\n "source_reference": "string",\n "change_type": "installment_amount_changed",\n "previous_value": {},\n "new_value": {},\n "context": {}\n }\n ],\n "total": 0\n}\n```\n\n</details>\n\n---\n\n### `getCustomerBalance`\n\nRetrieve the total balance (Kontostand) across all contracts and orders for a customer.\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### `Error`\n\nStandard error response format\n\n```ts\ntype Error = {\n error: string\n message: string\n}\n```\n\n### `BaseEntity`\n\nBase schema for all epilot entities with common system fields\n\n```ts\ntype BaseEntity = {\n _id?: string\n _title?: string\n _org?: string\n _schema?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n}\n```\n\n### `EntityId`\n\nUnique entity identifier (UUID format)\n\n```ts\ntype EntityId = string\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema (Schema-Slug)\n\n```ts\ntype EntitySlug = string\n```\n\n### `EntityRelationItem`\n\nReference to a related entity\n\n```ts\ntype EntityRelationItem = {\n entity_id?: string\n}\n```\n\n### `BaseBillingEvent`\n\nRepresents a single financial transaction entry (Buchungssatz) in the billing ledger.\nEach entry is either a debit or a credit, following double-entry accounting principles.\nCommon types include Abschlagszahlung (installment), Zahlungseingang (payment), R\xFCckerstattung (reimbursement), etc.\n\n\n```ts\ntype BaseBillingEvent = {\n _id?: string\n _title?: string\n _org?: string\n _schema?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n type: string\n direction?: "debit" | "credit"\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 booking_date: string // date\n due_date?: string // date\n paid_date?: string // date-time\n status?: "closed" | "open"\n related_event?: string\n external_link?: {\n href?: string // uri\n title?: string\n }\n attachments?: {\n $relation?: Array<{\n entity_id?: { ... }\n }>\n }\n note?: string\n internal_note?: string\n}\n```\n\n### `BillingEvent`\n\nCollection of supported billing event types (Buchungsarten).\nEach type represents a different kind of financial transaction\nthat affects the customer\'s balance.\n\n\n```ts\ntype BillingEvent = {\n type?: "installment"\n} | {\n type?: "payment"\n} | {\n type?: "reimbursement"\n} | {\n type?: "dunning_fee"\n} | {\n type?: "invoice"\n} | {\n type?: "final_bill"\n} | {\n type?: "bonus"\n} | {\n type?: "correction"\n} | {\n type?: string\n}\n```\n\n### `BillingEventUpdate`\n\nFields to update on an existing billing event.\n\n```ts\ntype BillingEventUpdate = {\n type?: string\n direction?: "debit" | "credit"\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 booking_date?: string // date\n due_date?: string // date\n paid_date?: string // date-time\n status?: "closed" | "open"\n related_event?: string\n external_link?: {\n href?: string // uri\n title?: string\n }\n attachments?: {\n $relation?: Array<{\n entity_id?: { ... }\n }>\n }\n note?: string\n internal_note?: string\n}\n```\n\n### `InstallmentEvent`\n\nInstallment billing event (Abschlagszahlung).\nRepresents a scheduled partial payment that the customer owes,\ntypically billed monthly for utilities like electricity or gas.\n\n\n```ts\ntype InstallmentEvent = {\n type?: "installment"\n}\n```\n\n### `PaymentEvent`\n\nPayment received event (Zahlungseingang).\nRepresents money received from the customer, reducing their balance.\nThis is a credit transaction.\n\n\n```ts\ntype PaymentEvent = {\n type?: "payment"\n}\n```\n\n### `ReimbursementEvent`\n\nReimbursement event (R\xFCckerstattung).\nRepresents a refund to the customer, typically after overpayment\nor billing correction. This is a credit transaction.\n\n\n```ts\ntype ReimbursementEvent = {\n type?: "reimbursement"\n}\n```\n\n### `DunningFeeEvent`\n\nDunning fee event (Mahngeb\xFChr).\nRepresents a late payment fee charged to the customer\nafter a payment reminder has been sent. This is a debit transaction.\n\n\n```ts\ntype DunningFeeEvent = {\n type?: "dunning_fee"\n}\n```\n\n### `InvoiceEvent`\n\n```ts\ntype InvoiceEvent = {\n type?: "invoice"\n}\n```\n\n### `FinalBillEvent`\n\nFinal bill event (Endabrechnung/Schlussrechnung).\nRepresents the final settlement when a contract ends,\naccounting for actual consumption vs. paid installments.\nCan be either debit (customer owes more) or credit (customer overpaid).\n\n\n```ts\ntype FinalBillEvent = {\n type?: "final_bill"\n}\n```\n\n### `BonusEvent`\n\nBonus/credit event (Gutschrift/Bonus).\nRepresents a promotional credit or bonus applied to the customer\'s account,\nsuch as welcome bonuses or loyalty rewards. This is a credit transaction.\n\n\n```ts\ntype BonusEvent = {\n type?: "bonus"\n}\n```\n\n### `CorrectionEvent`\n\nCorrection event (Korrekturbuchung).\nRepresents an adjustment to a previous billing entry,\nsuch as correcting an overcharge or undercharge.\nCan be either debit or credit depending on the correction.\n\n\n```ts\ntype CorrectionEvent = {\n type?: "correction"\n}\n```\n\n### `CustomEvent`\n\nCustom billing event (Benutzerdefinierte Buchung).\nAllows for organization-specific billing event types not covered\nby the standard types. Use a descriptive type name.\n\n\n```ts\ntype CustomEvent = {\n type?: string\n}\n```\n\n### `Contract`\n\nRepresents a customer contract (Vertrag) for billing purposes.\nContracts are the parent entities for billing events and contain\nbilling configuration such as installment amounts and billing cycles.\n\n\n```ts\ntype Contract = {\n _id?: string\n _title?: string\n _org?: string\n _schema?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\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 // date\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 // date\n billing_due_day?: number\n installment_amount?: number\n balance?: number\n balance_currency?: string\n}\n```\n\n### `ContractItem`\n\nContract entity with all required system fields populated\n\n```ts\ntype ContractItem = {\n _id?: string\n _title?: string\n _org?: string\n _schema?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\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 // date\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 // date\n billing_due_day?: number\n installment_amount?: number\n balance?: number\n balance_currency?: string\n}\n```\n\n### `InstallmentAmountValue`\n\n```ts\ntype InstallmentAmountValue = {\n amount?: number\n amount_decimal?: string\n currency?: string\n}\n```\n\n### `PriceContext`\n\n```ts\ntype PriceContext = {\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n unit_discount_amount_decimal?: string\n unit_discount_amount_net_decimal?: string\n currency?: string\n billing_period?: string\n unit?: string\n has_discount?: boolean\n is_dynamic_tariff?: boolean\n dynamic_tariff?: {\n mode?: string\n interval?: string\n average_price_decimal?: string\n markup_amount_decimal?: string\n markup_amount_net_decimal?: string\n markup_amount_gross_decimal?: string\n market_price_decimal?: string\n market_price_currency?: string\n market?: string\n bidding_zone?: string\n timestamp?: string\n }\n}\n```\n\n### `DynamicTariffPriceContext`\n\n```ts\ntype DynamicTariffPriceContext = {\n mode?: string\n interval?: string\n average_price_decimal?: string\n markup_amount_decimal?: string\n markup_amount_net_decimal?: string\n markup_amount_gross_decimal?: string\n market_price_decimal?: string\n market_price_currency?: string\n market?: string\n bidding_zone?: string\n timestamp?: string\n}\n```\n\n### `ConfigurationHistoryContext`\n\n```ts\ntype ConfigurationHistoryContext = {\n base_price?: {\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n unit_discount_amount_decimal?: string\n unit_discount_amount_net_decimal?: string\n currency?: string\n billing_period?: string\n unit?: string\n has_discount?: boolean\n is_dynamic_tariff?: boolean\n dynamic_tariff?: {\n mode?: { ... }\n interval?: { ... }\n average_price_decimal?: { ... }\n markup_amount_decimal?: { ... }\n markup_amount_net_decimal?: { ... }\n markup_amount_gross_decimal?: { ... }\n market_price_decimal?: { ... }\n market_price_currency?: { ... }\n market?: { ... }\n bidding_zone?: { ... }\n timestamp?: { ... }\n }\n }\n base_prices?: Array<{\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n unit_discount_amount_decimal?: string\n unit_discount_amount_net_decimal?: string\n currency?: string\n billing_period?: string\n unit?: string\n has_discount?: boolean\n is_dynamic_tariff?: boolean\n dynamic_tariff?: {\n mode?: { ... }\n interval?: { ... }\n average_price_decimal?: { ... }\n markup_amount_decimal?: { ... }\n markup_amount_net_decimal?: { ... }\n markup_amount_gross_decimal?: { ... }\n market_price_decimal?: { ... }\n market_price_currency?: { ... }\n market?: { ... }\n bidding_zone?: { ... }\n timestamp?: { ... }\n }\n }>\n working_price?: {\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n unit_discount_amount_decimal?: string\n unit_discount_amount_net_decimal?: string\n currency?: string\n billing_period?: string\n unit?: string\n has_discount?: boolean\n is_dynamic_tariff?: boolean\n dynamic_tariff?: {\n mode?: { ... }\n interval?: { ... }\n average_price_decimal?: { ... }\n markup_amount_decimal?: { ... }\n markup_amount_net_decimal?: { ... }\n markup_amount_gross_decimal?: { ... }\n market_price_decimal?: { ... }\n market_price_currency?: { ... }\n market?: { ... }\n bidding_zone?: { ... }\n timestamp?: { ... }\n }\n }\n working_prices?: Array<{\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n // ...\n}\n```\n\n### `ContractTariffContext`\n\n```ts\ntype ContractTariffContext = {\n product_id?: string\n product_title?: string\n}\n```\n\n### `ContractPricingContext`\n\n```ts\ntype ContractPricingContext = {\n base_price?: {\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n unit_discount_amount_decimal?: string\n unit_discount_amount_net_decimal?: string\n currency?: string\n billing_period?: string\n unit?: string\n has_discount?: boolean\n is_dynamic_tariff?: boolean\n dynamic_tariff?: {\n mode?: { ... }\n interval?: { ... }\n average_price_decimal?: { ... }\n markup_amount_decimal?: { ... }\n markup_amount_net_decimal?: { ... }\n markup_amount_gross_decimal?: { ... }\n market_price_decimal?: { ... }\n market_price_currency?: { ... }\n market?: { ... }\n bidding_zone?: { ... }\n timestamp?: { ... }\n }\n }\n base_prices?: Array<{\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n unit_discount_amount_decimal?: string\n unit_discount_amount_net_decimal?: string\n currency?: string\n billing_period?: string\n unit?: string\n has_discount?: boolean\n is_dynamic_tariff?: boolean\n dynamic_tariff?: {\n mode?: { ... }\n interval?: { ... }\n average_price_decimal?: { ... }\n markup_amount_decimal?: { ... }\n markup_amount_net_decimal?: { ... }\n markup_amount_gross_decimal?: { ... }\n market_price_decimal?: { ... }\n market_price_currency?: { ... }\n market?: { ... }\n bidding_zone?: { ... }\n timestamp?: { ... }\n }\n }>\n working_price?: {\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n unit_discount_amount_decimal?: string\n unit_discount_amount_net_decimal?: string\n currency?: string\n billing_period?: string\n unit?: string\n has_discount?: boolean\n is_dynamic_tariff?: boolean\n dynamic_tariff?: {\n mode?: { ... }\n interval?: { ... }\n average_price_decimal?: { ... }\n markup_amount_decimal?: { ... }\n markup_amount_net_decimal?: { ... }\n markup_amount_gross_decimal?: { ... }\n market_price_decimal?: { ... }\n market_price_currency?: { ... }\n market?: { ... }\n bidding_zone?: { ... }\n timestamp?: { ... }\n }\n }\n working_prices?: Array<{\n price_id?: string\n price_title?: string\n tariff_type?: string\n pricing_model?: string\n unit_amount_gross_decimal?: string\n unit_amount_net_decimal?: string\n before_discount_unit_amount_gross_decimal?: string\n before_discount_unit_amount_net_decimal?: string\n // ...\n}\n```\n\n### `ConfigurationHistoryRowBase`\n\n```ts\ntype ConfigurationHistoryRowBase = {\n event_id: string\n org_id: string\n entity_type: "contract" | "billing_account"\n entity_id: string\n schema_version: number\n effective_at?: string // date-time\n changed_at: string // date-time\n created_at: string // date-time\n source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown"\n source_label?: string\n source_system?: string\n source_reference?: string\n}\n```\n\n### `InstallmentAmountChangedHistoryRow`\n\n```ts\ntype InstallmentAmountChangedHistoryRow = {\n event_id: string\n org_id: string\n entity_type: "contract" | "billing_account"\n entity_id: string\n schema_version: number\n effective_at?: string // date-time\n changed_at: string // date-time\n created_at: string // date-time\n source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown"\n source_label?: string\n source_system?: string\n source_reference?: string\n change_type: "installment_amount_changed"\n previous_value?: {\n amount?: number\n amount_decimal?: string\n currency?: string\n }\n new_value: {\n amount?: number\n amount_decimal?: string\n currency?: string\n }\n context?: {\n base_price?: {\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }\n base_prices?: Array<{\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }>\n working_price?: {\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }\n working_prices?: Array<{\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }>\n }\n}\n```\n\n### `ContractPricingChangedHistoryRow`\n\n```ts\ntype ContractPricingChangedHistoryRow = {\n event_id: string\n org_id: string\n entity_type: "contract" | "billing_account"\n entity_id: string\n schema_version: number\n effective_at?: string // date-time\n changed_at: string // date-time\n created_at: string // date-time\n source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown"\n source_label?: string\n source_system?: string\n source_reference?: string\n change_type: "contract_pricing_changed"\n previous_context: {\n base_price?: {\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }\n base_prices?: Array<{\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }>\n working_price?: {\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }\n working_prices?: Array<{\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }>\n tariff?: {\n product_id?: { ... }\n product_title?: { ... }\n }\n tariffs?: Array<{\n product_id?: { ... }\n product_title?: { ... }\n }>\n }\n new_context: {\n base_price?: {\n price_id?: { ... }\n price_title?: { ... }\n // ...\n}\n```\n\n### `ConfigurationHistoryRow`\n\n```ts\ntype ConfigurationHistoryRow = {\n event_id: string\n org_id: string\n entity_type: "contract" | "billing_account"\n entity_id: string\n schema_version: number\n effective_at?: string // date-time\n changed_at: string // date-time\n created_at: string // date-time\n source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown"\n source_label?: string\n source_system?: string\n source_reference?: string\n change_type: "installment_amount_changed"\n previous_value?: {\n amount?: number\n amount_decimal?: string\n currency?: string\n }\n new_value: {\n amount?: number\n amount_decimal?: string\n currency?: string\n }\n context?: {\n base_price?: {\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }\n base_prices?: Array<{\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }>\n working_price?: {\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }\n working_prices?: Array<{\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }>\n }\n} | {\n event_id: string\n // ...\n}\n```\n\n### `ConfigurationHistoryResponse`\n\n```ts\ntype ConfigurationHistoryResponse = {\n history: Array<{\n event_id: string\n org_id: string\n entity_type: "contract" | "billing_account"\n entity_id: string\n schema_version: number\n effective_at?: string // date-time\n changed_at: string // date-time\n created_at: string // date-time\n source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown"\n source_label?: string\n source_system?: string\n source_reference?: string\n change_type: "installment_amount_changed"\n previous_value?: {\n amount?: { ... }\n amount_decimal?: { ... }\n currency?: { ... }\n }\n new_value: {\n amount?: { ... }\n amount_decimal?: { ... }\n currency?: { ... }\n }\n context?: {\n base_price?: { ... }\n base_prices?: { ... }\n working_price?: { ... }\n working_prices?: { ... }\n }\n } | {\n event_id: string\n org_id: string\n entity_type: "contract" | "billing_account"\n entity_id: string\n schema_version: number\n effective_at?: string // date-time\n changed_at: string // date-time\n created_at: string // date-time\n source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown"\n source_label?: string\n source_system?: string\n source_reference?: string\n change_type: "contract_pricing_changed"\n previous_context: {\n base_price?: { ... }\n base_prices?: { ... }\n working_price?: { ... }\n working_prices?: { ... }\n tariff?: { ... }\n tariffs?: { ... }\n }\n new_context: {\n base_price?: { ... }\n base_prices?: { ... }\n working_price?: { ... }\n working_prices?: { ... }\n tariff?: { ... }\n tariffs?: { ... }\n }\n changed_fields: "tariff" | "base_price" | "working_price" | "discount" | "dynamic_tariff_configuration"[]\n }>\n total: number\n}\n```\n\n### `PricingInformationBalance`\n\n```ts\ntype PricingInformationBalance = {\n amount?: number\n amount_decimal?: string\n currency?: string\n}\n```\n\n### `ContractPricingSchedule`\n\n```ts\ntype ContractPricingSchedule = {\n billing_due_day?: number\n billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly"\n installments_per_year?: number\n inferred: boolean\n}\n```\n\n### `ContractPricingInformation`\n\n```ts\ntype ContractPricingInformation = {\n entity_type: "contract"\n entity_id: string\n title?: string\n current_installment_amount?: {\n amount?: number\n amount_decimal?: string\n currency?: string\n }\n context?: {\n base_price?: {\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }\n base_prices?: Array<{\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }>\n working_price?: {\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }\n working_prices?: Array<{\n price_id?: { ... }\n price_title?: { ... }\n tariff_type?: { ... }\n pricing_model?: { ... }\n unit_amount_gross_decimal?: { ... }\n unit_amount_net_decimal?: { ... }\n before_discount_unit_amount_gross_decimal?: { ... }\n before_discount_unit_amount_net_decimal?: { ... }\n unit_discount_amount_decimal?: { ... }\n unit_discount_amount_net_decimal?: { ... }\n currency?: { ... }\n billing_period?: { ... }\n unit?: { ... }\n has_discount?: { ... }\n is_dynamic_tariff?: { ... }\n dynamic_tariff?: { ... }\n }>\n }\n balance?: {\n amount?: number\n amount_decimal?: string\n currency?: string\n }\n schedule?: {\n billing_due_day?: number\n billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly"\n installments_per_year?: number\n inferred: boolean\n }\n pending_installment_change?: boolean\n history: Array<{\n event_id: string\n org_id: string\n entity_type: "contract" | "billing_account"\n entity_id: string\n // ...\n}\n```\n\n### `BillingAccountPricingInformation`\n\n```ts\ntype BillingAccountPricingInformation = {\n entity_type: "billing_account"\n entity_id: string\n title?: string\n balance?: {\n amount?: number\n amount_decimal?: string\n currency?: string\n }\n contracts: Array<{\n entity_type: "contract"\n entity_id: string\n title?: string\n current_installment_amount?: {\n amount?: { ... }\n amount_decimal?: { ... }\n currency?: { ... }\n }\n context?: {\n base_price?: { ... }\n base_prices?: { ... }\n working_price?: { ... }\n working_prices?: { ... }\n }\n balance?: {\n amount?: { ... }\n amount_decimal?: { ... }\n currency?: { ... }\n }\n schedule?: {\n billing_due_day?: { ... }\n billing_period?: { ... }\n installments_per_year?: { ... }\n inferred: { ... }\n }\n pending_installment_change?: boolean\n history: Array<{\n event_id: { ... }\n org_id: { ... }\n entity_type: { ... }\n entity_id: { ... }\n schema_version: { ... }\n effective_at?: { ... }\n changed_at: { ... }\n created_at: { ... }\n source: { ... }\n source_label?: { ... }\n source_system?: { ... }\n source_reference?: { ... }\n change_type: { ... }\n previous_value?: { ... }\n new_value: { ... }\n context?: { ... }\n } | {\n event_id: { ... }\n org_id: { ... }\n entity_type: { ... }\n entity_id: { ... }\n schema_version: { ... }\n effective_at?: { ... }\n changed_at: { ... }\n created_at: { ... }\n source: { ... }\n source_label?: { ... }\n source_system?: { ... }\n source_reference?: { ... }\n change_type: { ... }\n previous_context: { ... }\n new_context: { ... }\n changed_fields: { ... }\n }>\n }>\n}\n```\n\n### `Balance`\n\nCustomer balance summary (Kontostand\xFCbersicht).\nRepresents the aggregated balance across all contracts and orders for a customer.\n\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 (W\xE4hrungscode).\nCommon values: EUR (Euro), CHF (Swiss Franc)\n\n\n```ts\ntype Currency = string\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
billing_default as default
|
|
7
|
+
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunkPNVSKDMVcjs = require('./chunk-PNVSKDMV.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunkPNVSKDMVcjs.require_billing_runtime.call(void 0, );
|
|
@@ -5,14 +5,26 @@ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, Unkno
|
|
|
5
5
|
|
|
6
6
|
declare namespace Components {
|
|
7
7
|
namespace Parameters {
|
|
8
|
-
export type ConfigurationHistoryChangeType = "installment_amount_changed";
|
|
8
|
+
export type ConfigurationHistoryChangeType = "installment_amount_changed" | "contract_pricing_changed";
|
|
9
9
|
export type From = number;
|
|
10
|
+
/**
|
|
11
|
+
* example:
|
|
12
|
+
* installment_amount_changed,contract_pricing_changed
|
|
13
|
+
*/
|
|
14
|
+
export type HistoryChangeTypes = string; // ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$
|
|
15
|
+
export type IncludeHistory = boolean;
|
|
10
16
|
export type Size = number;
|
|
11
17
|
}
|
|
12
18
|
export interface QueryParameters {
|
|
13
19
|
From?: Parameters.From;
|
|
14
20
|
Size?: Parameters.Size;
|
|
15
21
|
ConfigurationHistoryChangeType?: Parameters.ConfigurationHistoryChangeType;
|
|
22
|
+
HistoryChangeTypes?: /**
|
|
23
|
+
* example:
|
|
24
|
+
* installment_amount_changed,contract_pricing_changed
|
|
25
|
+
*/
|
|
26
|
+
Parameters.HistoryChangeTypes /* ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$ */;
|
|
27
|
+
IncludeHistory?: Parameters.IncludeHistory;
|
|
16
28
|
}
|
|
17
29
|
namespace Responses {
|
|
18
30
|
export type BadRequest = /* Standard error response format */ Schemas.Error;
|
|
@@ -756,18 +768,26 @@ declare namespace Components {
|
|
|
756
768
|
}
|
|
757
769
|
export interface ConfigurationHistoryContext {
|
|
758
770
|
base_price?: PriceContext;
|
|
771
|
+
/**
|
|
772
|
+
* Canonically ordered base-price components. The singular base_price remains for compatibility.
|
|
773
|
+
*/
|
|
774
|
+
base_prices?: PriceContext[];
|
|
759
775
|
working_price?: PriceContext;
|
|
776
|
+
/**
|
|
777
|
+
* Canonically ordered working-price components, including separate HT and NT prices when present. The singular working_price remains for compatibility.
|
|
778
|
+
*/
|
|
779
|
+
working_prices?: PriceContext[];
|
|
760
780
|
}
|
|
761
781
|
export interface ConfigurationHistoryResponse {
|
|
762
782
|
history: ConfigurationHistoryRow[];
|
|
763
783
|
total: number;
|
|
764
784
|
}
|
|
765
|
-
export
|
|
785
|
+
export type ConfigurationHistoryRow = InstallmentAmountChangedHistoryRow | ContractPricingChangedHistoryRow;
|
|
786
|
+
export interface ConfigurationHistoryRowBase {
|
|
766
787
|
event_id: string;
|
|
767
788
|
org_id: string;
|
|
768
789
|
entity_type: "contract" | "billing_account";
|
|
769
790
|
entity_id: string;
|
|
770
|
-
change_type: "installment_amount_changed";
|
|
771
791
|
/**
|
|
772
792
|
* example:
|
|
773
793
|
* 1
|
|
@@ -780,30 +800,6 @@ declare namespace Components {
|
|
|
780
800
|
source_label?: string;
|
|
781
801
|
source_system?: string;
|
|
782
802
|
source_reference?: string;
|
|
783
|
-
previous_value?: {
|
|
784
|
-
/**
|
|
785
|
-
* Amount in cents when available or derivable.
|
|
786
|
-
* example:
|
|
787
|
-
* 10050
|
|
788
|
-
*/
|
|
789
|
-
amount?: number;
|
|
790
|
-
/**
|
|
791
|
-
* Decimal amount string when available or derivable.
|
|
792
|
-
* example:
|
|
793
|
-
* 100.50
|
|
794
|
-
*/
|
|
795
|
-
amount_decimal?: string;
|
|
796
|
-
currency?: /**
|
|
797
|
-
* Currency code in ISO 4217 format (Währungscode).
|
|
798
|
-
* Common values: EUR (Euro), CHF (Swiss Franc)
|
|
799
|
-
*
|
|
800
|
-
* example:
|
|
801
|
-
* EUR
|
|
802
|
-
*/
|
|
803
|
-
Currency;
|
|
804
|
-
} | null;
|
|
805
|
-
new_value: InstallmentAmountValue;
|
|
806
|
-
context?: ConfigurationHistoryContext;
|
|
807
803
|
}
|
|
808
804
|
/**
|
|
809
805
|
* Represents a customer contract (Vertrag) for billing purposes.
|
|
@@ -1232,6 +1228,77 @@ declare namespace Components {
|
|
|
1232
1228
|
*/
|
|
1233
1229
|
Currency;
|
|
1234
1230
|
}
|
|
1231
|
+
export interface ContractPricingChangedHistoryRow {
|
|
1232
|
+
event_id: string;
|
|
1233
|
+
org_id: string;
|
|
1234
|
+
entity_type: "contract" | "billing_account";
|
|
1235
|
+
entity_id: string;
|
|
1236
|
+
/**
|
|
1237
|
+
* example:
|
|
1238
|
+
* 1
|
|
1239
|
+
*/
|
|
1240
|
+
schema_version: number;
|
|
1241
|
+
effective_at?: string; // date-time
|
|
1242
|
+
changed_at: string; // date-time
|
|
1243
|
+
created_at: string; // date-time
|
|
1244
|
+
source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown";
|
|
1245
|
+
source_label?: string;
|
|
1246
|
+
source_system?: string;
|
|
1247
|
+
source_reference?: string;
|
|
1248
|
+
change_type: "contract_pricing_changed";
|
|
1249
|
+
previous_context: {
|
|
1250
|
+
base_price?: PriceContext;
|
|
1251
|
+
/**
|
|
1252
|
+
* Canonically ordered base-price components. The singular base_price remains for compatibility.
|
|
1253
|
+
*/
|
|
1254
|
+
base_prices?: PriceContext[];
|
|
1255
|
+
working_price?: PriceContext;
|
|
1256
|
+
/**
|
|
1257
|
+
* Canonically ordered working-price components, including separate HT and NT prices when present. The singular working_price remains for compatibility.
|
|
1258
|
+
*/
|
|
1259
|
+
working_prices?: PriceContext[];
|
|
1260
|
+
tariff?: ContractTariffContext;
|
|
1261
|
+
/**
|
|
1262
|
+
* Canonically ordered tariff products for composite Contracts. The singular tariff is populated when exactly one tariff product exists.
|
|
1263
|
+
*/
|
|
1264
|
+
tariffs?: ContractTariffContext[];
|
|
1265
|
+
} | null;
|
|
1266
|
+
new_context: {
|
|
1267
|
+
base_price?: PriceContext;
|
|
1268
|
+
/**
|
|
1269
|
+
* Canonically ordered base-price components. The singular base_price remains for compatibility.
|
|
1270
|
+
*/
|
|
1271
|
+
base_prices?: PriceContext[];
|
|
1272
|
+
working_price?: PriceContext;
|
|
1273
|
+
/**
|
|
1274
|
+
* Canonically ordered working-price components, including separate HT and NT prices when present. The singular working_price remains for compatibility.
|
|
1275
|
+
*/
|
|
1276
|
+
working_prices?: PriceContext[];
|
|
1277
|
+
tariff?: ContractTariffContext;
|
|
1278
|
+
/**
|
|
1279
|
+
* Canonically ordered tariff products for composite Contracts. The singular tariff is populated when exactly one tariff product exists.
|
|
1280
|
+
*/
|
|
1281
|
+
tariffs?: ContractTariffContext[];
|
|
1282
|
+
} | null;
|
|
1283
|
+
changed_fields: ("tariff" | "base_price" | "working_price" | "discount" | "dynamic_tariff_configuration")[];
|
|
1284
|
+
}
|
|
1285
|
+
export interface ContractPricingContext {
|
|
1286
|
+
base_price?: PriceContext;
|
|
1287
|
+
/**
|
|
1288
|
+
* Canonically ordered base-price components. The singular base_price remains for compatibility.
|
|
1289
|
+
*/
|
|
1290
|
+
base_prices?: PriceContext[];
|
|
1291
|
+
working_price?: PriceContext;
|
|
1292
|
+
/**
|
|
1293
|
+
* Canonically ordered working-price components, including separate HT and NT prices when present. The singular working_price remains for compatibility.
|
|
1294
|
+
*/
|
|
1295
|
+
working_prices?: PriceContext[];
|
|
1296
|
+
tariff?: ContractTariffContext;
|
|
1297
|
+
/**
|
|
1298
|
+
* Canonically ordered tariff products for composite Contracts. The singular tariff is populated when exactly one tariff product exists.
|
|
1299
|
+
*/
|
|
1300
|
+
tariffs?: ContractTariffContext[];
|
|
1301
|
+
}
|
|
1235
1302
|
export interface ContractPricingInformation {
|
|
1236
1303
|
entity_type: "contract";
|
|
1237
1304
|
entity_id: string;
|
|
@@ -1252,6 +1319,10 @@ declare namespace Components {
|
|
|
1252
1319
|
installments_per_year?: number;
|
|
1253
1320
|
inferred: boolean;
|
|
1254
1321
|
}
|
|
1322
|
+
export interface ContractTariffContext {
|
|
1323
|
+
product_id?: string;
|
|
1324
|
+
product_title?: string;
|
|
1325
|
+
}
|
|
1255
1326
|
/**
|
|
1256
1327
|
* Correction event (Korrekturbuchung).
|
|
1257
1328
|
* Represents an adjustment to a previous billing entry,
|
|
@@ -2047,6 +2118,49 @@ declare namespace Components {
|
|
|
2047
2118
|
*/
|
|
2048
2119
|
internal_note?: string;
|
|
2049
2120
|
}
|
|
2121
|
+
export interface InstallmentAmountChangedHistoryRow {
|
|
2122
|
+
event_id: string;
|
|
2123
|
+
org_id: string;
|
|
2124
|
+
entity_type: "contract" | "billing_account";
|
|
2125
|
+
entity_id: string;
|
|
2126
|
+
/**
|
|
2127
|
+
* example:
|
|
2128
|
+
* 1
|
|
2129
|
+
*/
|
|
2130
|
+
schema_version: number;
|
|
2131
|
+
effective_at?: string; // date-time
|
|
2132
|
+
changed_at: string; // date-time
|
|
2133
|
+
created_at: string; // date-time
|
|
2134
|
+
source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown";
|
|
2135
|
+
source_label?: string;
|
|
2136
|
+
source_system?: string;
|
|
2137
|
+
source_reference?: string;
|
|
2138
|
+
change_type: "installment_amount_changed";
|
|
2139
|
+
previous_value?: {
|
|
2140
|
+
/**
|
|
2141
|
+
* Amount in cents when available or derivable.
|
|
2142
|
+
* example:
|
|
2143
|
+
* 10050
|
|
2144
|
+
*/
|
|
2145
|
+
amount?: number;
|
|
2146
|
+
/**
|
|
2147
|
+
* Decimal amount string when available or derivable.
|
|
2148
|
+
* example:
|
|
2149
|
+
* 100.50
|
|
2150
|
+
*/
|
|
2151
|
+
amount_decimal?: string;
|
|
2152
|
+
currency?: /**
|
|
2153
|
+
* Currency code in ISO 4217 format (Währungscode).
|
|
2154
|
+
* Common values: EUR (Euro), CHF (Swiss Franc)
|
|
2155
|
+
*
|
|
2156
|
+
* example:
|
|
2157
|
+
* EUR
|
|
2158
|
+
*/
|
|
2159
|
+
Currency;
|
|
2160
|
+
} | null;
|
|
2161
|
+
new_value: InstallmentAmountValue;
|
|
2162
|
+
context?: ConfigurationHistoryContext;
|
|
2163
|
+
}
|
|
2050
2164
|
export interface InstallmentAmountValue {
|
|
2051
2165
|
/**
|
|
2052
2166
|
* Amount in cents when available or derivable.
|
|
@@ -2629,6 +2743,10 @@ declare namespace Components {
|
|
|
2629
2743
|
export interface PriceContext {
|
|
2630
2744
|
price_id?: string;
|
|
2631
2745
|
price_title?: string;
|
|
2746
|
+
/**
|
|
2747
|
+
* Semantic tariff register for the price component, such as HT or NT.
|
|
2748
|
+
*/
|
|
2749
|
+
tariff_type?: string;
|
|
2632
2750
|
pricing_model?: string;
|
|
2633
2751
|
unit_amount_gross_decimal?: string;
|
|
2634
2752
|
unit_amount_net_decimal?: string;
|
|
@@ -2944,8 +3062,13 @@ declare namespace Paths {
|
|
|
2944
3062
|
}
|
|
2945
3063
|
namespace GetBillingAccountConfigurationHistory {
|
|
2946
3064
|
namespace Parameters {
|
|
2947
|
-
export type ChangeType = "installment_amount_changed";
|
|
3065
|
+
export type ChangeType = "installment_amount_changed" | "contract_pricing_changed";
|
|
2948
3066
|
export type From = number;
|
|
3067
|
+
/**
|
|
3068
|
+
* example:
|
|
3069
|
+
* installment_amount_changed,contract_pricing_changed
|
|
3070
|
+
*/
|
|
3071
|
+
export type HistoryChangeTypes = string; // ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$
|
|
2949
3072
|
export type Id = string;
|
|
2950
3073
|
export type Size = number;
|
|
2951
3074
|
}
|
|
@@ -2954,6 +3077,11 @@ declare namespace Paths {
|
|
|
2954
3077
|
}
|
|
2955
3078
|
export interface QueryParameters {
|
|
2956
3079
|
change_type?: Parameters.ChangeType;
|
|
3080
|
+
history_change_types?: /**
|
|
3081
|
+
* example:
|
|
3082
|
+
* installment_amount_changed,contract_pricing_changed
|
|
3083
|
+
*/
|
|
3084
|
+
Parameters.HistoryChangeTypes /* ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$ */;
|
|
2957
3085
|
from?: Parameters.From;
|
|
2958
3086
|
size?: Parameters.Size;
|
|
2959
3087
|
}
|
|
@@ -2963,11 +3091,25 @@ declare namespace Paths {
|
|
|
2963
3091
|
}
|
|
2964
3092
|
namespace GetBillingAccountPricingInformation {
|
|
2965
3093
|
namespace Parameters {
|
|
3094
|
+
/**
|
|
3095
|
+
* example:
|
|
3096
|
+
* installment_amount_changed,contract_pricing_changed
|
|
3097
|
+
*/
|
|
3098
|
+
export type HistoryChangeTypes = string; // ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$
|
|
2966
3099
|
export type Id = string;
|
|
3100
|
+
export type IncludeHistory = boolean;
|
|
2967
3101
|
}
|
|
2968
3102
|
export interface PathParameters {
|
|
2969
3103
|
id: Parameters.Id;
|
|
2970
3104
|
}
|
|
3105
|
+
export interface QueryParameters {
|
|
3106
|
+
history_change_types?: /**
|
|
3107
|
+
* example:
|
|
3108
|
+
* installment_amount_changed,contract_pricing_changed
|
|
3109
|
+
*/
|
|
3110
|
+
Parameters.HistoryChangeTypes /* ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$ */;
|
|
3111
|
+
include_history?: Parameters.IncludeHistory;
|
|
3112
|
+
}
|
|
2971
3113
|
namespace Responses {
|
|
2972
3114
|
export type $200 = Components.Schemas.BillingAccountPricingInformation;
|
|
2973
3115
|
}
|
|
@@ -3124,8 +3266,13 @@ declare namespace Paths {
|
|
|
3124
3266
|
}
|
|
3125
3267
|
namespace GetContractConfigurationHistory {
|
|
3126
3268
|
namespace Parameters {
|
|
3127
|
-
export type ChangeType = "installment_amount_changed";
|
|
3269
|
+
export type ChangeType = "installment_amount_changed" | "contract_pricing_changed";
|
|
3128
3270
|
export type From = number;
|
|
3271
|
+
/**
|
|
3272
|
+
* example:
|
|
3273
|
+
* installment_amount_changed,contract_pricing_changed
|
|
3274
|
+
*/
|
|
3275
|
+
export type HistoryChangeTypes = string; // ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$
|
|
3129
3276
|
export type Id = string;
|
|
3130
3277
|
export type Size = number;
|
|
3131
3278
|
}
|
|
@@ -3134,6 +3281,11 @@ declare namespace Paths {
|
|
|
3134
3281
|
}
|
|
3135
3282
|
export interface QueryParameters {
|
|
3136
3283
|
change_type?: Parameters.ChangeType;
|
|
3284
|
+
history_change_types?: /**
|
|
3285
|
+
* example:
|
|
3286
|
+
* installment_amount_changed,contract_pricing_changed
|
|
3287
|
+
*/
|
|
3288
|
+
Parameters.HistoryChangeTypes /* ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$ */;
|
|
3137
3289
|
from?: Parameters.From;
|
|
3138
3290
|
size?: Parameters.Size;
|
|
3139
3291
|
}
|
|
@@ -3143,11 +3295,25 @@ declare namespace Paths {
|
|
|
3143
3295
|
}
|
|
3144
3296
|
namespace GetContractPricingInformation {
|
|
3145
3297
|
namespace Parameters {
|
|
3298
|
+
/**
|
|
3299
|
+
* example:
|
|
3300
|
+
* installment_amount_changed,contract_pricing_changed
|
|
3301
|
+
*/
|
|
3302
|
+
export type HistoryChangeTypes = string; // ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$
|
|
3146
3303
|
export type Id = string;
|
|
3304
|
+
export type IncludeHistory = boolean;
|
|
3147
3305
|
}
|
|
3148
3306
|
export interface PathParameters {
|
|
3149
3307
|
id: Parameters.Id;
|
|
3150
3308
|
}
|
|
3309
|
+
export interface QueryParameters {
|
|
3310
|
+
history_change_types?: /**
|
|
3311
|
+
* example:
|
|
3312
|
+
* installment_amount_changed,contract_pricing_changed
|
|
3313
|
+
*/
|
|
3314
|
+
Parameters.HistoryChangeTypes /* ^(installment_amount_changed|contract_pricing_changed)(,(installment_amount_changed|contract_pricing_changed))*$ */;
|
|
3315
|
+
include_history?: Parameters.IncludeHistory;
|
|
3316
|
+
}
|
|
3151
3317
|
namespace Responses {
|
|
3152
3318
|
export type $200 = Components.Schemas.ContractPricingInformation;
|
|
3153
3319
|
}
|
|
@@ -3380,7 +3546,7 @@ interface OperationMethods {
|
|
|
3380
3546
|
* Get current pricing information and recent configuration history for a Contract.
|
|
3381
3547
|
*/
|
|
3382
3548
|
'getContractPricingInformation'(
|
|
3383
|
-
parameters?: Parameters<Paths.GetContractPricingInformation.PathParameters> | null,
|
|
3549
|
+
parameters?: Parameters<Paths.GetContractPricingInformation.QueryParameters & Paths.GetContractPricingInformation.PathParameters> | null,
|
|
3384
3550
|
data?: any,
|
|
3385
3551
|
config?: AxiosRequestConfig
|
|
3386
3552
|
): OperationResponse<Paths.GetContractPricingInformation.Responses.$200>
|
|
@@ -3390,7 +3556,7 @@ interface OperationMethods {
|
|
|
3390
3556
|
* Get current pricing information for the active Contracts linked to a Billing Account.
|
|
3391
3557
|
*/
|
|
3392
3558
|
'getBillingAccountPricingInformation'(
|
|
3393
|
-
parameters?: Parameters<Paths.GetBillingAccountPricingInformation.PathParameters> | null,
|
|
3559
|
+
parameters?: Parameters<Paths.GetBillingAccountPricingInformation.QueryParameters & Paths.GetBillingAccountPricingInformation.PathParameters> | null,
|
|
3394
3560
|
data?: any,
|
|
3395
3561
|
config?: AxiosRequestConfig
|
|
3396
3562
|
): OperationResponse<Paths.GetBillingAccountPricingInformation.Responses.$200>
|
|
@@ -3575,7 +3741,7 @@ interface PathsDictionary {
|
|
|
3575
3741
|
* Get current pricing information and recent configuration history for a Contract.
|
|
3576
3742
|
*/
|
|
3577
3743
|
'get'(
|
|
3578
|
-
parameters?: Parameters<Paths.GetContractPricingInformation.PathParameters> | null,
|
|
3744
|
+
parameters?: Parameters<Paths.GetContractPricingInformation.QueryParameters & Paths.GetContractPricingInformation.PathParameters> | null,
|
|
3579
3745
|
data?: any,
|
|
3580
3746
|
config?: AxiosRequestConfig
|
|
3581
3747
|
): OperationResponse<Paths.GetContractPricingInformation.Responses.$200>
|
|
@@ -3587,7 +3753,7 @@ interface PathsDictionary {
|
|
|
3587
3753
|
* Get current pricing information for the active Contracts linked to a Billing Account.
|
|
3588
3754
|
*/
|
|
3589
3755
|
'get'(
|
|
3590
|
-
parameters?: Parameters<Paths.GetBillingAccountPricingInformation.PathParameters> | null,
|
|
3756
|
+
parameters?: Parameters<Paths.GetBillingAccountPricingInformation.QueryParameters & Paths.GetBillingAccountPricingInformation.PathParameters> | null,
|
|
3591
3757
|
data?: any,
|
|
3592
3758
|
config?: AxiosRequestConfig
|
|
3593
3759
|
): OperationResponse<Paths.GetBillingAccountPricingInformation.Responses.$200>
|
|
@@ -3648,10 +3814,14 @@ type BonusEvent = Components.Schemas.BonusEvent;
|
|
|
3648
3814
|
type ConfigurationHistoryContext = Components.Schemas.ConfigurationHistoryContext;
|
|
3649
3815
|
type ConfigurationHistoryResponse = Components.Schemas.ConfigurationHistoryResponse;
|
|
3650
3816
|
type ConfigurationHistoryRow = Components.Schemas.ConfigurationHistoryRow;
|
|
3817
|
+
type ConfigurationHistoryRowBase = Components.Schemas.ConfigurationHistoryRowBase;
|
|
3651
3818
|
type Contract = Components.Schemas.Contract;
|
|
3652
3819
|
type ContractItem = Components.Schemas.ContractItem;
|
|
3820
|
+
type ContractPricingChangedHistoryRow = Components.Schemas.ContractPricingChangedHistoryRow;
|
|
3821
|
+
type ContractPricingContext = Components.Schemas.ContractPricingContext;
|
|
3653
3822
|
type ContractPricingInformation = Components.Schemas.ContractPricingInformation;
|
|
3654
3823
|
type ContractPricingSchedule = Components.Schemas.ContractPricingSchedule;
|
|
3824
|
+
type ContractTariffContext = Components.Schemas.ContractTariffContext;
|
|
3655
3825
|
type CorrectionEvent = Components.Schemas.CorrectionEvent;
|
|
3656
3826
|
type Currency = Components.Schemas.Currency;
|
|
3657
3827
|
type CustomEvent = Components.Schemas.CustomEvent;
|
|
@@ -3662,6 +3832,7 @@ type EntityRelationItem = Components.Schemas.EntityRelationItem;
|
|
|
3662
3832
|
type EntitySlug = Components.Schemas.EntitySlug;
|
|
3663
3833
|
type Error = Components.Schemas.Error;
|
|
3664
3834
|
type FinalBillEvent = Components.Schemas.FinalBillEvent;
|
|
3835
|
+
type InstallmentAmountChangedHistoryRow = Components.Schemas.InstallmentAmountChangedHistoryRow;
|
|
3665
3836
|
type InstallmentAmountValue = Components.Schemas.InstallmentAmountValue;
|
|
3666
3837
|
type InstallmentEvent = Components.Schemas.InstallmentEvent;
|
|
3667
3838
|
type InvoiceEvent = Components.Schemas.InvoiceEvent;
|
|
@@ -3670,4 +3841,4 @@ type PriceContext = Components.Schemas.PriceContext;
|
|
|
3670
3841
|
type PricingInformationBalance = Components.Schemas.PricingInformationBalance;
|
|
3671
3842
|
type ReimbursementEvent = Components.Schemas.ReimbursementEvent;
|
|
3672
3843
|
|
|
3673
|
-
export { type
|
|
3844
|
+
export { type InstallmentAmountValue as A, type Balance as B, type Client as C, type DunningFeeEvent as D, type EntityId as E, type FinalBillEvent as F, type InstallmentEvent as G, type InvoiceEvent as H, type InstallmentAmountChangedHistoryRow as I, type PaymentEvent as J, type PriceContext as K, type PricingInformationBalance as L, type OperationMethods as O, Paths as P, type ReimbursementEvent as R, Components as a, type PathsDictionary as b, type BaseBillingEvent as c, type BaseEntity as d, type BillingAccountPricingInformation as e, type BillingEvent as f, type BillingEventUpdate as g, type BonusEvent as h, type ConfigurationHistoryContext as i, type ConfigurationHistoryResponse as j, type ConfigurationHistoryRow as k, type ConfigurationHistoryRowBase as l, type Contract as m, type ContractItem as n, type ContractPricingChangedHistoryRow as o, type ContractPricingContext as p, type ContractPricingInformation as q, type ContractPricingSchedule as r, type ContractTariffContext as s, type CorrectionEvent as t, type Currency as u, type CustomEvent as v, type DynamicTariffPriceContext as w, type EntityRelationItem as x, type EntitySlug as y, type Error as z };
|