Order Organizations

Partner Hub
1

Order Organizations

:information_source: At the time of writing (june 2022), configuration of Order Organizations and Order Organization Groups through the user interface will be handled by C&B staff on the partners’ behalf. Partners requiring more flexibility and control can create and maintain both of them through the API.

Typically, the recipient of an Order or Referral will be identical to the Resource Group that’s offering the Product, and that’s also the default option when setting up a new Product. However, if the Partner is acting as a “distribution hub”, the recipient might be a third-party stakeholder unknown to RealEquity. In order to support such cases, it’s possible to create and group independent Order Organizations.

:information_source: Order Organizations and Order Recipients: At the time of writing (april 2022), Order Organizations are also referred to as Order Recipients in different parts of the user interface, and where they’re referred to from other Entities.

:warning: Order Organizations aren’t Actors: Order Organizations are separate Entities that only add a simple “description” property to their inherited Data Node properties.

Information required to handle Order Organizations manually

As an Entity, an Order Organization is basically just a flag designating, through it’s “displayName” property inherited from the Data Node, and an additional textual “description” property, which third-party stakeholder is the intended recipient.

The distribution of the order or referral to the designated recipient might be handled manually through the user interface, but its more likely that partners using this feature will want to do so using a system-to-system integration.

Information Type Description
Order Organization Name String (Required) The name of the Order Organization. Sets the displayName property inherited from the Data Node.
Order Organization Description String (Optional) The description of the Order Organization. Sets the description property of the Order Organization Entity.
Active Boolean (Required) Controls whether the Order Organization is active for selection in the user interface. Sets the active property of the Order Organization Entity.

Information required in order to handle Order Organization Groups manually

Order Organizations can be organized into a hierarchy of multiple levels of Order Organization Groups. This is very convenient when administering Order Organizations programmatically or through the user interface, but it doesn’t affect how an order or referral is received. Order Organization Groups are specializations of the Folder Entity.

:information_source: An order or referral can only be sent to one Order Organization, not a whole group. The purpose of the group is to make it easier to identify the right Order Organization to select.

Information Type Description
Order Organization Group Name String (Required) The name of the Order Organization Group. Sets the “displayName” property inherited from the Data Node.

For example, if Recipient A of Group B is configured as a “specific recipient” on Product C, only a direct reference to the Order Organization Entity of Recipient A will be made in the Referral.