docs(erp-toolkit): expand use cases with the Wilken integration set#127
Merged
Conversation
Adds the use cases that production integrations (e.g. Wilken) ship today but were missing from the docs. Inbound: - Sync Installment Schedule (Abschlagsplan as scheduled debit billing_events) - Sync Portal User (PROFILE contact + portal_user provisioning) - Enrich Sync Billing Events with running balance + debit/credit direction - Clarify Keep Billing Account In Sync as three sub-domain mappings (account, billing address, payment method) - Document File Proxy as the standard custom_download_url path for documents Outbound: - Submit Service Meter Reading (ServiceMeterReadingAdded, ticket-driven) - Submit New Order (OrderSubmission, journey acquisition) - Switch Tariff (TariffChange, product switch on existing contract) - Remove Billing Account Connection (BillingAccountConnectionRemoved) - Submit General Request (GeneralRequestCreated, contact form ticket) - Replace Request Data Sync custom webhook with the real OnDemandSyncCustomerRequested / OnDemandSyncContractRequested events - Realign existing payload-field lists with the actual context block (identityId / customerAccountId / contractNumber) - Note that PaymentMethodUpdated webhooks carry context only; the middle layer must re-fetch the billing account to read the new payment method Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expands
docs/integrations/erp-toolkit/use-cases.mdto cover the full set of inbound and outbound use cases that production integrations (audited against the live Wilken integration via the Integration Toolkit API) actually ship today.Inbound additions / clarifications
billing_eventrows withdirection: "debit"and stableDEDUCTION-<accountId>-<date>external IDs.PROFILEcontact +portal_userand links the portal user to the business-partner contact viamapped_contact.billing_account.balanceupdate and thedirection(debit/credit) attribute, and calls out that deterministicexternal_ids drive deduplication._tags: [DEBIT, CREDIT]convention.custom_download_urlis the standard approach when not migrating the binary content.Outbound additions / clarifications
ServiceMeterReadingAdded). The ticket-driven service-agent variant of meter reading submission.OrderSubmission). Journey-driven acquisition flow, documents thesupplyConnectionData.reasonmapping (CHANGE_OF_SUPPLIER,MOVE_IN,RATE_CHANGE).TariffChange). Tariff/product switch on an existing contract.BillingAccountConnectionRemoved). Portal-side unlink of a billing account from the portal user.GeneralRequestCreated). Contact-form ticket forwarded to the ERP, routed viarequestTypeKey.OnDemandSyncCustomerRequestedandOnDemandSyncContractRequestedevents that already exist in the core event catalog.contextblock (identityId,customerAccountId,contractNumber) anddatapayloads observed in production.Quick Reference tables
Both inbound and outbound tables in Quick Reference are extended to list every new use case with its core entities, core event, and typical trigger.
How this was verified
epilot integration-toolkit listIntegrationsV2(22 use cases — 10 inbound, 12 outbound) and reviewed each JSONata mapping for fields, identifiers and entity relations.ServiceMeterReadingAdded,OrderSubmission,TariffChange,BillingAccountConnectionRemoved,GeneralRequestCreated,OnDemandSyncCustomerRequested,OnDemandSyncContractRequested) is already documented indocs/integrations/core-events.md. No new events needed to be added.<EventSchemaViewer>and<EntitySchemaViewer>render<div id={…}>so all#anchorlinks resolve.npm run build— clean Docusaurus build, no broken-link or broken-anchor warnings.Test plan
npm run buildsucceeds with no broken-link warnings