From 2446696e53f27e6a29dcf4a57f82c1960366859a Mon Sep 17 00:00:00 2001 From: Karl Rankla Date: Mon, 16 Nov 2026 14:10:56 +0200 Subject: [PATCH] docs(events): add billing_accounts lists to contact- and ticket-rooted core events Sync the schemas of the nine events that gained billing_accounts (and accounts on CustomerDetailsUpdated) and explain when to read the list instead of the single billing_account. --- docs/integrations/core-events.md | 2 + ...illingAccountConnectionRemoved.config.json | 11 +- ...illingAccountConnectionRemoved.sample.json | 121 ++++- ...illingAccountConnectionRemoved.schema.json | 147 +++++- .../ContractWithdrawalRequested.config.json | 11 +- .../ContractWithdrawalRequested.sample.json | 121 ++++- .../ContractWithdrawalRequested.schema.json | 147 +++++- .../events/CustomerDetailsUpdated.config.json | 20 +- .../events/CustomerDetailsUpdated.sample.json | 289 +++++++++- .../events/CustomerDetailsUpdated.schema.json | 492 +++++++++++++++++- .../CustomerRequestSubmitted.config.json | 11 +- .../CustomerRequestSubmitted.sample.json | 119 ++++- .../CustomerRequestSubmitted.schema.json | 147 +++++- .../events/GeneralRequestCreated.config.json | 11 +- .../events/GeneralRequestCreated.sample.json | 121 ++++- .../events/GeneralRequestCreated.schema.json | 147 +++++- .../events/LocationMoveRequested.config.json | 11 +- .../events/LocationMoveRequested.sample.json | 121 ++++- .../events/LocationMoveRequested.schema.json | 147 +++++- .../ServiceInstallmentChange.config.json | 11 +- .../ServiceInstallmentChange.sample.json | 121 ++++- .../ServiceInstallmentChange.schema.json | 147 +++++- static/events/TariffChange.config.json | 11 +- static/events/TariffChange.sample.json | 121 ++++- static/events/TariffChange.schema.json | 147 +++++- .../TerminateContractRequested.config.json | 11 +- .../TerminateContractRequested.sample.json | 121 ++++- .../TerminateContractRequested.schema.json | 147 +++++- 28 files changed, 2999 insertions(+), 34 deletions(-) diff --git a/docs/integrations/core-events.md b/docs/integrations/core-events.md index e7fb3237..72af279c 100644 --- a/docs/integrations/core-events.md +++ b/docs/integrations/core-events.md @@ -17,6 +17,8 @@ See the [API Changelog](/api/changelog) for the full history of additions and ch Events follow a consistent structure with common metadata fields and event-specific payloads. Each event may include hydrated entity data from the entity graph. +An entity node is either a single object or a list. A contact can have several billing accounts and accounts, and a ticket can link several billing accounts. Events that start from a contact or a ticket therefore carry `billing_accounts` (and `CustomerDetailsUpdated` also carries `accounts`) with every related entity. The single `billing_account` and `account` fields stay for compatibility, but hold an arbitrary one of them when there are several, so read the list when your integration acts per billing account. + ### Common Event Fields All events include these fields: diff --git a/static/events/BillingAccountConnectionRemoved.config.json b/static/events/BillingAccountConnectionRemoved.config.json index 0b009d19..2cf09152 100644 --- a/static/events/BillingAccountConnectionRemoved.config.json +++ b/static/events/BillingAccountConnectionRemoved.config.json @@ -2,7 +2,7 @@ "event_name": "BillingAccountConnectionRemoved", "event_title": "Disassociate Billing Account", "event_description": "Customer request to disassociate a billing account from a contact", - "event_version": "1.0", + "event_version": "1.1", "event_tags": [ "builtin", "erp", @@ -35,6 +35,11 @@ "id": "billing_account", "schema": "billing_account", "cardinality": "one" + }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" } ], "edges": [ @@ -49,6 +54,10 @@ { "from": "ticket", "to": "billing_account" + }, + { + "from": "ticket", + "to": "billing_accounts" } ] }, diff --git a/static/events/BillingAccountConnectionRemoved.sample.json b/static/events/BillingAccountConnectionRemoved.sample.json index fa212ed5..84383e14 100644 --- a/static/events/BillingAccountConnectionRemoved.sample.json +++ b/static/events/BillingAccountConnectionRemoved.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "BillingAccountConnectionRemoved", - "_event_version": "1.0", + "_event_version": "1.1", "_event_source": "string", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "api", @@ -448,5 +448,122 @@ }, "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" - } + }, + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ] } \ No newline at end of file diff --git a/static/events/BillingAccountConnectionRemoved.schema.json b/static/events/BillingAccountConnectionRemoved.schema.json index e3489963..db7e3978 100644 --- a/static/events/BillingAccountConnectionRemoved.schema.json +++ b/static/events/BillingAccountConnectionRemoved.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "1.0" + "example": "1.1" }, "_event_source": { "type": "string", @@ -759,6 +759,151 @@ } }, "description": "billing_account entity (hydrated from entity graph)" + }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } } }, "required": [ diff --git a/static/events/ContractWithdrawalRequested.config.json b/static/events/ContractWithdrawalRequested.config.json index dce6654b..02659ca6 100644 --- a/static/events/ContractWithdrawalRequested.config.json +++ b/static/events/ContractWithdrawalRequested.config.json @@ -2,7 +2,7 @@ "event_name": "ContractWithdrawalRequested", "event_title": "Contract Withdrawal Request", "event_description": "A customer withdrew from a contract (Widerruf), e.g. through the withdrawal function required by § 356a BGB. Explicitly triggered by Automation once the withdrawal ticket is complete.", - "event_version": "1.0", + "event_version": "1.1", "event_tags": [ "builtin", "erp", @@ -57,6 +57,11 @@ "id": "billing_account", "schema": "billing_account", "cardinality": "one" + }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" } ], "edges": [ @@ -79,6 +84,10 @@ { "from": "ticket", "to": "billing_account" + }, + { + "from": "ticket", + "to": "billing_accounts" } ] }, diff --git a/static/events/ContractWithdrawalRequested.sample.json b/static/events/ContractWithdrawalRequested.sample.json index 1ad45df7..cfe3eef5 100644 --- a/static/events/ContractWithdrawalRequested.sample.json +++ b/static/events/ContractWithdrawalRequested.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "ContractWithdrawalRequested", - "_event_version": "1.0", + "_event_version": "1.1", "_event_source": "automation", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "automation", @@ -1195,5 +1195,122 @@ }, "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" - } + }, + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ] } \ No newline at end of file diff --git a/static/events/ContractWithdrawalRequested.schema.json b/static/events/ContractWithdrawalRequested.schema.json index ad4e4353..3471dac3 100644 --- a/static/events/ContractWithdrawalRequested.schema.json +++ b/static/events/ContractWithdrawalRequested.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "1.0" + "example": "1.1" }, "_event_source": { "type": "string", @@ -1707,6 +1707,151 @@ } }, "description": "billing_account entity (hydrated from entity graph)" + }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } } }, "required": [ diff --git a/static/events/CustomerDetailsUpdated.config.json b/static/events/CustomerDetailsUpdated.config.json index 1fc2719c..046ad548 100644 --- a/static/events/CustomerDetailsUpdated.config.json +++ b/static/events/CustomerDetailsUpdated.config.json @@ -2,7 +2,7 @@ "event_name": "CustomerDetailsUpdated", "event_title": "Customer Details Updated", "event_description": "Triggered when key customer details are changed on a Contact entity", - "event_version": "1.0", + "event_version": "1.1", "event_tags": [ "builtin", "erp", @@ -58,11 +58,21 @@ "schema": "account", "cardinality": "one" }, + { + "id": "accounts", + "schema": "account", + "cardinality": "many" + }, { "id": "billing_account", "schema": "billing_account", "cardinality": "one" }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" + }, { "id": "portal_user", "schema": "portal_user", @@ -74,10 +84,18 @@ "from": "contact", "to": "account" }, + { + "from": "contact", + "to": "accounts" + }, { "from": "contact", "to": "billing_account" }, + { + "from": "contact", + "to": "billing_accounts" + }, { "from": "contact", "to": "portal_user" diff --git a/static/events/CustomerDetailsUpdated.sample.json b/static/events/CustomerDetailsUpdated.sample.json index 85ee47b5..38bcd099 100644 --- a/static/events/CustomerDetailsUpdated.sample.json +++ b/static/events/CustomerDetailsUpdated.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "CustomerDetailsUpdated", - "_event_version": "1.0", + "_event_version": "1.1", "_event_source": "string", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "api", @@ -411,6 +411,176 @@ "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" }, + "accounts": [ + { + "_schema": "account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "_purpose": [ + "7675dc56-fd1b-46ee-9c35-defe0667b32e" + ], + "name": "string", + "customer_number": "string", + "registry_court": "string", + "registry_number": "string", + "tax_id": "string", + "tax_exemption": true, + "annual_revenue_currency": "EUR", + "annual_revenue_decimal": "123.45", + "annual_revenue": 0, + "industry": [ + "string" + ], + "company_size": "", + "website": "string", + "marketing_permission": true, + "address": [ + { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + } + ], + "payment": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contacts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "assigned_to": { + "id": "string", + "organization_id": "123", + "email": "user@example.com", + "display_name": "John Doe", + "name": "John Doe", + "preferred_language": "de", + "signature": "

Best regards,
John Doe

", + "roles": [ + "Owner" + ], + "image_uri": { + "original": "https://account-profile-images.epilot.cloud/1/avatar.png", + "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png" + }, + "properties": [ + { + "name": "profileImageName", + "value": "avatar.png" + } + ] + }, + "email": [ + { + "_tags": [ + "string" + ], + "email": "user@example.com" + } + ], + "phone": [ + { + "_tags": [ + "string" + ], + "phone": "+491234567890" + } + ], + "opportunities": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ], "billing_account": { "_schema": "billing_account", "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", @@ -526,6 +696,123 @@ "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" }, + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ], "portal_user": { "_schema": "portal_user", "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", diff --git a/static/events/CustomerDetailsUpdated.schema.json b/static/events/CustomerDetailsUpdated.schema.json index 017a9d64..655fbfb0 100644 --- a/static/events/CustomerDetailsUpdated.schema.json +++ b/static/events/CustomerDetailsUpdated.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "1.0" + "example": "1.1" }, "_event_source": { "type": "string", @@ -813,6 +813,351 @@ }, "description": "account entity (hydrated from entity graph)" }, + "accounts": { + "type": "array", + "description": "Array of account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "_purpose": { + "$ref": "#/definitions/PurposeAttribute", + "description": "Purposes" + }, + "name": { + "type": "string", + "description": "Company name" + }, + "customer_number": { + "type": "string", + "description": "Customer Number" + }, + "registry_court": { + "type": "string", + "description": "Registry court" + }, + "registry_number": { + "type": "string", + "description": "Registry number" + }, + "tax_id": { + "type": "string", + "description": "Tax ID" + }, + "tax_exemption": { + "type": "boolean", + "description": "Tax exemption" + }, + "annual_revenue_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "annual_revenue_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "annual_revenue": { + "type": "number", + "description": "Annual revenue" + }, + "industry": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Company industry" + }, + "company_size": { + "type": "string", + "enum": [ + "", + "1-9", + "9-49", + "50-99", + "100-249", + "250-499", + "500+" + ], + "description": "Company size" + }, + "website": { + "type": "string", + "description": "Website" + }, + "marketing_permission": { + "type": "boolean", + "description": "Marketing Permission" + }, + "address": { + "type": "array", + "items": { + "type": "object", + "description": "Address attribute", + "additionalProperties": true, + "properties": { + "_tags": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "billing" + ] + }, + "street": { + "type": "string", + "description": "The first line of the address. Typically the street address or PO Box number.", + "nullable": true, + "example": "Hauptstraße" + }, + "street_number": { + "type": "string", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", + "nullable": true, + "example": "123" + }, + "postal_code": { + "type": "string", + "description": "The postal code for the address.", + "nullable": true, + "example": "50668" + }, + "city": { + "type": "string", + "description": "The name of the city, district, village, or town.", + "nullable": true, + "example": "Cologne" + }, + "country": { + "type": "string", + "description": "The two-letter code for the country of the address.", + "nullable": true, + "example": "DE" + }, + "additional_info": { + "type": "string", + "description": "An additional description for the address", + "nullable": true + }, + "company_name": { + "type": "string", + "description": "the company name, usually used as extra delivery instructions", + "nullable": true + }, + "first_name": { + "type": "string", + "description": "the first name of the recipient, usually used as extra delivery instructions", + "nullable": true + }, + "last_name": { + "type": "string", + "description": "the last name of the recipient, usually used as extra delivery instructions", + "nullable": true + }, + "salutation": { + "type": "string", + "description": "the salutation of the recipient, usually used as extra delivery instructions", + "nullable": true + }, + "title": { + "type": "string", + "description": "the title of the recipient, usually used as extra delivery instructions", + "nullable": true + }, + "coordinates": { + "type": "string", + "description": "Geographical coordinates (latitude, longitude)", + "nullable": true, + "example": "50.948484, 6.943147" + }, + "plot_of_land": { + "type": "string", + "description": "Plot of land information", + "nullable": true + }, + "plot_area": { + "type": "string", + "description": "Area of the plot", + "nullable": true + }, + "start_date": { + "type": "string", + "description": "Start date for the address", + "format": "date", + "nullable": true + }, + "end_date": { + "type": "string", + "description": "End date for the address", + "format": "date", + "nullable": true + } + } + }, + "description": "Address" + }, + "payment": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment" + }, + "contacts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contacts" + }, + "assigned_to": { + "$ref": "#/definitions/User", + "description": "Assigned to" + }, + "email": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "email": { + "type": "string", + "format": "email" + } + }, + "required": [ + "email" + ] + }, + "description": "Email" + }, + "phone": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "phone": { + "type": "string", + "example": "+491234567890" + } + }, + "required": [ + "phone" + ] + }, + "description": "Phone" + }, + "opportunities": { + "$ref": "#/definitions/BaseRelation", + "description": "Opportunities" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } + }, "billing_account": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", @@ -955,6 +1300,151 @@ }, "description": "billing_account entity (hydrated from entity graph)" }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } + }, "portal_user": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", diff --git a/static/events/CustomerRequestSubmitted.config.json b/static/events/CustomerRequestSubmitted.config.json index c0b5f0ab..3b133af1 100644 --- a/static/events/CustomerRequestSubmitted.config.json +++ b/static/events/CustomerRequestSubmitted.config.json @@ -2,7 +2,7 @@ "event_name": "CustomerRequestSubmitted", "event_title": "Customer Request Submitted", "event_description": "Explicitly triggered by Automation after a customer request ticket and its file attachments are ready", - "event_version": "1.1", + "event_version": "1.2", "event_tags": [ "builtin", "erp", @@ -148,6 +148,11 @@ "id": "ticket_files", "schema": "file", "cardinality": "many" + }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" } ], "edges": [ @@ -178,6 +183,10 @@ { "from": "ticket", "to": "ticket_files" + }, + { + "from": "ticket", + "to": "billing_accounts" } ] }, diff --git a/static/events/CustomerRequestSubmitted.sample.json b/static/events/CustomerRequestSubmitted.sample.json index 36ae84e3..46ff9c77 100644 --- a/static/events/CustomerRequestSubmitted.sample.json +++ b/static/events/CustomerRequestSubmitted.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "CustomerRequestSubmitted", - "_event_version": "1.1", + "_event_version": "1.2", "_event_source": "automation", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "automation", @@ -1059,5 +1059,122 @@ "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" } + ], + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } ] } \ No newline at end of file diff --git a/static/events/CustomerRequestSubmitted.schema.json b/static/events/CustomerRequestSubmitted.schema.json index e8288f16..a4432da9 100644 --- a/static/events/CustomerRequestSubmitted.schema.json +++ b/static/events/CustomerRequestSubmitted.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "1.1" + "example": "1.2" }, "_event_source": { "type": "string", @@ -1800,6 +1800,151 @@ } } } + }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } } }, "required": [ diff --git a/static/events/GeneralRequestCreated.config.json b/static/events/GeneralRequestCreated.config.json index 5f4cff08..54a98296 100644 --- a/static/events/GeneralRequestCreated.config.json +++ b/static/events/GeneralRequestCreated.config.json @@ -2,7 +2,7 @@ "event_name": "GeneralRequestCreated", "event_title": "Contact Form", "event_description": "Customer request via contact form", - "event_version": "1.0", + "event_version": "1.1", "event_tags": [ "builtin", "erp", @@ -35,6 +35,11 @@ "id": "billing_account", "schema": "billing_account", "cardinality": "one" + }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" } ], "edges": [ @@ -49,6 +54,10 @@ { "from": "ticket", "to": "billing_account" + }, + { + "from": "ticket", + "to": "billing_accounts" } ] }, diff --git a/static/events/GeneralRequestCreated.sample.json b/static/events/GeneralRequestCreated.sample.json index 6f2d5289..ad191950 100644 --- a/static/events/GeneralRequestCreated.sample.json +++ b/static/events/GeneralRequestCreated.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "GeneralRequestCreated", - "_event_version": "1.0", + "_event_version": "1.1", "_event_source": "string", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "api", @@ -448,5 +448,122 @@ }, "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" - } + }, + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ] } \ No newline at end of file diff --git a/static/events/GeneralRequestCreated.schema.json b/static/events/GeneralRequestCreated.schema.json index 1d553921..1fa8011f 100644 --- a/static/events/GeneralRequestCreated.schema.json +++ b/static/events/GeneralRequestCreated.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "1.0" + "example": "1.1" }, "_event_source": { "type": "string", @@ -759,6 +759,151 @@ } }, "description": "billing_account entity (hydrated from entity graph)" + }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } } }, "required": [ diff --git a/static/events/LocationMoveRequested.config.json b/static/events/LocationMoveRequested.config.json index 62bc4249..44ce0644 100644 --- a/static/events/LocationMoveRequested.config.json +++ b/static/events/LocationMoveRequested.config.json @@ -2,7 +2,7 @@ "event_name": "LocationMoveRequested", "event_title": "Move Request", "event_description": "Customer request to move or relocate a service", - "event_version": "2.0", + "event_version": "2.1", "event_tags": [ "builtin", "erp", @@ -50,6 +50,11 @@ "id": "billing_account", "schema": "billing_account", "cardinality": "one" + }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" } ], "edges": [ @@ -80,6 +85,10 @@ { "from": "contract", "to": "billing_account" + }, + { + "from": "ticket", + "to": "billing_accounts" } ] }, diff --git a/static/events/LocationMoveRequested.sample.json b/static/events/LocationMoveRequested.sample.json index 4da70646..cab8618b 100644 --- a/static/events/LocationMoveRequested.sample.json +++ b/static/events/LocationMoveRequested.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "LocationMoveRequested", - "_event_version": "2.0", + "_event_version": "2.1", "_event_source": "string", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "api", @@ -774,5 +774,122 @@ }, "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" - } + }, + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ] } \ No newline at end of file diff --git a/static/events/LocationMoveRequested.schema.json b/static/events/LocationMoveRequested.schema.json index 106ed30c..971d7d25 100644 --- a/static/events/LocationMoveRequested.schema.json +++ b/static/events/LocationMoveRequested.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "2.0" + "example": "2.1" }, "_event_source": { "type": "string", @@ -1212,6 +1212,151 @@ } }, "description": "billing_account entity (hydrated from entity graph)" + }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } } }, "required": [ diff --git a/static/events/ServiceInstallmentChange.config.json b/static/events/ServiceInstallmentChange.config.json index 6ed03405..bbea4283 100644 --- a/static/events/ServiceInstallmentChange.config.json +++ b/static/events/ServiceInstallmentChange.config.json @@ -2,7 +2,7 @@ "event_name": "ServiceInstallmentChange", "event_title": "Service: Installment Change", "event_description": "Customer request to change the installment amount (Abschlag) via portal self-service. Triggered when a ticket with purpose \"Änderung Abschlag\" is created.", - "event_version": "1.0", + "event_version": "1.1", "event_tags": [ "builtin", "erp", @@ -145,6 +145,11 @@ "id": "contact", "schema": "contact", "cardinality": "one" + }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" } ], "edges": [ @@ -159,6 +164,10 @@ { "from": "ticket", "to": "contact" + }, + { + "from": "ticket", + "to": "billing_accounts" } ] }, diff --git a/static/events/ServiceInstallmentChange.sample.json b/static/events/ServiceInstallmentChange.sample.json index b5ee4c12..8e730fd8 100644 --- a/static/events/ServiceInstallmentChange.sample.json +++ b/static/events/ServiceInstallmentChange.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "ServiceInstallmentChange", - "_event_version": "1.0", + "_event_version": "1.1", "_event_source": "string", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "api", @@ -835,5 +835,122 @@ }, "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" - } + }, + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ] } \ No newline at end of file diff --git a/static/events/ServiceInstallmentChange.schema.json b/static/events/ServiceInstallmentChange.schema.json index a50f57a8..f00fc1ce 100644 --- a/static/events/ServiceInstallmentChange.schema.json +++ b/static/events/ServiceInstallmentChange.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "1.0" + "example": "1.1" }, "_event_source": { "type": "string", @@ -1217,6 +1217,151 @@ } }, "description": "contact entity (hydrated from entity graph)" + }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } } }, "required": [ diff --git a/static/events/TariffChange.config.json b/static/events/TariffChange.config.json index 8ec0ef98..60d71284 100644 --- a/static/events/TariffChange.config.json +++ b/static/events/TariffChange.config.json @@ -2,7 +2,7 @@ "event_name": "TariffChange", "event_title": "Tariff Change", "event_description": "Customer request to change tariff via portal", - "event_version": "1.0", + "event_version": "1.1", "event_tags": [ "builtin", "erp", @@ -121,6 +121,11 @@ "id": "order", "schema": "order", "cardinality": "one" + }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" } ], "edges": [ @@ -139,6 +144,10 @@ { "from": "ticket", "to": "order" + }, + { + "from": "ticket", + "to": "billing_accounts" } ] }, diff --git a/static/events/TariffChange.sample.json b/static/events/TariffChange.sample.json index ee94ec2d..1149d2d8 100644 --- a/static/events/TariffChange.sample.json +++ b/static/events/TariffChange.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "TariffChange", - "_event_version": "1.0", + "_event_version": "1.1", "_event_source": "string", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "api", @@ -1198,5 +1198,122 @@ }, "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" - } + }, + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ] } \ No newline at end of file diff --git a/static/events/TariffChange.schema.json b/static/events/TariffChange.schema.json index 27a33951..a200dd81 100644 --- a/static/events/TariffChange.schema.json +++ b/static/events/TariffChange.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "1.0" + "example": "1.1" }, "_event_source": { "type": "string", @@ -1703,6 +1703,151 @@ } }, "description": "order entity (hydrated from entity graph)" + }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } } }, "required": [ diff --git a/static/events/TerminateContractRequested.config.json b/static/events/TerminateContractRequested.config.json index a59c714f..5ad7504d 100644 --- a/static/events/TerminateContractRequested.config.json +++ b/static/events/TerminateContractRequested.config.json @@ -2,7 +2,7 @@ "event_name": "TerminateContractRequested", "event_title": "Terminate Contract Request", "event_description": "Customer request to terminate a contract", - "event_version": "1.0", + "event_version": "1.1", "event_tags": [ "builtin", "erp", @@ -40,6 +40,11 @@ "id": "billing_account", "schema": "billing_account", "cardinality": "one" + }, + { + "id": "billing_accounts", + "schema": "billing_account", + "cardinality": "many" } ], "edges": [ @@ -58,6 +63,10 @@ { "from": "ticket", "to": "billing_account" + }, + { + "from": "ticket", + "to": "billing_accounts" } ] }, diff --git a/static/events/TerminateContractRequested.sample.json b/static/events/TerminateContractRequested.sample.json index 8220d5d6..21920a76 100644 --- a/static/events/TerminateContractRequested.sample.json +++ b/static/events/TerminateContractRequested.sample.json @@ -3,7 +3,7 @@ "_event_time": "1970-01-01T00:00:00.000Z", "_event_id": "string", "_event_name": "TerminateContractRequested", - "_event_version": "1.0", + "_event_version": "1.1", "_event_source": "string", "_ack_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "_trigger_source_type": "api", @@ -822,5 +822,122 @@ }, "_created_at": "1970-01-01T00:00:00.000Z", "_updated_at": "1970-01-01T00:00:00.000Z" - } + }, + "billing_accounts": [ + { + "_schema": "billing_account", + "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "_org": "123", + "_title": "John Doe", + "_tags": [ + "family:label" + ], + "billing_account_number": "string", + "balance_currency": "EUR", + "balance_decimal": "123.45", + "balance": 0, + "billing_contact": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "billing_address": { + "_tags": [ + "billing" + ], + "street": "Hauptstraße", + "street_number": "123", + "postal_code": "50668", + "city": "Cologne", + "country": "DE", + "additional_info": "string", + "company_name": "string", + "first_name": "string", + "last_name": "string", + "salutation": "string", + "title": "string", + "coordinates": "50.948484, 6.943147", + "plot_of_land": "string", + "plot_area": "string", + "start_date": "1970-01-01", + "end_date": "1970-01-01" + }, + "payment_method": [ + { + "type": "payment_sepa", + "data": { + "bank_name": "Deutsche Bank", + "iban": "DE89370400440532013000", + "bic_number": "DEUTDEFF", + "fullname": "John Doe" + } + } + ], + "contracts": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "external_id": "string", + "workflows": { + "primary": { + "id": "string", + "definition_id": "string", + "name": "string", + "status": "STARTED", + "assignees": [ + "string" + ], + "progress": 0, + "phases_in_progress": [ + { + "phase_id": "string", + "phase_name": "string", + "phase_progress": 0 + } + ], + "last_update_time": "1970-01-01T00:00:00.000Z", + "upcoming_tasks_assignees": [ + "string" + ], + "task_id": "string", + "task_name": "string", + "task_assignees": [ + "string" + ], + "task_duedate": "1970-01-01T00:00:00.000Z", + "task_execution_type": "MANUAL", + "task_status": "UNASSIGNED", + "phase_id": "string", + "phase_name": "string", + "phase_assignees": [ + "string" + ], + "phase_progress": 0 + } + }, + "_files": { + "$relation": [ + { + "entity_id": "123e4567-e89b-12d3-a456-426614174000", + "_tags": [ + "example" + ] + } + ] + }, + "_created_at": "1970-01-01T00:00:00.000Z", + "_updated_at": "1970-01-01T00:00:00.000Z" + } + ] } \ No newline at end of file diff --git a/static/events/TerminateContractRequested.schema.json b/static/events/TerminateContractRequested.schema.json index 589cb67a..f7e25b18 100644 --- a/static/events/TerminateContractRequested.schema.json +++ b/static/events/TerminateContractRequested.schema.json @@ -23,7 +23,7 @@ "_event_version": { "type": "string", "description": "Schema version number", - "example": "1.0" + "example": "1.1" }, "_event_source": { "type": "string", @@ -1169,6 +1169,151 @@ } }, "description": "billing_account entity (hydrated from entity graph)" + }, + "billing_accounts": { + "type": "array", + "description": "Array of billing_account entities (hydrated from entity graph)", + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "required": [ + "_schema" + ], + "properties": { + "_schema": { + "readOnly": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "example": "billing_account", + "description": "URL-friendly identifier for the entity schema" + }, + "_id": { + "readOnly": true, + "type": "string", + "format": "uuid", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "description": "Unique identifier for the entity" + }, + "_org": { + "type": "string", + "description": "Organization Id the entity belongs to", + "readOnly": true, + "example": "123" + }, + "_title": { + "readOnly": true, + "type": "string", + "nullable": true, + "example": "John Doe", + "description": "Generated title for the entity based on schema title_template" + }, + "_tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + }, + "example": [ + "family:label" + ], + "description": "Entity Labels" + }, + "billing_account_number": { + "type": "string", + "description": "Billing Account Number" + }, + "balance_currency": { + "type": "string", + "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.", + "example": "EUR" + }, + "balance_decimal": { + "type": "string", + "description": "The currency value as a decimal string", + "example": "123.45" + }, + "balance": { + "type": "number", + "description": "Account Balance" + }, + "billing_contact": { + "$ref": "#/definitions/BaseRelation", + "description": "Billing Contact" + }, + "billing_address": { + "$ref": "#/definitions/AddressAttribute", + "description": "Billing Address" + }, + "payment_method": { + "type": "array", + "items": { + "type": "object", + "description": "Payment method details", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_sepa", + "payment_invoice", + "payment_cash" + ], + "example": "payment_sepa" + }, + "data": { + "type": "object", + "properties": { + "bank_name": { + "type": "string", + "example": "Deutsche Bank" + }, + "iban": { + "type": "string", + "example": "DE89370400440532013000" + }, + "bic_number": { + "type": "string", + "example": "DEUTDEFF" + }, + "fullname": { + "type": "string", + "example": "John Doe" + } + } + } + } + }, + "description": "Payment Method" + }, + "contracts": { + "$ref": "#/definitions/BaseRelation", + "description": "Contracts" + }, + "external_id": { + "type": "string", + "description": "External ID" + }, + "workflows": { + "$ref": "#/definitions/WorkflowOverview" + }, + "_files": { + "$ref": "#/definitions/BaseRelation" + }, + "_created_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity creation" + }, + "_updated_at": { + "readOnly": true, + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of entity last update" + } + } + } } }, "required": [