Custom Fields Description

Introduction

This article describes how Custom Properties work in the Platform. Custom Properties are additional details that Distributors or Sellers can add to Organizations, Subscriptions, and Offers. These properties are managed and displayed on the user interface, and can be synchronized with ERP or CRM systems.

In this article:

• Valid data formats for Custom Properties
• Editing Custom Properties

• Examples of properties in the UI

   

Valid Data Formats for Custom Properties

The following data formats are supported for Custom Properties:

• Name
• String
• Integer
• Boolean
• Single List
• Multi List

Each partner can define whether a template should be inherited by their "child" partners and platforms.

Editing Custom Properties

Users can edit values for supported objects either through the UI or via the API.

How to add Custom properties through API:

For an Organization	For a Subscription	For Offers
Click here	Click here	Click here

This task can also be submitted to the Support team by submitting a request to support@apxite.com

Note! For now, the properties that are in use (values are applied to the items) cannot be edited and will show this error message:

In the near future the option to add more values to the already existing and used properties will be released.

Examples of the properties in the UI:

For an Organization:

For a Subscription:
Such properties can be added after the subscription is purchased.
If these must be added during the purchase process, check out this article for the supported UI functionality.
For Offers:

Besides from the data formats, added properties are not going to be validated for other formats (such as email or date formats) in the platform and will be portrayed in the Outgoing Invoice section, in such manner:

Summary

Custom Properties allow Distributors and Sellers to add flexible, additional information to Organizations, Subscriptions, and Offers. These properties support multiple data formats and can be managed through the UI or API. While properties currently in use cannot be edited, future updates will expand this functionality.