Workflow triggers provide the capability to generate notifications when corporate account structures and properties are updated in the IDI platform (either from Customer Care, API or IDI Desktop Client), to inform other systems of the changes. The new triggers support the following events:
- when a corporate account is created
- when an account is removed from a corporate structure
- when invoice responsibility, market or parent is changed on a corporate account
Corporate Account Added
This trigger fires under the following scenarios:
- creating a new corporate structure
- adding an account into an existing corporate structure
Fields available in actions:
- customer id
- parent customer id
- account number
- parent account number
- invoice responsible
- account type
- account status
- market
Considerations
To add a customer to a corporate structure both the account and the structure must have the same bill cycle and market. Additionally, if the new account is not invoice responsible (NIR), the corporate structure must have at least one ancestor that is Invoice Responsible.
To add a customer to a corporate structure via the Web API, the ModifyCorporateAccount operation should be called. With this API you can add multiple accounts to an existing corporate structure at the same time. Successfully adding an account to a corporate structure will fire a Corporate Account Added trigger for each customer added to the structure.
In IDI Desktop Client, it is only possible to add a single customer to a corporate structure at a time. After the account has been added to the structure, a Corporate Account Added trigger will be fired.
Corporate Account Deleted
This trigger fires under the following scenarios:
- removing an invoice-responsible account from the corporate account structure
- removing a non-invoice responsible account from the corporate account structure
- removing the last account from the corporate account structure
- removing an account from the corporate account structure that has children (only possible via the API)
Fields available in actions:
- customer id
- parent customer id
- account number
- parent account number
- invoice responsible
- account type
- account status
- market
Considerations
To remove a customer and all of its dependents from a corporate structure via the Web API, the Customer web service Modify Corporate Account operation should be called. This will fire a Corporate Account Deleted trigger for each account that has been removed from the structure.
In IDI Desktop Client, you can only remove a single customer from a corporate account at a time. Additionally, all dependents of a customer must be removed before that customer can be removed from the structure. When a customer is removed from a corporate structure, a Corporate Account Deleted trigger will be fired.
Corporate Account Modified
This trigger fires under the following scenarios:
- toggling invoice responsibility (also applies when toggling invoice responsibility on children)
- reparenting an account (only possible via the API)
- modifying the market at the root account
Fields available in actions:
- customer id
- parent customer id
- parent customer id (old)
- account number
- parent account number
- parent account number (old)
- invoice responsible
- invoice responsible (old)
- account type
- account status
- market
- market (old)
Considerations
To modify a corporate structure via the Web API, the Customer Service ModifyCorporateAccount operation should be called. With this API you can both reparent any number of accounts and the invoice responsibility of any number of accounts in the structure in the same API call. The resulting structure must be valid with regard to invoice responsibility, market and billing cycles. A Corporate Account Modified trigger will be fired for each account modified by this call.
In the web services, changing a corporate structure market will fire both the CorporateAccountModified trigger and the CustomerModified trigger for each account in the structure.
In IDI Desktop Client, you must remove a child from a corporate structure before reparenting it.
In IDI Desktop Client, you can change invoice responsibility on only a single account at a time. When changing the invoice responsibility of the account, the resulting structure must still be valid. A Corporate Account Modified trigger will be fired for the modified account.
In IDI Desktop Client, you can also change the market of the entire structure. This will cause a Corporate Account Modified trigger will be fired for each account in the tree.
In both IDI Desktop Client and the web apps, you cannot change the market of a corporate structure and toggle invoice responsibility or reparent accounts in the same action.
