Data Import/Included Value Import

From Emersion
Revision as of 11:09, 31 July 2015 by Scarpenter (talk)
Jump to: navigation, search


Plan Service Included Value Slot Import Data Definition table
Data field Description
ID The ID of the service plan included value. This is found via Packages and Plans > Management > Service Plans > Included Value tab. If left blank, a new included value structure for the service plan will be created. If an ID is provided, the included value settings will be updated. (optional field)
NAME A name for the included value allowance. (mandatory field)
INCLUDED_VALUE An integer, representing the amount of included value. (mandatory field)
IS_SHARED A flag denoting if any available quota which remains at the end of the period can be shared with other services on the same account with similar shared subscriptions. Accepted values are:
  • 0 Is not shared
  • 1 Is shared

If left blank, 0 will be set. (optional field)

FALLBACK_RATECARD_ID The ID of the rate card that is used once the included value is reached and excess charges commences. The rate card must exist in Emersion. (optional field)
INCLUDED_VALUE_TYPE_ID The type of included value. Accepted values are:
  • Dollars
  • Seconds
  • Kilobytes
  • Units

These fields are case sensitive (mandatory field)

SERVICE_PLAN_ID Service plan this included value is for. The service plan must exist in Emersion, (mandatory field)
INCLUDED_VALUE_SLOT_TYPE_ID The corresponding slot number. Accepted values are:
  • SLOT1
  • SLOT2
  • SLOT3
  • SLOT4

These fields are case sensitive (mandatory field)

EXTERNAL_NAME The ‘external’ name is the vanity name for this included value allowance that will be used on any external or public facing interface or invoice. (mandatory field)
INCVAL_PRORATA A flag denoting whether the allowance is pro-rated when a short period exists. Accepted values are:
  • 0 allowance is not pro-rated
  • 1 allowance is pro-rated

If left blank, 1 will be set. (optional field)

SHARE_KEY When shared (Is Shared = 1), you can optionally share the plan service included value using a text string. If Is Shared = 0, this information will be discarded.