Fonteva

Developer Documentation

Modals

Modals are used throughout the product to provide users with a simple way to modify records, view information, and navigate through a wizard.

Markup

<div class="slds-modal">
  <div class="slds-modal__container">
    <div class="slds-modal__header">
      <button class="slds-button slds-modal__close slds-button--icon-inverse">
        <lightning:icon iconName="utility:close" size="medium" />
      </button>
      <div class="slds-text-heading_medium">Title</div>
    </div>
    <div class="slds-modal__content slds-p-vertical_medium slds-p-horizontal_large">
      ...
    </div>
    <div class="slds-modal__footer">
      <button class="slds-button slds-button_neutral">
        ...
      </button>
      <button class="slds-button slds-button_brand">
        ...
      </button>
    </div>
  </div>
</div>
<div class="slds-backdrop" />
...
<div class="slds-modal__content slds-p-vertical_medium slds-p-horizontal_large">
  <div>...</div>
  <div class="slds-grid slds-gutters_x-small">
    <div class="slds-col">
      ...
    </div>
    <div class="slds-col">
      ...
    </div>
  </div>
  <div class="slds-grid slds-wrap slds-gutters_x-small">
    <div class="slds-col slds-medium-size_*-of-* slds-large-size_*-of-*">
      ...
    </div>
    <div class="slds-col slds-medium-size_*-of-* slds-large-size_*-of-*">
      ...
    </div>
  </div>
</div>
...
...
<div class="slds-modal__header slds-modal__header_empty">
  <button class="slds-button slds-modal__close slds-button--icon-inverse">
    <lightning:icon iconName="utility:close" size="medium" />
  </button>
</div>
...
...
<div class="slds-modal__footer">
  <button class="slds-button slds-button_neutral">
    ...
  </button>
  <button class="slds-button slds-button_brand">
    ...
  </button>
</div>
...

AnalyticsEvent

AnalyticsEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eventString false pageview
pageNameString true
trackerIdString false UA-35884772-9

BaseComponent

BaseComponent
For more information on configuring Quick Actions, please visit Salesforce Help

Button

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
additionalClassesString false
dataAttributesMap Data attributes false {}
disableBoolean Disable Button false false
enableProgressIndicatorBoolean Progress Indicator false true
groupString false
imageClassesString Image Src false
imageSrcString Image Src false
isSubmitButtonBoolean false false
labelString false
lightningIconString Icon to load from Lightning:Icon component. false
lightningIconSizeString Size of icon to load from Lightning:Icon component. false medium
lightningIconVariantString Variant property for Lightning Icon false inverse
nameString false
onClickActionAura.Action This allows handling onClick events true
progressIndicatorLocationString Progress Indicator Location false expand-right
svgAssistiveTextString Image Src false
svgClassString Image Src false
svgContainerClassString Image Src false
svgPathString Image Src false
typeString false brand
valueString false

Methods

  • startIndicator()
  • stopIndicator(disable)
  • Parameters
    disable
    Type: Boolean
    Description:
    Required?: false
  • updateLabel(label)
  • Parameters
    label
    Type: String
    Description: Label For Button
    Required?: false

ButtonToggleIndicatorEvent

ButtonToggleIndicatorEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString false toggle
groupString false

CurrencyField

For more information on configuring Quick Actions, please visit Salesforce Help

		Example for CurrencyField
	

Component Attributes

Attribute Name Attribute Type Description Required Default
currencyISOCodeString true
formattedValueString false
isMultiCurrencyOrgBoolean false false
showFreeLabelBoolean false true
valueString false 0

FileUploadCropEvent

FileUploadCropEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString true
fieldIdString true

Img

Img
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
altString the img tag alt text false
classString the img tag class false
extraString comma-separated `key=value` to add extra attributes to the img tag false
heightString the img tag height false
idString the img tag id false
onclickAura.Action A callback for onclick events false
srcString the img tag source false
styleString the img tag style false
titleString the img tag title false
widthString the img tag width false

InputFieldClearErrorMessagesEvent

InputFieldClearErrorMessagesEvent
For more information on configuring Quick Actions, please visit Salesforce Help

InputFieldValidationEvent

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

InputFieldValueChangedEvent

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
fieldIdString true
groupString false
oldValueObject false
optionsList false
secondaryGroupString false
valueObject false

InputFields

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
customFieldTypeBoolean Custom Field Type false false
disableRadioEventBoolean Disable Radio Event false false
disabledBoolean Disable Field false false
errorsList Errors false []
fieldNameString false
fieldTypeString input type field false
fireChangeEventBoolean Fire Change Event false false
formatString Format for field false
globalIdString Global Id false
groupString Group name false
helpTextString Help Text false
idString false
isBooleanBoolean false false
isRequiredBoolean input value false false
labelString input name false
labelStyleClassesString Addition CSS Classes for label false
linkTextString false
linkTextActionAura.Action false
loadingBoolean Loaded false true
maxValueValidationMessageString false Input max value is:
maxlengthInteger input length false
minValueValidationMessageString false Input must be greater than:
otherAttributesMap Other Attributes false {}
sObjectNameString false
secondaryGroupString Group name false
secondaryIdString false
selectOptionsList select options false
styleClassesString Addition CSS Classes false
stylesheetString input stylesheet false
suppressValidationMessagesBoolean false false
useSecondaryIdBoolean false false
validatedBoolean Validated false true
valueMap input value false {}

Methods

  • changeFieldType(fieldType, value, otherAttributes)
  • Change Field Type

    Parameters
    fieldType
    Type: String
    Description:
    Required?: true
    value
    Type: String
    Description: SelectedValue
    Required?: false
    otherAttributes
    Type: Object
    Description: SelectedValue
    Required?: false
  • clearErrorMessages()
  • Error Message For Field

  • clearOptions()
  • Clear Options available for the input

  • clearValue()
  • Clear Value via Method

  • reInitialize()
  • Reinitialize Comp

  • setErrorMessages(errorMessages)
  • Set Error Messages

    Parameters
    errorMessages
    Type: Array
    Description: Error Message
    Required?: false
  • setOtherAttributes(otherAttributes, forceReInitialization)
  • Set Other Attributes

    Parameters
    otherAttributes
    Type: Object
    Description: Other Attributes
    Required?: false
    forceReInitialization
    Type: Boolean
    Description: Force ReInitialization
    Required?: false
  • setSelectOptions(selectOptions, value)
  • Validate Field

    Parameters
    selectOptions
    Type: Array
    Description: Select Options
    Required?: false
    value
    Type: String
    Description: SelectedValue
    Required?: false
  • updateValue(value, refresh)
  • Update Value via Method

    Parameters
    value
    Type: String
    Description: Value To Set
    Required?: false
    refresh
    Type: Boolean
    Description: Fires input change event
    Required?: false
  • validate()
  • Validate Field

MessagePrompt

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
cancelButtonLabelString false Close
closeOnClickActionAura.Action This allows handling onClick events false {!c.hideModal}
enableSubmitButtonProgressIndicatorBoolean false true
idString false
messageString true
preFormatTextBoolean false false
severityString false info
showCancelButtonBoolean false true
showSubmitButtonBoolean false true
submitButtonLabelString false Submit
submitOnClickActionAura.Action This allows handling onClick events false {!c.hideModal}
titleString true

Methods

  • hideModal()
  • Modal Modal

  • showModal()
  • Show Modal

  • stopIndicator()
  • Stop Indicator

  • updateMessage(message)
  • Update Message

    Parameters
    message
    Type: String
    Description:
    Required?: true
  • updateTitle(title)
  • Update Title

    Parameters
    title
    Type: String
    Description:
    Required?: true

RefreshComponentEvent

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

RefreshInputField

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
dataObject false {}
groupString false
refreshBoolean false
typeString false

RichTextInputFieldModalEvent

RichTextInputFieldModalEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString true
fieldIdString true

SVG

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
assistiveTextString Description name of icon false
classString the class of this SVG tag, can be use for CSS purpose false
containerClassString Container class name for span container of icon false
nameString Symbol name of icon false
namespaceString Namespace false
svgClassString Class for SVG false
svgPathString the path for the icon in the static resource, this will be use in a SVG use tag false

ShowComponentEvent

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
componentNameString false
componentParamsObject false {}
identifierString false

Spinner

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Toast

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Methods

  • showMessage(title, message, autoHide, severity, position)
  • Parameters
    title
    Type: String
    Description:
    Required?: false
    message
    Type: String
    Description:
    Required?: false
    autoHide
    Type: Boolean
    Description:
    Required?: false
    severity
    Type: String
    Description:
    Required?: false
    position
    Type: String
    Description:
    Required?: false
  • showMessages(messages)
  • Parameters
    messages
    Type: List
    Description:
    Required?: false

Tooltip

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
helpTextString Help Text false

UIApi

UIApi
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
uniqueIdString true

UIApiResponseEvent

UIApiResponseEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
fieldsMap true
uniqueIdString true

UrlUtil

A method-only component containing methods dealing with URLs
For more information on configuring Quick Actions, please visit Salesforce Help

Methods

  • getTimedDirectLink(url, callback)
  • When passed a URL targeting /apex/AwsProxy, will return a signed, timed link direct to AWS. Otherwise returns the caller's URL. URL is the only parameter provided to the callback.

    Parameters
    url
    Type: String
    Description:
    Required?: false
    callback
    Type: Function
    Description:
    Required?: false
  • wrapLinks(cmp, attrNames, callback)
  • Performs `getDirectTimedLink` against all of the `attrNames` stored in `cmp`.

    Parameters
    cmp
    Type: Component
    Description:
    Required?: true
    attrNames
    Type: Object[]
    Description:
    Required?: true
    callback
    Type: Function
    Description:
    Required?: false

ValidationErrorMessages

ValidationErrorMessages
For more information on configuring Quick Actions, please visit Salesforce Help

Methods

  • hideMessages()
  • showMessages(messages)
  • Parameters
    messages
    Type: List
    Description:
    Required?: false

BaseComponent

BaseComponent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
disableThemeValueBoolean false false
isAuthenticatedBoolean false false
isRecordPreviewBoolean false false
organizationIdString false
salesOrderString false
siteIdValueString false
siteObjSiteRecord false
storeObjStore false
themeObjTheme false
usrMap false {}

BaseComponentLoadCompleteEvent

BaseComponentLoadCompleteEvent
For more information on configuring Quick Actions, please visit Salesforce Help

CookieUsagePrompt

CookieUsagePrompt
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
contactString Contact to load to check if cookie prompt is already accepted or not false
isGuestBoolean false false
isThemedBoolean Boolean to toggle the community theme or not false true
siteString Site to load to check if cookie prompt is required true

FontevaBaseInterface

FontevaBaseInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
identifierString false
isPreviewBoolean false
paramsMap false

FontevaController

Fonteva Controller
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
disableRoutingBoolean false false
disableThemeBoolean false false
isPreviewBoolean false false
recordIdString false
siteIdString false
urlVarsObject false

MediaAssetUploadQuickAction

MediaAssetUploadQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

ThemeBuilderQuickAction

ThemeBuilderQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

AccessPermission

AccessPermission
For more information on configuring Quick Actions, please visit Salesforce Help

AccessPermissionQuickAction

AccessPermissionQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

AdminAppConfig

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
appConfigObjObject false
newAppConfigObjObject false
settingObjsList false []

AmendSubscription

AmendSubscription
For more information on configuring Quick Actions, please visit Salesforce Help

CheckoutWrapper

CheckoutAddress
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
customerIdString false
environmentKeyString false
gatewayTokenString false
iFrameStylesString false
isThemedBoolean false true
offsiteRedirectUrlString false
paymentPageLoadedBoolean false false
paymentSuccessReturnObjMap false
postbackRedirectUrlString false
redirectUrlString false
retURLString false
returnObjMap false
salesOrderIdString false
salesOrderObjMap false {}
showOfflinePaymentBoolean false false
showProformaPaymentBoolean false false
storeIdId false
successfulPaymentReturnUrlString false

ContactCreatedEvent

ContactCreatedEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
accountIdString false
contactIdString false
uniqueIdentifierString true

ContactPopover

ContactPopover
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
accountIdString false
customerObjMap false {}
positionString false left
uniqueIdentifierString true customerLookup

Methods

  • closePopover()
  • setNameValues(firstName, lastName, accountId)
  • Parameters
    firstName
    Type: String
    Description:
    Required?: false
    lastName
    Type: String
    Description:
    Required?: false
    accountId
    Type: String
    Description:
    Required?: false
  • showPopover()

CustomPaymentTypeActionEvent

CustomPaymentTypeActionEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
paramsMap false {}
typeString true

CustomPaymentTypeInterface

CustomPaymentTypeInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
customPaymentTypeObjMap true
epaymentString false
iFrameStylesString false
pathPrefixString false
salesOrderString false

CustomerLookup

For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
autoHideContactBoolean false true
contactIdString false contactId
contactLabelString false Contact
contactNubbinLocationString false right
customerObjMap false {}
fireChangeEventBoolean input value false false
globalConIdString Global Value false
groupString Group name false
isRequiredBoolean input value false false
labelString false {!$Label.c.CustomerLookupLabel}
sldsIconResourceString false OrderApi__SLDS_Icons
validatedBoolean false false
valueMap false {}

Methods

  • showContactField()
  • updateValue(value, contact, fireChangeEvent)
  • Parameters
    value
    Type: String
    Description: Value To Set
    Required?: false
    contact
    Type: String
    Description: Value To Set
    Required?: false
    fireChangeEvent
    Type: Boolean
    Description: input value
    Required?: false
  • validate()

CustomerLookupFilterUpdatedEvent

CustomerLookupFilterUpdatedEvent
For more information on configuring Quick Actions, please visit Salesforce Help

InvoicePayment

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
storeIdId false

KnownAddressChangeEvent

KnownAddressChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
uniqueIdString true
valueObject false

KnownAddressModalEvent

KnownAddressModalEvent indicates that the modal has been displayed.
For more information on configuring Quick Actions, please visit Salesforce Help

KnownAddresses

KnownAddresses
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
contactIdString true
createModalAddressHeaderString false {!$Label.c.Known_Address_New_Address_Modal_Header}
editModalAddressHeaderString false {!$Label.c.Known_Address_Edit_Address_Modal_Header}
knownAddressObjMap false
knownAddressesKnownAddress[] false
loadKnownAddressesBoolean false true
showNoAddressTextBoolean false false
showSummaryBoolean false false
uniqueIdString false
useBackdropBoolean false true
validatedBoolean false false
valueMap false {}

Methods

  • resetToDefaultAddress()
  • validate()
  • validateSummaryAddress()

KnownAddressesModal

CheckoutAddressModal
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
contactIdString true
createModalAddressHeaderString false New Address
editModalAddressHeaderString false Edit Address
uniqueIdString false
useBackdropBoolean false true
valueMap false {}

Methods

  • closeModal()
  • Close Modal

  • showModal(isNew, isFirst)
  • Show Modal

    Parameters
    isNew
    Type: Boolean
    Description:
    Required?: false
    isFirst
    Type: Boolean
    Description:
    Required?: false

ManageAddress

ManageAddress
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
hideHeaderBoolean false false
isThemedBoolean false false
recordIdId false

ManageKnownAddressesQuickAction

ManageKnownAddressesQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

ManageRenewalPathsQuickAction

ManageRenewalPathsQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

ManageSubscriptionPlansQuickAction

ManageSubscriptionPlansQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

PackageItemsListing

PackageItemsListing
For more information on configuring Quick Actions, please visit Salesforce Help

PayNow

PayNow
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eCheckRedirectUrlString false
enableSavePaymentBoolean false true
environmentKeyString true
iFrameStylesString false
isFrontEndBoolean false true
isSalesOrderBoolean false true
offsiteRedirectUrlString false
overridePaymentMethodString false
pathPrefixString false
paymentObjMap false {}
paymentSuccessReturnObjMap false
postbackRedirectUrlString false
recordIdString false
renderAsTabsBoolean false false
requireSavePaymentMethodBoolean false false
showOfflinePaymentBoolean false false
storeIdString false
successRedirectUrlString false
suppressOffsiteButtonsBoolean false false

Methods

  • processTokenPayment()
  • validateTokenPayment()

PayNowTabChangeEvent

PayNowTabChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
currentTabString true
customTabBoolean false false
showCustomButtonBoolean false false

PayPalPaymentType

PayPalPaymentType
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentGatewayListing

PackageItemsListing
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentGatewaysQuickAction

PaymentGatewaysQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentMethodChangeEvent

PaymentMethodChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentMethodTabsLT

PaymentMethodTabsLT
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentMethodTabsVF

PaymentMethodTabsVF
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentMethods

PaymentMethods
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
hideHeaderBoolean false false
paymentGatewayPaymentGateway false
recordIdId false
singleGatewayToUseString false

PaymentMethodsInterface

PaymentMethodsInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
componentToCreateString true
contactIdString true
contactNameString false
paymentGatewayMap false
paymentMethodsObject[] false []

PaymentMethodsPaypal

PaymentMethodsPaypal
For more information on configuring Quick Actions, please visit Salesforce Help

PriceRules

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

PriceRulesQuickAction

PriceRulesQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

ProcessingChangesEvent

ProcessingChangesEvent
For more information on configuring Quick Actions, please visit Salesforce Help

RefreshItems

RefreshItems
For more information on configuring Quick Actions, please visit Salesforce Help

Refunds

Refunds
For more information on configuring Quick Actions, please visit Salesforce Help

RenewSubscription

RenewSubscription
For more information on configuring Quick Actions, please visit Salesforce Help

SalesOrderInvoice

For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
dateFormatString true
retURLString false
returnObjMap false
salesOrderIdString false

SalesOrderProformaInvoice

For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
retURLString false
returnObjMap false
salesOrderIdString false

SalesOrderShipping

SalesOrderShipping
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
addressNotFoundTextString false {!$Label.c.Known_Address_None_Found}
isPortalBoolean false false
noAddressesFoundBoolean false false
salesOrderObject false {}
shippingObjMap false {}
validatedBoolean false false

SalesOrderUpdateEvent

SalesOrderUpdateEvent
For more information on configuring Quick Actions, please visit Salesforce Help

SalesOrders

For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
customerObjMap false {}
dateFormatString false
eCheckRedirectUrlString false
enableSavePaymentBoolean false true
environmentKeyString false
gatewayTokenString false
isCommunityViewBoolean false false
paymentPageLoadedBoolean false false
paymentSuccessReturnObjMap false
retURLString false
returnObjMap false
salesOrderIdString false
showHeaderButtonsBoolean false true
showOfflinePaymentBoolean false true
storeIdId false
successfulPaymentReturnUrlString false

SaveKnownAddressEvent

SaveKnownAddressEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
idString false
typeString false new
uniqueIdString false

SubmitOffsitePaymentEvent

SubmitOffsitePaymentEvent
For more information on configuring Quick Actions, please visit Salesforce Help

ToggleKnownAddressSummaryEvent

ToggleKnownAddressSummaryEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
showSummaryBoolean false false
uniqueIdString true

DeleteFilterRow

For more information on configuring Quick Actions, please visit Salesforce Help

EditLightingCompInterface

EditLightingCompInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
indexInteger false
pageComponentMap true
validatedBoolean false true

EventAgendaCriteria

EventAgendaCriteria
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeesLabelString attendees input field name false {!$Label.c.Event_Builder_Agenda_Attendees}
customListList[] false []
dateFormatString true
dayLabelBoolean days input field name false {!$Label.c.Event_Builder_Agenda_Day}
fieldOptionsObjMap false {}
headingLabelString label is used for main header false {!$Label.c.Event_Builder_Agenda_Search_and_Filter_Schedule_Items}
isCustomListBoolean false false
isPortalBoolean false false
sessionSearchLabelString session input field name false {!$Label.c.Event_Builder_Agenda_Schedule_Item_Search}
sortByLabelBoolean sort by input field name false {!$Label.c.Event_Builder_Agenda_Sort_By}
speakerLabelString speakers input field name false {!$Label.c.Event_Builder_Agenda_Speaker}
styleClassesString Addition CSS Classes false
trackLabelBoolean tracks input field name false {!$Label.c.Event_Builder_Agenda_Track}

Methods

  • filterScheduleItems(eventAgendaCriteriaObj)
  • This method filters and returns back the filtered schedule items.

    Parameters
    eventAgendaCriteriaObj
    Type: Map
    Description: Filter Parameter
    Required?: false

EventAgendaFilterEvent

EventAgendaFilterEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eventAgendaCriteriaObjMap false {}
fieldIdString false

EventBuilderEditor

EventBuilderEditor
For more information on configuring Quick Actions, please visit Salesforce Help

EventBuilderQuickAction

EventBuilderQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

EventBuilderTabInterface

EventBuilderTabInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eventObjMap false
sitesList false

EventBuilderWrapper

EventBuilderWrapper
For more information on configuring Quick Actions, please visit Salesforce Help

EventCategories

EventCategories
For more information on configuring Quick Actions, please visit Salesforce Help

AccountSearchComponent

AccountSearchComponent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
queryFilterString additional query filter to narrow down the accounts returned in the result false
storeObjStore false
valueMap input value false {}

BaseComponent

BaseComponent
For more information on configuring Quick Actions, please visit Salesforce Help

BuildEventPageEvent

BuildEventPageEvent
For more information on configuring Quick Actions, please visit Salesforce Help

ConferenceEvent

ConferenceEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventActionButtons

EventActionButtons
For more information on configuring Quick Actions, please visit Salesforce Help

Methods

  • stopIndicator(id)
  • Modal Modal

    Parameters
    id
    Type: String
    Description:
    Required?: true

EventAgenda

EventAgenda
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjAttendeeRecord false
previousComponentString false
readOnlyBoolean false true
showPurchaseBoolean false false

EventAgendaModal

EventAgendaModal
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjAttendeeRecord false
initialPurchaseBoolean false true
readOnlyBoolean false true
showPurchaseBoolean false false

EventAgendaSection

EventAgendaSection
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
initialPurchaseBoolean false true
readOnlyBoolean true
sessionMap true
showPurchaseBoolean false false

EventAgendaSectionItem

EventAgendaSectionItem
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
initialPurchaseBoolean false true
itemMap true
readOnlyBoolean false
showPurchaseBoolean false false

EventCancelRegistrationEvent

EventCancelRegistrationEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventChangePageEvent

EventChangePageEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomHTML

EventCustomHTML
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomHTMLEdit

EventCustomHTMLEdit
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomImage

EventCustomImage
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomImageEdit

EventCustomImageEdit
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomVideo

EventCustomVideo
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomVideoEdit

EventCustomVideoEdit
For more information on configuring Quick Actions, please visit Salesforce Help

EventInterface

EventInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap false
componentObjMap false
directionString false next
eventObjMap false
identifierBoolean false
initialPurchaseBoolean false
isPreviewBoolean false false
readOnlyBoolean false false
salesOrderString false
salesOrderObjMap false
siteObjMap false
storeObjMap false
usrMap false

EventMainView

ConfEventMainView
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventOverview

EventOverview
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventPaymentReceipt

EventPaymentReceipt
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventPrimaryVenue

EventPrimaryVenue
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegAttendeeChangeEvent

EventRegAttendeeChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegSeatingSeat

EventRegSeatingSeat
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegSeatingSection

EventRegSeatingSection
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegisterButtonToggleEvent

EventRegisterButtonToggleEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationAttendee

EventRegistrationAttendee
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
disableRemoveBoolean false false
eventObjMap false
fireChangeEventBoolean false true
indexInteger false -1
isAuthenticatedBoolean false true
isGuestBoolean false false
isSalesOrderLineBoolean false true
isWaitlistBoolean false false
labelString false {!$Label.c.Search_Attendee_Field_Label}
labelStyleClassesString false hidden
lineMap true
primaryRegistrationInvitationBoolean false false
salesOrderIdString false
salesOrderObjMap salesOrderObj false {}
showAttendeeLabelBoolean false false
showHorizontalPaddingBoolean false true
storeObjMap true

EventRegistrationAttendeeSelection

EventRegistrationAttendeeSelection
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
initialPurchaseBoolean false true
previousComponentString false

EventRegistrationAttendeeUpdateEvent

EventRegistrationAttendeeUpdateEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
assignmentAssignment false
linesSalesOrderLine[] false
salesOrderLineSalesOrderLine false
salesOrderObjMap false
waitlistWaitlistEntry false

EventRegistrationCheckoutSummary

EventRegistrationCheckoutSummary
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
previousComponentString false

EventRegistrationFlowDetails

EventRegistrationFlowDetails
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap false

EventRegistrationForm

EventRegistrationForm
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationForms

EventRegistrationForms
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
disableNavigationButtonsBoolean false false
isTicketFormsBoolean false true
previousComponentString false
subjectLookupFieldString false OrderApi__Assignment__c

EventRegistrationInvitationOnly

EventRegistrationInvitationOnly
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
showRegisterButtonBoolean false true

EventRegistrationSeatingAssignment

EventRegistrationSeatingAssignment
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationSeatingTicket

EventRegistrationSeatingTicket
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationSeatingTickets

EventRegistrationSeatingTickets
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationSeatingWrapper

EventRegistrationSeatingWrapper
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationTicketSelection

EventRegistrationTicketSelection
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
linesByTicketList false
showRegisterButtonBoolean false false
ticketPurchaseObjObject false

EventRegistrationWrapper

EventRegistrationWrapper
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
agendaOnlyBoolean false false
initialPurchaseBoolean false true
readOnlyBoolean false true
secondaryCompNameString false

EventSecondaryVenues

EventSecondaryVenues
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

EventSpeakers

EventSpeakers
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventSponsorPackages

EventSponsorPackages
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventSponsors

EventSponsors
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventToggleSideNavEvent

EventToggleSideNavEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventVenueMap

EventVenueMap
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

EventWrapper

EventWrapper
For more information on configuring Quick Actions, please visit Salesforce Help

FeaturedEventSpeakers

FeaturedEventSpeakers
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

FeaturedEventSponsors

FeaturedEventSponsors
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

FontevaBaseInterface

FontevaBaseInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
identifierString false
paramsMap false

FontevaController

Fonteva Controller (DO NOT USE)
For more information on configuring Quick Actions, please visit Salesforce Help

Login

Login
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eventIdString false
loginDataMap false {}
returnUrlString false
showOverviewBoolean false false
siteObjMap false
storeObjMap false

LoginComponentEvent

LoginComponentEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
cancelLoginProcessBoolean false
enabledBoolean false
guestContactMap false
showOverviewBoolean false false

ManageMyRegistration

ManageMyRegistration
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

MyAttendeeForm

MyAttendeeForm
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap true
attendeesObject[] false

MyAttendeeSessionForms

MyAttendeeSessionForms
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap true

MyAttendees

MyAttendees
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeesAttendeeRecord[] false

MyAttendeesForms

MyAttendeesForms
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Receipt

Receipt
For more information on configuring Quick Actions, please visit Salesforce Help

RegistrationProcessChangeEvent

RegistrationProcessChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString true
componentString false
salesOrderObjMap false

RegistrationProcessCompleteEvent

RegistrationProcessCompleteEvent
For more information on configuring Quick Actions, please visit Salesforce Help

RegistrationProcessSetGlobalObjectsEvent

RegistrationProcessSetGlobalObjectsEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap false
salesOrderObjMap false

RegistrationToolbarUpdateEvent

RegistrationToolbarUpdateEvent
For more information on configuring Quick Actions, please visit Salesforce Help

ReloadAttendeesEvent

ReloadAttendeesEvent
For more information on configuring Quick Actions, please visit Salesforce Help

RequiredPackageItemClassEvent

RequiredPackageItemClassEvent
For more information on configuring Quick Actions, please visit Salesforce Help

SalesOrderLineDeletedEvent

SalesOrderLineDeletedEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
soMap updated salesorder obj false
solIdString sol to be deleted false

SeatSelectedEvent

SeatSelectedEvent
For more information on configuring Quick Actions, please visit Salesforce Help

SessionSelectEvent

SessionSelectEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
allowConflictsboolean Shows if selected session allow conflicts false false
fireServerCallboolean fire apex method to create session items false false
sessionstring Session Selected true
sessionItemstring Session Selected true
sessionSelectedboolean Session Selected or removed true
ticketTypesList ticketType sols selected for the session false []
waitlistedboolean Session Selected as waitlist false false

ShowSeatingTicketsEvent

ShowSeatingTicketsEvent
For more information on configuring Quick Actions, please visit Salesforce Help

ToggleOrderSummaryCloseButtonEvent

ToggleOrderSummaryCloseButtonEvent
For more information on configuring Quick Actions, please visit Salesforce Help

TransferAttendeeRegistration

TransferAttendeeRegistration
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeMap attendee is an object to transfer contact to false {}
attendeeObjMap attendeeObj is a current user attendee false {}

TransitionAttendeeModal

TransitionAttendeeModal
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString false
classString false

ViewSectionEvent

ViewSectionEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Api

Api Service, Resource, and Mapping objects

Methods

This component supports the following methods.

getAPIGroupings:
global static List<Grouping> getAPIGroupings(String apiService)
Method Arguments
Name Type Description
apiService String
Returns: List<Api.Grouping> -
getDispatchObjs:
global static List<Dispatch> getDispatchObjs()
getDispatchObjs:
global static List<Dispatch> getDispatchObjs(String apiService)
Method Arguments
Name Type Description
apiService String
Returns: List<Api.Dispatch> -
getService:
global static Service getService(String apiService)
Method Arguments
Name Type Description
apiService String {String} Api.Service.name
Returns: Api.Service - Service
getServices:
global static Service[] getServices(String namespace)
Method Arguments
Name Type Description
namespace String
Returns: List<Api.Service> - Service[] list of all Api.Service objects configured
getServices:
global static Service[] getServices()
getResources: Returns Api.Resource objects related to the given apiService {Api.Service.name}, and apiObject {Api.Resource.apiObject}
global static Resource[] getResources(String apiService)
Method Arguments
Name Type Description
apiService String {String} value for Api.Service.name
Returns: List<Api.Resource> - Api.Resource[]
getResourcesByGrouping: Returns Api.Resource objects related to the given apiGrouping {Api.Grouping.name}
global static Resource[] getResourcesByGrouping(String apiGrouping)
Method Arguments
Name Type Description
apiGrouping String {String} value for Api.Grouping.name
Returns: List<Api.Resource> - Api.Resource[]
getAllResources: Returns all Api.Resource objects
global static Resource[] getAllResources()
getServiceConnections: Returns Api.ServiceConnection objects related to the given apiService {Api.Service.name}
global static ServiceConnection[] getServiceConnections(String apiService)
Method Arguments
Name Type Description
apiService String {String} value for Api.Service.name
Returns: List<Api.ServiceConnection> - Api.ServiceConnection[]
getServiceConnectionConfig: Return Api.ServiceConnectionConfig object based on name and connection
global static ServiceConnectionConfig getServiceConnectionConfig(String serviceConnection,String name)
Method Arguments
Name Type Description
serviceConnection String String name
name String String name of config value
Returns: Api.ServiceConnectionConfig - ServiceConnectionConfig obj
setDailyCalloutLimitConfig: Set the Daily Limit of HTTP callouts for each service connection
global static Api.ServiceConnectionConfig setDailyCalloutLimitConfig(String apiServiceConnection,Integer dailyLimit)
Method Arguments
Name Type Description
apiServiceConnection String String
dailyLimit Integer Integer
Returns: Api.ServiceConnectionConfig - Api.ServiceConnectionConfig
getResource: Returns Api.Resource object related to the given apiService {Api.Service.name}, and apiObject {Api.Resource.apiObject}
global static Resource getResource(String apiService, String targetSObject)
Method Arguments
Name Type Description
apiService String {String} value for Api.Service.name
targetSObject String
Returns: Api.Resource - Api.Resource
getVariables: Returns custom setting Variable objects for making outgoing calls
global static Variable[] getVariables(String apiResource)
Method Arguments
Name Type Description
apiResource String {String} value for Api.Resource object
Returns: List<Api.Variable> - List<Api.Variable> objects
getMappings: Returns all Api.Mapping objects related to a given Api.Service found by {String} apiService, and {String} apiObject
global static Mapping[] getMappings(String apiResource, String apiObject)
Method Arguments
Name Type Description
apiResource String
apiObject String {String} value for the Api.Resource.apiObject
Returns: List<Api.Mapping> - Api.Mapping[]
getMapping: Returns Api.Mapping object related to the given apiService {Api.Service.name}, apiObject {Api.Resource.apiObject}, and apiField {Api.Mapping.apiField}
global static Mapping getMapping(String apiResource, String apiObject, String apiField)
Method Arguments
Name Type Description
apiResource String
apiObject String {String} value for the Api.Resource.apiObject
apiField String {String} value for the Api.Mapping.apiField
Returns: Api.Mapping - Api.Mapping
deserialize: Returns a new SObject for the given apiService {Api.Service.name} and Dom.XmlNode (must have a root element matching a Api.Resource related to the Api.Service returned by the apiName {String})
global static SObject[] deserialize(String apiService, Dom.XmlNode node)
Method Arguments
Name Type Description
apiService String {String} Name of the Api.Service object to find
node Dom.XmlNode {Dom.XmlNode} XML node where the root element matches
Returns: List<SObject> - SObject[]
getPreviousJSONResponse: Get Previous JSON response based on Api.Resource and the HTTP Verb that was used. This method allows dev to get old responses to pull out data needed.
global static Map<String,Object> getPreviousJSONResponse(Api.Resource resource, String httpVerb, Integer position)
Method Arguments
Name Type Description
resource Api.Resource Api.Resource
httpVerb String String
position Integer Integer Position the JSON to pull out if the same resource has been called mulitple times
Returns: Map<String, Object> - Map<String,Object> serialize JSON response
getLastJSONResponse: Get Last JSON response based on Api.Resource and the HTTP Verb that was used. This method allows dev to get old responses to pull out data needed.
global static Map<String,Object> getLastJSONResponse(Api.Resource resource, String httpVerb)
Method Arguments
Name Type Description
resource Api.Resource Api.Resource
httpVerb String String
Returns: Map<String, Object> - Map<String,Object> serialize JSON response
getLastRawResponse: Get Last Raw response based on Api.Resource and the HTTP Verb that was used. This method allows dev to get old responses to pull out data needed.
global static String getLastRawResponse(Api.Resource resource, String httpVerb)
Method Arguments
Name Type Description
resource Api.Resource Api.Resource
httpVerb String String
Returns: String - String raw response from vendor
get: Method to get a list of SObjects based on Resource Name
global static List<SObject> get(String resourceName)
Method Arguments
Name Type Description
resourceName String String resource name
Returns: List<SObject> - List<SObject> List of Sobjects that are mapped from JSON
get: Method to get a list of SObjects based on Resource Name with custom config object
global static List<SObject> get(String resourceName,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of Sobjects that are mapped from JSON
post: Method to POST SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> post(String resourceName,SObject sObj)
Method Arguments
Name Type Description
resourceName String String resource name
sObj SObject SObject that will be converted to JSON
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from POST response
post: Method to POST SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> post(String resourceName,SObject sObj,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
sObj SObject SObject that will be converted to JSON
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from POST response
post: Method to POST SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> post(String resourceName,List<SObject> SObjects)
Method Arguments
Name Type Description
resourceName String String resource name
SObjects List<SObject> List<SObject> that will be converted to JSON
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from POST response
post: Method to POST SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> post(String resourceName,List<SObject> SObjects,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
SObjects List<SObject> List<SObject> that will be converted to JSON
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from POST response
put: Method to PUT SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> put(String resourceName,SObject sObj)
Method Arguments
Name Type Description
resourceName String String resource name
sObj SObject SObject that will be converted to JSON
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from PUT response
put: Method to PUT SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> put(String resourceName,SObject sObj,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
sObj SObject SObject that will be converted to JSON
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from PUT response
put: Method to PUT SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> put(String resourceName,List<SObject> SObjects)
Method Arguments
Name Type Description
resourceName String String resource name
SObjects List<SObject> List<SObject> that will be converted to JSON
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from PUT response
put: Method to PUT SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> put(String resourceName,List<SObject> SObjects,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
SObjects List<SObject> List<SObject> that will be converted to JSON
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from PUT response
:
global static String makeRequest(String endpoint,        String uri,        List<String> uriParameters,        Map<String,String> urlParameters,        VendorAuthenticationService vendorAuthService,        String body,        String method,        Map<String,String> headers,        Boolean debugMode,        Boolean retryAuth)

Api.ResourceConfig

Api.ResourceConfig top-level object for configuration of new Api resource network calls

Methods

This component supports the following methods.

ResourceConfig: Constructor that will setup some base information such as parameters, uri parameters, headers
global ResourceConfig()
ResourceConfig: Constructor that will setup some base information such as parameters, uri parameters, headers
global ResourceConfig(Map<String,String> parameters,List<String> uriParameters,Map<String,String> headers)
Method Arguments
Name Type Description
parameters Map<String, String>
uriParameters List<String>
headers Map<String, String>
Returns: Void
setParameters: Set Parameters map for URL calls
global void setParameters(Map<String,String> parameters)
Method Arguments
Name Type Description
parameters Map<String, String> Map<String,String> of GET/POST parameters
Returns: Void
setUriParameters: Set list of URI parameters that will be filled into the URL
global void setUriParameters(List<String> uriParameters)
Method Arguments
Name Type Description
uriParameters List<String> List<String>
Returns: Void
setHeaders: Set Headers Map that will be used for network calls
global void setHeaders(Map<String,String> headers)
Method Arguments
Name Type Description
headers Map<String, String> Map<String,String> key/value pairs of parameters
Returns: Void
setServiceConnection: Set the Service Connection the user would like to use for the outgoing calls
global void setServiceConnection(String serviceConnection)
Method Arguments
Name Type Description
serviceConnection String String name of service connection
Returns: Void
setCheckForExistingRecords: Set the check for existing records or bypass that
global void setCheckForExistingRecords(Boolean checkForExistingRecords)
Method Arguments
Name Type Description
checkForExistingRecords Boolean Boolean
Returns: Void
setRawResponseOnly: Set so that the raw response is saved and no mapping is done
global void setRawResponseOnly(Boolean rawResponseOnly)
Method Arguments
Name Type Description
rawResponseOnly Boolean Boolean
Returns: Void

Api.ServiceConnectionConfig

Multiple configuration values such as scope etc for OAuth calls.
Properties
configId: String
name: String
value: String
isMasked: Boolean
apiServiceConnection: String

Api.ServiceConnection

Service connection class that stores multiple connections tied to a single Service
Properties
configId: String
accessToken: String
refreshToken: String
clientId: String
clientSecret: String
username: String
password: String
apiService: String
isDefault: Boolean
scope: String
configs: List<Api.ServiceConnectionConfig>

Api.Service

Api.Service top-level object for configuration of new Api integrations
Properties
name: String
namespace: String
endpoint: String
isEnabled: Boolean
debugMode: Boolean
apexClass: String
imagePath: String
authType: VendorAuthenticationService.AuthType
displayName: String
description: String
isReadOnly: Boolean
resources: List<Api.Resource>
connections: List<Api.ServiceConnection>

Api.Resource

Api.Resource contains all Api.Mappings related to a given response object

Methods

This component supports the following methods.

setParentGrouping:
global void setParentGrouping(String parentGrouping)
Method Arguments
Name Type Description
parentGrouping String
Returns: Void
getParentGrouping:
global String getParentGrouping()
Properties
configId: String
apiService: String
apiObject: String
targetSObject: String
apiObjectKeyField: String
targetObjectKeyField: String
createURI: String
readURI: String
updateURI: String
deleteURI: String
createVerb: String
readVerb: String
updateVerb: String
deleteVerb: String
disablePostPutParse: Boolean
mappings: List<Api.Mapping>
variables: List<Api.Variable>

Api.Grouping

Api.Grouping individual api Groups under the API.Resource

Methods

This component supports the following methods.

setGroupingId:
global void setGroupingId(String groupingId)
Method Arguments
Name Type Description
groupingId String
Returns: Void
setApiResource:
global void setApiResource(String apiResource)
Method Arguments
Name Type Description
apiResource String
Returns: Void
setApiService:
global void setApiService(String apiService)
Method Arguments
Name Type Description
apiService String
Returns: Void
getApiService:
global String getApiService()
setApiObject:
global void setApiObject(String apiObject)
Method Arguments
Name Type Description
apiObject String
Returns: Void
setTargetrelatedLookupField:
global void setTargetrelatedLookupField(String targetrelatedLookupField)
Method Arguments
Name Type Description
targetrelatedLookupField String
Returns: Void
getGroupingId:
global String getGroupingId()
getApiResource:
global String getApiResource()
getApiObject:
global String getApiObject()
getTargetrelatedLookupField:
global String getTargetrelatedLookupField()

Api.Mapping

Api.Mapping individual api fields mapped to SObjectFields for a given Api.Service and Api.Resource
Properties
configId: String
apiService: String
apiResource: String
apiObject: String
apiField: String
targetField: String
targetFieldType: String
relatedObjectField: String

Api.Variable

Api.Variable that maps to outgoing request variable such as GET variables. Ability to set if field has default value and if it is required
Properties
configId: String
apiResource: String
defaultValue: String
fieldApiName: String
fieldApiValue: String
required: Boolean
deserializeMapping: Map<String, String>
serializeMapping: Map<String, String>

Api.Dispatch

Properties
configId: String
apiResource: String
sObjectName: String
isEnabled: Boolean
afterInsert: Boolean
afterUpdate: Boolean
disableRun: Boolean
executionOrder: Integer
httpVerb: String
apiService: String
dispatchVariables: List<Api.DispatchHeaderVariables>

Api.DispatchHeaderVariables

Properties
configId: String
apiDispatch: String
key: String
value: String
isHeader: Boolean
isVariable: Boolean
isTokenVariable: Boolean
tokenOrder: Integer

ApiOauthController

OAuth controller class that will do the login flow using the interface

Methods

This component supports the following methods.

ApiOauthController:
global ApiOauthController()
getToken: Call Vendor to get the Token based on the OAuth login flow
global PageReference getToken()
login: Login and start OAuth flow to send to vendor site
global PageReference login(String apiConnectionName)
Method Arguments
Name Type Description
apiConnectionName String String of the connection name to use to login
Returns: PageReference - PageReference Send user to vendors login page
login: Login and start OAuth flow to send to vendor site
global PageReference login()

ApiRouteBase

Api Route base for all routes

Methods

This component supports the following methods.

getRoute:
global virtual Blob getRoute()
postRoute:
global virtual Blob postRoute()
putRoute:
global virtual Blob putRoute()
deleteRoute:
global virtual Blob deleteRoute()

ApiRouter

Rest Api Router For Framework

Methods

This component supports the following methods.

get:
global static void get()
post:
global static void post()
put:
global static void put()

ApiRouter.Route

ApiRouter.Route top-level object for configuration of new Api integrations

Methods

This component supports the following methods.

setName:
global void setName(String name)
Method Arguments
Name Type Description
name String
Returns: Void
setApexClass:
global void setApexClass(String apexClass)
Method Arguments
Name Type Description
apexClass String
Returns: Void
getName:
global String getName()
getApexClass:
global String getApexClass()

AppUpdate

Wrapper class for Update Custom Setting

Methods

This component supports the following methods.

get:
global static AppUpdate get(String updateName)
Method Arguments
Name Type Description
updateName String
Returns: AppUpdate -
isActivated:
global static Boolean isActivated(String updateName)
Method Arguments
Name Type Description
updateName String
Returns: Boolean -
isActivated:
global static Boolean isActivated(String updateName, Datetime createdDate)
Method Arguments
Name Type Description
updateName String
createdDate Datetime
Returns: Boolean -
Properties
configId: String
displayName: String
description: String
isActivated: Boolean
apexClass: String
forcedActivationDate: Date
namespace: String

AppUpdateInterface

Interface class for App Updates
Interface

Methods

This component supports the following methods.

activateUpdate:
void activateUpdate()

AwsUtil

AwsUtil provides helper methods to deal with files stored securely in AWS. For internal users, this class is the controller for AwsProxy.page & UrlUtil.cmp

Methods

This component supports the following methods.

getTimedDirectLink: Transforms links targeting our internal AwsProxy into timed, direct links to AWS. Otherwise return the URL.
global static String getTimedDirectLink(String url)
Method Arguments
Name Type Description
url String the url to transform
Returns: String - the transformed link
getPostSignature:
global static S3Data getPostSignature(String key,Boolean usePublicBucket)
Method Arguments
Name Type Description
key String
usePublicBucket Boolean
Returns: AwsUtil.S3Data -

AwsUtil.S3Data

Properties
signature: String
isoDate: String
credential: String
policyJson: String
expires: String
bucketName: String
region: String
ttl: Integer

Config

Platform configuration objects for JSON serialization/deserialization. Used to register apps and provide an easy way to export and import JSON based configurations.

Methods

This component supports the following methods.

export: Exports Fonteva configurations
global static String export()
export: Exports Fonteva configurations
global static String export(Boolean prettify)
Method Arguments
Name Type Description
prettify Boolean Return JSON String in "Pretty Print" format
Returns: String - String JSON string
push: Commit configuration objects to the database
global static void push(Object configObject)
Method Arguments
Name Type Description
configObject Object {Object} Instance of any supported
Returns: Void
push: Commit configuration objects to the database
global static void push(Object[] configObjects)
Method Arguments
Name Type Description
configObjects List<Object> {Object[]} Instance of any supported
Returns: Void
clear: Removes the given configuration object from Framework custom settings
global static void clear(Object configObject)
Method Arguments
Name Type Description
configObject Object {Object} Instance of configuration object
Returns: Void
clear: Removes the given configuration object from Framework custom settings
global static void clear(Object[] configObjects)
Method Arguments
Name Type Description
configObjects List<Object> {Object[]} Instance of configuration object
Returns: Void
clear:
global static void clear(String namespace)
Method Arguments
Name Type Description
namespace String
Returns: Void
clearAll: Remove all configurations from Framework custom settings
global static void clearAll()
Properties
registeredApps: List<RegisteredApp>

CurrencyUtils

Util class to convert currencies from record currencyisocode to system currencyisococde.

Methods

This component supports the following methods.

getCurrencyIsoCode: retrieves the currencyisocode of the organisation.
global static String getCurrencyIsoCode(SObject record)
Method Arguments
Name Type Description
record SObject
Returns: String - string

CustomScript

Custom Script configuration class provides low-level interaction static methods and serves as an instance of a Framework Custom Script object
Properties
apexClass: String
name: String
namespace: String
description: String

DecimalUtils

Static methods for working with Decimals

Methods

This component supports the following methods.

round: Returns the rounded (System.RoundingMode.Half_Up) value for the given decimal
global static Decimal round(Decimal decimalToRound)
Method Arguments
Name Type Description
decimalToRound Decimal {Decimal}
Returns: Decimal - {Decimal}

Dispatcher

Dispatcher routes SObjects sent by triggered events to the appropriate Domain Apex Class for logic processing. Dispatcher also logs any non-final exception thrown as a new System Log record to assist trouble shooting and defect replication.

Methods

This component supports the following methods.

dispatchTrigger: Primary method for routiung SObjects sent by Apex Triggers. <p> The syntax for calling this method from a trigger is simple <example> trigger AccountTrigger on Account (before insert...) { Fonteva.Dispatcher.dispatchTrigger(); } <p> No arguments are required because all trigger variables persist as context variables throughout the execution context of any given trigger event. Registered App, and Registered Objects are dynamically detected using various Apex Describe methods.
global static void dispatchTrigger()
Properties
dispatchLog: List<Dispatcher.Route>
disableTriggerInContext: Map<String, Boolean>

Dispatcher.Route

Class to route dispatched action such as Trigger execution
Properties
dispatchedClass: Type
order: Integer
sobjectToken: SobjectType

Domain

Domain model software pattern for manaing SObject logic and validation through a series of stubbed out overrideable methods

Methods

This component supports the following methods.

Domain: Constructor for Domain with list of SObjects that are going to be acted up
global Domain(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject> List<SObject>
Returns: Void
applyDefaults:
global virtual void applyDefaults()
validate:
global virtual void validate()
validate:
global virtual void validate(Map<Id,SObject> existingRecords)
Method Arguments
Name Type Description
existingRecords Map<Id, SObject>
Returns: Void
beforeInsert:
global virtual void beforeInsert()
beforeUpdate:
global virtual void beforeUpdate(Map<Id,SObject> existingRecords)
Method Arguments
Name Type Description
existingRecords Map<Id, SObject>
Returns: Void
beforeDelete:
global virtual void beforeDelete()
afterInsert:
global virtual void afterInsert()
afterUpdate:
global virtual void afterUpdate(Map<Id,SObject> existingRecords)
Method Arguments
Name Type Description
existingRecords Map<Id, SObject>
Returns: Void
afterDelete:
global virtual void afterDelete()
error: Returns the same message that was passed in as an argument after adding the error to the errorList @see ErrorFactory
global String error(String message, SObject record)
Method Arguments
Name Type Description
message String Message to show to the end user that explains the nature of the error
record SObject SObject that caused the error
Returns: String - String The value of the message string passed in as an argument
error: Returns the same message that was passed in as an argument after adding the error to the errorList @see ErrorFactor
global String error(String message, SObject record, SObjectField field)
Method Arguments
Name Type Description
message String Message to show to the end user that explains the nature of the error
record SObject SObject that caused the error
field SObjectField SObject field that caused the error
Returns: String - String The value of the message string passed in as an argument
Properties
records: List<SObject>
errors: Domain.ErrorFactory

Domain.DomainConstructor

Interface

Methods

This component supports the following methods.

construct:
Domain construct(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject>
Returns: Domain -

FormatUtils

Methods

This component supports the following methods.

getDatePlaceholderText: Generate a Date Format string per the User's Locale setting
global static String getDatePlaceholderText()
formatStrToDate:
global static Date formatStrToDate(String dateStr)
Method Arguments
Name Type Description
dateStr String
Returns: Date -
formatDateToStr:
global static String formatDateToStr(Date dateObj)
Method Arguments
Name Type Description
dateObj Date
Returns: String -

Guid

GUID (Global Unique Identifier) generator class

Methods

This component supports the following methods.

generate: Returns a random and unique GUID a.k.a. Global Unique Identifier in the form of a string
global static String generate()

Installer

Installer for populating settings and defaults for the Fonteva Framework @implements Scriptable

Methods

This component supports the following methods.

onInstall: Method to be called on installation of Framework
global static void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext InstallContext
Returns: Void
onUninstall: Method to be called on installation of Framework
global static void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext InstallContext
Returns: Void
install: Static method to install the base objects from Framework
global static void install()

Log

Implementation of Fonteva Framework system logs with several static methods useful for interacting with the log including creating logs, and stack trace leveling

Methods

This component supports the following methods.

setAppInContext: Set the app in context so logs can blame the appropriate app when an exception is caught by dispatcher or otherwise debugged via the Log service Framework @throws InvalidAppNamespaceException if no Registered_App__c sobject is found for the given namespace.
global static void setAppInContext(String sparkNamespace)
Method Arguments
Name Type Description
sparkNamespace String The registered namespace for the Spark app to set in context.
Returns: Void
setObjectInContext: Sets the object in context for the Log by sobjectType (objectToken)
global static void setObjectInContext(SobjectType objectToken)
Method Arguments
Name Type Description
objectToken SobjectType SobjectType of the object in context.
Returns: Void
push: Pushes a function 'push' event into the stack trace
global static void push(String eventDescription)
Method Arguments
Name Type Description
eventDescription String
Returns: Void
push: Creates new diagnostic entry for the current log
global static void push(String apexClass, String method)
Method Arguments
Name Type Description
apexClass String String value for Apex Class name
method String String value for Apex Class method name
Returns: Void
pop: Pops the current level and adds a INFO level debug in the Salesforce debug log
global static void pop()
debug: Log ad-hoc debug statement into the diagnosticLog which can be helpful when an exception is later thrown in the script statement to trace the core problem back to the root cause
global static void debug(String debugString)
Method Arguments
Name Type Description
debugString String Content to push to the current log.
Returns: Void
debugException: Creates a new System Log record containing useful debug related date including the current stack trace and all diagnostic log entries that occured before the exception was caught in an execution context
global static void debugException(Exception ex)
Method Arguments
Name Type Description
ex Exception Exception object to create the System Log for
Returns: Void
popAll: Resets the currentLevel to 0 and calls pop()
global static void popAll()
CurrentLog: Returns the string value of the current diagnostic log
global static String CurrentLog()

LookupController

Controller for the Lookup.component

Methods

This component supports the following methods.

:
global static List<SObject> searchRecords(String queryString, String objectName,        List<String> fieldNames, String fieldsToSearch,        String filterClause, String orderBy, Integer recordLimit)

Message

Methods

This component supports the following methods.

getMessage:
global String getMessage()
getSeverity:
global Severity getSeverity()
serialize:
global static String serialize()
addMessage: Static block to initialize cache in execution context.
global static void addMessage(String message)
Method Arguments
Name Type Description
message String
Returns: Void
addMessage:
global static void addMessage(String message,Severity severityType)
Method Arguments
Name Type Description
message String
severityType Message.Severity
Returns: Void
addMessage:
global static void addMessage(Exception ex,Severity severityType)
Method Arguments
Name Type Description
ex Exception
severityType Message.Severity
Returns: Void
addMessage:
global static void addMessage(String messageStr,Severity severityType, Boolean logMessage)
Method Arguments
Name Type Description
messageStr String
severityType Message.Severity
logMessage Boolean
Returns: Void
clear:
global static void clear()
getMessages:
global static List<Message> getMessages(Severity severityType)
Method Arguments
Name Type Description
severityType Message.Severity
Returns: List<Message> -
getMessages:
global static Map<Severity,List<Message>> getMessages()
Properties
Success: Message.Severity

Message.Severity

Enum Values

  • Error
  • Danger
  • Warning
  • Info
  • Success

PageUtils

Static utility methods for working with Apex Pages

Methods

This component supports the following methods.

getParam: Returns String value of a page parameter
global static String getParam(String paramName)
Method Arguments
Name Type Description
paramName String Name of the page parameter to return
Returns: String - String
getIdParam: Returns Id value of a page parameter
global static Id getIdParam(String paramName)
Method Arguments
Name Type Description
paramName String Name of the page parameter to return
Returns: Id - Id
getBooleanParam: Returns Id value of a page parameter
global static Boolean getBooleanParam(String paramName)
Method Arguments
Name Type Description
paramName String Name of the page parameter to return
Returns: Boolean - Boolean

RegisteredApp

Registered App configuration class instance and static methods

Methods

This component supports the following methods.

export: Exports the configuration JSON data for a given Registered App
global static String export(String namespace)
Method Arguments
Name Type Description
namespace String The Namespace of the registered app to export configurations
Returns: String - String JSON configurations for the given registered app in the installed org
export: Exports the configuration JSON data for a given Registered App
global static String export(String namespace, Boolean prettify)
Method Arguments
Name Type Description
namespace String The Namespace of the registered app to export configurations
prettify Boolean Return JSON string in "Pretty Print" format
Returns: String - String JSON configurations for the given registered app in the installed org
Properties
name: String
namespace: String
apexNamespace: String
homepage: String
description: String
installClass: String
iconImageUrl: String
bannerImageUrl: String
owner: String
developerEmail: String
shortDescription: String
isEnabled: Boolean
isManaged: Boolean
isPaid: Boolean
registeredObjects: List<RegisteredObject>
routingRules: List<RoutingRule>
customScripts: List<CustomScript>
rollupSummaryFields: List<RollupSummaryField>
apiServices: List<Api.Service>
settingsPages: List<SettingsPage>

RegisteredObject

Registered Object configuration class
Properties
sObjectName: String
namespace: String
apexClass: String
soqlLimit: String
soqlOrderBy: String
salesforceId: String
triggersEnabled: Boolean
isEnabled: Boolean
isStandard: Boolean
validationDisabled: Boolean
orderBy: String

Registry

Helper class for Registry__mdt, the generic key/value store

Methods

This component supports the following methods.

runOnce: Run a script once. Uses the registry to prevent re-run of jobs.
global static Boolean runOnce(Scriptable s, String jobName)
Method Arguments
Name Type Description
s Scriptable the scriptable to run once
jobName String a key name that the job will be stored as
Returns: Boolean - true if the job ran; false if it was skipped
getEntries: Get active registry entries. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static List<Registry__mdt> getEntries()
getEntry: Get a registry enty. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static Registry__mdt getEntry(String category, String key)
Method Arguments
Name Type Description
category String
key String
Returns: Registry__mdt - the entry specified by category+key or null if not found
getEntries: Get registry entries. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static List<Registry__mdt> getEntries(Boolean includeDisabled)
Method Arguments
Name Type Description
includeDisabled Boolean pass true to include entries with `Is_Enabled=false`
Returns: List<Registry__mdt> - all of the registry entries
getEntriesByCat: Get active registry entries matching the category. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static List<Registry__mdt> getEntriesByCat(String category)
Method Arguments
Name Type Description
category String the category to filter on
Returns: List<Registry__mdt> - matching registry entries
getEntryMapByCat: Get active registry entries matching the category. Returns a map of keys => values
global static Map<String, String> getEntryMapByCat(String category)
Method Arguments
Name Type Description
category String the category to filter on
Returns: Map<String, String> - matching map of keys => values
getEntryMapByCat: Get active registry entries matching the category. Returns a map of keys => values
global static Map<String, String> getEntryMapByCat(String category, Boolean includeDisabled)
Method Arguments
Name Type Description
category String the category to filter on
includeDisabled Boolean pass true to include entries with `Is_Enabled=false`
Returns: Map<String, String> - matching map of keys => values
getEntriesByCat: Get registry entries matching the category. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static List<Registry__mdt> getEntriesByCat(String category, Boolean incudeDisabled)
Method Arguments
Name Type Description
category String the category to filter on
incudeDisabled Boolean pass true to include entries with `Is_Enabled=false`
Returns: List<Registry__mdt> - matching registry entries
upsertEntry: Upsert a registry entry, identified by category+key
global static void upsertEntry(String category, String key, String value)
Method Arguments
Name Type Description
category String the category
key String the key
value String the value
Returns: Void
upsertEntries: Upsert a batch of registry entries, each identified by category+key
global static void upsertEntries(List<Entry> entries)
Method Arguments
Name Type Description
entries List<Registry.Entry> a list of registry entries to upsert
Returns: Void
upsertGenericEntries:
global static void upsertGenericEntries(List<GenericEntry> entries)
Method Arguments
Name Type Description
entries List<Registry.GenericEntry>
Returns: Void

Registry.Entry

Data transfer object used when calling `upsertEntries`

Methods

This component supports the following methods.

Entry: Convenience constructor
global Entry(String category, String key, String value)
Method Arguments
Name Type Description
category String the entry category
key String the entry key
value String the entry value
Returns: Void
Properties
category: String
key: String
value: String

Registry.GenericEntry

Generic data transfer object used when calling `upsertGenericEntries`. Does not upsert "Registry" entries, inserts _any_ type of custom metadata

Methods

This component supports the following methods.

GenericEntry: Convenience constructor
global GenericEntry(String fullName, String label, Map<String, String> fqKeysValues)
Method Arguments
Name Type Description
fullName String the full name of the metadata record
label String the friendly name of the metadata record
fqKeysValues Map<String, String> a map of fully-qualified keys => string values to be set in the metadata record
Returns: Void
GenericEntry: Convenience constructor
global GenericEntry(String fullName, String label, Map<String, Object> fqKeysObjValues)
Method Arguments
Name Type Description
fullName String the full name of the metadata record
label String the friendly name of the metadata record
fqKeysObjValues Map<String, Object>
Returns: Void
Properties
fullName: String
label: String
fqKeysValues: Map<String, String>

RollupSummaryField

Registered Object configuration class
Properties
configId: String
namespace: String
childField: String
childSObject: String
parentField: String
parentSObject: String
relationshipField: String
filter: String
operation: String
isEnabled: Boolean
enableTrigger: Boolean
Concatenate_Distinct: RollupSummaryField.Operation

RollupSummaryField.Operation

Enum Values

  • Sum
  • Max
  • Min
  • Avg
  • Count
  • Concatenate
  • Concatenate_Distinct

RollupSummaryService

Static methods for declaritive rollup calculations @see RollupSummary

Methods

This component supports the following methods.

rollup: Method wraps the Rollup.rollup method, provides context via the lookups described in Rollup_Summary_Field__c
global static void rollup(List<SObject> childRecords)
Method Arguments
Name Type Description
childRecords List<SObject> Child records being modified
Returns: Void

RoutingRule

Routing Rule configuration class
Properties
configId: String
apexClass: String
namespace: String
sObjectName: String
isEnabled: Boolean
executionOrder: Integer

SObjectService

Service for Sobjects(Insert, update, Delete, Upsert)

Methods

This component supports the following methods.

insertRecord:
global static void insertRecord(SObject obj)
Method Arguments
Name Type Description
obj SObject
Returns: Void
insertRecords:
global static void insertRecords(SObject[] objects)
Method Arguments
Name Type Description
objects List<SObject>
Returns: Void
updateRecord:
global static void updateRecord(SObject obj)
Method Arguments
Name Type Description
obj SObject
Returns: Void
updateRecords:
global static void updateRecords(SObject[] objects)
Method Arguments
Name Type Description
objects List<SObject>
Returns: Void
deleteRecord:
global static void deleteRecord(SObject obj)
Method Arguments
Name Type Description
obj SObject
Returns: Void
deleteRecords:
global static void deleteRecords(SObject[] objects)
Method Arguments
Name Type Description
objects List<SObject>
Returns: Void
upsertRecord:
global static void upsertRecord(SObject obj)
Method Arguments
Name Type Description
obj SObject
Returns: Void
upsertRecords:
global static void upsertRecords(SObject[] objects)
Method Arguments
Name Type Description
objects List<SObject>
Returns: Void

SObjectUtils

Static utility methods for working with SObjects

Methods

This component supports the following methods.

getPicklistValues: Returns List<SelectOption> for a given SObjectField
global static SelectOption[] getPicklistValues(SObjectField field)
Method Arguments
Name Type Description
field SObjectField
Returns: List<SelectOption> - List<SelectOption>
getDependentPicklistOptions:
global static Map<String,List<Map<String,String>>> getDependentPicklistOptions(SObjectType baseObject, SObjectField controllingField,SObjectField dependentField)
Method Arguments
Name Type Description
baseObject SObjectType
controllingField SObjectField
dependentField SObjectField
Returns: Map<String, List<Map<String, String>>> -
mapObject: Returns the target SObject with the values of any custom fields found on the source SObject that share the same local name (api name without a namespace prefix - if applicable)
global static SObject mapObject(SObject source, SObject destination)
Method Arguments
Name Type Description
source SObject Source SObject to map values
destination SObject
Returns: SObject - SObject Source SObject with updated valuesap
mapObject: Returns the target SObject with the values of any custom fields found on the source SObject that share the same local name (api name without a namespace prefix - if applicable)
global static SObject mapObject(SObject source, SObject destination, Boolean updateEmptyFieldsOnly)
Method Arguments
Name Type Description
source SObject Source SObject to map values
destination SObject Target SObject to update values
updateEmptyFieldsOnly Boolean
Returns: SObject - SObject Source SObject with updated valuesap
mapObject: @see mapObject
global static SObject mapObject(SObject source, SObject destination, Boolean updateEmptyFieldsOnly, Boolean updateBooleanFields)
Method Arguments
Name Type Description
source SObject
destination SObject
updateEmptyFieldsOnly Boolean
updateBooleanFields Boolean
Returns: SObject -
mapObject:
global static SObject mapObject(SObject source, SObject destination, Boolean updateEmptyFieldsOnly, Boolean updateBooleanFields, Boolean updateAcrossNamespaces)
Method Arguments
Name Type Description
source SObject
destination SObject
updateEmptyFieldsOnly Boolean
updateBooleanFields Boolean
updateAcrossNamespaces Boolean
Returns: SObject -
mapChildFieldsFromRelated: Returns the target SObject with the values of any custom fields found on the source SObject that share the same local name (api name without a namespace prefix - if applicable)
global static void mapChildFieldsFromRelated(SObject[] records, String referenceToParentId, Map<String, String[]> fieldMap)
Method Arguments
Name Type Description
records List<SObject> Record SObject to map values
referenceToParentId String Parent SObject Id reference field name in child
fieldMap Map<String, List<String>> Map of Parent field names to be mapped to child field names
Returns: Void
getIdValue: Returns Id value for a given SObject and fieldName (API Name)
global static Id getIdValue(SObject sObj, String fieldName)
Method Arguments
Name Type Description
sObj SObject SObject
fieldName String SObjectField Api Name
Returns: Id - Id
validatefieldsCSV: validates the csv fields.
global static Boolean validatefieldsCSV(String objectName, String fieldCSV)
Method Arguments
Name Type Description
objectName String name of the object to be validated against.
fieldCSV String list of comma seperated fields.
Returns: Boolean - Boolean
validatefieldsCSV: validates the csv fields that can be used in a where clause of a soql.
global static Boolean validatefieldsCSV(String objectName, String fieldCSV, Boolean isFilterable, Boolean isSortable)
Method Arguments
Name Type Description
objectName String name of the object to be validated against.
fieldCSV String list of comma seperated fields.
isFilterable Boolean
isSortable Boolean
Returns: Boolean - Boolean
validatefieldSetsCSV: validates the csv fieldsets.
global static Boolean validatefieldSetsCSV(String objectName, String fieldSetCSV)
Method Arguments
Name Type Description
objectName String name of the object to be validated against.
fieldSetCSV String list of comma seperated fieldsets.
Returns: Boolean - Boolean
validatefieldSetsNoNSPCSV: validates the csv fieldsets without nsp.
global static Boolean validatefieldSetsNoNSPCSV(String objectName, String fieldSetCSV)
Method Arguments
Name Type Description
objectName String name of the object to be validated against.
fieldSetCSV String list of comma seperated fieldsets.
Returns: Boolean - Boolean

SchemaService

The SchemaService class provides built in caching for collecting various Apex Describe information on both SObjects and SObject fields.

Methods

This component supports the following methods.

getSObjectType: Returns a token for the SObjectType found by the string value of the SObject's api name.
global static SObjectType getSObjectType(String objectName)
Method Arguments
Name Type Description
objectName String String value of the SObject API name
Returns: SObjectType - SObjectType
getDescribe: Returns a DescribeSObjectResult object for a given SObjectType token.
global static DescribeSObjectResult getDescribe(SObjectType objectToken)
Method Arguments
Name Type Description
objectToken SObjectType The SObjectType to return the
Returns: DescribeSObjectResult - DescribeSObjectResult
getFieldSetMap: Returns a map with key of the field api name (without namespace if same as pkg) and value of the Schema.Fieldset.
global static Map<String, Schema.Fieldset> getFieldSetMap(SObjectType token)
Method Arguments
Name Type Description
token SObjectType SObjectType token to return the field map for.
Returns: Map<String, Schema.Fieldset> - Map<String, Schema.Fieldset>
getFieldMap: Returns a map with key of the fieldset api name (without namespace if same as pkg) and value of the fildset.
global static Map<String,SObjectField> getFieldMap(SObjectType token)
Method Arguments
Name Type Description
token SObjectType SObjectType token to return the field map for.
Returns: Map<String, SObjectField> - Map<String,SObjectField>
getSObjectField: Returns the token for a SObject field from the SObjectType 'token' and a String 'fieldName'.
global static SObjectField getSObjectField(SObjectType token, String fieldName)
Method Arguments
Name Type Description
token SObjectType
fieldName String
Returns: SObjectField - SObjectField
getDescribe: Returns the DescribeFieldResult object for a given SObjectField
global static DescribeFieldResult getDescribe(SObjectField field)
Method Arguments
Name Type Description
field SObjectField SObjectField to describe
Returns: DescribeFieldResult - DescribeFieldResult
getDescribe: Return a field describe for a given object and field by string value for each argument (objectName and fieldName)
global static DescribeFieldResult getDescribe(String objectName, String fieldName)
Method Arguments
Name Type Description
objectName String The api name for the SObject type that contains the field to describe
fieldName String The api name for the field to describe
Returns: DescribeFieldResult - DescribeFieldResult
getDescribe: Returns a DescribeFieldResult object for a given SObjectType and field name (String value)
global static DescribeFieldResult getDescribe(SObjectType objectToken, String fieldName)
Method Arguments
Name Type Description
objectToken SObjectType SObjectType for the SObject that holds the
fieldName String String value of the api name for the field to return
Returns: DescribeFieldResult - DescribeFieldResult
checkObjectAccess: Returns the name of a relationship in string form - used to create dynamic queries in the Selector class
global static Boolean checkObjectAccess(SObjectType objectType, Boolean isInsert, Boolean isUpdate, Boolean isDelete)
Method Arguments
Name Type Description
objectType SObjectType
isInsert Boolean
isUpdate Boolean
isDelete Boolean
Returns: Boolean -

Scriptable

Interface used by CustomScripts for ad-hoc script integration of Registered Apps - displayed on the Registered Apps detail page in Mission Control
Interface

Methods

This component supports the following methods.

run:
void run()

Selector

Selector class for enabling common SOQL queries across registered objects with built in feature detection for Person Account, and Multi-Currency orgs, adding fields for those features when called in orgs enabled for them.

Methods

This component supports the following methods.

getSObjectType: Override to allow a no-argument constructor for an extension to this class
global virtual SObjectType getSObjectType()
getFieldSets: Returns a list of Field Sets to use as the query fields if applicable
global virtual List<FieldSet> getFieldSets()
getOrderBy:
global virtual String getOrderBy()
Selector: Global no-argument constructor, only valid if the class is being constructed in an extension class
global Selector()
Selector:
global Selector(SObjectType type,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
enableForUpdate Boolean
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
enableForUpdate Boolean
Returns: Void
Selector:
global Selector(SObjectType type,Integer soqlLimit)
Method Arguments
Name Type Description
type SObjectType
soqlLimit Integer
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,String soqlSort)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlSort String
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,Integer soqlLimit)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlLimit Integer
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause, SObjectField lookupField)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
lookupField SObjectField
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,Integer soqlLimit,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlLimit Integer
enableForUpdate Boolean
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause, SObjectField lookupField,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
lookupField SObjectField
enableForUpdate Boolean
Returns: Void
Selector:
global Selector(SObjectType type, SObjectField lookupField, String soqlWhereClause,Integer soqlLimit)
Method Arguments
Name Type Description
type SObjectType
lookupField SObjectField
soqlWhereClause String
soqlLimit Integer
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,String soqlSort,Integer soqlLimit,SObjectField lookupField)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlSort String
soqlLimit Integer
lookupField SObjectField
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,String soqlSort,Integer soqlLimit,SObjectField lookupField,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlSort String
soqlLimit Integer
lookupField SObjectField
enableForUpdate Boolean
Returns: Void
Selector: Construct from SObjectType
global Selector(SObjectType type)
Method Arguments
Name Type Description
type SObjectType SObjectType
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a token for a child object lookup field to include a relationship query to the target child sobject type in the query result
global Selector(SObjectType type, SObjectField lookupField)
Method Arguments
Name Type Description
type SObjectType SObjectType
lookupField SObjectField SObjectField
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a token for a child object lookup field to include a relationship query to the target child sobject type in the query result
global Selector(SObjectType type, SObjectField lookupField, String soqlFilter)
Method Arguments
Name Type Description
type SObjectType SObjectType
lookupField SObjectField SObjectField
soqlFilter String String
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class
global Selector(SObjectType type, FieldSet fieldSet)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSet FieldSet FieldSet
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class
global Selector(SObjectType type, List<FieldSet> fieldSets)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSets List<FieldSet> List<FieldSet>
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class
global Selector(SObjectType type, List<FieldSet> fieldSets, String soqlFilter)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSets List<FieldSet> List<FieldSet>
soqlFilter String String
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class - as well as a SObjectField token for a related child object field that lookups to the primary query object to include a relationship query to that object (WARNING! all child fields are returned in the query result)
global Selector(SObjectType type, List<FieldSet> fieldSets, SObjectField lookupField)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSets List<FieldSet> List<FieldSet>
lookupField SObjectField
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class - as well as a SObjectField token for a related child object field that lookups to the primary query object to include a relationship query to that object (WARNING! all child fields are returned in the query result)
global Selector(SObjectType type, List<FieldSet> fieldSets, SObjectField lookupField, String soqlFilter)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSets List<FieldSet> List<FieldSet>
lookupField SObjectField SObjectField
soqlFilter String String
Returns: Void
getAll: Returns all rows for the SObjectType without filter
global virtual List<SObject> getAll()
selectById: Returns single SObject by record Id
global virtual SObject selectById(Id value)
Method Arguments
Name Type Description
value Id Id of record to return
Returns: SObject - SObject
selectById: Returns single SObject by Id in a custom reference field (String name)
global virtual SObject selectById(Id value, String referenceFieldName)
Method Arguments
Name Type Description
value Id Id of record to return
referenceFieldName String Full API name of the field to search for the Id (value)
Returns: SObject - SObject
selectById: Returns a list of SObjects for a given set of record ids
global virtual List<SObject> selectById(Set<Id> idSet)
Method Arguments
Name Type Description
idSet Set<Id> Set<Id> of record Ids
Returns: List<SObject> - List<SObject>
selectById: Returns a list of SObjects for a given set of custom reference ids - field to filter by specified by referenceFieldName
global virtual List<SObject> selectById(Set<Id> idSet, String referenceFieldName)
Method Arguments
Name Type Description
idSet Set<Id> Set<Id> custom reference Ids
referenceFieldName String Field to filter Ids
Returns: List<SObject> - List<SObject>
selectOptions: Returns list of SelectOptions using the getAll SObject list query
global SelectOption[] selectOptions()
selectOptions: Returns list of SelectOption objects using the record ids as a filter for the options returned
global SelectOption[] selectOptions(Set<Id> idSet)
Method Arguments
Name Type Description
idSet Set<Id> Set<Id> of record Ids
Returns: List<SelectOption> - SelectOption[]
selectOptions: Returns list of SelectOption objects using the record ids as a filter for the options returned
global SelectOption[] selectOptions(Set<Id> idSet, String referenceFieldName)
Method Arguments
Name Type Description
idSet Set<Id> Set<Id> of record Ids
referenceFieldName String Full API name of field to use for id filter
Returns: List<SelectOption> - SelectOption[]
getQueryLocator:
global Database.QueryLocator getQueryLocator()
getQueryLocator:
global Database.QueryLocator getQueryLocator(Set<Id> idSet)
Method Arguments
Name Type Description
idSet Set<Id>
Returns: Database.QueryLocator - Database.QueryLocator
getQueryLocator:
global Database.QueryLocator getQueryLocator(Set<Id> idSet, String referenceField)
Method Arguments
Name Type Description
idSet Set<Id> Id set for soql where clause
referenceField String
Returns: Database.QueryLocator - Database.QueryLocator
buildQueryStatement: @see buildQuery(String)
global String buildQueryStatement()
buildQueryStatement: Returns SOQL template in string form
global String buildQueryStatement(String referenceFieldName)
Method Arguments
Name Type Description
referenceFieldName String
Returns: String - String
Properties
fieldsToString: String

SetUtils

Useful static methods for working with the Set primitive data type

Methods

This component supports the following methods.

getIds: Returns a set of ids containing the record ids for each SObject contained in the list of sobjects passed in as an argument
global static Set<Id> getIds(List<SObject> records)
Method Arguments
Name Type Description
records List<SObject> List of records to return a set of ids for
Returns: Set<Id> - Set<Id> Ids for each record in the list of sobjects passed in as an argument
getIds: Returns a set of ids containing the record ids for each SObject contained in the list of sobjects passed in as an argument
global static Set<Id> getIds(List<SObject> records, String fieldName)
Method Arguments
Name Type Description
records List<SObject> List of records to return a set of ids for
fieldName String String fieldName to extract Id from
Returns: Set<Id> - Set<Id> Ids for each record in the list of sobjects passed in as an argument

SettingsPage

Settings_Page__c mirrored configuration class
Properties
apexComponent: String
apexClass: String
label: String
namespace: String
description: String

SettingsPage.DynamicComponent

Interface for providing the ApexPages.Component to draw for Framework's dynamic Settings Pages @since 2.1.0
Interface

Methods

This component supports the following methods.

getComponent:
ApexPages.Component getComponent()

StringUtils

Useful static methods for working with the String primitive data type

Methods

This component supports the following methods.

clean: Returns the string passed in as an argument without whitespace characters at the start or end - if the string passed into the method is null an empty string will be returned
global static String clean(String inputString)
Method Arguments
Name Type Description
inputString String
Returns: String - String Empty string if null string passed in as argument, or

TemplateController

Controller for all template vf pages used for staff facing interfaces.

Methods

This component supports the following methods.

TemplateController:
global TemplateController()
getCDNPath:
global String getCDNPath()

VendorAuthenticationService

Base virtual class that all vendor classes will extend for Auth functionality Such as OAuth

Methods

This component supports the following methods.

VendorAuthenticationService: Consturcutor that takes in the Api.ServiceConnection object on creation
global VendorAuthenticationService(Api.ServiceConnection serviceConnection)
Method Arguments
Name Type Description
serviceConnection Api.ServiceConnection
Returns: Void
VendorAuthenticationService: Default constructor with no parameters
global VendorAuthenticationService()
getAuthConfig: Get Auth Config objects for a particular Auth Type. Will return list of instantiated config objects that implement the same interface
global static List<AuthConfig> getAuthConfig(VendorAuthenticationService.AuthType authType)
Method Arguments
Name Type Description
authType VendorAuthenticationService.AuthType VendorAuthenticationService.AuthType
Returns: List<VendorAuthenticationService.AuthConfig> - List<AuthConfig> List of configs
getAuthTypes: Get list of all auth types that are available in the system.
global static List<VendorAuthenticationService.AuthType> getAuthTypes()
setTokenUrl: Set the base Oauth get token URL as that differs from Vendor to Vendor
global void setTokenUrl(String url)
Method Arguments
Name Type Description
url String Templated url that will be called to start Oauth login flow
Returns: Void
setAuthCodeUrl: Set the base Oauth get authorization URL as that differs from Vendor to Vendor
global void setAuthCodeUrl(String url)
Method Arguments
Name Type Description
url String Templated url that will be called to get token
Returns: Void
setRefreshTokenUrl: Set the base Oauth get refresh token URL as that differs from Vendor to Vendor
global void setRefreshTokenUrl(String url)
Method Arguments
Name Type Description
url String Templated url that will be called to get refresh token
Returns: Void
setHttpMethodGetToken: Set HTTP method to get Token, this differs from Vendor to Vendor.
global void setHttpMethodGetToken(String httpMethod)
Method Arguments
Name Type Description
httpMethod String String method GET or POST
Returns: Void
setApiServiceConnection: Set the Api.ServiceConnection object that is needed for methods to figure out what endpoint to call
global void setApiServiceConnection(Api.ServiceConnection apiServiceConnectionObj)
Method Arguments
Name Type Description
apiServiceConnectionObj Api.ServiceConnection Api.ServiceConnection
Returns: Void
setSuccessfulLoginRedirect: Set the PageReference object that is needed for redirect
global void setSuccessfulLoginRedirect(PageReference successPage)
Method Arguments
Name Type Description
successPage PageReference PageReference
Returns: Void
setFailureLoginRedirect: Set the PageReference object that is needed for redirect
global void setFailureLoginRedirect(PageReference failurePage)
Method Arguments
Name Type Description
failurePage PageReference PageReference
Returns: Void
setApiAuthType: Set the Auth Type for the vendor
global void setApiAuthType(VendorAuthenticationService.AuthType apiAuthType)
Method Arguments
Name Type Description
apiAuthType VendorAuthenticationService.AuthType
Returns: Void
getTokenUrl: Get Base Oauth token url set by Vendor
global String getTokenUrl()
getAuthCodeUrl: Get Base Oauth Authorization code url set by Vendor
global String getAuthCodeUrl()
getRefreshTokenUrl: Get Base Oauth refresh token url set by Vendor
global String getRefreshTokenUrl()
getHttpMethodGetToken: Get Base Oauth token HTTP method to get token which is set by Vendor
global String getHttpMethodGetToken()
getRedirectUrl:
global String getRedirectUrl()
getRedirectUrl: Get Redirect URL that will be used by vendor to call back
global virtual String getRedirectUrl(String connectionId)
Method Arguments
Name Type Description
connectionId String
Returns: String -
getApiServiceConnection: Get the associated Api.ServiceConnection object that contains the connection info
global virtual Api.ServiceConnection getApiServiceConnection()
buildTokenUrl: Build PageReference object that will redirect you to vendor. Each vendor does this differently so the token URL needs to build by vendor class.
global virtual PageReference buildTokenUrl()
buildAuthorizationCodeUrl: Build the Authorization code url which is the final step in the Oauth flow to get the token.
global virtual String buildAuthorizationCodeUrl(Map<String,String> parameters)
Method Arguments
Name Type Description
parameters Map<String, String>
Returns: String - String HTTP URL that will be called to get token
extractAccessToken: Extract Token from Vendor response. Needs to be overriden as every Vendor sends a different response
global virtual String extractAccessToken(String messageBody)
Method Arguments
Name Type Description
messageBody String String containing response from Vendor
Returns: String - String Extracted Access Token
: Build Auth Header that depends on Vendor for OAuth. Some vendors do not require this
global virtual String buildAuthHeader(        String url,        String method,        Map<String,String> signatureParams,        String secret)
Method Arguments
Name Type Description
url String
otherHeaderParams Map<String,String>
Returns: - String auth header
getApiAuthType: Get the currently set AuthType for the particular vendor
global AuthType getApiAuthType()
Properties
None: VendorAuthenticationService.AuthType

VendorAuthenticationService.AuthConfig

AuthConfig Inteface that allows us to list configs needed for OAuth or other authentication mechanisms
Interface

Methods

This component supports the following methods.

getName: Get the name of the config that will be stored as the name of Api.ServiceConnectionConfig
String getName()
isRequired: Check to see if the configuration is required to make the authentication be successful
Boolean isRequired()
getType: Get the type of the config such as STRING,URL etc
String getType()
getDefaultValue: Get the default value if it exists, if not a null value is returned
String getDefaultValue()

VendorAuthenticationService.AuthType

Enum Values

  • OAuth
  • OAuth2
  • OAuth1A
  • Basic
  • None

Base

Base class containing common client-side properties. Values are pulled in at runtime, validated and/or transformed, and, finally, serialized to the client. TO-DO might need to add more properties.

Methods

This component supports the following methods.

setDebug:
global void setDebug(Boolean value)
Method Arguments
Name Type Description
value Boolean
Returns: Void
setElementId:
global void setElementId(String value)
Method Arguments
Name Type Description
value String
Returns: Void
setJsController:
global void setJsController(String value)
Method Arguments
Name Type Description
value String
Returns: Void
setApexController:
global void setApexController(String value)
Method Arguments
Name Type Description
value String
Returns: Void
setComponentTitle:
global void setComponentTitle(String value)
Method Arguments
Name Type Description
value String
Returns: Void
setStyleClass:
global void setStyleClass(String value)
Method Arguments
Name Type Description
value String
Returns: Void

Base.BaseComponentException

BaseController

Base controller for configuration based components

Methods

This component supports the following methods.

BaseController:
global BaseController()
BaseController:
global BaseController(Base config)
Method Arguments
Name Type Description
config Base
Returns: Void
getConfigJson:
global virtual String getConfigJson()
getComponentId: Generate a random String for a given component. This provides uniqueness for JS variables using same component multiple times
global virtual String getComponentId()

CalendarController

Apex controller class for Calendar Component. Global because of the Remote Action method in the component.

Methods

This component supports the following methods.

getCalendarEvents: Remote action method that will return a list of Calendar Events
global static List<CalendarEvent> getCalendarEvents(List<CalendarInputWrapper> calendarData)
Method Arguments
Name Type Description
calendarData List<CalendarInputWrapper>
Returns: List<CalendarController.CalendarEvent> -

CalendarController.CalendarEvent

Build the query based on the Calendard Input Wrapper Record.

CalendarInputWrapper

Global class to load Calendar data. Used in calendar Apex Component, populate a list of CalendarInputWrapper and pass it as attribute on calendar component

Methods

This component supports the following methods.

getObjectName:
global String getObjectName()
setObjectName:
global void setObjectName(String value)
Method Arguments
Name Type Description
value String
Returns: Void
getTitleField:
global String getTitleField()
setTitleField:
global void setTitleField(String value)
Method Arguments
Name Type Description
value String
Returns: Void
getStartDateField:
global String getStartDateField()
setStartDateField:
global void setStartDateField(String value)
Method Arguments
Name Type Description
value String
Returns: Void
getEndDateField:
global String getEndDateField()
setEndDateField:
global void setEndDateField(String value)
Method Arguments
Name Type Description
value String
Returns: Void
getFieldsToDisplay:
global List<String> getFieldsToDisplay()
setFieldsToDisplay:
global void setFieldsToDisplay(List<String> values)
Method Arguments
Name Type Description
values List<String>
Returns: Void
getBeginningDateTime:
global Datetime getBeginningDateTime()
setBeginningDateTime:
global void setBeginningDateTime(Datetime value)
Method Arguments
Name Type Description
value Datetime
Returns: Void
getEndDateTime:
global Datetime getEndDateTime()
setEndDateTime:
global void setEndDateTime(Datetime value)
Method Arguments
Name Type Description
value Datetime
Returns: Void
getColor:
global String getColor()
setColor:
global void setColor(String value)
Method Arguments
Name Type Description
value String
Returns: Void

ComponentConfig

Apex object used to render configurations for PagesApi components.

Methods

This component supports the following methods.

ComponentConfig: ComponentConfig Constructor uses a page element and a list of page element attributes to create a Map of a String => Object to populate for implementations of the IComponent interface.
global ComponentConfig(Page_Element__c element, Page_Element_Attribute__c[] elementAttributes)
Method Arguments
Name Type Description
elementPagesApi__Page_Element__c
elementAttributes List<Page_Element_Attribute__c>
Returns: Void
getCustomHtml:
global String getCustomHtml()
getAttributes:
global Map<String,Object> getAttributes()

ComponentConfigOption

Configuration object for PagesApi Component attributes.

Methods

This component supports the following methods.

setLabel:
global void setLabel (String value)
Method Arguments
Name Type Description
value String
Returns: Void
setName:
global void setName (String value)
Method Arguments
Name Type Description
value String
Returns: Void
setOptions:
global void setOptions (SelectOption[] value)
Method Arguments
Name Type Description
value List<SelectOption>
Returns: Void
setConfigType:
global void setConfigType (Type value)
Method Arguments
Name Type Description
value Type
Returns: Void
setIsRequired:
global void setIsRequired (Boolean value)
Method Arguments
Name Type Description
value Boolean
Returns: Void
setDescription:
global void setDescription (String value)
Method Arguments
Name Type Description
value String
Returns: Void
setDefaultValue:
global void setDefaultValue (String value)
Method Arguments
Name Type Description
value String
Returns: Void

ComponentService

Apex services for working with dynamic components in PagesApi

Methods

This component supports the following methods.

build: Returns a list of ApexPages.Component objects to use when rendering components on pages.
global static ApexPages.Component[] build(Set<Id> pageElementIds)
Method Arguments
Name Type Description
pageElementIds Set<Id>
Returns: List<ApexPages.Component> - ApexPages.Component[] Array of ApexPages.Component objects

DefaultTemplateController

default_template page controller

Methods

This component supports the following methods.

DefaultTemplateController:
global DefaultTemplateController()
getSite:
global virtual Site__c getSite()
getSiteNav:
global Menu__c getSiteNav()
getPageNav:
global Menu__c getPageNav()
getTheme:
global Theme__c getTheme()
getPage:
global Page__c getPage()
getCurrentContact:
global Contact getCurrentContact()
getCurrentUser:
global User getCurrentUser()
getIsAuthenticated:
global Boolean getIsAuthenticated()
getLanguageISOCode:
global virtual String getLanguageISOCode()
getIsAuthenticatedUser:
global Boolean getIsAuthenticatedUser()
getShowMainNav:
global Boolean getShowMainNav()
getCDN:
global String getCDN()

FeedController

Controller class for Feed component.

Methods

This component supports the following methods.

getUsers:
global static List<User> getUsers(String searchString)
Method Arguments
Name Type Description
searchString String
Returns: List<User> -
getFeedData:
global static ConnectApi.FeedElementPage getFeedData(String groupId, String pageToken)
Method Arguments
Name Type Description
groupId String
pageToken String
Returns: ConnectApi.FeedElementPage -
postFeedData:
global static ConnectApi.FeedElement postFeedData(String groupId, String textInput)
Method Arguments
Name Type Description
groupId String
textInput String
Returns: ConnectApi.FeedElement -
postFeedDataWithFile:
global static ConnectApi.FeedElement postFeedDataWithFile(String groupId, String textInput, Blob fileInput, String fileType,String fileName)
Method Arguments
Name Type Description
groupId String
textInput String
fileInput Blob
fileType String
fileName String
Returns: ConnectApi.FeedElement -
postCommentData:
global static ConnectApi.Comment postCommentData(String groupId, String feedElementId, String textInput)
Method Arguments
Name Type Description
groupId String
feedElementId String
textInput String
Returns: ConnectApi.Comment -
getCommentsForFeedElement:
global static ConnectApi.CommentPage getCommentsForFeedElement(String feedElementId, String pageToken)
Method Arguments
Name Type Description
feedElementId String
pageToken String
Returns: ConnectApi.CommentPage -
likeElement:
global static ConnectApi.ChatterLike likeElement(String subjectId, String subjectType)
Method Arguments
Name Type Description
subjectId String
subjectType String
Returns: ConnectApi.ChatterLike -
unlikeFeedItem:
global static void unlikeFeedItem(String likeId)
Method Arguments
Name Type Description
likeId String
Returns: Void

FeedController.FeedConfig

FontevaControllerService

Fonteva Controller

Methods

This component supports the following methods.

getRecord:
global virtual Object getRecord(String recordId)
Method Arguments
Name Type Description
recordId String
Returns: Object -
getRecordMap:
global virtual Map<String,Object> getRecordMap(String urlVars)
Method Arguments
Name Type Description
urlVars String
Returns: Map<String, Object> -
getRecordMap:
global virtual Map<String,Object> getRecordMap(String urlVars,Boolean isPreview)
Method Arguments
Name Type Description
urlVars String
isPreview Boolean
Returns: Map<String, Object> -

FormBuilderController

Methods

This component supports the following methods.

getSkipLogicData: Gets the field in context and assigns the field to the newField object.
global static SkipLogicWrapper getSkipLogicData(String fieldId)
Method Arguments
Name Type Description
fieldId String
Returns: FormBuilderController.SkipLogicWrapper -
saveSkipLogic:
global static void saveSkipLogic(String data)
Method Arguments
Name Type Description
data String
Returns: Void

FormBuilderController.SkipLogicWrapper

Methods

This component supports the following methods.

SkipLogicWrapper:
global SkipLogicWrapper(String fieldId)
Method Arguments
Name Type Description
fieldId String
Returns: Void

FormDetailController

Controller for the form_detail.page

Methods

This component supports the following methods.

FormDetailController:
global FormDetailController(ApexPages.StandardController stdCon)
Method Arguments
Name Type Description
stdCon ApexPages.StandardController
Returns: Void
getFieldDisplayTypeOptions: Clears any values found for the current field and field group in context
global static String getFieldDisplayTypeOptions()

FormResponseService

Default Logic for Form_response__c SObject

Methods

This component supports the following methods.

upsertSobjects: Returns a map where the key is the form response record id and the value is a collection of Sobjects the system created as a result of the form response submission.
global static Map<Id,List<Id>> upsertSobjects(Set<Id> formResponseIds)
Method Arguments
Name Type Description
formResponseIds Set<Id>
Returns: Map<Id, List<Id>> - Map<Id,Sobject[]> Map form response id to a collection of sobjects

GoogleAuthRegHandler

Methods

This component supports the following methods.

createUser:
global User createUser(Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
portalId Id
data Auth.UserData
Returns: User -
updateUser:
global void updateUser(Id userId, Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
userId Id
portalId Id
data Auth.UserData
Returns: Void

GroupMembersController

Controller class for the VF Component groupmembers

Methods

This component supports the following methods.

doSearch:
global static List<Community_Group_Member__c> doSearch(GroupMembersConfig configs, List<SearchFilters> filters, String searchString)
Method Arguments
Name Type Description
configs GroupMembersController.GroupMembersConfig
filters List<GroupMembersController.SearchFilters>
searchString String
Returns: List<Community_Group_Member__c> -

GroupMembersController.GroupMembersConfig

GroupMembersController.SearchFilters

GroupsController

Controller class for the VF Component Groups

Methods

This component supports the following methods.

doSearch:
global static List<CommunityGroupWrapper> doSearch(GroupsConfig configs, List<SearchFilters> filters, String searchString)
Method Arguments
Name Type Description
configs GroupsController.GroupsConfig
filters List<GroupsController.SearchFilters>
searchString String
Returns: List<GroupsController.CommunityGroupWrapper> -

GroupsController.GroupsConfig

GroupsController.SearchFilters

GroupsController.CommunityGroupWrapper

Method that returns the FieldNames and FieldLabels Map @return Map<String,String>
Properties
cgroup: Community_Group__c
groupCount: Integer
isMyGroup: Boolean
isPrivate: Boolean
type: String

IComponent

Enables extension packages to register and build new PagesApi components by providing stubs to build new components with config objects and to retrieve config options.
Interface

Methods

This component supports the following methods.

getComponent:
ApexPages.Component getComponent(ComponentConfig config)
Method Arguments
Name Type Description
config ComponentConfig
Returns: ApexPages.Component -
getOptions:
ComponentConfigOption[] getOptions()

ISiteCreator

Enables extension packages to provide a mechanism to create new communities from template and related configurations.
Interface

Methods

This component supports the following methods.

create:
Site__c create(Site__c siteObj)
Method Arguments
Name Type Description
siteObjPagesApi__Site__c
Returns: Site__c -

LinkedInAuthRegHandler

Methods

This component supports the following methods.

createUser:
global User createUser(Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
portalId Id
data Auth.UserData
Returns: User -
updateUser:
global void updateUser(Id userId, Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
userId Id
portalId Id
data Auth.UserData
Returns: Void

MenuController

Controller class for navbar and navlist Visualforce Components (together part of Menu).

Methods

This component supports the following methods.

getMenuItemsTree: RemoteAction method that returns the Hierarchy for all the Menu Items
global static List<MenuHierarchy> getMenuItemsTree(String menuName)
Method Arguments
Name Type Description
menuName String
Returns: List<MenuHierarchy> - LIst<MenuHierarachy>

MenuHierarchy

Wrapper class for the Menu Items Hierarchy.

Methods

This component supports the following methods.

MenuHierarchy:
global MenuHierarchy(Menu_Item__c item, String parentId)
Method Arguments
Name Type Description
itemPagesApi__Menu_Item__c
parentId String
Returns: Void
getItem:
global Menu_Item__c getItem()
getMenuName:
global String getMenuName()
getTarget:
global String getTarget()
getNavURL:
global String getNavURL()
getParentId:
global String getParentId()
compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object
Returns: Integer -

PackageScripts

Framework configuration scripts as well as the default install and uninstall handler class for the PagesApi Managed Package.

Methods

This component supports the following methods.

onInstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext
Returns: Void
onUninstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext
Returns: Void
install:
global static void install()

PackageScripts.Install

Used for the custom script config to invoke install scripts of PagesApi app from Framework mission control/setup pages @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Permissioner

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Metadata

Always set the Org Defaults on install/upgrade

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.SampleSite

Methods

This component supports the following methods.

run: Used for the custom script config to load data for sample site to work @implements Framework.Scriptable
global void run()

Site

Global Site Service for Site__c configs

Methods

This component supports the following methods.

getSite:
global static Site__c getSite()
getPathPrefix:
global static String getPathPrefix()
setSite:
global static void setSite(Site__c siteObj)
Method Arguments
Name Type Description
siteObjPagesApi__Site__c
Returns: Void

TableComponentController

Controller class for the VF Component TableComponent

Methods

This component supports the following methods.

invoke: Remoting method to get the SObject Records for any object called from Datatable's AJAX Request
global static DataTableResponse invoke(List<Map<String, Object>> request, String sobjectName)
Method Arguments
Name Type Description
request List<Map<String, Object>> - Input Request provided by the DataTable
sobjectName String - Salesforce SObjectName
Returns: TableComponentController.DataTableResponse - DatatableResponse that can be used by API for table processing
invokeSearch:
global static DataTableResponse invokeSearch(DataTable request, String sobjectName)
Method Arguments
Name Type Description
request TableComponentController.DataTable
sobjectName String
Returns: TableComponentController.DataTableResponse -
getFieldLabelMap: Remoting method to get the fieldLabMap for any SObject, basically would return labels to show on a Table
global static Map<String,String> getFieldLabelMap(String sobjectName)
Method Arguments
Name Type Description
sobjectName String - Salesforce SObjectName
Returns: Map<String, String> - Map<String,String>
getFieldTypeMap: Remoting method to get the fieldLabMap for any SObject, basically would return labels to show on a Table
global static Map<String,String> getFieldTypeMap(String sobjectName)
Method Arguments
Name Type Description
sobjectName String - Salesforce SObjectName
Returns: Map<String, String> - Map<String,String>

TableComponentController.DataTableResponse

TableComponentController.DataTable

Properties
iDisplayStart: Integer
iDisplayLength: Integer
columns: List<String>
sortColumns: List<Integer>
sortDirections: List<String>
searchString: String

TwitterAuthRegHandler

Methods

This component supports the following methods.

createUser:
global User createUser(Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
portalId Id
data Auth.UserData
Returns: User -
updateUser:
global void updateUser(Id userId, Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
userId Id
portalId Id
data Auth.UserData
Returns: Void

AccessPermission

Access Permission check class

Methods

This component supports the following methods.

AccessPermission:
global AccessPermission(Id customerId)
Method Arguments
Name Type Description
customerId Id
Returns: Void
setCustomerIds:
global void setCustomerIds (Set<Id> customerIds)
Method Arguments
Name Type Description
customerIds Set<Id>
Returns: Void
haveAccess:
global Boolean haveAccess(SObject sObj)
Method Arguments
Name Type Description
sObj SObject
Returns: Boolean -
haveAccess:
global List<SObject> haveAccess(List<SObject> sObjs)
Method Arguments
Name Type Description
sObjs List<SObject>
Returns: List<SObject> -
haveAccessByContacts:
global Map<Id,Set<Id>> haveAccessByContacts(List<SObject> sObjs)
Method Arguments
Name Type Description
sObjs List<SObject>
Returns: Map<Id, Set<Id>> -

AccessibleSitesController

Get Accessible Sites

Methods

This component supports the following methods.

AccessibleSitesController:
global AccessibleSitesController()

CampaignController

Custom Controller for Campaign Display

Methods

This component supports the following methods.

getSalesOrderLines:
global static List<Sales_Order_Line__c> getSalesOrderLines(String salesorderid)
Method Arguments
Name Type Description
salesorderid String
Returns: List<Sales_Order_Line__c> -
closeSalesOrder:
global static String closeSalesOrder(String salesorderid)
Method Arguments
Name Type Description
salesorderid String
Returns: String -

CampaignPageBuilderController

Controller for pagebuilder.page which allows user to manage the page elements for any parent.

Methods

This component supports the following methods.

updateOrder: Dynamically find the parent for the pageElement, based on the page parameter, get the SObjectName, fieldname @Assumption: the fieldname for the parent is same as SObject Name (Does not support custonm field names)
global static String updateOrder(List<PageElementOrder> items)
Method Arguments
Name Type Description
items List<CampaignPageBuilderController.PageElementOrder>
Returns: String -

CampaignPageBuilderController.PageElementOrder

CampaignPageComponentControllerBase

Catalog Base Controller

Methods

This component supports the following methods.

CampaignPageComponentControllerBase:
global CampaignPageComponentControllerBase()
getCatalogItems:
global List<Item__c> getCatalogItems(String catalog)
Method Arguments
Name Type Description
catalog String
Returns: List<Item__c> -
buildSalesOrder:
global static void buildSalesOrder(String dataJson)
Method Arguments
Name Type Description
dataJson String
Returns: Void
buildSalesOrderFromComponent:
global PageReference buildSalesOrderFromComponent(String salesorderid,Id selectedItem,Integer selectedQuantity)
Method Arguments
Name Type Description
salesorderid String
selectedItem Id
selectedQuantity Integer
Returns: PageReference -
getQuantityPrice:
global static Decimal getQuantityPrice(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Decimal -
getQuantityPrice:
global static Decimal getQuantityPrice(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -
getQuantityOptions:
global List<SelectOption> getQuantityOptions()

Catalog

Methods

This component supports the following methods.

Catalog:
global Catalog (Id catalogId)
Method Arguments
Name Type Description
catalogId Id
Returns: Void
Catalog:
global Catalog (Id catalogId, Id customerId)
Method Arguments
Name Type Description
catalogId Id
customerId Id
Returns: Void
getItems:
global Map<Id,Item> getItems()
getItemsPriceRules:
global Map<Id,Price_Rule__c> getItemsPriceRules(Set<Id> itemIDs)
Method Arguments
Name Type Description
itemIDs Set<Id>
Returns: Map<Id, Price_Rule__c> -

Catalog.Item

Methods

This component supports the following methods.

getPriceRule:
global Price_Rule__c getPriceRule ()
getPriceRule:
global Price_Rule__c getPriceRule(Double quantity)
Method Arguments
Name Type Description
quantity Double
Returns: Price_Rule__c -

CatalogCheckboxDisplayController

Catalog Radio Display Component Controller

Methods

This component supports the following methods.

getUpdatedPriceByQuantity:
global static Decimal getUpdatedPriceByQuantity(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -

CatalogRadioDisplayController

Catalog Radio Display Component Controller

Methods

This component supports the following methods.

getUpdatedPriceByQuantity:
global static Decimal getUpdatedPriceByQuantity(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -

CatalogSelectDisplayController

Catalog Select Display Component Controller

Methods

This component supports the following methods.

getUpdatedPriceByQuantity:
global static Decimal getUpdatedPriceByQuantity(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -

CatalogTileDisplayController

Catalog Tile Display Component

Methods

This component supports the following methods.

getUpdatedPriceByQuantity:
global static Decimal getUpdatedPriceByQuantity(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -

CheckoutShippingController

Custom Controller for shipping during checkout

Methods

This component supports the following methods.

addShippingRate: Always converts to Kilogram for calculation
global static void addShippingRate(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Void

CheckoutSummaryController

Custom Controller for checkout summary (Total of Tax, Shipping and Items)

Methods

This component supports the following methods.

updateTotals:
global static Map<String,Object> updateTotals(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Map<String, Object> -
getTotals:
global static String getTotals(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: String -
closeAndPostSalesOrder:
global static PageReference closeAndPostSalesOrder(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: PageReference -
applyDiscount:
global static Boolean applyDiscount(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Boolean -

Contacts

Domain class for the Contact SObjectType

Methods

This component supports the following methods.

getUpdatedBadgeTypes:
global static Badge_Type__c[] getUpdatedBadgeTypes(Id contactId)
Method Arguments
Name Type Description
contactId Id
Returns: List<Badge_Type__c> -
updateContactBadges:
global static Contact updateContactBadges(Id contactId)
Method Arguments
Name Type Description
contactId Id
Returns: Contact -

Contacts.Constructor

Methods

This component supports the following methods.

construct:
global Framework.Domain construct(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject>
Returns: Framework.Domain -

CustomPaymentTypeContext

Class for Custom Payment Type Config

Methods

This component supports the following methods.

setSalesOrder:
global void setSalesOrder(Sales_Order__c salesOrder)
Method Arguments
Name Type Description
salesOrderOrderApi__Sales_Order__c
Returns: Void
setItem:
global void setItem(Item__c item)
Method Arguments
Name Type Description
itemOrderApi__Item__c
Returns: Void
getSalesOrder:
global Sales_Order__c getSalesOrder()
getItem:
global Item__c getItem()
setContext:
global void setContext(String context)
Method Arguments
Name Type Description
context String
Returns: Void
getContext:
global String getContext()

CustomPaymentTypeTemplate

Base Class for Custom Payment Type Template

Methods

This component supports the following methods.

getPaymentOptions:
global virtual List<Map<String,String>> getPaymentOptions(List<Payment_Method__c> paymentMethods,CustomPaymentTypeContext customPaymentTypeContext)
Method Arguments
Name Type Description
paymentMethods List<Payment_Method__c>
customPaymentTypeContext CustomPaymentTypeContext
Returns: List<Map<String, String>> -
customizeName:
global virtual String customizeName(Payment_Method__c paymentMethod,CustomPaymentTypeContext customPaymentTypeContext)
Method Arguments
Name Type Description
paymentMethodOrderApi__Payment_Method__c
customPaymentTypeContext CustomPaymentTypeContext
Returns: String -
customizeValue:
global virtual String customizeValue(Payment_Method__c paymentMethod,CustomPaymentTypeContext customPaymentTypeContext)
Method Arguments
Name Type Description
paymentMethodOrderApi__Payment_Method__c
customPaymentTypeContext CustomPaymentTypeContext
Returns: String -
calcuatePaymentMethods:
global static List<Map<String,String>> calcuatePaymentMethods(String customerId,CustomPaymentTypeContext customPaymentTypeContextObj)
Method Arguments
Name Type Description
customerId String
customPaymentTypeContextObj CustomPaymentTypeContext
Returns: List<Map<String, String>> -
calculatePaymentMethods:
global static List<Map<String,String>> calculatePaymentMethods(String customerId,CustomPaymentTypeContext customPaymentTypeContextObj)
Method Arguments
Name Type Description
customerId String
customPaymentTypeContextObj CustomPaymentTypeContext
Returns: List<Map<String, String>> -

EPayment

Class to get epayments

Methods

This component supports the following methods.

createEpayments:
global static EPayment__c[] createEpayments(Scheduled_Payment__c[] scheduledPayments)
Method Arguments
Name Type Description
scheduledPayments List<Scheduled_Payment__c>
Returns: List<EPayment__c> -

EpaymentWebServices

Methods

This component supports the following methods.

doPost:
global static void doPost()

Invoice

Wrapper for Invoice. @implements Comparable. Ability to sort Invoices based on their due date.

Methods

This component supports the following methods.

compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object An instance of Invoice
Returns: Integer - -1 if the due date of this invoice is before.

InvoiceLine

Wrapper for Invoice Line Object. @implements Comparable. Ability to sort Invoice Lines based on their payment priority

Methods

This component supports the following methods.

compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object An instance of InvoiceLine to be compared Against
Returns: Integer - -1 if this has lower priority.

Invoices

Domain class for the Invoice__c SObjectType

Methods

This component supports the following methods.

Invoices:
global Invoices(List<Invoice__c> sObjectList)
Method Arguments
Name Type Description
sObjectList List<Invoice__c>
Returns: Void

Invoices.Constructor

Methods

This component supports the following methods.

construct:
global Framework.Domain construct(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject>
Returns: Framework.Domain -

Item

Class to get items under item class

Methods

This component supports the following methods.

Item:
global Item(Id itemId)
Method Arguments
Name Type Description
itemId Id
Returns: Void
getListPrice:
global PriceRule getListPrice()
getPrice:
global PriceRule getPrice(Double quantity,Id customerId, Map<String, Integer> customerPRUsed)
Method Arguments
Name Type Description
quantity Double
customerId Id
customerPRUsed Map<String, Integer>
Returns: PriceRule -
getPrice:
global PriceRule getPrice(Double quantity,Id customerId)
Method Arguments
Name Type Description
quantity Double
customerId Id
Returns: PriceRule -
getItemSubPlans:
global ItemSubscriptionPlan[] getItemSubPlans(Id customerId, Double quantity, Id[] subPlans)
Method Arguments
Name Type Description
customerId Id
quantity Double
subPlans List<Id>
Returns: List<ItemSubscriptionPlan> -

ItemClass

Class to get items under item class and their prices

Methods

This component supports the following methods.

ItemClass:
global ItemClass(Id itemClassId)
Method Arguments
Name Type Description
itemClassId Id
Returns: Void
ItemClass:
global ItemClass(Id itemClassId,Id customerId)
Method Arguments
Name Type Description
itemClassId Id
customerId Id
Returns: Void
ItemClass:
global ItemClass(Id itemClassId,Id customerId,Id sourceCodeId)
Method Arguments
Name Type Description
itemClassId Id
customerId Id
sourceCodeId Id
Returns: Void
getItems:
global Map<Id,Item> getItems()
getItems:
global Map<Id,Item> getItems(Boolean forceAccessPermissions)
Method Arguments
Name Type Description
forceAccessPermissions Boolean
Returns: Map<Id, Item> -

ItemSubscriptionPlan

Methods

This component supports the following methods.

ItemSubscriptionPlan:
global ItemSubscriptionPlan(Id subId, PriceRule listPrice)
Method Arguments
Name Type Description
subId Id
listPrice PriceRule
Returns: Void
getSubscription:
global Id getSubscription()
getPrice:
global PriceRule getPrice()

NavListController

Controller class for navbar and navlist Visualforce Components (together part of Menu).

Methods

This component supports the following methods.

getMenuItemsTree: RemoteAction method that returns the Hierarchy for all the Menu Items
global static List<PagesApi.MenuHierarchy> getMenuItemsTree(String jsonDataStr)
Method Arguments
Name Type Description
jsonDataStr String
Returns: List<PagesApi.MenuHierarchy> - LIst<MenuHierarachy>

OrderSummaryController

Controller class for order_summary Visualforce Component

Methods

This component supports the following methods.

updateOrder: Method to update the order line items based on Line Item Id Sales Order Line Quantity - based on quantityField.
global static void updateOrder(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Void
deleteOrderLine: Method to delete the order line item
global static void deleteOrderLine(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Void

PackageItem

wrapper class for Package_Item__c

Methods

This component supports the following methods.

PackageItem: Construct a PackageItem wrapper from a Package_Item__c
global PackageItem(Package_Item__c pi)
Method Arguments
Name Type Description
piOrderApi__Package_Item__c the package item SObject
Returns: Void
PackageItem: Construct a PackageItem wrapper from a parentId and a packageId
global PackageItem(String parentItemId, String packageId)
Method Arguments
Name Type Description
parentItemId String the parent item id
packageId String the bundled item id
Returns: Void
save: Persist the PackageItem wrapper to the corresponding SObject
global void save()
Properties
name: String
parentItemName: String
packagedItemName: String
type: String
item: String
itemClass: String
isRequired: Boolean
hasNoAdditionalCharge: Boolean
hasAdditionalCharge: Boolean
minQuantity: Integer
maxQuantity: Integer
maxQuantityPerItem: Integer
displayName: String
buttonDisplayName: String
displayInstructions: String
packageItemId: String
parentItemId: String
minQuantityFieldLabel: String
maxQuantityFieldLabel: String
displayNameFieldLabel: String
buttonDisplayNameFieldLabel: String
displayInstructionsFieldLabel: String
maxQuantityPerItemFieldLabel: String
ticketTypeId: String
scheduleItemId: String
sponsorPackageId: String

PackageScripts

Ad-hoc scripts to support master data manipulation for the OTC Managed Package

Methods

This component supports the following methods.

onInstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext
Returns: Void
onUninstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext
Returns: Void
install: Execute the installation scripts for the OrderApi managed package
global static void install()

PackageScripts.Install

Runs all default installation scripts for the OTC Managed Package @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Exceptions

Creates and links an account and contact record to NationSuite's settings for Exception Account and Exception Contact respectively. @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.AppConfig

Creates basic accounting master data and other preference releated configurations. @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Register

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Rollups

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.DeleteConfig

Invoice__c.Credits_Applied__c (Sum)

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.CustomScripts

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Jobs

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.CustomPaymentScripts

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.SubBchJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.SPCBchJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.BBchableJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.TermBchJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.FlowBJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.KABchJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Wipe

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Metadata

Methods

This component supports the following methods.

run:
global void run()

PaymentConfigPreferences

Methods

This component supports the following methods.

PaymentConfigPreferences:
global PaymentConfigPreferences()
getKey:
global String getKey()
getSecret:
global String getSecret()
getSignedSecret:
global String getSignedSecret()
isDebugModeEnabled:
global Boolean isDebugModeEnabled()
setKey: Sets the Spreedly Key
global void setKey(String key)
Method Arguments
Name Type Description
key String
Returns: Void
setSecret: Sets the Spreedly Secret
global void setSecret(String secret)
Method Arguments
Name Type Description
secret String
Returns: Void
setSignedSecret: Sets the Spreedly Signed Secret
global void setSignedSecret(String signedSecret)
Method Arguments
Name Type Description
signedSecret String
Returns: Void
setDebugMode: Sets the enable individual accounts field for the preference in context.
global void setDebugMode(Boolean debugMode)
Method Arguments
Name Type Description
debugMode Boolean
Returns: Void
push: List of all eBusiness Preferences
global void push()

PortalShoppingCartController

Controller for portal_shopping_cart.component

Methods

This component supports the following methods.

updateOrder: Called from apex:actionFunction invoked from onclick event of item delete action link
global static void updateOrder(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Void

Preferences

Methods

This component supports the following methods.

Preferences:
global Preferences()
Preferences:
global Preferences(Id setupOwnerId)
Method Arguments
Name Type Description
setupOwnerId Id
Returns: Void
getBusinessGroupId: Id of the preferred Business Group sobject Id.
global Id getBusinessGroupId()
getIncomeAccountId: Id of the preferred default Income GL Account sobject Id.
global Id getIncomeAccountId()
getRefundAccountId: Id of the preferred default Refund GL Account sobject Id.
global Id getRefundAccountId()
getDepositAccountId: Id of the preferred default Deposit GL Account sobject Id.
global Id getDepositAccountId()
getAdjustmentAccountId: Id of the preferred default Adjustment GL Account sobject Id.
global Id getAdjustmentAccountId()
getARAccountId: Id of the preferred default A/R GL Account sobject Id.
global Id getARAccountId()
getPaymentGatewayId: Id of the preferred default Payment Gateway sobject Id.
global Id getPaymentGatewayId()
getExceptionAccountId: Returns the ID of the Account sobject configured as the Exception Account
global Id getExceptionAccountId()
getExceptionContactId: Returns the ID of the Contact sobject configured as the Exception Contact
global Id getExceptionContactId()
getPaymentTermsId: Returns the ID of the preferred Payment Terms sobject
global Id getPaymentTermsId()
getTaxAccountId: Returns the preferred Tax GL Account sobject Id
global Id getTaxAccountId()
getTaxLocaleId: Returns the preferred Tax Locale sobject Id
global Id getTaxLocaleId()
getEnableIndividualAccounts:
global Boolean getEnableIndividualAccounts()
getEnableBillingSyncBypass:
global Boolean getEnableBillingSyncBypass()
getDisableSavePymntMethodOptn:
global Boolean getDisableSavePymntMethodOptn()
getDBCommitted: If the custom setting (app_config__c) in context has been inserted in the database this will return true, otherwise false
global Boolean getDBCommitted()
getSetupOwnerId: The Id of the user, profile, or organization that owns the hierarchy setting (configObj) in context
global Id getSetupOwnerId()
setSetupOwnerId: Sets the setup owner id for the preference in context.
global void setSetupOwnerId(Id setupOwnerId)
Method Arguments
Name Type Description
setupOwnerId Id
Returns: Void
setPaymentTerms: Sets the Pyament Terms for the preference in context.
global void setPaymentTerms(Id PTId)
Method Arguments
Name Type Description
PTId Id
Returns: Void
setRefundAccount: Sets the Refund Account for the preference in context.
global void setRefundAccount(Id RAId)
Method Arguments
Name Type Description
RAId Id
Returns: Void
setTaxAccount: Sets the tax account for the preference in context.
global void setTaxAccount(Id TAId)
Method Arguments
Name Type Description
TAId Id
Returns: Void
setTaxLocale: Sets the tax locale for the preference in context.
global void setTaxLocale(Id TLId)
Method Arguments
Name Type Description
TLId Id
Returns: Void
setExceptionAccount: Sets the exception account for the preference in context.
global void setExceptionAccount(Id EAId)
Method Arguments
Name Type Description
EAId Id
Returns: Void
setExceptionContact: Sets the exception contact for the preference in context.
global void setExceptionContact(Id ECId)
Method Arguments
Name Type Description
ECId Id
Returns: Void
setIncomeAccount: Sets the income account for the preference in context.
global void setIncomeAccount(Id IAId)
Method Arguments
Name Type Description
IAId Id
Returns: Void
setDepositAccount: Sets the deposit account for the preference in context.
global void setDepositAccount(Id DAId)
Method Arguments
Name Type Description
DAId Id
Returns: Void
setDiscountAccount: Sets the discount account for the preference in context.
global void setDiscountAccount(Id DAId)
Method Arguments
Name Type Description
DAId Id
Returns: Void
setARAccount: Sets the AR account for the preference in context.
global void setARAccount(Id ARAId)
Method Arguments
Name Type Description
ARAId Id
Returns: Void
setAdjustmentAccount: Sets the adjustment account for the preference in context.
global void setAdjustmentAccount(Id AAId)
Method Arguments
Name Type Description
AAId Id
Returns: Void
setBusinessGroup: Sets the business group for the preference in context.
global void setBusinessGroup(Id BGId)
Method Arguments
Name Type Description
BGId Id
Returns: Void
setUpdateContactStandardEmailField: Sets the update contact standard email field for the preference in context.
global void setUpdateContactStandardEmailField(Boolean UCSEF)
Method Arguments
Name Type Description
UCSEF Boolean
Returns: Void
setUpdateContactStandardPhoneField: Sets the update contact standard phone field for the preference in context.
global void setUpdateContactStandardPhoneField(Boolean UCSPF)
Method Arguments
Name Type Description
UCSPF Boolean
Returns: Void
setNamespacePrefix: Sets the namespacePrefix for the preference in context.
global void setNamespacePrefix(String nsp)
Method Arguments
Name Type Description
nsp String
Returns: Void
setIndividualAccountNameExtension: Sets the individual account name extension for the preference in context.
global void setIndividualAccountNameExtension(String IANE)
Method Arguments
Name Type Description
IANE String
Returns: Void
setitemWeightUOM: Sets the item weight UOM for the preference in context.
global void setitemWeightUOM(String IWUOM)
Method Arguments
Name Type Description
IWUOM String
Returns: Void
setEnableIndividualAccounts: Sets the enable individual accounts field for the preference in context.
global void setEnableIndividualAccounts(Boolean EIA)
Method Arguments
Name Type Description
EIA Boolean
Returns: Void
setDisableSavePymntMethodOptn: Sets the disable save payment method option in Payment Processing Page for the preference in context.
global void setDisableSavePymntMethodOptn(Boolean disableSPMO)
Method Arguments
Name Type Description
disableSPMO Boolean
Returns: Void
setCalculateSalesTax: Sets the calculate sales tax for the preference in context.
global void setCalculateSalesTax(Boolean CST)
Method Arguments
Name Type Description
CST Boolean
Returns: Void
push: List of all eBusiness Preferences
global void push()
exportAll: List of all eBusiness Preferences
global static Preferences[] exportAll()

PriceRule

Class to get active price for item

Methods

This component supports the following methods.

PriceRule:
global PriceRule(Price_Rule__c priceRuleObj)
Method Arguments
Name Type Description
priceRuleObjOrderApi__Price_Rule__c
Returns: Void
getPriceRule:
global Price_Rule__c getPriceRule()
setPriceRule:
global static void setPriceRule(Sales_Order_Line__c[] sols, String contactId, String sourceCodeId)
Method Arguments
Name Type Description
sols List<Sales_Order_Line__c>
contactId String
sourceCodeId String
Returns: Void

RenewalPath

Methods

This component supports the following methods.

RenewalPath:
global RenewalPath()
setAccountId:
global void setAccountId(String accountId)
Method Arguments
Name Type Description
accountId String
Returns: Void
setContactId:
global void setContactId(String contactId)
Method Arguments
Name Type Description
contactId String
Returns: Void
setItemId:
global void setItemId(String itemId)
Method Arguments
Name Type Description
itemId String
Returns: Void
setsubscriptionId:
global void setsubscriptionId(String subscriptionId)
Method Arguments
Name Type Description
subscriptionId String
Returns: Void
getItem:
global Item__c getItem()
getIsDefault:
global Boolean getIsDefault()
serializeRenewalPath:
global static String serializeRenewalPath(RenewalPath rJSON)
Method Arguments
Name Type Description
rJSON RenewalPath
Returns: String -
isRenewalPathDefined: Global method returns true if Subscription Item has any RenewalPath related
global static Boolean isRenewalPathDefined(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Boolean -
getRenewalPathItems: Global method returns List of RenewalPath records which are applicable for that user
global static RenewalPath[] getRenewalPathItems(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: List<RenewalPath> -

SalesReceipt

Api object for processing customer orders

Methods

This component supports the following methods.

SalesReceipt:
global SalesReceipt(Id customer_id)
Method Arguments
Name Type Description
customer_id Id
Returns: Void
Properties
customer_id: Id
line_items: List<SalesReceipt.LineItem>

SalesReceipt.LineItem

Methods

This component supports the following methods.

LineItem:
global LineItem(Id item_id, Integer quantity)
Method Arguments
Name Type Description
item_id Id
quantity Integer
Returns: Void
LineItem:
global LineItem(Id item_id, Integer quantity, Boolean price_override, Decimal sale_price)
Method Arguments
Name Type Description
item_id Id
quantity Integer
price_override Boolean
sale_price Decimal
Returns: Void
LineItem:
global LineItem(Id invoice_id, Decimal invoice_payment_amount)
Method Arguments
Name Type Description
invoice_id Id
invoice_payment_amount Decimal
Returns: Void
Properties
invoice_id: Id
item_id: Id
price_override: Boolean
amount: Decimal
quantity: Integer

ScheduledPayments

Domain class for the Scheduled_Payment__c SObjectType

Methods

This component supports the following methods.

processScheduledPayment:
global static void processScheduledPayment(Id scheduledPaymentId)
Method Arguments
Name Type Description
scheduledPaymentId Id
Returns: Void

ScheduledPayments.Constructor

Methods

This component supports the following methods.

construct:
global Framework.Domain construct(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject>
Returns: Framework.Domain -

ShoppingCart

Object for working with shopping carts and related data for customers accessing the app in a salesforce community

Methods

This component supports the following methods.

ShoppingCart:
global ShoppingCart()
ShoppingCart:
global ShoppingCart(Boolean autoInsert)
Method Arguments
Name Type Description
autoInsert Boolean
Returns: Void
getSalesOrder:
global Sales_Order__c getSalesOrder()
getSalesOrder:
global Sales_Order__c getSalesOrder(Boolean forceCreateSO)
Method Arguments
Name Type Description
forceCreateSO Boolean
Returns: Sales_Order__c -
updateCookie:
global static void updateCookie(Id cookieSalesOrderId, Id cookieUserId)
Method Arguments
Name Type Description
cookieSalesOrderId Id
cookieUserId Id
Returns: Void
createSalesOrderLineCookie:
global static void createSalesOrderLineCookie(Id cookieSalesOrderLineId)
Method Arguments
Name Type Description
cookieSalesOrderLineId Id
Returns: Void
createSalesOrderLineCookies:
global static void createSalesOrderLineCookies(Set<Id> cookieSalesOrderLineIds)
Method Arguments
Name Type Description
cookieSalesOrderLineIds Set<Id>
Returns: Void
clearSalesOrderLineCookie:
global static void clearSalesOrderLineCookie()
deleteUnwantedSalesOrderLines:
global static void deleteUnwantedSalesOrderLines()

StoreService

Service class for the Store__c SObjectType

Methods

This component supports the following methods.

buildStoreAccount:
global static Account buildStoreAccount(Store__c store,Contact contactObj)
Method Arguments
Name Type Description
storeOrderApi__Store__c
contactObj Contact
Returns: Account -
getGuestContact:
global static Contact getGuestContact(Store__c store,String email,String firstName, String lastName,String matchingField)
Method Arguments
Name Type Description
storeOrderApi__Store__c
email String
firstName String
lastName String
matchingField String
Returns: Contact -

EventRegistrationController

Methods

This component supports the following methods.

EventRegistrationController:
global EventRegistrationController()
setSelectedTicketType:
global static String setSelectedTicketType(String selectedTicketType,String item,String soId,String ticketTypeSOLId)
Method Arguments
Name Type Description
selectedTicketType String
item String
soId String
ticketTypeSOLId String
Returns: String -

GenerateEventMobilePass

Generate mobile pass for events

Methods

This component supports the following methods.

GenerateEventMobilePass:
global GenerateEventMobilePass(Event__c eventObj,Attendee__c attendeeObj)
Method Arguments
Name Type Description
eventObjEventApi__Event__c
attendeeObjEventApi__Attendee__c
Returns: Void
setRegUrl:
global void setRegUrl(String url)
Method Arguments
Name Type Description
url String
Returns: Void
isPassbookAvailable:
global Boolean isPassbookAvailable()
getPassUrl:
global String getPassUrl()

MobilePassController

Generate mobile pass for events controller

Methods

This component supports the following methods.

generatePass:
global static String generatePass(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: String -

PackageScripts

Methods

This component supports the following methods.

onInstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext
Returns: Void
onUninstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext
Returns: Void
install: Execute the installation scripts for the EventApi managed package
global static void install()

PackageScripts.Install

Runs all default installation scripts for the EventApi Managed Package @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.AppConfig

Creates basic accounting master data and other preference releated configurations. @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Register

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Rollups

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.CustomScripts

Event__c.Waitlist_Entry__c (# of Waiting people for an Event) (Count)

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Jobs

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Metadata

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.SetQRCodesDefaults

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.swapDescriptiononVenue

Methods

This component supports the following methods.

run:
global void run()

SponsorPackageWrapper

SponsorPackage Wrapper Class

Methods

This component supports the following methods.

compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object
Returns: Integer -

TemplateController

Methods

This component supports the following methods.

TemplateController:
global TemplateController()
cleanSalesOrderLines:
global void cleanSalesOrderLines()

PackageScripts

Package Scripts

Methods

This component supports the following methods.

onInstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext
Returns: Void
onUninstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext
Returns: Void
install: Execute the installation scripts for the OrderApi managed package
global static void install()

PackageScripts.Install

Runs all default installation scripts for the OrderApi Managed Package @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run ()

PackageScripts.MigrateIsFeaturedData

SponsorPackageWrapper

SponsorPackage Wrapper Class

Methods

This component supports the following methods.

compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object
Returns: Integer -

currencyField

Attributes

record: SObject
** Conditionally Required ** The SObject Record .
field: String
** Conditionally Required when record is filled in ** The Salesforce Field .
value: String
** Conditionally Required ** Use this when you dont want to use outputField but still get the formatting .
currencySymbol: String
** Conditionally Required ** The Currency Symbol .
currencyISOCode: String
** Conditionally Required ** The Currency ISO Code you want to use for this component .
useOutputField: Boolean
** Conditionally Required ** The Currency ISO Code you want to use for this component .

img

Attributes

src: String
the img tag source
clazz: String
the img tag class
id: String
the img tag id
style: String
the img tag style
alt: String
the img tag alt text
width: String
the img tag width
height: String
the img tag height
title: String
the img tag title
extra: String
comma-separated `key=value` to add extra attributes to the img tag

lookup

Attributes

value: String
Set the value of the lookup input field
styleClass: String
CSS class attribute to apply on the search input box.
style: String
CSS style attribute to apply on the search input box.
placeholder: String
Text to display as a placeholder in the search input box.
object: String
The type of record we are searching.
objectIdField: String
The field that provides the object Id.
primaryField: String
The field that provides the primary display value.
secondaryField: String
A field to differentiate the display value. Appears in parens.
minSearchLength: Integer
How many characters you must type before searching. Must be 2 or more.
searchScope: String
Indicates which types of fields on the object to search. One of ALL, NAME, EMAIL, PHONE, SIDEBAR.
filterClause: String
WHERE clause to filter records. Do not include WHERE.
orderBy: String
Name of field to sort records by.
recordLimit: String
Maximum number of records to return to the list.
destinationForSelectedId: String
Id of a field, such as an apex:inputHidden, that should get Salesforce Id of the selected item.
destinationForSelectedValue: String
Id of a field, such as an apex:inputHidden, that should get the displayed name/value of the selected item.
stealFocus: Boolean
Whether to automatically move the focus to the search box when the component is displayed.
multipleSelect: Boolean
If select box is multiple select or single select. Default is mutltiple

mdapi_unzip

Attributes

oncomplete: String
Javascript executed on unzip of file entry
name: String
Name of the Javascript function generated to unzip files

mdapi_zip

Attributes

oncomplete: String
Javascript executed once all files have been zipped
name: String
Name of the Javascript function generated to zip files

mdapi_zip_entry

Attributes

path: String
Path to entry in the zip file
data: String
File data

messages

Attributes

severity: String
Severity Of Messages To Display

slds_accordion

calendar

Attributes

calendarType: String
** Required ** The Type of Calendar .
calendarInput: CalendarInputWrapper[]
** Required ** List of CalendarInput Type data to render on Calendar
clickable: Boolean
** Optional ** If the list is clickable
width: String
** Optional ** The Width of the Calendar in pixels
height: String
** Optional ** The Height of the Calendar in pixels
contentHeight: String
** Optional ** Content Height of the cell
pageTitle: String
** Optional ** The page title
styleClass: String
** Optional ** The Styleclass for the top level div
calendarStyleClass: String
** Optional ** The Styleclass for the Calendar div

customhtml

Attributes

html: String
** Required ** The Custom HTML that need to be rendered in the Component.
layout: String
** Required ** The Custom HTML that need to be rendered in the Component.
styleClass: String
** Optional ** Style Class for the Custom HTML

dataTable

Attributes

sobjectName: String
fieldSetName: String
** Optional / Required ** The name of the fieldset for column display. Name field is displayed by default
fieldCsv: String
searchable: boolean
sortable: boolean
** Optional ** if the table is sortable
tableHeading: String
** Optional ** The Table heading to be displayed
defaultSortOrder: String
** Optional ** the default sort order
defaultPageSize: Integer
** Optional ** The page size of a table
styleClass: String
tableStyleClass: String
defaultSortColumns: String
** Optional ** CSV String of default Sort columns
editable: Boolean
** Optional ** If the Table is editable
panelStyle: String
Valid styles include default, primary, warning, info, success, inverse and danger.

detail

Attributes

fieldSetNames: String[]
** Conditionally Required ** List of (or one) fieldset(s) to show up on detail page .
fieldSetNamesCSV: String
** Conditionally Required ** List of (or one) fieldset(s) to show up on detail page in the CSV Format.
subjectId: Id
** Required ** Record Id of the Sobject
styleClass: String
** Optional ** The Adhoc Styleclass for the outer div
editable: Boolean
** Optional ** If the detail page is editable
onSubmit: String
** Optional ** Javascript to execute on Form Submit
onSaveComplete: String
** Optional ** Javascript to execute onSaveComplete
successRedirectPageKey: String
** Optional ** External Id of a Page Record.
columnsPerRow: Integer
** Required ** Number of columns per row

feed

Attributes

subjectid: Id
** Required ** The group to which the feed is posted.

form

Attributes

formId: Id
** Required ** The record Id of the form to render.
formResponseId: Id
** Optional ** The record Id of the response to update is optional.
subjectId: Id
** Optional ** The subject Id is used to link the form response to a parent sobject.
subjectLookupField: sobjectField
SobjectField token to use when linking the subject (found by subjectId) as the parent to a Form Response. The field must be a field found on the Form Response custom object and match the subjectId sobject type.
wizard: Boolean
Render the form in wizard format, defaults false
width: String
Valid value for CSS width default is 100%.
reRender: String
Value of the component Id to rerender when the form is saved
onSubmit: String
Javascript to execute when the form is submitted.
responderId: Id
Provide any valid Contact, Account, or User Id to link to the form response generated by the component.
wizardHeight: String
The wizard functionality has been deprecated - it will be replaced in a future release.
wizardNavPosition: String
Control the position of the wizard navigation, does not affect the component when wizard is not set to true. Valid values are right, left, top, and bottom. Default is left.
componentNamespace: String
Namespace component for javascript
submitButtonLabel: String
The label for the submit button on the form.
displaySubmitButton: Boolean
Display Submit Button Label
formIdentifier: String
The label for the submit button on the form.

formexternal

Attributes

formId: Id
** Required ** The record Id of the form to render.
componentNamespace: String
Namespace component for javascript
formResponseId: Id
** Optional ** The record Id of the response to update is optional.
subjectId: Id
** Optional ** The subject Id is used to link the form response to a parent sobject.
subjectLookupField: sobjectField
SobjectField token to use when linking the subject (found by subjectId) as the parent to a Form Response. The field must be a field found on the Form Response custom object and match the subjectId sobject type.
width: String
Valid value for CSS width default is 100%.
reRender: String
Value of the component Id to rerender when the form is saved
onSubmit: String
Javascript to execute when the form is submitted.
responderId: Id
Provide any valid Contact, Account, or User Id to link to the form response generated by the component.
renderSubmit: Boolean
Whether or not to render the submit button
renderTitleInstructions: Boolean
Whether or not to render the title/instructions

groupmembers

Attributes

subjectid: String
The Id of the record. If provided will search related records within that id
searchable: boolean
If the component is searchable
titlefield: String
** Optional ** The Table heading to be displayed
imagefield: String
** Optional ** The Table heading to be displayed
descriptionfieldCSV: String
** Optional ** The Table heading to be displayed
defaultpagesize: Integer
** Optional ** The page size of a table
defaultsortorder: String
** Optional ** The Sort Order for members
defaultsortfield: String
** Optional ** The Sort field for members
modaltitlefield: String
** Optional ** The title field on modal
modaldescriptionfieldsetCSV: String
** Optional ** The title field on modal
filterFieldcsv: String
** Optional ** The title field on modal
showmodalonclick: Boolean
** Optional ** Show the Modal when card is clicked
showfilters: Boolean
** Optional ** Show the Modal when card is clicked
no_results_found_message: String
** Optional ** Message displayed when no results are returned

groups

Attributes

subjectid: String
The Id of the Site. If provided will search related records within that id
showmygroups: Boolean
Boolean flag to show only logged in user groups
searchable: boolean
If the component is searchable
titlefield: String
** Optional ** The Table heading to be displayed
imagefield: String
** Optional ** The Table heading to be displayed
descriptionfieldCSV: String
** Optional ** The Table heading to be displayed
defaultpagesize: Integer
** Optional ** The page size of a table
defaultsortorder: String
** Optional ** The Sort Order for members
defaultsortfield: String
** Optional ** The Sort field for members
filterfieldCSV: String
** Optional ** The filter fields for the page.
showfilters: Boolean
** Optional ** Show the Modal when card is clicked
no_results_found_message: String
** Optional ** Message displayed when no results are returned
navigateurl: String
** Optional ** Url to navigate to when clicked on a card

list

Attributes

records: SObject[]
** Required ** The list of records .
sobjectName: String
** Required ** The SObject name on which a list is created .
filter: String
** Required ** The Sobject filter .
recordLimit: Integer
** Required ** The Sobject Record Limit .
ordered: boolean
** Optional ** Whether the list is ordered or unordered list
orderByFields: String
** Optional ** The fields on which the records must be ordered (can have multiple fields, comma separated)
sortOrder: String
** Optional ** The sort order for the records, valid values ASC and DESC
titleField: String
** Optional ** the field that is highlighted
descriptionFieldsCSV: String
** Optional ** the fields to show under the list item
searchable: Boolean
** Optional ** If the list is searchable
pageSize: Integer
** Optional ** The List Page Size
styleClass: String
** Optional ** Styleclass for top level div container
listStyleClass: String
** Optional ** Styleclass for the UL List group
itemStyleClass: String
** Optional ** StyleClass for the List Item
headerStyleClass: String
** Optional ** StyleClass for the Headers
detailStyleClass: String
** Optional ** StyleClass for the Details
refStyleClass: String
** Optional ** StyleClass for the header field.

navbar

Attributes

name: String
** Required ** Name of Menu .
styleClass: String
** Optional ** The StyleClass for the Menu Component
brandRedirect: String
** Optional ** The Redirect URL when Brand Logo is clicked
brandLogo: String
** Optional ** The Logo URL for the brand image
brandTitle: String
** Optional ** The brand title
navStyleClass: String
** Optional ** The StyleClass for the Nav Component
ulStyleClass: String
** Optional ** The StyleClass for the Ul Component
logoImgClass: String
** Optional ** The StyleClass Logo Image

navlist

Attributes

title: String
** Optional ** The title of Menu .
name: String
** Required ** Name of Menu .
styleClass: String
** Optional ** The StyleClass for the Menu Component
elementStyleClass: String
** Optional ** The StyleClass for the a element
ulStyleClass: String
** Optional ** The StyleClass for the a element
panelType: String
The type of panel includes default, primary, warning, or danger.
displayInPanel: Boolean
Displays the menu inside of a panel.

profiletabs

Attributes

userId: String
** Required ** User Id of the User .
fieldSetNamesCSV: String
** Required ** Fieldsets to show on the Details tab .

userprofile

Attributes

userId: String
** Required ** User Id of the User .
fieldSetNamesCSV: String
** Required ** Fieldsets to show on the Details tab .

userprofilephoto

Attributes

userId: String
** Required ** User Id of the User .
width: String
** Optional ** The Width of the Image .
height: String
** Optional ** The height of the Image .
inputFileStyleClass: String
** Optional ** Input File Style Class .
styleClass: String
** Optional ** StyleClass for the div .
inputFileStyleClass: String
** Optional ** Input File Style Class .

accessible_sites

Attributes

customerId: String
Contact Id of current User

admin_app_config

campaign_page_preview_error

customer360

Attributes

customerId: Id
** REQUIRED ** The ID of an account or contact record to use as the display subject for the component.

epayment_credit_card

Attributes

redirectUrl: String
The url to redirect users after a payment transaction.
postbackUrl: String
The url to redirect users after a payment transaction.
gatewayToken: String
Payment gateway token.
salesOrder: Sales_Order__c
Sales Order object.
epayment: EPayment__c
Epayment sobject.
disable: Boolean
disables the component if there is an error
payment_method_retain: Boolean
Checks the save payment method checkbox by default
hide_save_payment: Boolean
Ability to save payment method
has_payment_error: Boolean
Boolean value to hide AVS values after payment error
credit_card_namespace: String
Namespace for credit card
batch: String
Batch Id

epayment_echeck

Attributes

redirectUrl: String
The url to redirect users after a payment transaction.
gatewayToken: String
Payment gateway token.
salesOrder: Sales_Order__c
Sales Order object.
epayment: EPayment__c
Epayment object.
payment_method_retain: Boolean
Checks the save payment method checkbox by default
hide_save_payment: Boolean
Ability to save payment method
namespace: String
Namespace for e-check component
batch: String
Batch Id

epayment_invoice

Attributes

salesOrder: Sales_Order__c
Sales Order object.
ePayment: EPayment__c
Epayment object.
redirectUrl: String
The url to redirect users after a payment transaction.

epayment_offline

Attributes

salesOrder: Sales_Order__c
Sales Order object.
ePayment: EPayment__c
Epayment object.
redirectUrl: String
The url to redirect users after a payment transaction.
batch: String
Batch Id

epayment_payment_methods

Attributes

customerId: Id
Account/Contact for which the payment methods are managed
salesOrder: Sales_Order__c
Sales Order object.
redirectUrl: String
The url to redirect users after a payment transaction.
gatewayToken: String
Payment gateway token.
epayment: EPayment__c
Epayment sobject.
disable: Boolean
disables the component if there is an error
saved_methods_namespace: String
Namespace for saved payment methods
batch: String
Batch Id

epayment_proforma_invoice

Attributes

salesOrder: Sales_Order__c
Sales Order object.

epayment_result

invoice

Attributes

invoiceId: Id
The id of the invoice to display in the component.

loader

navlist

Attributes

title: String
** Optional ** The title of Menu .
name: String
** Required ** Name of Menu .
ulStyleClass: String
** Optional ** The StyleClass for the a element
panelType: String
The type of panel includes default, primary, warning, or danger.
displayInPanel: Boolean
Displays the menu inside of a panel.
contactId: Id
Contact Id for user

new_receipt_invoice

Attributes

recInvId: Id
The salesforce unique record id of the receipt to display.

order_summary

Attributes

pgController: PageControllerBase
The controller for the page using the component.
componentId: String
The unique component Id for the Component. Will be useful when using multiple components in a single Visualforce page
subjectId: Id
** Required ** Record Id of the parent SObject
styleClass: String
** Optional ** The Adhoc Styleclass for the outer div
header: String
** Optional ** The text for header
cartHeader: String
** Optional ** The header for Cart Section
totalLabel: String
** Optional ** The Cart Total Label
tableClass: String
** Optional ** The Adhoc Styleclass for the table div
itemStyleClass: String
** Optional ** The Adhoc Styleclass for the Item div
removeBtnStyleClass: String
** Optional ** The Adhoc Styleclass for the remove button div
imageWidth: String
** Optional ** The Width of the Image
imageHeight: String
** Optional ** The Height of the Image
pageRerenderPanels: String
** Optional ** The rerender panels - CSV separated, on the parent page that need to be rerendered when order summary changes

payment_methods

Attributes

customerId: Id
Account/Contact for which the payment methods are managed
gatewayToken: String
Token of the gateway with which the new payment methods can be verified
redirecturl: String
redirect url to where you want to redirect the page to after successful verfification

portal_shopping_cart

proforma_invoice_email_pdf

Attributes

soId: String
Sales order record to which the email is sent to

proforma_invoice_template

Attributes

soId: String
Sales order record to which the email is sent to

receipt

Attributes

receiptId: Id
The salesforce unique record id of the receipt to display.

add_to_calendar

Attributes

event: Event__c
The Sobject for the event used as the subject for the component must query the event EventApi__Start_Date_Time__c, EventApi__End_Date_Time__c, EventApi__Calendar_Reminder_Text__c, and EventApi__Display_Name__c fields.
venue: Venue__c
Primary Venue
startDateTime: String
Start Date Time Converted based on timezone
endDateTIme: String
End Date Time Converted based on timezone
calendars: String
Comma-separated list of calendars to support for the component. Valid calendar values are 'iCalendar','Google Calendar','Outlook','Outlook Online', and 'Yahoo! Calendar.'

group_confirmation_email

Attributes

attendeeId: String
Attendee record to which the email is sent to

group_registration_email

Attributes

attendeeId: String
Attendee record to which the email is sent to

mobile_pass

Attributes

event: Event__c
The Sobject for the event used as the subject for the component must query the event EventApi__Start_Date_Time__c, EventApi__End_Date_Time__c, EventApi__Organizer_Name__c, EventApi__Location_Information__c, and EventApi__Display_Name__c fields.
attendee: Attendee__c
The Sobject for the attendee used as the subject for the component.
eventId: Id
The Id for the event used as the subject for the component must query the event EventApi__Start_Date_Time__c, EventApi__End_Date_Time__c, EventApi__Organizer_Name__c, EventApi__Location_Information__c, and EventApi__Display_Name__c fields.
attendeeId: Id
The Id for the attendee used as the subject for the component.
logoImageUrl: String
The logo Image Url.
barcodeUrl: String
Barcode URL for QR code on pass
passIconWidth: String
Pass Icon Width
passIconHeight: String
Pass Icon Height
labelColor: String
Label Color
foregroundColor: String
Color for value font
imageStyleClasses: String
Style Classes for image tag

venue_map

Attributes

venue: Venue__c
Venue sobject to use as the subject for the rendered map.
documentElementId: String
Enter a unique string to use as the div id for the map container.
height: String
Enter the height of the map.

Framework__API_Dispatch_Header_Variables__c

API Dispatch Header Variable
API Dispatch header variables

Custom Fields

API Name Label Type Length Required
Description
Framework__Api_Dispatch__c Api Dispatch Text 255 true
**Required** The name of the API Field to pull the value from
Framework__Key__c Key Text 255 true
**Required** Headers Or Variable Key
Framework__Value__c Value Text 255 true
**Required** Headers Or Variable Value
Framework__SObject_Field_Value__c Value Text 255 false
Value for Header or Variable pulled from SObject so that the value can be dynamic
Framework__Is_Header__c Is Header Checkbox false
**Optional** Is Key/Value Pair a header value
Framework__Is_Variable__c Is Variable Checkbox false
**Optional** Is Key/Value Pair a variable value
Framework__Is_Token_Variable__c Is Token Variable Checkbox false
**Optional** Is Key/Value Pair a token variable value
Framework__Token_Order__c Token Order Number false
**Conditionally** Order for token replacement only if Is Token Variable is set to true

Framework__API_Dispatch__c

API Dispatch
API Dispatch to fire API Calls

Custom Fields

API Name Label Type Length Required
Description
Framework__Api_Resource__c Api Resource Text 255 true
**Required** The name of the API Field to pull the value from
Framework__API_Service__c API Service Text 255 true
**Required** The name of the related API Service
Framework__HTTP_Verb__c HTTP Verb Text 255 true
**Required** Which HTTP verb to call in the Api Resource
Framework__SObject_Name__c SObject Name Text 255 false
Framework__Is_Enabled__c Is Enabled Checkbox false
When enabled, the trigger that fires on the object represented by this rule will route to the defined Apex Class. Default checked.
Framework__Disable_Run__c Disable Run Checkbox false
Disable the next run if the current run is done for after update or after insert
Framework__After_Insert__c After Insert Checkbox false
Fire HTTP calls after insert happens on triggered object
Framework__After_Update__c After Update Checkbox false
Fire HTTP calls after update happens on triggered object
Framework__Execution_Order__c Execution Order Number false
**Conditionally** Order for API Calls to be executed

Framework__API_Grouping__c

API Grouping
List of API Groupings to SObjects related to one API Service and one API Object

Custom Fields

API Name Label Type Length Required
Description
Framework__Api_Object__c Api Object Text 255 true
Name of the JSON API object.
Framework__API_Service__c API Service Text 255 true
The name of the related API Service
Framework__Target_Related_Lookup_Field__c Target Related Lookup Field Text 255 true
Relationship Field between the related object and the primary object selected in the API_Resource__c
Framework__Primary_Api_Resource__c Primary API Resource Text 255 true
Primary API Resource under which this grouping exists.

Framework__API_Mapping__c

API Mapping
List of API mappings to SObjectFields related to one API Service and one API Object

Custom Fields

API Name Label Type Length Required
Description
Framework__Api_Field__c Api Field Text 255 true
**Required** The name of the API Field to pull the value from
Framework__Api_Object__c Api Object Text 255 true
**Required** Name of the parent Api Object for the specified Api Field.
Framework__Api_Resource__c Api Resource Text 255 true
**Required** Name of the parent Api Resource
Framework__Related_Object_Field__c Related Object Field Text 255 false
Framework__Target_Field_Type__c Target Field Type Text 255 true
**Required** The name of the Schema.DisplayType (found in SObjectField.getDescribe().getType())
Framework__Target_Field__c Target Field Text 255 true
**Required** The API name of the target SObjectField to populate with the value of the API Field (Source)

Framework__API_Resource__c

API Resource
API Resource linked to a API Service

Custom Fields

API Name Label Type Length Required
Description
Framework__API_Service__c API Service Text 255 true
**Required** The name of the related API Service configuration.
Framework__Api_Grouping__c Api Grouping Text 255 false
ID of the API Grouping the resource belongs to.
Framework__Api_Object_Key_Field__c Api Object Key Field Text 255 true
Framework__Api_Object__c Api Object Text 255 true
**Required** The name of the API Object related to the API Resource, typically the name of a json object or xml root element.
Framework__Create_URI__c Create URI Text 255 false
Framework__Create_Verb__c Create Verb Text 255 false
Framework__Delete_URI__c Delete URI Text 255 false
Framework__Delete_Verb__c Delete Verb Text 255 false
Framework__Disable_Post_Put_JSON_Parse__c Disable POST/PUT JSON Parse Checkbox false
Denotes if the response from the POST/PUT should be parsed or not.
Framework__Is_List__c Is List Checkbox false
Denotes if the api resource is a list of records or a single record.
Framework__Read_URI__c Read URI Text 255 false
Framework__Read_Verb__c Read Verb Text 255 false
Framework__Target_Object_Key_Field__c Target Object Key Field Text 255 true
Framework__Target_SObject__c Target SObject Text 255 true
**Required** The full api name of the target SObjectType to bind the API Object too.
Framework__Update_URI__c Update URI Text 255 false
Framework__Update_Verb__c Update Verb Text 255 false

Framework__API_Route__c

API Route
API Router route

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 true
**Required** The name of the apex class that implements the ApiInterface class

Framework__API_Service_Connection_Config__c

API Service Connection Config
Multiple connection name/value pairs that may be needed for calls and login.

Custom Fields

API Name Label Type Length Required
Description
Framework__API_Service_Connection__c API Service Connection Text 255 true
Framework__Name__c Name Text 60 true
Framework__Value__c Value Text 255 true
Framework__Is_Masked__c Is Masked Checkbox false

Framework__API_Service_Connection__c

API Service Connection
Service connection object that stores connection info and is related to API Service so you can have multiple connections to single vendor

Custom Fields

API Name Label Type Length Required
Description
Framework__API_Service__c API Service Text 255 true
Framework__Access_Token__c Access Token Text 255 false
Framework__Access_Token_Ext1__c Access Token Ext 1 Text 255 false
Framework__Refresh_Token__c Refresh Token Text 255 false
Framework__Refresh_Token_Ext1__c Refresh Token Ext 1 Text 255 false
Framework__Client_Id__c Client Id Text 255 false
Framework__Client_Secret__c Client Secret Text 255 false
Framework__Is_Default__c Is Default Checkbox false
Framework__Password__c Password Text 255 false
Framework__Scope__c Scope Text 255 false
Framework__Username__c Username Text 255 false

Framework__API_Service__c

API Service
List of API Services registered with the Framework

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 true
Framework__Auth_Type__c Auth Type Text 255 true
Framework__Description__c Description Text 255 false
Framework__Display_Name__c Display Name Text 255 false
Framework__Is_Read_Only__c Is Read Only Checkbox false
When checked, changes can only be made by System.
Framework__Debug_Mode__c Debug Mode Checkbox false
When checked, the responses received from the API Service will be written to System Logs for debugging and troubleshooting.
Framework__Endpoint__c Endpoint Text 255 true
**Required** The base url to send api requests related to the API service
Framework__Is_Enabled__c Is Enabled Checkbox false
Checked when the API Service is live, Unchecked when the API Service is disabled.
Framework__Namespace__c Namespace Text 255 false
Framework__Image_Path__c Image Path Text 255 false

Framework__API_Variable__c

API Variable
Variables that will be used to make network call

Custom Fields

API Name Label Type Length Required
Description
Framework__API_Resource__c API Resource Text 255 true
Framework__Default_Value__c Default Value Text 255 false
Framework__Field_Api_Name__c Field Api Name Text 255 true
Framework__Field_Api_Value__c Field Api Value Text 255 false
Framework__Required__c Required Checkbox false

Framework__App_Update__c

App Update
Custom Setting that controls which features are enabled or disabled.

Custom Fields

API Name Label Type Length Required
Description
Framework__Display_Name__c Display Name Text 255 true
**Required** The name of the critical update to be applied
Framework__Namespace__c Namespace Text 255 true
**Required** The namespace for the app update
Framework__Description__c Description Text 255 false
The description of the critical update to be applied
Framework__Is_Activated__c Is Activated Checkbox false
When activated the apex class will be executed and enable the feature.
Framework__Is_Dismissed__c Is Dismissed Checkbox false
When the app update notification is dismissed.
Framework__Apex_Class__c Apex Class Text 255 false
Apex class to execute when the update is activated
Framework__Forced_Activation_Date__c Forced Activation Date Date false
Date that the update will be force activated and Apex class will be executed.
Framework__Activated_Date__c Activated Date DateTime false
the date when this app update was activated.

Framework__Core__c

Core
**Protected** Fonteva Core hierarchy setting controls Fonteva platform enablement

Custom Fields

API Name Label Type Length Required
Description
Framework__Custom_Domain__c Custom Domain Text 255 false
Custom Domain for org's with special "my.salesforce.com" domains.
Framework__Is_Enabled__c Is Enabled Checkbox false
Enable or disable Fonteva and all Registered Apps
Framework__Triggers_Enabled__c Triggers Enabled Checkbox false
Enable or disable Registered Object Triggers and Trigger Extensions
Framework__Enable_Async_Rollups__c Enable Async Rollups Checkbox false
Enable or disable Async Rollups

Framework__Currency_Conversion_Table__c

Currency Conversion Table
**Protected** Custom settings used for Currency Conversion Table since Portal User does not have access to Standard "CurrencyType" object to get rates.

Custom Fields

API Name Label Type Length Required
Description
Framework__Conversion_JSON__c Conversion JSON TextArea false
Stores the daily rates in JSON format. Scheduled class updates this JSON only if Multi Currency is enabled for related environment.

Framework__Custom_Script__c

Custom Script
**Protected** Configurations for managing ad hoc custom apex scripts related to Registered Apps.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
Name of the apex class (no namespace - or dot namespace conventions) that executes the script and implements the ScriptableInterface.
Framework__Description__c Description TextArea false
Short description for the script when viewed in a list.
Framework__Name__c Name Text 255 false
The display name of the script to end users.
Framework__Namespace__c Namespace Text 255 false
The namespace assigned to the Registered App that owns the configuration.

Framework__Developer_Settings__c

Developer Settings
**Public** Developer settings for working with Framework and extending packages.

Custom Fields

API Name Label Type Length Required
Description
Framework__CDN_Base_Url__c CDN Base Url Text 255 false
** Warning! Do Not Modify ** The base url for the cdn server used to surface assets for framework (lux) ui.

Framework__FontevaPulse_Component__mdt

Fonteva Pulse Component

Custom Fields

API Name Label Type Length Required
Description
Framework__Is_Enabled__c Is Enabled Checkbox false
When checked, this record will become enabled as a template.
Framework__Lightning_Component_Name__c Lightning Component Name Text 255 false
**REQUIRED** Name of the Lightning component that needs to be added. Only provide the name of the component without namespace.

Framework__Registered_App__c

Registered App
**PROTECTED** Enables managed packages to register with NationSuite's Base managed package services.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
The Apex Class assigned to the Registered App.
Framework__Banner_Image_Path__c Banner Image Path Text 255 false
Relative path to the location of the png, gif, or jpeg image file containing a 960 x 300 image used as the banner art for the Registered App's detail page in Mission Control.
Framework__Description__c Description TextArea false
Framework__Developer_Email__c Developer Email Email false
Developer email address used for exception notifications and other workflows related to the Registered App.
Framework__Homepage__c Homepage Url false
Website URL that points to the app's homepage where user's can find additional information.
Framework__Icon_Image_Path__c Icon Image Path Text 255 false
Relative path to the location of the png or gif file containing a 120x120 pixel icon image for the Registered App.
Framework__Install_Class__c Install Class Text 255 false
Framework__Is_Enabled__c Is Enabled Checkbox false
When checked, the app is enabled and dispatch will allow all triggers controlled by the app to fire in the environment. Default checked.
Framework__Is_Managed__c Is Managed Checkbox false
Checked when the registered app is a managed package installed from the AppExchange. Default checked.
Framework__Is_Paid__c Is Paid Checkbox false
Checked when the Registered App is a paid license model.
Framework__Name__c Name Text 255 false
The name of the application as it should appear to end users.
Framework__Owner__c Owner Text 255 false
The name of the individual or business entity that holds the rights for the Registered App.
Framework__Short_Description__c Short Description TextArea false
Short description (less than 255 characters) to use in pages that contain a list of Registered Apps.

Framework__Registered_Object__c

Registered Object
Maps SObjects to a Registered App, Domain Apex Class, and Selector Apex Class with additional controls and configurations.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
The Apex Class assigned as the domain for the Registered Object.
Framework__Validation_Disabled__c Validation Disabled Checkbox false
Disable validation that is run when triggers are dispatched
Framework__Is_Enabled__c Is Enabled Checkbox false
When unchecked, exceptions will be thrown for all triggerable events related to the associated SObjectType. Default checked.
Framework__Is_Standard__c Is Standard Checkbox false
True when the object registered is a standard Salesforce object (Account, Contact, Opportunity, etc...)
Framework__Namespace__c Namespace Text 255 false
Framework__SOQL_Limit__c SOQL Limit Text 255 false
Framework__SOQL_Order_By__c SOQL Order By Text 255 false
Framework__Salesforce_ID__c Salesforce ID Text 20 false
Salesforce.com Id for the related SObject.
Framework__Triggers_Enabled__c Triggers Enabled Checkbox false
When checked Triggers will be routed through Dispatcher for the associated SObjectType assuming all other route trigger evaluated conditions return true. Default checked.

Framework__Registry__mdt

Fonteva Registry Entry

Custom Fields

API Name Label Type Length Required
Description
Framework__Is_Enabled__c Is Enabled Checkbox false
todo
Framework__Category__c Entry Category Text 255 false
todo
Framework__Key__c Entry Key Text 255 true
todo
Framework__Value__c Entry Value LongTextArea 32768 false
todo

Framework__Rollup_Summary_Field__c

Rollup Summary Field
**PROTECTED** "Rollup Summary Field" (RollupSummaryField.class) configurations.

Custom Fields

API Name Label Type Length Required
Description
Framework__Child_Field__c Child Field Text 255 false
Framework__Child_SObject__c Child SObject Text 255 false
Framework__Filter__c Filter Text 255 false
Framework__Is_Enabled__c Is Enabled Checkbox false
Framework__Namespace__c Namespace Text 255 false
Framework__Operation__c Operation Text 255 false
Framework__Parent_Field__c Parent Field Text 255 false
Framework__Parent_SObject__c Parent SObject Text 255 false
Framework__Relationship_Field__c Relationship Field Text 255 false
Framework__Parent_Batch_Scope__c Parent Batch Scope Number false
Number of parent records going into the batch during the resync of the rollup
Framework__Child_Batch_Scope__c Child Batch Scope Number false
Number of child records going into the batch during the batch rollup
Framework__Enable_Batching__c Enable Batching Checkbox false
Rollup enabled for batch processing.
Framework__Enable_Trigger__c Enable Trigger Checkbox false
Enable trigger for parent SObject that will be updated in result of the rollup running.

Framework__Routing_Rule__c

Routing Rule
**PROTECTED** Configurations to control trigger and trigger extension behaviors.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
The class that contains all logic for the object identified by the rule.
Framework__Execution_Order__c Execution Order Number false
The order in which the extension will fire 0 (first) thru 999 (last) positions supported.
Framework__Is_Enabled__c Is Enabled Checkbox false
When enabled, the trigger that fires on the object represented by this rule will route to the defined Apex Class. Default checked.
Framework__Namespace__c Namespace Text 255 false
Framework__SObject_Name__c SObject Name Text 255 false

Framework__Settings_Page__c

Settings Page
** PROTECTED ** List of settings pages configured for a registered app.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
The apex class that implements the DyanamicComponent.Handler interface.
Framework__Apex_Component__c Apex Component Text 255 false
The full api name of the apex (visualforce) component to use when rendering the contents of the page.
Framework__Description__c Description Text 255 false
The description to display to end users.
Framework__Label__c Label Text 255 false
The label for the settings page.
Framework__Namespace__c Namespace Text 255 false
The namespace that corresponds with the registered app that owns the settings page.

Framework__System_Log__c

System Log
Fonteva System Logs captures diagnostic and debugging data for all exceptions handled by Registered Apps using the Fonteva Framework.

Custom Fields

API Name Label Type Length Required
Description
Framework__Data__c Data LongTextArea 32768 false
Data contains the current log at the time the System Log was generated either by an exception, Registered App event, Fonteva Framework event, or user triggered event.
Framework__Exception_Data__c Exception Data LongTextArea 32768 false
Exception data contains information specifically related to exceptions handled by the Fonteva Platform including code line number, exception message, exception type, as well as blamed Registered App and/or Registered Object when applicable.
Framework__Path__c Path Text 255 false
The path of the requested URL from the user who created the System Log.
Framework__Registered_App__c Registered App Text 255 false
The display name of the Registered App that generated the log.
Framework__Registered_Object__c Registered Object Text 255 false
The full api name of the Registered Object that generated the System Log.
Framework__Type__c Type Text 255 false
**System Calculated** Populates with a general description of the event that triggered the System Log.
Framework__User_Profile__c User Profile Text false
The user profile.
Framework__User_Type__c User Type Text false
The user type.
Framework__Is_Shipped__c Is Shipped Checkbox false
Whether or not the log has shipped to our remote logging server.

PagesApi__Community_Group_Member__c

Community Group Member
Junction object which would connect groups or contacts or accounts to different groups.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Account__c Account LookupPagesApi__Account false
Defines the group member to an Account record.
PagesApi__Activated_Date__c Activated Date Date false
Defaults to today's date when no value is populated on record insert.
PagesApi__Bio__c Bio LongTextArea 131072 false
Description of the group member.
PagesApi__Chatter_Group_Member_Id__c Chatter Group Member Id Text 18 false
DO NOT UPDATE. The ID in this field links the group member to a chatter group member. For groups with the contact member entity type only.
PagesApi__Community_Group__c Community Group MasterDetail false
The group under which all the members are linked.
PagesApi__Contact__c Contact LookupPagesApi__Contact false
Defines the group member to a Contact record.
PagesApi__Deactivated_Date__c Deactivated Date Date false
The group member deactivation date.
PagesApi__Display_In_Directory__c Display In Directory Checkbox false
Allows group member to appear in search results when displaying group list views in the portal. Defaults checked if Is Active is checked.
PagesApi__Display_Name__c Display Name Text 255 false
The name of the Group Member as you would like it to display when published to customers.
PagesApi__Email__c Email Email false
The group member's email.
PagesApi__Facebook_Profile_URL__c Facebook Profile URL Text 255 false
URL where the user should be redirected when they click the Facebook icon in the group dashboard.
PagesApi__Google_Profile_URL__c Google+ Profile URL Text 255 false
URL where the user should be redirected when they click the Google+ icon in the group dashboard.
PagesApi__Image_URL__c Image URL Url false
URL for the group member's image or photo.
PagesApi__Is_Active_User__c Is Active User Checkbox false
Identifies an active user related to the group member.
PagesApi__Is_Active__c Is Active Checkbox false
Select whether the group member is active. Defaults checked.
PagesApi__Is_Manager__c Is Manager Checkbox false
Select whether the group member is allowed to manage the group. Defaults unchecked.
PagesApi__Join_Request_Date__c Join Request Date Date false
The date that the group member requested to join a private group.
PagesApi__LinkedIn_Profile_URL__c LinkedIn Profile URL Text 255 false
URL where the user should be redirected when they click the LinkedIn icon in the group dashboard.
PagesApi__Linked_Community_Group__c Linked Community Group LookupPagesApi__Community_Group__c false
Defines the group member that is a part of a collection of groups.
PagesApi__Role__c Role Picklist false
Role of the group member in the group.
PagesApi__Status__c Status Picklist false
Status of the group member record: 1. Request Submitted - group member has requested to join a private group. 2. Active - group member has been added to a group. 3. Request Declined - group member has been rejected upon request to join a private group. 4. Deactivated - group member has been deactivated.
PagesApi__Twitter_Profile_URL__c Twitter Profile URL Text 255 false
URL where the user should be redirected when they click the Twitter icon in the group dashboard.
PagesApi__User__c User LookupPagesApi__User false
Defines a relationship to a contact's related community user record. CANNOT BE UPDATED.

PagesApi__Community_Group__c

Community Group
A group of members which could contain either groups or contacts or accounts.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Banner__c Banner Url false
Banner displayed in the group
PagesApi__Chatter_Group_Id__c Chatter Group ID Text 18 false
**System Calculated** Collaboration group ID that the community group is linked with.
PagesApi__Community_Network_ID__c Community Network ID Text false
** System Calculated ** This field shows the ID for the related community.
PagesApi__Description__c Description LongTextArea 131072 false
Description of the group that should appear in the dashboard of the group.
PagesApi__Email__c Email Email false
The Group's email address.
PagesApi__Enable_Access_Permissions__c DEPRECATED Checkbox false
When checked, the Group will only be made visible when the Contact meets the criteria set in the "Access Permissions" related list. Unchecked by default.
PagesApi__Enable_Community_Feed__c Enable Community Feed Checkbox false
Enables chatter features in the community. Requires members to be enabled.
PagesApi__Enable_Events__c Enable Events Checkbox false
Enables event only features in the community.
PagesApi__Enable_Members__c Enable Members Checkbox false
Enables Member features in the community.
PagesApi__Disable_Join__c Disable Join Checkbox false
Disable joining the community group.
PagesApi__Facebook_Profile_URL__c Facebook Profile URL Text 255 false
URL where the user should be redirected when they click the Facebook icon in the group dashboard.
PagesApi__Google_Profile_URL__c Google+ Profile URL Text 255 false
URL where the user should be redirected when they click the Google+ icon in the group dashboard.
PagesApi__Group_Image_URL__c Group Image URL Url false
URL for the group image that should appear in the dashboard of the group.
PagesApi__Group_Member_Edit_Field_Sets_CSV__c Group Member Edit Field Sets(CSV) Text 255 false
This field references field sets that define the attributes to be updated by the group member when editing their group member profile.
PagesApi__Group_Member_View_Field_Sets_CSV__c Group Member View Field Sets(CSV) Text 255 false
This field references field sets that define the attributes to be seen on the group member modal.
PagesApi__Group_Owner__c Group Owner LookupPagesApi__User false
Owner of the group. Defaults to the user creating the group, if not populated.
PagesApi__Group_Roster_Label__c Group Roster Label Text 255 false
Button label displayed on the group detail page.
PagesApi__Group_Roster_Link__c Group Roster Link Url false
Page where the user should be redirected when they click the roster link. Defaults to the group roster page.
PagesApi__Is_Account_Member_Entity__c SYSTEM Checkbox false
**System Calculated** Selected if Member Entity Type is "Account."
PagesApi__Is_Contact_Member_Entity__c SYSTEM Checkbox false
**System Calculated** Selected if Member Entity Type is "Contact."
PagesApi__Is_Group_Member_Entity__c SYSTEM Checkbox false
**System Calculated** Selected if Member Entity Type is "Group."
PagesApi__Is_Private__c Is Private Checkbox false
Checked if the group is Private.
PagesApi__Is_Public__c SYSTEM Checkbox false
Checked if group is Public.
PagesApi__Is_Published__c Is Published Checkbox false
By checking this field, the group will be displayed in the Community Portal.
PagesApi__Is_Unlisted__c SYSTEM Checkbox false
Checked if group is Unlisted.
PagesApi__LinkedIn_Profile_URL__c LinkedIn Profile URL Text 255 false
URL where the user should be redirected when they click the LinkedIn icon in the group dashboard.
PagesApi__Member_Entity_Type__c Member Entity Type Picklist false
Defines the member type. Only the type selected can be a member of the group.
PagesApi__Member_Search_Display_Fields_CSV__c Member Search Display Fields (CSV) Text 255 false
Defines the fields to be displayed on the group member tiles in the Group Members page using comma separated values of field API names. Limited to Group Member fields only.
PagesApi__Member_Search_Filter_Fields_CSV__c Member Search Filter Fields (CSV) Text 255 false
Enter additional fields, comma separated, to narrow group member searches on the group listing page. Be sure to use the field's API name.
PagesApi__Member_Search_Display_Field_s_CSV__c Member Search Display Fields (CSV) LongTextArea 31768 false
Defines the fields to be displayed on the group member tiles in the Group Members page using comma separated values of field API names. Limited to Group Member fields only.
PagesApi__Member_Search_Filter_Field_s_CSV__c Member Search Filter Fields (CSV) LongTextArea 31768 false
Enter additional fields, comma separated, to narrow group member searches on the group listing page. Be sure to use the field's API name.
PagesApi__Members__c Members Summary false
Number of members in the group.
PagesApi__Privacy_Setting__c Privacy Setting Picklist false
Choose the privacy settings of the group: 1. Public - Open visibility; Open join process 2. Private - Restricted visibility; Approval based join process 3. Unlisted - Visible only to members, not searchable; Backend join process
PagesApi__Private_Community_Feed__c Private Community Feed Checkbox false
Enables Chatter only for members of the community group.
PagesApi__Private_Events__c Private Events Checkbox false
Enables Events only for members of the community group.
PagesApi__Private_Members__c Private Members Checkbox false
Enables member features for members only in the community.
PagesApi__Search_Results_Sort_Field__c Search Results Sort Field Text 255 false
** Defaults Group Name ** Combined with the Search Results Sort Order, this field defines the field to sort group member search results in ascending or descending order. Limited to Community Group Member Fields Only.
PagesApi__Search_Results_Sort_Order__c Search Results Sort Order Text 255 false
** Defaults Ascending ** Combined with the Search Results Sort Field, this field defines the order in which the search results will be displayed.
PagesApi__Search_Results__c Search Results Number false
** Default 10 ** The value in this field defines the maximum number of results that will be returned for search results on the Group Members tab.
PagesApi__Show_Group_Roster__c Show Group Roster Checkbox false
Displays the link of the group roster in the community group dashboard.
PagesApi__Show_Search_Filters__c Show Search Filters Checkbox false
** Default Unchecked ** This field enables or disables the filters in the Group Search page.
PagesApi__Site__c Site LookupPagesApi__Site__c false
** Required ** Link to the Site which owns the Community Group.
PagesApi__Twitter_Profile_URL__c Twitter Profile URL Text 255 false
URL where the user should be redirected when they click the Twitter icon in the group dashboard.
PagesApi__Type__c Type Picklist false
This field allows you to define a type of group to be available in the group search. This field's values can be updated to better suite your organization's needs.

PagesApi__Component__c

Component
List of dynamic components that can be used to create new page elements.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Apex_Class__c Apex Class Text 255 true
The name of the Apex Class that implements the dynamic component interface.
PagesApi__Description__c Description Text 255 false
Short description for the Dynamic Component.
PagesApi__Has_Body__c Has Body Checkbox false
If true, users can define custom html that will be inserted into the apex:componentBody. Default false.
PagesApi__Icon_Path__c Icon Path Url false
The path to the component Icon that can be used in various pages
PagesApi__Image_Path__c Image Path Text 255 false
Link to an image file showing an example implementation of the dynamic component.
PagesApi__Preview_Width__c Preview Width Number false
PagesApi__Do_Not_Display_In_Page_Builder_UI__c Do Not Display In Page Builder UI Checkbox false
When checked, the Component will not be made available for selection in the page builder ui.

PagesApi__Contact

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Site__c Site LookupPagesApi__Site__c false
Select the Site you wish to use as the default Site for the Contact.
PagesApi__Cookie_Usage_Accepted__c Cookie Usage Accepted Checkbox false
When checked, the Contact has accepted the Cookie Usage Prompt and will not be prompted again.

PagesApi__Field_Group__c

Field Group
Field Groups store data about the behavior of a set of fields published on a web form.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__DML_Operation__c Database Operation Picklist false
The value specified in this field either creates new records ("Insert") or updates existing records ("Upsert").
PagesApi__Form__c Form LookupPagesApi__Form__c false
**Required** Identifies the field group's related form.
PagesApi__Allow_Users_to_Delete_Mapped_Records__c Allow Users to Delete Mapped Records Checkbox false
** WARNING ** when checked, users will be able to delete records mapped to the field group even if they were not created by the form submitter.
PagesApi__Instructions__c Instructions LongTextArea 32768 false
The content entered in this field is displayed to end users to assist in entering data into the fields contained in the field group.
PagesApi__Is_Multiple__c Allow Multiple Entries Checkbox false
Enables multiple record entries for an object on the form (like a related list).
PagesApi__Mapped_Object__c Mapped Object Text 255 false
Specifies the target object to which records are created or updated for this field group.
PagesApi__Mapped_Relationship_Field__c Mapped Relationship Field Text 255 false
When linked to a parent field group, this field stores the api name of the lookup or master-detail field that links the two objects together.
PagesApi__Order__c Order Number false
Identifies the order the Field Group is displayed on the form (Sorted Ascending).
PagesApi__Parent_Field_Group__c Parent Field Group LookupPagesApi__Field_Group__c false
Specifies the Parent Object for this Field Group's records.
PagesApi__SOQL_Filter__c SOQL Filter Text 255 false
Defines the filter criteria used to retrieve existing records for this Field Group.

PagesApi__Field_Response__c

Field Response
Object used to identify the responses from form submissions.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Field_Group__c Field Group LookupPagesApi__Field_Group__c false
** System Calculated ** Link to related Field Group.
PagesApi__Field_Help_Text__c Field Help Text Text false
** System Calculated ** Displays the field's help text.
PagesApi__Field_Label__c Field Label Text false
** System Calculated ** Displays the parent field's label.
PagesApi__Field_Order__c Field Order Number false
** System Calculated ** Displays the order specified on the form.
PagesApi__Field_Type__c Field Type Text false
** System Calculated ** Displays the field type.
PagesApi__Field__c Field LookupPagesApi__Field__c false
** System Calculated Required ** Identifies the value's related field.
PagesApi__Form_Response__c Form Response LookupPagesApi__Form_Response__c false
Identifies the related Form Response for form submissions.
PagesApi__Mapped_Field__c Mapped Field Text false
** System Calculated ** Displays the mapped field from the parent field.
PagesApi__Report_Response__c Report Response Text 255 false
** Use for Reporting on Responses ** The report response field trims the length of the entered response to restrict size to less than 255 chars. Currently salesforce will not allow a report to perform groupings on long text area fields.
PagesApi__Response_Group__c Response Group Text 255 false
** SYSTEM FIELD DO NOT EDIT **
PagesApi__System_Reference__c System Reference Text 18 false
** SYSTEM FIELD DO NOT EDIT ** Maps created object id for upsert updates.
PagesApi__Response__c Response LongTextArea 100000 false
** Required ** Identifies the submitted field's value.
EventApi__Attendee__c Attendee LookupEventApi__Attendee__c false
** System Calculated ** Link between the Field Response and the Attendee. Used to display registration question answers.
EventApi__Speaker__c Speaker LookupEventApi__Speaker__c false
** System Calculated ** Link between the Field Response and the Speaker. Used to display Speaker Contract & Agreement information on the Speaker record.
EventApi__Sponsor__c Sponsor LookupEventApi__Sponsor__c false
** System Calculated ** Link between the Field Response and the Sponsor. Used to display Sponsor Contract & Agreement information on the Sponsor record.

PagesApi__Field__c

Field
Fields store data that drives the look and field and behavior of web forms published in the Web Publisher application.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Field_Group__c Field Group LookupPagesApi__Field_Group__c false
**Required** All fields must be associated with a Field Group. Field Groups can be used to update and create new records in the database.
PagesApi__Form__c Form LookupPagesApi__Form__c false
Associates this field to a form.
PagesApi__Help_Text__c Help Text TextArea false
A value in this field displays a help icon next to the field on the form. Hovering the cursor over the help icon displays a text box with the help text field's content to assist the user in understanding the nature of the question.
PagesApi__Hidden_Field_Value__c Hidden Field Value Text 255 false
Populates a hidden field with the value entered in this field (only required when field is hidden on the form by default).
PagesApi__Is_Hidden__c Hidden Field Checkbox false
Does not display the field to end users when checked. This is typically used when you wish to pass default or constant values as the value for the field.
PagesApi__Is_Required__c Is Required Checkbox false
Requires the field for all users submitting the form. Defaults unchecked.
PagesApi__Mapped_Field__c Mapped Field Text 255 false
**Optional** Specifies the field the response will be mapped to.
PagesApi__Options__c Options LongTextArea 32768 false
Specifies the list of values for a Picklist or Multi-Picklist field below. Each value should be separated by a new line.
PagesApi__Order__c Order Number false
Specifies the order this field is presented to the end user.
PagesApi__Type__c Type Picklist false
Identifies the field type to be created. Section Header and Instructional Text fields build out read-only content in the form to enhance the user experience.

PagesApi__Fonteva_Controller_Route__mdt

Fonteva Controller Route
Lightning community routes by record id's.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Apex_Class__c Apex Class Text 255 false
Apex class to get record information based on route
PagesApi__SObject_Name__c SObject Name Text 255 false
SObject name to base the route on
PagesApi__Component__c Component Text 255 false
Lightning Component name without the namespace to show based on SObject route.
PagesApi__Is_Enabled__c Is Enabled Checkbox false
When checked, this record will become enabled as a route.

PagesApi__Form_Response__c

Form Response
Object used to capture form submission attributes that parents Field Responses.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Account__c Account LookupPagesApi__Account false
Identifies the account or the contact's related account.
PagesApi__Contact__c Contact LookupPagesApi__Contact false
Identifies the related contact to the form submission.
PagesApi__Date__c Date Date false
** System Calculated ** Identifies the date the form was submitted.
PagesApi__Entity__c Entity Picklist false
Identifies the "Customer" of the record.
PagesApi__Form__c Form LookupPagesApi__Form__c false
** Required ** Identifies the response's related form.
PagesApi__Responder_Link__c Responder Text false
** System Calculated ** Link to the responder record (Account, Contact, or User).
PagesApi__User__c User LookupPagesApi__User false
** System Calculated ** Link to the User that responded to the Form.
OrderApi__Assignment__c Assignment LookupOrderApi__Assignment__c false
Link to related Assignment.
OrderApi__Item__c Item LookupOrderApi__Item__c false
Link to related Item.
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
Link to related Sales Order Line.
OrderApi__Sales_Order__c Sales Order LookupOrderApi__Sales_Order__c false
Link to related Sales Order.
EventApi__Attendee__c Attendee LookupEventApi__Attendee__c false
** System Calculated ** Link between the Form Response and the Attendee.
EventApi__Registration_Item__c Registration Item LookupEventApi__Registration_Item__c false
** System Calculated ** Link between the Form Response and the Registration Item.
EventApi__Speaker__c Speaker LookupEventApi__Speaker__c false
** System Calculated ** Link between the Form Response and the Speaker.
EventApi__Sponsor__c Sponsor LookupEventApi__Sponsor__c false
** System Calculated ** Link between the Form Response and the Sponsor.

PagesApi__Form__c

Form
Build and publish responsive HTML5 web forms to portal communities or your public facing website.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Description__c Description LongTextArea 32768 false
Optional description for the Form.
PagesApi__Display_Style__c Display Style Picklist false
Defines the display style for the Form. Can be Standard, Accordion or Wizard
PagesApi__Submit_Style__c Submit Style Picklist false
Defines the submit style for the Form. Can be Url Location or Javascript
PagesApi__Submit_Value__c Submit Value LongTextArea 32768 false
URL Location or Javascript to execute on form submission
PagesApi__User_Instructions__c User Instructions LongTextArea 32768 false
Enter the instructions you wish to show users while filling out the form.
PagesApi__Wizard_Review_Instructions__c Wizard Review Instructions LongTextArea 32768 false
For Wizard-style forms only. This text appears on the final review screen.

PagesApi__Media_Asset_Collection__c

Media Collection
Collection of Media Assets.

PagesApi__Media_Asset__c

Media Asset
Upload documents, photographs, animations, videos, music, stylesheets, and javascript files for use in any Fonteva Community.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Download_Link__c Download Link Text false
Download the asset (opens new tab based on browser settings and behavior).
PagesApi__Extension__c Extension Text 255 false
** System Calculated Required ** The extension of the file.
PagesApi__Filename__c Filename Text 255 true
** Required ** The name of the file.
PagesApi__MIME_Type__c MIME Type Text 255 true
** System Calculated ** MIME types form a standard way of classifying file types on the Internet. The MIME Type of the related asset is required.
PagesApi__Media_Asset_Collection__c Media Asset Collection LookupPagesApi__Media_Asset_Collection__c false
Lookup to the Media Asset Collection Object, acts as a grouping parent
PagesApi__Path__c Path Text 255 true
The location of the media asset.
PagesApi__Short_Description__c Short Description TextArea false
Short description about the image that has been uploaded
PagesApi__Title__c Title Text 80 false
The title for the media asset

PagesApi__Menu_Item__c

Menu Item
Menu Items create a hierarchy of links to both Pages and Custom Weblinks.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Custom_URL__c Custom URL LongTextArea 32768 false
** Conditionally Required ** URL for the Web Link. Required for "Custom URL" Menu Items.
PagesApi__Display_Order__c Display Order Number false
** Required ** The order in which this Menu Item should display.
PagesApi__Display_Text__c Display Text LongTextArea 32768 false
** Conditionally Required ** The text to display for "Text" Menu Items.
PagesApi__Icon__c Icon Text 255 false
Optional icon to use in context with the Menu Item. Note! Icon fonts are available only if you define links to the Stylesheets containing their definitions in either the Theme or in a Site's Global CSS.
PagesApi__Link_Target__c Link Target Text 255 false
Specifies how target link is opened in the browser. Valid values include "_self" to open in the same tab, and "_blank" to open in a new window or tab.
PagesApi__Menu_Item__c Parent LookupPagesApi__Menu_Item__c false
Link to the parent Menu Item.
PagesApi__Menu__c Menu MasterDetail false
** Required ** Master-detail link to the parent Menu.
PagesApi__On_Click_Javascript__c On Click Javascript LongTextArea 32768 false
Javascript to run for the "on click" event (when the Menu Item is clicked).
PagesApi__Page__c Page LookupPagesApi__Page__c false
** Conditionally Required ** When the Type of Menu Item is "Page Link".
PagesApi__Style_Class__c Style Class Text 255 false
Custom CSS Style Class to use for the Menu Item.
PagesApi__Value__c Value Text 255 false
** SYSTEM **
PagesApi__Is_Standard__c Is Standard Checkbox false
** SYSTEM **
PagesApi__Type__c Type Picklist false
** Required ** The Type of Menu Item defaults to "Page Link".

PagesApi__Menu__c

Menu
Menus group a collection of Pages and are used to create Navigation elements for Sites published using Fonteva's Publisher.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Site__c Site LookupPagesApi__Site__c false
** Required ** The Site controls the Pages made available when creating Menu Items for the Menu.

PagesApi__Page_Element_Attribute__c

Page Element Attribute
Page Element Attributes store the configuration required for various Page Elements.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Key__c Key Text 255 true
** Required ** Attribute key as defined by the page element dynamic component.
PagesApi__Page_Element__c Page Element MasterDetail false
** Required ** Link to related Page Element.
PagesApi__Value__c Value LongTextArea 32768 false
The value set for the page element configuration.
PagesApi__Type__c Type Text 255 false
** System Field ** The expected and required data type of the page element attribute.

PagesApi__Page_Element__c

Page Element
Page Elements define the content for pages in Fonteva Communities.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Component__c Component Text 255 false
The name of the PagesApi component.
PagesApi__HTML__c HTML LongTextArea 131072 false
HTML content for the page element.
PagesApi__Order__c Order Number false
** Required ** The order in which the element renders inside of a given page section.
PagesApi__Page__c Page LookupPagesApi__Page__c false
** Required ** Link to the page that renders the page element.
OrderApi__Campaign_Page__c Campaign Page LookupOrderApi__Campaign_Page__c false
Link to related Campaign Page.

PagesApi__Page__c

Page
Stores the configurations for custom pages created in Fonteva's Publisher (PagesApi).

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Auth_Required__c Auth Required Checkbox false
When checked the Page will require a User to be authenticated either through the Customer Portal, Partner Portal, or Community. Defaults unchecked.
PagesApi__Enable_SEF_URLs__c Enable SEF URLs Checkbox false
When checked URLs will be re-written into a user friendly format based on the configurations of the Site and Page "Slug" fields. Defaults unchecked.
PagesApi__Is_Published__c Is Published Checkbox false
When checked, the Page is made available either online or in the backend staff interface.
PagesApi__No_Archive__c No Archive Checkbox false
When checked, Google, Yahoo, and Bing will be instructed to not archive the page/cache the Page. Defaults unchecked.
PagesApi__No_Follow__c No Follow Checkbox false
When checked, Google, Yahoo, and Bing will be instructed to not follow and index any links on the Page. Defaults unchecked.
PagesApi__No_Index__c No Index Checkbox false
When checked, Google, Yahoo, and Bing will be instructed to not include the Page in Search Engine Results. Defaults checked.
PagesApi__Page_ID__c Page ID AutoNumber false
Auto incrementing number used as an External ID for the Page.
PagesApi__SEF_Slug__c SEF Slug Text 255 false
Search Engine Friendly (SEF) "Slug" to use when re-writing URLs to improve usability and SEO.
PagesApi__Site__c Site LookupPagesApi__Site__c false
** Required ** Link to the Site where the Page will be published.
PagesApi__Is_Standard__c Is Standard Checkbox false
** SYSTEM **
PagesApi__Menu__c Menu LookupPagesApi__Menu__c false
Link to the related page menu configuration.
PagesApi__Page_URL__c Page URL Url false
** System Calculated ** The URL for the page.
PagesApi__Form__c Form LookupPagesApi__Form__c false
Link to the related form.
PagesApi__Site_Template_Key__c SYSTEM Text false
** System Calculated ** The template key used for the parent site.
PagesApi__Visualforce_Page__c Visualforce Page Text 255 false
The API name (with namespace) of the visualforce page referenced by this page configuration.
PagesApi__Title_Tag__c Title Tag Text 80 false
** Required ** HTML Title tag.
OrderApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked access to the Page is controlled by the related user-defined Access Permissions. Defaults unchecked - essentially enabling all public and authenticated Users access to the Page and related content.

PagesApi__S3__c

S3
** PROTECTED ** Amazon Web Services S3 integration configuration.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__ACL__c ACL Text 255 true
** Required ** Default ACL to use for all media assets. Defaults to "public-read".
PagesApi__Access_Key__c Access Key Text 255 true
** Required ** AWS Access Key
PagesApi__Bucket__c Bucket Text 255 true
** Required ** AWS S3 Bucket used to store all media assets.
PagesApi__Folder__c Folder Text 255 true
** Required ** The customer folder (root) where all media assets will be stored.
PagesApi__Secret__c Secret Text 255 true
** Required ** AWS Secret

PagesApi__Site_Template__c

Site Template
Custom site templates built for Fonteva Communities.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Apex_Class__c Apex Class Text 255 false
PagesApi__Description__c Description Text 255 false
PagesApi__Display_Name__c Display Name Text 255 false
PagesApi__Namespace__c Namespace Text 255 false
PagesApi__Image_Path__c Image Path Text 255 false
PagesApi__Configuration_Fieldset__c Configuration Field Set Text 255 false
PagesApi__Form_VF_Page__c Form VF Page Text 255 false
PagesApi__Custom_Page_VF_Page__c Custom Page VF Page Text 255 false

PagesApi__Site__c

Site
Sites are a collection of Pages published and hosted natively on the Force.com platform.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Site_URL__c Site URL Url false
The base URL for the Site.
PagesApi__Auth_Provider_Default_Account__c Auth Provider Default Account LookupPagesApi__Account false
The default account to use for Auth Provider
PagesApi__Base_Title_Tag__c Base Title Tag Text 255 false
** System Calculated Required Override ** The Base Title Tag is used as a prefix or suffix to all child Page "Title Tags". For example : "My Custom Page < My Base Title Tag". Defaults to the name of the Site.
PagesApi__Community_Network_ID__c Community Network ID Text 255 false
PagesApi__Community_Network_Name__c Community Network Name Text 255 false
PagesApi__Default_Community_New_User_Profile__c Default Community New User Profile Text 255 false
PagesApi__Description__c Description LongTextArea 32768 false
Optional description of the Site.
PagesApi__Enable_SEF_URLs__c Reserved for Future Use Checkbox false
Reserved for Future Use
PagesApi__Google_Login_URL__c Google Login URL Url false
Login URL from Auth Provider in Setup
PagesApi__Is_Default__c Is Default Checkbox false
The default site for a given community. Only one site can be default for a community.
PagesApi__User_Self_Registration_URL__c User Self Registration URL Url false
The URL for the self registration page.
PagesApi__User_Login_URL__c User Login URL Url false
The URL for the login page.
PagesApi__User_Reset_Password_URL__c User Reset Password URL Url false
The URL for the reset password page.
PagesApi__Group_Search_Default_Sort_Field__c Group Search Default Sort Field Text 255 false
** Defaults Group Name ** Combined with the Search Results Sort Order, this field defines the field to sort group search results in ascending or descending order. Limited to Group Fields Only.
PagesApi__Group_Search_Filters_CSV__c Group Search Filters (CSV) Text 255 false
This field references the field set that defines the attributes that a user can use to filter search results.
PagesApi__Group_Search_Page_Results__c Group Search Page Results Number false
** Default 10 ** The value in this field defines the maximum number of results that will be returned for search results on the Groups page.
PagesApi__Group_Search_Result_Display_Fields_CSV__c Group Search Result Display Fields (CSV) Text 255 false
Defines the fields to be displayed on the group tiles in the Groups page using comma separated values of field API names. Limited to Community Group fields only.
PagesApi__Group_Search_Results_Sort_Order__c Group Search Results Sort Order Picklist false
** Defaults Ascending ** Combined with the Search Results Sort Field, this field defines the order in which the search results will be displayed.
PagesApi__Is_Published__c Is Published Checkbox false
When checked, the Site will be published and made available to the appropriate audience. Defaults unchecked.
PagesApi__Enable_Cookie_Prompt__c Enable Cookie Prompt Checkbox false
When checked, the Site will display a prompt asking the user to accept the use of cookies. If not accepted, the user will be redirected to an external site.
PagesApi__Cookie_Decline_Redirect_URL__c Cookie Decline Redirect URL Url false
Required if Enable Cookie Prompt is checked. Field contains the URL to redirect to if the prompt is not accepted. This is conditionally required.
PagesApi__LinkedIn_Login_URL__c LinkedIn Login URL Url false
Login URL from Auth Provider in Setup
PagesApi__Login_Redirect_URL__c Login Redirect URL Text 255 false
PagesApi__Login_Override_URL__c Login Override URL LongTextArea 32768 false
Portal users will be redirected to the provided URL when the "Login" button is clicked on the authentication page.
PagesApi__Create_Account_Override_URL__c Create Account Override URL LongTextArea 32768 false
Providing a URL will hide the "Create a user account" checkbox on the authentication page and display the provided URL link in its place.
PagesApi__Profile_Page_URL__c Profile Page URL Text 255 false
PagesApi__Menu__c Nav Menu LookupPagesApi__Menu__c false
Link to the Menu to use for the Site's "Primary" Navigation.
PagesApi__No_Archive__c No Archive Checkbox false
PagesApi__No_Follow__c No Follow Checkbox false
PagesApi__No_Index__c No Index Checkbox false
PagesApi__SEF_Slug__c Reserved for Future Use Text 255 false
Reserved for Future Use
PagesApi__Site_Template_Key__c Site Template Key Text 255 false
The name of the template to use for creating standard pages and menus related to the site.
PagesApi__Show_Group_Search_Filters__c Show Group Search Filters Checkbox false
** Default Unchecked ** This field enables or disables the filters in the Groups page.
PagesApi__Theme__c Theme LookupPagesApi__Theme__c false
** Required ** The Theme to use for the branding and style of pages contained in the Site.
PagesApi__Title_Tag_Separator__c Title Tag Separator Text 1 false
Optional character to use to separate the Base Title Tag from the Page Title Tag. In the example below the "<" character is used as the Title Tag Separator. Defaults to "|" "My Custom Page Title Tag < My Base Title Tag"
PagesApi__Twitter_Login_URL__c Twitter Login URL Url false
Login URL from Auth Provider in Setup
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
OrderApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked access to the Site is controlled by the related user-defined Access Permissions. Defaults unchecked - essentially enabling all public and authenticated Users access to the Site and related content.
OrderApi__Enable_eStore__c SYSTEM Checkbox false
** System Calculated ** Checked when the Site is linked to a Store.
OrderApi__Store__c Store LookupOrderApi__Store__c false
Link to the Related Store.

PagesApi__Skip_Logic_Rule__c

Skip Logic Rule

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Answer__c Answer Text 255 true
Value on which the rule is activated.
PagesApi__Destination__c Destination LongTextArea 131072 false
List of fields that should appear on selecting the value matching the answer field value(CSV).
PagesApi__Field__c Field MasterDetail false
CSV field with list of fields the rule defined against.

PagesApi__Theme__c

Theme
Themes store configurations for page style and branding.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Body_Background_Color__c Body Background Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Brand_Primary__c Brand Primary Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Brand_Secondary__c Brand Secondary Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Custom_CSS__c Custom CSS LongTextArea 32768 false
Custom CSS is inserted before the closing html head ("</head>") tag into pages using this Theme.
PagesApi__Custom_Print_Stylesheet_URL__c Custom Print Stylesheet URL Text 255 false
Secure ("https://") url to the location of a custom stylesheet to use for rendering pages for print media.
PagesApi__Custom_Stylesheet_URL__c Custom Stylesheet URL Text 255 false
The secure ("https://") url where the stylesheet is hosted.
PagesApi__Description__c Description LongTextArea 32768 false
Optional description for the Theme.
PagesApi__Footer__c Footer LongTextArea 55000 false
Custom HTML to display in the footer of all pages that use the theme.
PagesApi__HTML_Head__c HTML Head LongTextArea 55000 false
Insert custom scripts and styles before the closing </head> tag into pages that use this Theme.
PagesApi__Header__c Header LongTextArea 55000 false
Custom HTML to display in the header of all pages that use the theme.
PagesApi__Link_Color__c Link Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Logo_Image__c Logo Image Text 255 false
The secure ("https://") url where the logo image file is located. We recommend uploading a logo that is of equal height and width and less than 20kb with a 72dpi resolution. The minimum height and width is 150px the maximum is 1000px.
PagesApi__Logo_Text__c Logo Text Text 255 false
If a logo image is not defined for the Theme the logo text will be used by default. Applies only for themes using "Fonteva Drive" as a stylesheet template.
PagesApi__Logo_URL__c Logo URL Text 255 false
The url of the web page to direct users when they click the logo text or logo image on any web page using this Theme. Valid only for Themes using "Fonteva Drive" as a stylesheet template.
PagesApi__Navbar_Background_Color__c Navbar Background Text 255 false
The background color to use for the primary navigation bar affixed to the top of community related pages.
PagesApi__Supernav_Background_Color__c Supernav Background Text 255 false
The background color to use for the supernav.
PagesApi__Supernav_Link_Color__c Supernav Link Text 255 false
The color to use for links contained inside the supernav.
PagesApi__Supernav_Text_Color__c Supernav Text Text 255 false
The color to use for text contained inside the supernav.
PagesApi__Favicon_Image__c Favicon Image Text 255 false
The image to use for a favicon used for visual site identification in various browser interfaces (bookmarks,tabs,etc...).
PagesApi__Navbar_Link_Color__c Navbar Link Text 255 false
The color to use for links contained inside the primary navigation bar affixed to the top of community related pages.
PagesApi__Text_Color__c Text Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Supernav_HTML_Position_1__c Supernav HTML Position 1 LongTextArea 30000 false
The Text/HTML for the Supernav Position #1.
PagesApi__Supernav_HTML_Position_2__c Supernav HTML Position 2 LongTextArea 30000 false
The Text/HTML for the Supernav Position #2.
PagesApi__Supernav_HTML_Position_3__c Supernav HTML Position 3 LongTextArea 30000 false
The Text/HTML for the Supernav Position #3.
PagesApi__Community_Styles__c SYSTEM LongTextArea 30000 false
Generated Styles for Community.
PagesApi__Lightning_Community_Styles__c SYSTEM LongTextArea 30000 false
Generated Styles for Lightning Community.

PagesApi__User

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Is_Federated_User__c Is Federated User Checkbox false
PagesApi__Profile_Cover_Image__c Profile Cover Image Text 255 false
The secure ("https://") url where the profile cover image file is located. We recommend uploaded a logo that has a width of 1100px and height of 300px.

OrderApi__AVS_Response_Code__c

AVS Response Codes

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Description__c Description Text 255 false

OrderApi__Access_Permission__c

Access Permission
Access Permissions control the accessibility of content accessed via the API.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Badge_Type__c Badge Type LookupOrderApi__Badge_Type__c false
** Conditionally Required ** If "User Restricted Access Rule" is unchecked, a link to the Badge Type required to access the content is required.
OrderApi__Catalog__c Catalog LookupOrderApi__Catalog__c false
Link to the related Catalog that the Display Permission is controlling.
OrderApi__Icon__c Enabled Badge Type Text false
** System Calculated ** Icon for the related Badge Type with Badge Name.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
Link to the controlled Item Class -- when linked to an Item Class the Access Permission will clone itself by default to all Items created as a child to the Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
When linked to an Item - the Access Permission serves as validation for wether the purchasing Account or Contact is allowed to be assigned and/or sold the Item.
OrderApi__Page__c Page LookupPagesApi__Page__c false
Link to the related Page that the Display Permission is controlling.
OrderApi__Site__c Site LookupPagesApi__Site__c false
Link to the related Site that the Display Permission is controlling.
OrderApi__Store__c Store LookupOrderApi__Store__c false
Link to the related Store that the Display Permission is controlling.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to the Event related to the configured Access Permission.
EventApi__Registration_Group__c Registration Group LookupEventApi__Registration_Group__c false
** System Calculated ** Link to the Registration Group configured with the Access Permission.
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c false
** System Calculated ** Link to the Schedule Item configured with the Access Permission.
EventApi__Sponsor_Package__c Sponsor Package LookupEventApi__Sponsor_Package__c false
** System Calculated ** The link to the Sponsor Package configured with the Access Permission.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
** System Calculated ** The link to the Ticket Type configured with the Access Permission.
EventApi__Event_Status_Page__c Event Status Page LookupEventApi__Event_Status_Page__c false
** System Calculated ** The link to the Event Status Page configured with the Access Permission.

OrderApi__Account

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account_Email__c Account Email Email false
The default/primary email for the account.
OrderApi__Annual_Engagement_Score__c Annual Engagement Score Number false
Aggregates the Account's active engagement scores from it's badge records for the current year.
OrderApi__Outstanding_Credits__c Outstanding Credits Currency false
** System Calculated ** The sum of the Credit Memo Balance Due field for all Credit Memos linked to this customer.
OrderApi__Disable_Badge_Flow_down__c Disable Badge Flow-down Checkbox false
When checked, this field disables any inheritance of flow-down badges from the parent account.
OrderApi__Lifetime_Engagement_Score__c Lifetime Engagement Score Number false
Aggregates the Account's active engagement scores from it's badge records.
OrderApi__Primary_Contact__c Primary Contact LookupOrderApi__Contact false
The Primary Contact for the Account will auto-populate on all Account Transactions, Payments, etc... by default.
OrderApi__Price_Rules_Usages__c SYSTEM LongTextArea 131072 false
** SYSTEM ** JSON of price rules
OrderApi__Privacy_Settings__c Privacy Settings Picklist false
**Defaults to private** This field sets the visibility settings when account search is enabled. Public: Any user in the system can search. Private: Searchable by authenticated users only. Unlisted: Can not be searched at all.

OrderApi__AccountDomain__c

Account Domain
Stores the accepted domain names for the related account, which will be used for account matching.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Company__c Company LookupOrderApi__Account false
**Required** Linked the to related account.
OrderApi__Value__c Value Text 255 true
**Required** The value for the domain.

OrderApi__App_Config__c

App Config
Order to Cash Preferences for Fonteva Order Management

Custom Fields

API Name Label Type Length Required
Description
OrderApi__AR_Account__c A/R Account Text 20 false
Default AR (Accounts Receivable) Account.
OrderApi__Adjustment_Account__c Adjustment Account Text 20 false
Default Adjustment Account.
OrderApi__Business_Group__c Business Group Text 20 false
User/Profile default Business Group.
OrderApi__Calculate_Sales_Tax__c Calculate Sales Tax Checkbox false
When checked, enables the tax related valdiations and calculations.
OrderApi__Deposit_Account__c Deposit Account Text 20 false
Default Deposit Account.
OrderApi__Disable_Save_Payment_Method_Option__c Disable Save Payment Method Option Checkbox false
When checked, it disables the save payment method option on process payment.
OrderApi__Discount_Account__c Discount Account Text 20 false
Default Discount Account.
OrderApi__Enable_Individual_Accounts__c Enable Individual Accounts Checkbox false
When checked, Users will create individual/person/household accounts when contacts are created without a relationship to an existing account.
OrderApi__Exception_Account__c Exception Account Text 20 false
**System Calculated/Override** NationSuite creates an exception account record to use when a contact with no parent account is linked to a financial transaction without a specified account.
OrderApi__Exception_Contact__c Exception Contact Text 20 false
**System Calculated/Override** NationSuite creates an exception contact record to use when an account with no primary contact is linked to a financial transaction without a specified contact.
OrderApi__Income_Account__c Income Account Text 20 false
Default Income Account (used when creating new Business Groups and Items)
OrderApi__Individual_Account_Name_Extension__c Individual Account Name Extension Text 255 false
The individual account name extension is used when naming new individual/person accounts created in the system. The default value is "Household" which produces "John Doe Household".
OrderApi__Item_Weight_UOM__c Item Weight UOM Text 255 false
This field defines the default unit of measurement for shipping calculations.
OrderApi__Namespace_Prefix__c Namespace Prefix Text 20 false
**System Calculated/Do Not Modify** Namespace Prefix for the NationSuite Platform package.
OrderApi__Payment_Gateway__c Payment Gateway Text 100 false
Default Payment Gateway.
OrderApi__Payment_Terms__c Payment Terms Text 20 false
Default Payment Terms.
OrderApi__Refund_Account__c Refund Account Text 20 false
Default Refund Account.
OrderApi__Tax_Account__c Tax Account Text 20 false
Default Tax GL Account.
OrderApi__Tax_Locale__c Tax Locale Text 20 false
Default Tax Locale.
OrderApi__Bypass_Account_Billing_Address_Sync__c Bypass Account Billing Address Sync Checkbox false
Warning! Existing integrations may be broken when enabling this feature. When checked, the Account Billing Address field will no longer be updated with the value of the Account Shipping Address field.
OrderApi__Update_Contact_Standard_Email_Field__c Update Contact Standard Email Field Checkbox false
Warning! Existing integrations may be broken when enabling this feature. When checked, the contact email field will be updated with the value of the contact preferred email field.
OrderApi__Update_Contact_Standard_Phone_Field__c Update Contact Standard Phone Field Checkbox false
Warning! Existing integrations may be broken when enabling this feature. When checked, the contact phone field will be updated with the value of the contact preferred phone field.

OrderApi__Assignment_Role__c

Assignment Role
Configure custom roles for Contacts to be assigned to against "Assignable" Items.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Description__c Description LongTextArea 32768 false
Optional description for the Assignment Role.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, the Roles is considered "Active".
OrderApi__Is_Default__c Is Default Checkbox false
When checked, the Roles is considered as"Default Assignment Role".
OrderApi__Is_Primary__c Is Primary Checkbox false
When checked, any Contact "Assignment" linked to the Assignment Role will be considered a "Primary Contact" for the "Assigned To Record". Defaults unchecked.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
OrderApi__Receives_Email_Notifications__c Receives Email Notifications Checkbox false
When checked, any Contact "Assignment" linked to the Assignment Role will receive notifications related to the "Assigned To Record" by default. Defaults unchecked.

OrderApi__Assignment__c

Assignment
Assignments track Contacts assigned to purchases of Items (Only available when Items are available for Assignment - determined by the parent Item Class)

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Assigned_Date__c Assigned Date Date false
** System Calculated Required Override ** Defaults to the parent Sales Order Line.
OrderApi__Assignment_Role__c Assignment Role LookupOrderApi__Assignment_Role__c false
** System Calculated Required Override ** Link to the Role for the assigned Contact on record.
OrderApi__Company_Name__c Company Name Text 255 false
Contact company name.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
** Required ** Link to assigned Contact record
OrderApi__Description__c Description LongTextArea 32768 false
Optional description for the Assignment.
OrderApi__Email__c Email Email false
** Conditionally Required ** The email address to send notifications to regarding the "Assigned To" record -- required if "Receives Email Notifications" is checked. Defaults to the related Contact's "Preferred Email".
OrderApi__First_Name__c First Name Text 255 false
Contact first name.
OrderApi__Full_Name__c Full Name Text 255 false
Contact full name.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, the Contact is considered "Active". Defaults checked.
OrderApi__Is_Primary__c Is Primary Checkbox false
When checked, the Assignment is considered "Primary".
OrderApi__Is_Unassigned__c Is Unassigned Checkbox false
** System Calculated ** This checkbox will auto check to true when a Subscriber (Assignment) is marked as "Is Active" unchecked AND is related to a "Is Active" checked Subscription.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated ** Link to related Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
** System Calculated ** Link to related Item.
OrderApi__Last_Name__c Last Name Text 255 false
Contact last name.
OrderApi__Mailing_City__c Mailing City Text 255 false
Contact mailing city.
OrderApi__Mailing_Country__c Mailing Country Text 255 false
Contact mailing country.
OrderApi__Mailing_Postal_Code__c Mailing Postal Code Text 255 false
Contact mailing postal code.
OrderApi__Mailing_State__c Mailing State Text 255 false
Contact mailing postal code.
OrderApi__Mailing_Street__c Mailing Street Text 255 false
Contact mailing street.
OrderApi__Phone__c Phone Phone false
Contact phone.
OrderApi__Receives_Email_Notifications__c Receives Email Notifications Checkbox false
When checked the linked Contact will be copied on all emails sent regarding the "Assigned To" record. Defaults to the value of the same field on the related "Role" configuration.
OrderApi__Sales_Order_Line__c Sales Order Line (Source) LookupOrderApi__Sales_Order_Line__c false
** Required ** Assignments must be linked to a source Sales Order Line
OrderApi__Subscription_Line__c Subscription Line LookupOrderApi__Subscription_Line__c false
** System Calculated ** Link to related Subscription Line.
OrderApi__Subscription__c Subscription LookupOrderApi__Subscription__c false
Link to related Subscription for the subscribing customer.
OrderApi__Term__c Term LookupOrderApi__Renewal__c false
Link to related Term for the subscribing customer.
OrderApi__Title__c Title Text 255 false
Contact title.
OrderApi__Unassigned_Date__c Unassigned Date Date false
The date the Contact was unassigned.
EventApi__Other_Information__c Other Information LongTextArea 32768 false
Other information needed to configure the assignment.
EventApi__Seat__c Seat LookupEventApi__Seat__c false
Linked to the related seat.
EventApi__Contact_Created_By_System__c Contact Created By System Checkbox false
This field will be automatically checked when the contact is created while registering for an event.

OrderApi__Badge_Type__c

Badge Type
Configure Badge Types to assign to Contacts to allow greater control and flexibility around pricing and content accessibility.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Description__c Description LongTextArea 32768 false
Optional description of the Badge Type
OrderApi__Enable_Badge_Flow_down__c Enable Badge Flow-down Checkbox false
When checked and when the badge is assigned to an account, all contacts of that account, child accounts, and child account's contacts will inherit the benefits. Limited to only one level of child accounts.
OrderApi__Engagement_Score__c Engagement Score Number false
The engagement score that is to be assigned to the entity's badge record.
OrderApi__Icon_Location__c Icon Location Text 255 false
** System Calculated Override ** Override the default Badge Type icon with a custom image to distinguish the Badge Type from other Badge Types.
OrderApi__Icon__c Icon Text false
** System Calculated ** Badge Image Icon -- displayed in most Contact Badge list views.
OrderApi__Image_Location__c Image Location Text 255 false
Distinguish the Badge Type from other Badge Types by providing the URL to a securely hosted image to use as the Badge Type Image.
OrderApi__Image__c Image Text false
** System Calculated ** Preview the Badge Image configured for the Badge Type.
OrderApi__Is_Active__c Is Active Checkbox false
When checked the Badge Type is active and available for assignment to a Contact
OrderApi__Is_Published__c Is Published Checkbox false
When checked, Contacts assigned Badge related to the Badge Type will have the option to display the Badge on their Community Profile (valid only if Fonteva Communities is enabled for your environment - contact your administrator if you have any questions)
OrderApi__Public_Description__c Public Description Html 32768 false
The contents of this field will publish to the community portal.
OrderApi__Short_Description__c Short Description Text 255 false
Optional (but highly recommended) short description used on reports and to provide context to end users looking at a list of Contacts assigned to various badges.

OrderApi__Badge_Workflow__c

Badge Workflow
Trigger the assignment and unassignment of Badges to Contacts using Badge Workflow

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Auto_Expire__c Auto Expire Checkbox false
When checked, the Badge will automatically unassign itself from the Contact record when the Assignment record becomes in active. "Is Active" is unchecked. Defaults unchecked.
OrderApi__Badge_Type__c Badge Type LookupOrderApi__Badge_Type__c false
** Required ** Link to the related Badge Type
OrderApi__Item__c Item LookupOrderApi__Item__c false
Link to the related Item
OrderApi__Line_Contact__c Line Contact Checkbox false
** System Calculated/Override ** Checked when the Type field set to "Line Contact".
OrderApi__Line_Account__c Line Account Checkbox false
** System Calculated/Override ** Checked when the Type field set to "Line Account".
OrderApi__Assigned_Contacts__c Assigned Contacts Checkbox false
** System Calculated/Override ** Checked when the Type field set to "Assigned Contacts".
OrderApi__Type__c Type Picklist false
** Required ** Select "Line Contact" to assign the Badge to the purchasing Customer as defined in the "Contact" lookup field on the Sales Order Line. Select "Assigned Contacts" to give the Badge to all "Active" assigned Contacts.

OrderApi__Badge__c

Badge
Badges are assigned to Contacts either automatically (Badge Workflow) or manually. Badges can enable Contacts for special Price Rules - as well as permission to read, update, or delete certain content types.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
Link to the assigned Account.
OrderApi__Assignment__c Assignment LookupOrderApi__Assignment__c false
** System Calculated ** Badges can be auto-assigned to Contacts based on "Assignment" the link to the "Assignment" record is used to auto-unassign the badge when the Contact has been "Unassigned".
OrderApi__Awarded_Date__c Awarded Date Date false
** System Calculated Required Override ** The date the Badge Type was assigned to the Contact. Defaults to today's date if no other value provided on record creation.
OrderApi__Badge_Description__c Badge Description Text false
** System Calculated ** Value of the "Short Description" field for the linked Badge Type.
OrderApi__Badge_Type_Icon__c Badge Text false
** System Calculated ** Icon with link anchored by the Badge Type Name to the Badge Type assigned to the Contact.
OrderApi__Badge_Type__c Badge Type LookupOrderApi__Badge_Type__c false
OrderApi__Badge_Workflow__c Badge Workflow LookupOrderApi__Badge_Workflow__c false
** System Calculated ** Link to related Badge Workflow that auto-assigned the Badge Type to the Contact.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
Link to the assigned Contact.
OrderApi__Expired_Date__c Expired Date Date false
** System Calculated ** The date the Badge Type was un-assigned from the Contact.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, the Badge is considered "Awarded" and "Active" and will be considered when calculating any permission or pricing configurations related to the linked Badge Type. Defaults checked.
OrderApi__Engagement_Score__c Engagement Score Number false
The numerical engagement score assigned for receiving the badge.
OrderApi__Item__c Item LookupOrderApi__Item__c false
** System Calculated ** Link to related Item that was related to the Assignment or the Sales Order Line that invoked the workflow that auto-assigned the Badge Type to the Contact.
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
** System Calculated ** Link to related Sales Order Line that invoked the workflow that auto-assigned the Badge Type to the Contact.

OrderApi__Batch__c

Batch
Batch receipts to improve and faciliate bank reconcilation.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Actual_Amount__c Actual Amount Currency false
**System Calculated** The sum (amount) of entries entered for the batch.
OrderApi__Actual_Count__c Actual Count Number false
**System Calculated** The current number of entries entered for the batch.
OrderApi__Batch_Number__c Batch Number AutoNumber false
**Auto Calculated** Auto incrementing number. (External Id)
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override/Required** Link to the related Business Group from the Batch inherited from the current user's assigned Business Group if not defined on record creation.
OrderApi__Closed_Date__c Closed Date Date false
The date the Batch was closed and assessed as Ready to Post.
OrderApi__Date__c Default Date Date false
The date to use as the default Date for related Receipts.
OrderApi__Deposit_Account__c Deposit Account LookupOrderApi__GL_Account__c false
**System Calculated/Override/Required** The GL account related to the deposit account (bank) for the batch.
OrderApi__Entity__c Default Entity Picklist false
Select a default Entity for related Receipts to the Batch.
OrderApi__Expected_Amount__c Expected Amount Currency false
**Required** The expected sum (amount) of entries for the batch.
OrderApi__Expected_Count__c Expected Count Number false
**Required** The expected number of entries for the batch.
OrderApi__Is_Closed__c Is Closed Checkbox false
When checked the batch is considered closed and the system will restrict users (without special permissions assigned to their profile) from editing the batch or entries associated with the batch.
OrderApi__Is_Posted__c Is Posted Checkbox false
When checked, related receipts are posted to Transactions.
OrderApi__Item__c Default Item LookupOrderApi__Item__c false
Link to related Item to use as "Default" for related Batch Receipts. (Available in Batch UI only)
OrderApi__Opened_Date__c Opened Date Date false
The date the Batch was opened.
OrderApi__Payment_Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
Link to the Payment Gateway assigned to the Batch (for online transactions and offline entry of transactions)
OrderApi__Payment_Type__c Payment Type Picklist false
Select the Payment Type for the Batch.
OrderApi__Posted_Date__c Posted Date Date false
The date the Batch was posted.
OrderApi__Source_Code__c Source Code LookupOrderApi__Source_Code__c false
Source Code to set by default on cash entries created from the Batch.

OrderApi__Business_Group__c

Business Group
Separate groups or business entities to facilitate clear reporting on business lines and/or entities.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__AR_Account__c A/R Account LookupOrderApi__GL_Account__c false
**Required** Business groups require a relationship to a default A/R account.
OrderApi__Business_Entity_Type__c Business Entity Type Picklist false
**Optional/When Applicable** Specify the Legal Entity Type for the Business Group.
OrderApi__Calculate_Sales_Tax__c Calculate Sales Tax Checkbox false
When checked, enables the tax related validations and calculations.
OrderApi__Customer_Support_URL__c Customer Support URL Text 255 false
Fully qualified URL is required. A fully qualified URL contains the http:// (or https://www). If the URL is just your domain, the trailing / should also be provided.
OrderApi__Credit_Memo_Account__c Credit Memo Account LookupOrderApi__GL_Account__c false
Link to the GL Account used to create new credit memo receipts linked to this business group.
OrderApi__Default_Payment_Gateway__c Default Payment Gateway LookupOrderApi__Payment_Gateway__c false
Defines the Default Payment Gateway to the related Business Group.
OrderApi__Deposit_Account__c Deposit Account LookupOrderApi__GL_Account__c false
**System Calculated/Override** The default deposit account to use for posting cash entry transactions.
OrderApi__Description__c Description Text 255 false
Briefly describe the ledger as you would like to see it on a report. (72 Chars. or less)
OrderApi__Display_Name__c Display Name Text 255 false
** System Calculated Override ** The name that should be displayed when the Business Group is referenced on Invoices and other external pages and documents. Defaults to the "Name" defined for the Business Group.
OrderApi__Transfers_Payable_Account__c Transfers Payable Account LookupOrderApi__GL_Account__c false
The GL Account to use for intracompany transfer payable transactions.
OrderApi__Transfers_Receivable_Account__c Transfers Receivable Account LookupOrderApi__GL_Account__c false
The GL Account to use for intracompany transfer receivable transactions.
OrderApi__Email__c Email Email false
** System Calculated ** The email address to display to customers on Invoices and related documents.
OrderApi__Homepage_URL__c Homepage URL Url false
Fully qualified URL is required. A fully qualified URL contains the http:// (or https://www). If the URL is just your domain, the trailing / should also be provided.
OrderApi__Invoice_Footer__c Invoice/Receipt Footer LongTextArea 32768 false
Custom message that displays at the bottom of all invoices and receipts.
OrderApi__Invoice_OverPayment_Credit_Memo_Limit__c Invoice Overpayment Credit Memo Limit Currency false
When an invoice is overpaid by an amount less than or equal to the value of this field, a new credit memo will be created and applied against the customer's account automatically.
OrderApi__Invoice_Header__c Invoice/Receipt Header LongTextArea 32768 false
Custom message that displays at the top of all invoices and receipts.
OrderApi__Invoice_Write_off_Limit__c Invoice Write-off Limit Currency false
When an Invoice is underpaid by an amount lesser or equal to the value of this field, the Invoice will automatically adjust itself and write off the remaining balance due.
OrderApi__Invoice_Write_off_Account__c Invoice Write-off Account LookupOrderApi__GL_Account__c false
Link to the GL Account used to write-off remaining balances for Invoices linked to this Business Group.
OrderApi__Is_Master__c Is Master Checkbox false
When checked, the Business Group is enabled for e-invoicing and can connect to a Payment Gateway for e-payment processing. When unchecked, a Parent Business Group must be designated. Defaults checked.
OrderApi__Mailing_Address__c Mailing Address LongTextArea 32768 false
** System Calculated Required Override ** The address to display on Invoices and related documents that reference the Business Group. Defaults from the Organization settings.
OrderApi__Merchant_Location__c Merchant Location Text 255 false
Some gateways allow you to customize the location of the merchant that appears on customer's credit card statements. (Optional) provide a merchant location descriptor.
OrderApi__Merchant_Name__c Merchant Name Text 255 false
Some gateways allow you to customize the name that appears on customer's credit card statements. (Optional) provide a custom merchant name descriptor.
OrderApi__Parent_Business_Group__c Parent Business Group LookupOrderApi__Business_Group__c false
Lookup Relationship to Business Group. Create a hierarchy of Business Groups by department, legal entity, etc. to improve Financial Reporting.
OrderApi__Phone__c Phone Phone false
** System Calculated Override ** The phone number to display to customers on Invoices and related documents. Defaults to the Organization's phone number.
OrderApi__Theme__c Theme LookupPagesApi__Theme__c false
Link to the Theme to use for the Business Group's eInvoicing portal.
OrderApi__Type__c Type Picklist false
List of Business Group Types (Department, Affiliate, Partner, Etc.). Select the most appropriate type from the list.
OrderApi__Shipping_Rate_Basis__c Shipping Rate Basis Picklist false
Select whether you want shipping to be calculated based on item weight or item value (price).
OrderApi__Enable_Shipping_By_Order_Total__c Enable Shipping by Order Total Checkbox false
When selected, customers will see a single shipping rate for the entire order. Otherwise, customers will see shipping rates for each unique item in their order. In either case, shipping is calculated only for items that have "Require Shipping" enabled.
OrderApi__Invoice_Header_Fieldset_CSV__c Invoice Header Fieldset CSV LongTextArea 131072 false
Stores the custom fieldsets of an invoice header as a CSV.
OrderApi__Receipt_Header_Fieldset_CSV__c Receipt Header Fieldset CSV LongTextArea 131072 false
Stores the custom fieldsets of a receipt header as a CSV.
OrderApi__Invoice_Lines_Fieldset__c Invoice Lines Fieldset LongTextArea 131072 false
Stores the custom fieldsets of an invoice line as a CSV.
OrderApi__Receipt_Lines_Fieldset__c Receipt Lines Fieldset LongTextArea 131072 false
Stores the custom fieldsets of a receipt line as a CSV.
OrderApi__Receipt_Header_HTML__c Receipt Header HTML Html 32768 false
Custom message that displays at the top of all receipts.
OrderApi__Invoice_Header_HTML__c Invoice Header HTML Html 32768 false
Custom message that displays at the top of all invoices.
OrderApi__Receipt_Footer_HTML__c Receipt Footer HTML Html 32768 false
Custom message that displays at the bottom of all receipts.
OrderApi__Invoice_Footer_HTML__c Invoice Footer HTML Html 32768 false
Custom message that displays at the bottom of all invoices.
OrderApi__Proforma_Invoice_Authentication_Required__c Proforma Invoice Authentication Required Checkbox false
When checked, the customer paying a proforma invoice will be forced to authenticate prior to accepting payment.
OrderApi__Proforma_Invoice_Email_Body__c Proforma Invoice Email Body Html 32768 false
The default message used as part of the "Send Proforma Email" Workflow
OrderApi__Proforma_Invoice_Email_From_Address__c Proforma Invoice Email From Address Text 255 false
The email address of the sender of the proforma invoice email sent to your customers. Your user's email will be used if this field is left blank.
OrderApi__Proforma_Invoice_Email_From_Name__c Proforma Invoice Email From Name Text 255 false
The name of the sender of the proforma invoice email as it will display to your customers. Your user's first name and last name will be used if this field is left blank.
OrderApi__Proforma_Invoice_Email_Subject__c Proforma Invoice Email Subject Text 240 false
The default subject of the proforma invoice email sent to your customers. Your user's email will be used if this field is left blank.
OrderApi__Proforma_Invoice_Footer__c Proforma Invoice Footer Html 32768 false
The contents of this field will display inside the Footer of all proforma invoice documents generated from Sales Orders linked to this Business Group.
OrderApi__Proforma_Invoice_Header__c Proforma Invoice Header Html 32768 false
The contents of this field will display inside the header of all proforma invoice documents generated from Sales Orders linked to this Business Group.
OrderApi__Required_Tax_Fields_CSV__c Required Tax Fields (CSV) Text 255 false
Enter the API name of the Sales Order Billing address field the system will require on checkout. (Ex. Billing_State__c)

OrderApi__CVV_Response_Code__c

CVV Response Code

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Description__c Description Text 255 false

OrderApi__Campaign_Page__c

Campaign Page
Page that can be built by customer to show to user to purchase items.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Average_Sale__c Average Sale Currency false
** System Calculated ** Total Revenue / Sales
OrderApi__Average_Visitor_Value__c Average Visitor Value Currency false
** System Calculated ** Total Revenue / Visits.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
OrderApi__Conversion_Rate__c Conversions Number false
** System Calculated ** Sales / Visits
OrderApi__Expenses__c Expenses Currency false
Enter expenses to track ROI
OrderApi__Goal__c Goal Currency false
Enter a revenue goal for the campaign page.
OrderApi__Header_Content__c Header Content LongTextArea 100000 false
Custom HTML rendered in the header of the page.
OrderApi__Footer_Content__c Footer Content LongTextArea 100000 false
Custom HTML rendered in the footer of the page.
OrderApi__Name__c Campaign Name Text 255 false
The name of the Campaign
OrderApi__Description__c Description TextArea false
The description for the Campaign page record
OrderApi__Is_Published__c Is Published Checkbox false
Boolean flag that specifies if the page is available for use
OrderApi__Payment_Gateway__c SYSTEM LookupOrderApi__Payment_Gateway__c false
OrderApi__ROI__c ROI Currency false
** System Calculated ** Total Revenue - Expenses.
OrderApi__Sales__c Sales Number false
** System Calculated ** Number of sales orders generated.
OrderApi__Shopping_Cart_Enabled__c Shopping Cart Enabled Checkbox false
When checked, the page will auto-integrate with the shopping cart configured for the related Store configuration.
OrderApi__Source_Code__c Source Code LookupOrderApi__Source_Code__c false
Optional Source Code to tag all transactions generated from the page.
OrderApi__Site__c SYSTEM LookupPagesApi__Site__c false
** Required ** Link to the Site to use for page styles and Store
OrderApi__Store__c SYSTEM LookupOrderApi__Store__c false
** Conditionally Required ** Link to the Store configuration to use if the page has the "Shopping Cart Enabled" checkbox checked.
OrderApi__Theme__c SYSTEM LookupPagesApi__Theme__c false
** Required ** Link to the Theme to use for the page styles.
OrderApi__Title_Tag__c Title Tag Text 255 false
Used as the content of the HTML title attribute for the rendered page.
OrderApi__Total_Revenue__c Total Revenue Currency false
** System Calculated ** Total sales generated from the page.
OrderApi__Visits__c Visits Number false
** System Calculated ** Number of times people have viewed the campaign page - Does not calculate visits from the page preview mode button.
EventApi__Event__c Event LookupEventApi__Event__c false
Event that this campaign page will allow registration on

OrderApi__Catalog_Item__c

Catalog Item
Item listings control how a particular Item is presented in a Item Catalog

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Catalog__c Catalog LookupOrderApi__Catalog__c false
**Required** Link to related Catalog
OrderApi__Is_Featured__c Is Featured Checkbox false
When checked, the Item will be featured when using display types that support featured items.
OrderApi__Is_Published__c Is Published Checkbox false
** System Calculated Override ** Is Published is unchecked when the linked Item "Is Active" is unchecked. When checked, the Item "Listing" is included when results are retrieved via the API for E-Store integrations. Defaults checked for "Active" Items.
OrderApi__Item__c Item LookupOrderApi__Item__c false
**Required** Link to related Item

OrderApi__Catalog__c

Catalog
Primary control for the display of a group of Items in a Store

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Catalog__c Parent Catalog LookupOrderApi__Catalog__c false
Link to the parent Item Catalog record. Use Item Catalog hierarchies to better organize your products and streamline your customer's online shopping cart experience.
OrderApi__Description__c Description LongTextArea 32768 false
Optional description for the Item Catalog
OrderApi__Display_Order__c Display Order Number false
Display order of catalogs that will be displayed on campaign pages
OrderApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked access to the Catalog is controlled by the related user-defined Access Permissions. Defaults unchecked - essentially enabling all public and authenticated Users access to the Catalog and related content.
OrderApi__Is_Published__c Is Published Checkbox false
When checked, the Catalog will be made available for display via the API. Defaults unchecked.
OrderApi__Store__c Store LookupOrderApi__Store__c false
** Required ** Link to related Store

OrderApi__Connection_Type_Mapping__c

Connection Type Mapping
Connection Types map to other Connection Types using Connection Type Mappings.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Connection_Type__c Connection Type MasterDetail false
**Required** The Connection Type being mapped to another Connection Type.
OrderApi__Mapped_Connection_Type__c Mapped Connection Type LookupOrderApi__Connection_Type__c false
**Required** The Connection Type that is being mapped.
OrderApi__System_Created__c System Created Checkbox false
**System Field** Do not manually update or override. When checked the mapping is created by a trigger, when unchecked the mapping was created manually. Defaults to unchecked.

OrderApi__Connection_Type__c

Connection Type
Connection Types allow you to customize the different types of Connections that can be created in the database.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Active__c Active Checkbox false
Only active Connection Types can be used to create new Connections.
OrderApi__Allow_Accounts__c Allow Accounts Checkbox false
When checked, this Relationship Type can be associated with Accounts.
OrderApi__Allow_Contacts__c Allow Contacts Checkbox false
When checked, this Relationship Type can be associated with Contacts.
OrderApi__Category__c Category Picklist false
**Required** Select the most appropriate category for the Relationship Type.
OrderApi__Mapped_Connections__c Mapped Connections Summary false
**System Calculated** Count of Mapped Connection Types.

OrderApi__Connection__c

Connection
Connections allow you to relate one Contact or Account to other Contacts and Accounts in the database.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
The Account related to the Connection. (Required if Contact is not populated)
OrderApi__Category__c Category Text false
**System Calculated** The Category of the related Connection Type.
OrderApi__Connected_Account__c Connected Account LookupOrderApi__Account false
Connected Account of the Connection. (Required if Connected Contact not populated)
OrderApi__Connected_Contact__c Connected Contact LookupOrderApi__Contact false
Connected Contact of the Connection. (Required if Connected Account not populated)
OrderApi__Connected_To__c Connected To Text false
**System Calculated** Link to either the Connected Contact or the Connected Account for the Connection.
OrderApi__Connection_Type2__c Connection Type LookupOrderApi__Connection_Type__c false
**Required** Connection Type for the Connected Entity.
OrderApi__Connection_Type__c Connection Type LookupOrderApi__Connection_Type__c false
**Required** Connection Type for the Primary Entity.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
The Contact related to the Connection. (Required if Account is not populated)
OrderApi__Description__c Description LongTextArea 32768 false
Additional information/notes about the Connection.
OrderApi__End_Date__c End Date Date false
The date the Connection was terminated.
OrderApi__Start_Date__c Start Date Date false
**Required** The date the Connection was established.
OrderApi__System_Created__c System Created Checkbox false
**System Field** Do not manually update/override. Automatically checked when the Connection was created by a trigger as the result of a new Connection inserted into the database.
OrderApi__Termination_Reason__c Termination Reason LongTextArea 32768 false
Reason for terminating the connection.

OrderApi__Contact

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Annual_Engagement_Score__c Annual Engagement Score Number false
Aggregates the Contact's active engagement scores from it's badge records for the current year.
OrderApi__Assistant_Do_Not_Call__c Assistant Do Not Call Checkbox false
Do Not Call the Contact's Assistant Phone.
OrderApi__Assistant_Email_Opt_Out__c Assistant Email Opt Out Checkbox false
The Contact's Assistant will not receive email communications.
OrderApi__Assistant_Email__c Assistant Email Email false
The Contact's Assistant Email address.
OrderApi__Badges__c Badges LongTextArea 131072 false
This field lists all the active badges in alphabetical order including all badges inherited from it's parent account or it's parent account through flowdown (when enabled)
OrderApi__Price_Rules_Usages__c SYSTEM LongTextArea 131072 false
** SYSTEM ** JSON of price rules
OrderApi__Outstanding_Credits__c Outstanding Credits Currency false
** System Calculated ** The sum of the Credit Memo Balance Due field for all Credit Memos linked to this customer.
OrderApi__Home_Do_Not_Call__c Home Do Not Call Checkbox false
Do Not Call the Contact's Home Phone.
OrderApi__Is_Primary_Contact__c Is Primary Contact Checkbox false
OrderApi__Lifetime_Engagement_Score__c Lifetime Engagement Score Number false
Aggregates the Contact's active engagement scores from it's badge records.
OrderApi__Mobile_Do_Not_Call__c Mobile Do Not Call Checkbox false
Do Not Call the Contact's Mobile Phone.
OrderApi__Other_Do_Not_Call__c Other Do Not Call Checkbox false
Do Not Call the Contact's Other Phone.
OrderApi__Other_Email_Opt_Out__c Other Email Opt Out Checkbox false
Contact will not receive communications to their Other Email.
OrderApi__Other_Email__c Other Email Email false
Other/Additional Email for the Contact.
OrderApi__Personal_Email_Opt_Out__c Personal Email Opt Out Checkbox false
Contact will not receive communications to their Personal Email.
OrderApi__Personal_Email__c Personal Email Email false
Personal/Home Email address for the Contact.
OrderApi__Potential_Duplicate_Contacts__c Potential Duplicate Contacts Text 255 false
OrderApi__Preferred_Email_Type__c Preferred Email Type Picklist false
**Defaults to Personal Email** Select the Preferred Email Type for the Contact. The value of the corresponding email field will update the standard Contact Email field.
OrderApi__Preferred_Email__c Preferred Email Text false
**System Calculated** The Preferred Email for the Contact is calculated by mapping the Preferred Email Type to it's corresponding field's value.
OrderApi__Preferred_Phone_Type__c Preferred Phone Type Picklist false
**Defaults to Personal Email** Select the Preferred Phone Type for the Contact. The value of the corresponding phone field will update the standard Contact Phone field.
OrderApi__Preferred_Phone__c Preferred Phone Text false
**System Calculated** The Preferred Phone for the Contact is calculated by mapping the Preferred Phone Type to it's corresponding field's value.
OrderApi__Privacy_Settings__c Privacy Settings Picklist false
**Defaults to private** This field sets the visibility settings when contact search is enabled. Public: Any user in the system can search. Private: Searchable by authenticated users only. Unlisted: Can not be searched at all.
OrderApi__Sync_Address_Billing__c Sync Address w/Account (Billing) Checkbox false
When checked, the system will overwrite the parent account's billing address with the value of the contact's mailing address. Default is unchecked.
OrderApi__Sync_Address_Shipping__c Sync Address w/Account (Shipping) Checkbox false
When checked, the system will overwrite the parent account's shipping address with the value of the contact's mailing address. Default is unchecked.
OrderApi__Sync_Email__c Sync Preferred Email w/Account Checkbox false
When checked, the system will overwrite the parent account's phone with the value of the contact's preferred phone. Default is unchecked.
OrderApi__Sync_Phone__c Sync Preferred Phone w/Account Checkbox false
When checked, the system will overwrite the parent account's phone with the value of the contact's preferred phone. Default is unchecked.
OrderApi__Work_Do_Not_Call__c Work Do Not Call Checkbox false
Do Not Call the Contact's Work Phone.
OrderApi__Work_Email_Opt_Out__c Work Email Opt Out Checkbox false
Contact will not receive communications to their Work Email.
OrderApi__Work_Email__c Work Email Email false
Work/Business Email for the Contact.
OrderApi__Work_Phone__c Work Phone Phone false
The Work Phone for the Contact.

OrderApi__Credit_Memo_Line__c

Credit Memo Line
Credit Memo Lines track revenue used from Credit Memos against invoices.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Amount__c Amount Currency false
**System Calculated/Override** Total over payments received.
OrderApi__Credit_Memo__c Credit Memo MasterDetail false
**Required** Link to the Credit Memo being used by the invoice.
OrderApi__Credit_Account__c Liability Account LookupOrderApi__GL_Account__c false
**System Calculated/Override** The account to use for crediting revenue applied against an Invoice. Default value is the linked Invoice's A/R account.
OrderApi__Invoice__c Invoice LookupOrderApi__Invoice__c false
Invoice where the OverPayment is made.
OrderApi__Invoice_Line__c Invoice Line LookupOrderApi__Invoice_Line__c false
Invoice Line where the OverPayment is made.
OrderApi__Is_Drafted__c Is Drafted Checkbox false
When checked, the credit memo is in a draft status.
OrderApi__Is_Posted__c Is Posted Checkbox false
When checked, the credit memo creates transactions.
OrderApi__Status__c Status Picklist false
**System Calculated/Override** Primary indicator of the credit memo's current status. Default value is "Draft".

OrderApi__Credit_Memo__c

Credit Memo
Credit Memos track revenue received as additional payment.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
**System Calculated/Override** Link to the customer's account record. Auto-populates with the related contact's parent account if not defined prior to entry.
OrderApi__Amount__c Amount Currency false
**System Calculated/Override** Total over payments received.
OrderApi__Applied_Amount__c Applied Amount Summary false
** System Calculated ** The total amount of credit memo lines that have been posted related to this Credit Memo.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Link to the business group record - business groups will auto-populate if not defined on entry.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
**System Calculated/Override** Link to the customer's contact record. Auto-populates with the related account's primary contact if not defined prior to entry.
OrderApi__Debit_Account__c Debit Account LookupOrderApi__GL_Account__c false
**System Calculated/Override** The GL account to use when posting to debit. Default value is the linked Business Group's writeoff account.
OrderApi__Entity__c Entity Picklist false
**Required** Select "Account" if the Credit Memo should be added to the related account, select "Contact" if the Credit Memo should be added to the related "Contact".
OrderApi__Invoice__c Invoice LookupOrderApi__Invoice__c false
Invoice where the OverPayment is made.
OrderApi__Is_Drafted__c Is Drafted Checkbox false
When checked, the credit memo is in a draft status.
OrderApi__Is_Posted__c Is Posted Checkbox false
When checked, the credit memo creates transactions.
OrderApi__Customer_Link__c Customer Text false
** System Calculated ** Link to the customer record.
OrderApi__Credit_Account__c Credit Account LookupOrderApi__GL_Account__c false
**System Calculated/Override** The account to use for crediting additional revenue received. Default value is the linked Business Group's Credit Memo account.
OrderApi__Posted_Date__c Posted Date Date false
** System Calculated/Override ** The date the Credit Memo was posted.
OrderApi__Remaining_Amount__c Remaining Amount Currency false
**System Calculated** Total - Applied
OrderApi__Status__c Status Picklist false
**System Calculated/Override** Primary indicator of the credit memo's current status. Default value is "Draft".

OrderApi__Custom_Payment_Type_Template__mdt

Custom Payment Type Template
Configurations for custom payment types available for stores.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Auto_Post_Sales_Order__c Auto Post Sales Order Checkbox false
When checked, Sales Orders will be posted prior to receiving payment. Usually occurs when payments take several days to process. When unchecked Sales Orders will post once payments are received.
OrderApi__Available_for_Recurring_Payments__c Available for Recurring Payments Checkbox false
When checked, payment methods will be available for recurring payments.
OrderApi__Is_Enabled__c Is Enabled Checkbox false
Whether the metadata record is enabled or not.
OrderApi__Lightning_Component_for_Checkout__c Lightning Component for Checkout Text 255 false
Defines the lightning component to be used in checkout pages.
OrderApi__Apex_Class__c Apex Class Text 255 false
Apex Class to drive multiple display features of custom payment types.
OrderApi__Lightning_Component_for_Payment_Method__c Lightning Component for Payment Method Text 255 false
Defines the lightning component to be used in the Payment Method page for the front and backend.

OrderApi__Custom_Payment_Type__c

Custom Payment Type
Represents additional payment types for the related stores.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Custom_Payment_Type_Template__c Custom Payment Type Template Text 255 true
Defines the name of the custom metadata type used for this Custom Payment Type
OrderApi__Display_On_Backend_Checkout__c Display on Backend Checkout Checkbox false
When checked, the related custom payment type is displayed on the backend payment page.
OrderApi__Display_On_Frontend_Checkout__c Display on Frontend Checkout Checkbox false
When checked, the related custom payment type is displayed on the frontend checkout page.
OrderApi__Display_Order__c Display Order Number false
Display order number of the related payment type for the frontend payment type tabs.
OrderApi__Instructions__c Instructions Html 100000 false
The text inserted here will display in the portal when the user selects this payment type.
OrderApi__Is_Enabled__c Is Enabled Checkbox false
When checked, the related custom payment type is enabled.
OrderApi__Payment_Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
Linked to the related payment gateway.
OrderApi__Store__c Store LookupOrderApi__Store__c true
**Required** Linked to the related store.

OrderApi__EPayment_Line__c

ePayment Line
Tracks how E-Payments (if successful) will be applied in the system, either to an Item or Invoice.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Tax_Override__c Tax Override Checkbox false
This field is used to override any tax calculations by the system.
OrderApi__Tax_Percent__c Tax Percent Percent false
Combined with the Parent EPayment Line's Sales Price, this field is used to calculate the tax amount for the related item.
OrderApi__Is_Tax__c Is Tax Checkbox false
Defines the EPayment Line that is being used for tax.
OrderApi__Activation_Date__c Activation Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be activated is calculated based on conditions set on the related Subscription Plan and can be manually over-ridden if "Auto Calculate Activation Date" is unchecked.
OrderApi__Activity_Type__c Activity Type Text false
**System Calculated** The parent activity "Transaction Type".
OrderApi__Auto_Calculate_Activation_Date__c Auto Calculate Activation Date Checkbox false
** System Calculated Override ** Valid if the EPayment Line is related to a "Subscription" Item. When checked, the system will automatically calculate the "Activation Date" based on conditions set on the selected "Subscription Plan". Defaults checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Link to the related Business Group.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
This field is populated to show the related contact.
OrderApi__End_Date__c End Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be ended is calculated based on conditions set on the related Subscription Plan and Activation Date.
OrderApi__EPayment__c E-Payment MasterDetail false
**Required** Link to the related E-Payment.
OrderApi__EPayment_Line__c Parent EPayment Line LookupOrderApi__EPayment_Line__c false
Link to related parent EPayment Line.
OrderApi__GL_Account__c GL Account LookupOrderApi__GL_Account__c false
**System Calculated/Required/Override** Link to the related GL Account.
OrderApi__Invoice__c Invoice LookupOrderApi__Invoice__c false
Link to related Invoice. Payment Activity Lines must be linked to one and only one Invoice, Credit Memo, or Sales Order.
OrderApi__Invoice_Line__c Invoice Line LookupOrderApi__Invoice_Line__c false
Relates epayment lines to invoice lines.
OrderApi__Is_Renewal__c Is Renewal Checkbox false
When checked, related EPayment Line is considered as "Subscription Renewal".
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
Link to related Item Class
OrderApi__Item__c Item LookupOrderApi__Item__c false
**Required** Link to related Item.
OrderApi__List_Price__c List Price Currency false
**System Calculated** The value of the "Price" field for the related Item.
OrderApi__Payment_Method__c Payment Method Text false
**System Calculated** The payment activity payment method type.
OrderApi__Price_Override__c Price Override Checkbox false
When checked, the system will derive the Sale Price from the most appropriate Price Rule. Default checked.
OrderApi__Price_Rule__c Price Rule LookupOrderApi__Price_Rule__c false
**System Calculated/Override** Link to related Price Rule applied for the related Item.
OrderApi__Quantity__c Quantity Number false
**Required** Quantity of Items. Default 1.
OrderApi__Sale_Price__c Sale Price Currency false
**System Calculated/Override** The Sale Price (per unit) for the related Item. Default 0.00.
OrderApi__Status__c Status Text false
**System Calculated** Icon representation of the payment activities status.
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
** Conditionally Required ** Link to the related plan that controls Activation and Expiration dates related to any Subscription Item. Required when the EPayment Line is linked to a Item that is the child of a "Subscription" Item Class.
OrderApi__Subscription__c Subscription (Upgrade/Renew) LookupOrderApi__Subscription__c false
Link to the Subscription that is being upgraded or renewed.
OrderApi__Subtotal__c Subtotal Currency false
**System Calculated** Quantity * Sale Price
OrderApi__Total__c Total Currency true
**Required** The amount (currency) for payment and/or refund (depending on payment activity type) for the payment activity line. Default value is 0.00.

OrderApi__EPayment__c

ePayment
ePayment api transaction logging.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__API_Amount__c API Amount Text false
**System Calculated** API Amount (String) Value of ABS(Amount) * 100.
OrderApi__API_Response__c API Response LongTextArea 131072 false
Stores the API response received from the gateway.
OrderApi__AVS_Code__c AVS Code Text 255 false
**System Calculated** AVS (Address Verification Service) returned in the response of the api transaction.
OrderApi__AVS_Message__c AVS Message Text 255 false
**System Calculated** AVS (Address Verification Service) Message.
OrderApi__Account__c Account LookupOrderApi__Account false
**System Calculated** Link to the related account (if applicable).
OrderApi__Amount__c Amount Summary false
**System Calculated** Sum of the "Total" field of related Payment Activity Lines.
OrderApi__Bank_Account_Holder_Type__c Bank Account Holder Type Text 255 false
Bank account holder type for the echeck or direct debit payment method (when supported by your payment gateway).
OrderApi__Bank_Account_Number__c Bank Account Number Text 255 false
The bank account number for echeck or direct debit payments (when supported by your payment gateway).
OrderApi__Bank_Account_Type__c Bank Account Type Text 255 false
The bank account type for echeck or direct debit payments (when supported by your payment gateway).
OrderApi__Bank_Name__c Bank Name Text 255 false
The bank name for echeck or direct debit payments (when supported by your payment gateway).
OrderApi__Bank_Routing_Number__c Bank Routing Number Text 255 false
The bank account routing number for echeck or direct debit payments (when supported by your payment gateway).
OrderApi__Batch__c Batch LookupOrderApi__Batch__c false
**System Calculated** Link to related batch.
OrderApi__Billing_City__c Billing City Text 255 false
Billing City for the customer's Payment Method.
OrderApi__Billing_Country__c Billing Country Text 255 false
Billing Country for the customer's Payment Method.
OrderApi__Billing_Postal_Code__c Billing Postal Code Text 255 false
Billing Postal Code for the customer's Payment Method.
OrderApi__Billing_State__c Billing State Text 255 false
Billing State for the customer's Payment Method.
OrderApi__Billing_Street__c Billing Street Text 255 false
Billing Street for the customer's Payment Method.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated** Link to the related Business Group.
OrderApi__CVV_Code__c CVV Code Text 255 false
**System Calculated** CVV (Card Verification Value) Code.
OrderApi__CVV_Message__c CVV Message Text 255 false
**System Calculated** CVV (Card Verification Value) Message.
OrderApi__Cancelled__c Cancelled Checkbox false
**System Calculated** Cancelled (true/false) returned in the response body of the API Transaction.
OrderApi__Card_Number__c Card Number Text 20 false
The masked credit card number associated with the payment method.
OrderApi__Card_Type__c Card Type Text 255 false
**System Calculated** The credit card type (if applicable).
OrderApi__Contact__c Contact LookupOrderApi__Contact false
**System Calculated** Link to the related contact record if applicable.
OrderApi__Create_Payment_Schedule__c Create Payment Schedule Checkbox false
When checked, the payment activity (if charged successfully) will create a new Payment Schedule, copying all Payment Activity Lines over to the detail of the new Payment Schedule. Default unchecked.
OrderApi__Currency_Code__c Currency Code Text 255 false
The iso-code for the currency used for the API transaction. Default is "USD"
OrderApi__Date__c Date Date false
The date for the epayment.
OrderApi__Deposit_Account__c Deposit Account LookupOrderApi__GL_Account__c false
**System Calculated** Link to the deposit GL account.
OrderApi__Description__c Description Text 255 false
**System Calculated** The description sent to the payment processor.
OrderApi__Eligible_for_Card_Updater__c Eligible for Card Updater Checkbox false
When checked, the payment method is available for the Card on File Updater service where Fonteva will update any expired or changed cards in your ePayment vault so that any future transactions are processed uninterrupted.
OrderApi__Email__c Email Text 255 false
**System Calculated** The email address of the customer used to transact with the api.
OrderApi__Entity__c Entity Picklist false
**System Calculated** Valid values are "Account" and "Contact", the system uses the entity field to determine the primary customer on a given transaction.
OrderApi__EPayment__c E-Payment (Source) LookupOrderApi__EPayment__c false
Link to the related EPayment which is authorized for payment.
OrderApi__Error_Code__c Error Code Text 255 false
The error code given by the payment gateway.
OrderApi__Errors__c Errors LongTextArea 32768 false
**System Calculated** List of errors returned in the response of the api transaction.
OrderApi__First_Name__c First Name Text 255 false
**System Calculated** The first name of the customer used to transact with the api.
OrderApi__First_Six_Digits__c First Six Digits Text 6 false
The first six (6) digits of the payment method (credit card or bank account number).
OrderApi__Full_Name__c Full Name Text 255 false
**System Calculated** The full name of the customer.
OrderApi__Gateway_Token__c Gateway Token Text 255 false
**System Calculated** The gateway token used for the API call.
OrderApi__Gateway_Transaction_ID__c Gateway Transaction ID Text 255 false
The transaction id for the epayment as stored by the connected payment gateway.
OrderApi__Has_Errors__c Has Errors Checkbox false
**System Calculated** Checked when the api transaction responds with a one or more error messages.
OrderApi__IP_Address__c IP Address Text 255 false
**System Calculated** The IP (Internet Protocol) address send and returned in the api transaction response.
OrderApi__Is_Scheduled__c Scheduled Checkbox false
**System Calculated**
OrderApi__Last_4_Digits__c Last 4 Digits Text 4 false
**System Calculated** The last four digits of the payment method number (credit card or bank account).
OrderApi__Last_Four_Digits__c Last Four Digits Text 4 false
The last four (4) digits of the payment method (credit card or bank account number).
OrderApi__Last_Name__c Last Name Text 255 false
**System Calculated** The last name of the customer used to transact with the api.
OrderApi__Merchant_Location_Descriptor__c Merchant Location Descriptor Text 255 false
**System Calculated** The merchant location descriptor returned in the e-payment api transaction response.
OrderApi__Merchant_Name_Descriptor__c Merchant Name Descriptor Text 255 false
**System Calculated** The merchant name descriptor returned in the e-payment api transaction response.
OrderApi__Message__c Message Text 255 false
The message sent in the response for the e-payment api transaction.
OrderApi__Month__c Exp Month Number false
**System Calculated** The credit card expiration month (MM).
OrderApi__Number__c Number Text 255 false
**System Calculated** Masked (all but last four digits) version of the credit card or bank account number.
OrderApi__Number_of_Installments__c Number of Installments Number false
**Required Conditionally** The number of invoices or scheduled payments to create for the payment schedule. Required to create a new payment schedule with Schedule Type of "Termed Recurring" or "Installment".
OrderApi__On_Test_Gateway__c On Test Gateway Checkbox false
**System Calculated** Checked when the api transaction was invoked using a test gateway token.
OrderApi__Order_ID__c Order ID Text 255 false
The Fonteva Sales Order or Receipt number associated with the ePayment.
OrderApi__Path__c Path Text 255 false
**System Calculated** Populates with the current web page path of the user when executing a new payment activity transaction.
OrderApi__Payment_Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
**System Calculated** The related payment gateway.
OrderApi__Payment_Method_Token__c Payment Method Token Text 255 false
**System Calculated** The API token for the payment method used for the transaction.
OrderApi__Payment_Method_Type__c Payment Method Type Text 255 false
**System Calculated** The payment method type used for the api transaction.
OrderApi__Payment_Method__c Payment Method LookupOrderApi__Payment_Method__c false
**System Calculated** A link to the related payment method (if applicable).
OrderApi__Pending__c Pending Checkbox false
**System Calculated** Pending (true/false) returned in the response body of the API Transaction.
OrderApi__Phone__c Phone Phone false
**System Calculated** The phone number sent to the gateway (optional/additional customer data)
OrderApi__Process_Payment__c Process Payment Checkbox false
When checked, the systems will attempt to process the related E-payment.
OrderApi__Process_Void__c Process Void Checkbox false
When checked, the system will attempt to void this EPayment.
OrderApi__Receipt_Created__c Receipt Created Checkbox false
**System Calculated** Checked when the E-Payment transaction is successfull and the system has created a new Receipt.
OrderApi__Reference_Token__c Reference Token Text 255 false
**System Calculated** The reference token used (in lieu of a payment method) to invoke the transaction. (Reference Transactions are not supported by all gateways).
OrderApi__Refund_Receipt__c Refund Receipt LookupOrderApi__Receipt__c false
**System Caluclated** Refund Reciept record for which the Epayment is processed
OrderApi__Retain_on_Success__c Retain on Success Checkbox false
**System Calculated** When checked, the system will store the credit card in a secure vault allowing you to charge the customer automatically using the same payment method at a later date.
OrderApi__Sales_Order__c Sales Order (Source) LookupOrderApi__Sales_Order__c false
**System Calculated/Override** Link to related Payment Schedule.
OrderApi__Schedule_Frequency__c Schedule Frequency Picklist false
**Conditionally Required** "Daily", "Weekly", "Monthly", "Quarterly", "Semi-Annually", or "Annually" required when creating new payment schedules from an E-Payment transaction.
OrderApi__Schedule_Type__c Schedule Type Picklist false
**Conditionally Required** "Installment", "Termed Recurring", or "Evergreen Recurring" required when creating new payment schedules from an E-Payment transaction.
OrderApi__Scheduled_Payment__c Scheduled Payment LookupOrderApi__Scheduled_Payment__c false
Link to the Scheduled Payment record that generated the E-Payment **Only populated when the E-Payment is generated from a Scheduled Payment record**
OrderApi__Source_Code__c Source Code LookupOrderApi__Source_Code__c false
**System Calculated** Link to related source code.
OrderApi__Start_Date__c Start Date Date false
**Required Conditionally** The date to start the Payment Schedule, required to create new payment schedules from a E-Payment transaction.
OrderApi__State__c State Text 255 false
The current state of the transaction
OrderApi__Status__c Status Text false
**System Calculated** User-friendly status display with icon indicating success/failure of the Payment Activity.
OrderApi__Storage_State__c Storage State Text 255 false
**System Calculated** The storage state of the payment method used in the api transaction.
OrderApi__Succeeded__c Succeeded Checkbox false
**System Calculated** The transaction succeeded without error.
OrderApi__Total__c Total Currency false
The total amount of the epayment transaction.
OrderApi__Transaction_Token__c Transaction Token Text 255 false
**System Calculated** The token used to transact with the gateway.
OrderApi__Transaction_Type__c Transaction Type Text 255 false
**System Calculated** The transaction type identified in the response of the api transaction.
OrderApi__Verification_Value__c Verification Value Text 255 false
**System Calculated** The verification value of the payment method used in the api transaction.
OrderApi__Year__c Exp Year Number false
**System Calculated** The credit card expiration year (YYYY).

OrderApi__GL_Account__c

GL Account
GL Accounting codes used for linking debits and credits with the appropriate codes.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Business_Group__c Business Group MasterDetail false
**Required** Master-Detail Relationship to Business Group.
OrderApi__Detail__c Detail Picklist false
Customize the detail pick-list to assist you in categorizing the GL Accounts in accounting reports.
OrderApi__Report_Category__c Report Category Picklist false
**Do Not Modify Picklist Values** Select the appropriate report category for the GL Account.
OrderApi__Type__c Type Picklist false
Select the appropriate type for the GL Account.

OrderApi__Invoice_Line__c

Invoice Line
Invoice Lines hold the detail for a Invoice.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Tax_Override__c Tax Override Checkbox false
This field is used to override any tax calculations by the system.
OrderApi__Tax_Percent__c Tax Percent Percent false
Combined with the Parent Invoice Line's Sales Price, this field is used to calculate the tax amount for the related item.
OrderApi__Is_Tax__c Is Tax Checkbox false
Defines the Invoice Line that is being used for tax.
OrderApi__Activation_Date__c Activation Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be activated is calculated based on conditions set on the related Subscription Plan and can be manually over-ridden if "Auto Calculate Activation Date" is unchecked.
OrderApi__Adjustment_Reason__c Adjustment Reason Picklist false
Select the reason for the adjustment.
OrderApi__Amount_Paid__c Amount Paid Currency false
Sum of all payments applied to this invoice line.
OrderApi__Amount_Refunded__c Amount Refunded Currency false
Sum of all refunds applied to this invoice line.
OrderApi__AR_Account__c A/R Account LookupOrderApi__GL_Account__c false
Identifies the GL Account used for A/R transactions.
OrderApi__Adjustments__c Adjustments Currency false
Sum of all adjustments, both positive and negative, applied to this invoice line.
OrderApi__Balance_Due__c Balance Due Currency false
This field identifies the remaining balance unpaid for this invoice line.
OrderApi__Invoice_Line__c Parent Invoice Line LookupOrderApi__Invoice_Line__c false
Populated for adjustments, this field relates the invoice line to a parent invoice line.
OrderApi__Payment_Priority__c Payment Priority Number false
If populated, this field is used to identify the order in which partial payments are applied to an invoice.
OrderApi__Auto_Calculate_Activation_Date__c Auto Calculate Activation Date Checkbox false
** System Calculated Override ** Valid if the Sales Order Line is related to a "Subscription" Item. When checked, the system will automatically calculate the "Activation Date" based on conditions set on the selected "Subscription Plan". Defaults checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Default value is mapped from the parent invoice. The Business Group controls what items are available to associate with the invoice line. If no value exists, all active items will be allowed to be associated.
OrderApi__Calculate_Shipping_Details__c Calculate Shipping Details Checkbox false
Default checked. Copies the shipping information from the invoice.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
This field is populated to show the related contact.
OrderApi__Credits_Applied__c Credits Applied Currency false
**System Calculated/Override** Sum of all payments received using credits on the account for the Invoice Line.
OrderApi__Credit_Memo__c Credit Memo LookupOrderApi__Credit_Memo__c false
**System Calculated/Override** Link to the Credit Memo record, when an overpayment is made.
OrderApi__Deferred_Revenue_Adjustment__c Deferred Revenue Adjustment Checkbox false
Creates Deferred Revenue adjustments when checked for Adjustments.
OrderApi__End_Date__c End Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be ended is calculated based on conditions set on the related Subscription Plan and Activation Date.
OrderApi__GL_Account__c GL Account LookupOrderApi__GL_Account__c false
**System Calculated/Required/Override** Link to the related GL Account.
OrderApi__Invoice__c Invoice MasterDetail false
**Required** All Invoice Lines require a linked Invoice.
OrderApi__Is_Adjustment__c Is Adjustment Checkbox false
When checked, the system will not the consider the line in inventory calculations. Adjustment lines are the only type of lines that can be added to invoices w/o payments that have posted.
OrderApi__Is_Posted__c Is Posted Checkbox false
**Only use for Invoice Line Adjustments related to Posted Invoices** When checked, the adjustment line is posted and a Transaction is created in the system.
OrderApi__Is_Renewal__c Is Renewal Checkbox false
When checked, related Invoice Line is considered as "Subscription Renewal".
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated / Override ** Link to the related Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
Link to the item related to the record.
OrderApi__Line_Description__c Line Description Text 255 false
Optional line description will be added to invoices, receipts, and detailed customer statements. If blank, the value of this field will match the value of the related item's "Receipt Description" field.
OrderApi__List_Price__c List Price Currency false
**System Calculated** The standard price for the item selected on the invoice line.
OrderApi__Posted_Date__c Posted Date (Adjustment) Date false
**System Calculated** Valid for adjustments only. Default is blank, populates with the current date's value when a line is flagged as "Is Adjustment" and "Is Posted".
OrderApi__Price_Override__c Price Override Checkbox false
Overrides the calculation of price based on the most appropriate price for the purchasing customer. Default is unchecked.
OrderApi__Price_Rule__c Price Rule LookupOrderApi__Price_Rule__c false
The price rule related to the invoice line. When added or changed, the unit price will reflect the price defined on the price rule.
OrderApi__Quantity__c Quantity Number false
The quantity of Items to include on the Invoice Detail. Required if the Item does not have "Disable Price Rules" checked. Default 1.
OrderApi__Sale_Price__c Sale Price Currency false
**System Calculated/Override** The price per-unit for the item sold on the invoice line.
OrderApi__Shipping_City__c Shipping City Text 255 false
Optional shipping city for the item's ordered on the invoice line. If left blank, the value of this field will be updated with the value of the parent invoice's "Shipping City" field.
OrderApi__Shipping_Contact__c Shipping Contact Text 255 false
Optional shipping contact for the item's ordered on the invoice line. If left blank, the value of this field will be updated with the value of the parent invoice's "Shipping Contact" field.
OrderApi__Shipping_Country__c Shipping Country Text 255 false
Optional shipping country for the item's ordered on the invoice line. If left blank, the value of this field will be updated with the value of the parent invoice's "Shipping Country" field.
OrderApi__Shipping_Postal_Code__c Shipping Postal Code Text 255 false
Optional shipping postal code for the item's ordered on the invoice line. If left blank, the value of this field will be updated with the value of the parent invoice's "Shipping Postal Code" field.
OrderApi__Shipping_State__c Shipping State Text 255 false
Optional shipping state for the item's ordered on the invoice line. If left blank, the value of this field will be updated with the value of the parent invoice's "Shipping State" field.
OrderApi__Shipping_Street__c Shipping Street Text 255 false
**System Calculated/Conditional** Shipping Street derives from the Contact Mailing Street or the Account Shipping Street when Calculate Shipping Details is checked.
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
** Conditionally Required ** Link to the related plan that controls Activation and Expiration dates related to any Subscription Item. Required when the Invoice Line is linked to a Item that is the child of a "Subscription" Item Class.
OrderApi__Subscription__c Subscription (Upgrade/Renew) LookupOrderApi__Subscription__c false
Link to the Subscription that is being upgraded or renewed.
OrderApi__Subtotal__c Subtotal Currency false
**System Calculated** Sale Price * Quantity
OrderApi__Total__c Total Currency false
**System Calculated/Override** Quantity * Sale Price
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
**System Calculated** Link to the related Sales Order Line.
OrderApi__Parent_Sales_Order_Line__c Parent Sales Order Line LookupOrderApi__Sales_Order_Line__c false
**System Calculated** Link to the related Parent Sales Order Line.
OrderApi__Is_Shipping_Rate__c Is Shipping Rate Checkbox false
Defines the Invoice Line that is being used for shipping.

OrderApi__Invoice__c

Invoice
Invoices track sales to customers that are not immediately paid for.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__AR_Account__c A/R Account LookupOrderApi__GL_Account__c false
**System Calculated/Override** The A/R account to use when posting to receivables. Default value is the linked Business Group's A/R account.
OrderApi__Account__c Account LookupOrderApi__Account false
**System Calculated/Override** Link to the customer's account record. Auto-populates with the related contact's parent account if not defined prior to entry.
OrderApi__Adjustments__c Adjustments Summary false
**System Calculated** The sum of the value of related invoice line's "Total" field if the line's "Is Adjustment" field is checked.
OrderApi__Amount_Paid__c Amount Paid Currency false
**System Calculated/Override** Sum of all payments received for the Invoice.
OrderApi__Amount_Refunded__c Amount Refunded Currency false
** System Calculated ** The total amount of refunds that have been posted related to this Invoice.
OrderApi__Balance_Due__c Balance Due Currency false
**System Calculated** Total - Total Payments
OrderApi__Billing_City__c Billing City Text 255 false
The value of this field will be updated with the Account's Billing City or Contact's Mailing City, based on "Entity" if not defined on record entry.
OrderApi__Billing_Contact__c Billing Contact Text 255 false
The value of this field will be updated with the Account or Contact, based on "Entity" if not defined on record entry.
OrderApi__Billing_Country__c Billing Country Text 255 false
The value of this field will be updated with the Account's Billing Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
OrderApi__Billing_Postal_Code__c Billing Postal Code Text 255 false
The value of this field will be updated with the Account's Billing Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
OrderApi__Billing_State__c Billing State Text 255 false
The value of this field will be updated with the Account's Billing State or Contact's Mailing State, based on "Entity" if not defined on record entry.
OrderApi__Billing_Street__c Billing Street Text 255 false
**System Calculated/Conditional** Billing Street derives from the Contact Mailing Street or the Account Billing Street when Calculate Billing Details is checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Link to the business group record - business groups will auto-populate if not defined on entry.
OrderApi__Calculate_Billing_Details__c Calculate Billing Details Checkbox false
When checked the system will calculate billing details automatically. If entity is "Contact" the mailing address of the contact is used, otherwise the account's billing address is used. The contact on the invoice will populate the billing contact field.
OrderApi__Calculate_Due_Date__c Auto-Calculate Due Date Checkbox false
When checked, the system will calculate the Due Date for the Invoice based on the selected Payment Terms.
OrderApi__Calculate_Shipping_Details__c Calculate Shipping Details Checkbox false
If checked the system will calculate shipping details automatically. If entity is "Contact" the mailing address of the contact is used, otherwise the account's shipping address is used. The contact on the invoice will populate the shipping contact field.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
**System Calculated/Override** Link to the customer's contact record. Auto-populates with the related account's primary contact if not defined prior to entry.
OrderApi__Credits_Applied__c Credits Applied Currency false
**System Calculated/Override** Sum of all payments received using credits on the account for the Invoice.
OrderApi__Customer_Link__c Customer Text false
**System Calculated** Link to the customer's record, controlled by the "Entity" field.
OrderApi__Customer_Reference_Number__c Customer Reference Number Text 255 false
**System Calculated/Override/Conditional** Customer Reference Number (PO) flows down from related Sales Order (if applicable).
OrderApi__Days_Overdue__c Days Overdue Number false
**System Calculated** If an invoice is overdue the integer value of today's date - the invoice due date will be used to populate this field.
OrderApi__Description__c Description LongTextArea 32768 false
Internal-facing description for the Invoice. Does not display by default on Invoices, Receipts, and Templates containing Invoice information.
OrderApi__Due_Date__c Due Date Date false
**System Calculated/Override** The date that payment is due for the invoice. By default the system derives the date from the invoice date and payment terms.
OrderApi__Entity__c Entity Picklist false
**Required** Select "Account" if the invoice should be billed to the related account, select "Contact" if the invoice should be sent to the related "Contact".
OrderApi__Has_Payments__c Has Payments Checkbox false
**System Calculated** True if the Invoice has at least one payment applied against it.
OrderApi__Has_Refunds__c Has Refunds Checkbox false
**System Calculated** True if the Invoice has one or more applied credit memos ("Cash Payments") agains it.
OrderApi__Invoice_Date__c Invoice Date Date true
**Required/System Calculated/Override** The invoice date is derived from the parent sales order object.
OrderApi__Is_Cancelled__c Is Cancelled Checkbox false
**System Calculated/Override** Checked when the Invoice was never posted and later cancelled as a result of the linked Sales Order being cancelled.
OrderApi__Is_Overdue__c Overdue Checkbox false
**System Calculated** If an invoice is posted and the due date is in the past with an outstanding balance this field will be checked.
OrderApi__Is_Paid__c Paid Checkbox false
**System Calculated** If an invoice balance due is less than or equal to 0 and flagged as "Posted" this field will be checked.
OrderApi__Is_Posted__c Posted Checkbox false
Checked if the invoice has been posted and transactions (journal entries) have been created.
OrderApi__Is_Voided__c Voided Checkbox false
When checked the Invoice will be voided and any "Receivable" transactions will be reversed. Default unchecked.
OrderApi__Item_Count__c Item Count Summary false
**System Calculated** Count of the number of items related to the invoice.
OrderApi__Memo__c Memo LongTextArea 32768 false
Optional memo that will display on the invoice sent to the customer as well as on customer statements.
OrderApi__Paid_Date__c Paid Date Date false
**System Calculated/Override** The date the invoice was paid in full.
OrderApi__Payment_Count__c Number of Payments Number false
**System Calculated/Override** Count of the number of "Payment" Receipts related to the Invoice.
OrderApi__Payment_Terms__c Payment Terms LookupOrderApi__Payment_Terms__c false
The payment terms for the invoice. If not defined on record creation the default terms defined on the Commerce custom setting will be used.
OrderApi__Posted_Date__c Posted Date Date false
**System Calculated/Override** The date the receivable transaction posted.
OrderApi__Refund_Count__c Number of Refunds Number false
**System Calculated/Override** Count of "Refund" Receipts related to the Invoice.
OrderApi__Sales_Order__c Sales Order LookupOrderApi__Sales_Order__c false
**System Calculated/Override** Link to the Sales Order that generated the Invoice.
OrderApi__Scheduled_Payment__c Scheduled Payment LookupOrderApi__Scheduled_Payment__c false
**System Calculated/Override** Link to the Scheduled Payment.
OrderApi__Shipping_City__c Shipping City Text 255 false
The value of this field will be updated with the Account's Shipping City or Contact's Mailing City, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Contact__c Shipping Contact Text 255 false
The value of this field will be updated with the Account or Contact, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Country__c Shipping Country Text 255 false
The value of this field will be updated with the Account's Shipping Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Postal_Code__c Shipping Postal Code Text 255 false
The value of this field will be updated with the Account's Shipping Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
OrderApi__Shipping_State__c Shipping State Text 255 false
The value of this field will be updated with the Account's Shipping State or Contact's Mailing State, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Street__c Shipping Street Text 255 false
**System Calculated/Conditional** Shipping Street derives from the Contact Mailing Street or the Account Billing Street when Calculate Shipping Details is checked.
OrderApi__Status__c Status Picklist false
**System Calculated/Override** Primary indicator of the invoice's current status. Default value is "Draft".
OrderApi__Subscription__c Subscription LookupOrderApi__Subscription__c false
** System Calculated ** Link to related Subscription. Populated only when the Invoice is sent from a Subscription that is scheduled for auto-invoice on an "Installment" payment plan.
OrderApi__Subtotal__c Subtotal Summary false
**System Calculated** The sum of the value of each related invoice detail line "Subtotal" field.
OrderApi__Total__c Total Currency false
**System Calculated** Subtotal + Adjustments + Sales Tax
OrderApi__Voided_Date__c Voided Date Date false
**System Calculated** The date the invoice was voided.

OrderApi__Item_Class__c

Item Class
Master categorization and logic driver for Items and Item purchase work flow.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Active_Assignments__c Active Assignments Number false
** System Calculated ** Identifies the number of active Assignments related to this class.
OrderApi__Assignments_Display_Label__c Assignments Display Label Text 255 false
The label to display in the wizard for the step related to assigning people to a subscription.
OrderApi__Assign_to_Item__c Assign to Item Checkbox false
When checked, Assignments by default will be linked directly to the related Item without a parent "Assignment SObject".
OrderApi__Assignment_Inventory__c Assignment Inventory Number false
Identifies maximum number of available Assignment related to class.
OrderApi__Assignment_SObject__c Assignment SObject Text 255 false
** Conditionally Required ** The API name of the custom object to create when a "Assignable" Item is purchased. Required if "Enable Assignments" is checked.
OrderApi__Available_Inventory__c Available Inventory Number false
Identifies maximum number of available Items related to class.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
OrderApi__Defer_Revenue__c Defer Revenue Checkbox false
When checked, the deferred revenue recognition rules will be considered when posting transactions.
OrderApi__Deferred_Revenue_Account__c Deferred Revenue Account LookupOrderApi__GL_Account__c false
GL Account Where Deferred Revenue Recognition is Tracked
OrderApi__Deferred_Revenue_Term__c Deferred Revenue Term (In Months) Number false
Term the Revenue has to be deferred if not a Subscription.
OrderApi__Description__c Description LongTextArea 32768 false
OrderApi__Disable_Scheduling__c Disable Scheduling Checkbox false
Scheduling is disabled when an item of this class is purchased
OrderApi__Enable_Assignment_Inventory__c Enable Assignment Inventory Checkbox false
When checked, the system will track the number of active assignments related to the Item Class and auto-expire all related Items once the "Assignment Inventory" is less than or equal to the "Active Assignments".
OrderApi__Enable_Assignments__c Enable Assignments Checkbox false
OrderApi__Enable_Item_Class_Inventory__c Enable Item Class Inventory Checkbox false
When checked, the system will track the number of times any Item linked to this Item Class.
OrderApi__Flex_Day_of_the_Month__c Flex Day of the Month Number false
Deferred Revenue before flex day is treated as no partial credit and after flex day it will post the transactions from next month.
OrderApi__Interview_Form_Display_Label__c Interview Form Display Label Text 255 false
The label to display in the wizard for the step related to completing the interview form questions.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, Items will be allowed to be linked to the Item Class. Defaults checked.
OrderApi__Is_Contribution__c Is Contribution Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled with extra contribution (donation) related controls and features. Defaults unchecked.
OrderApi__Is_Downloadable__c Is Downloadable Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled with extra downloadable specific controls and features. Defaults unchecked.
OrderApi__Is_Event__c Is Event Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled with extra event specific controls and features. Defaults unchecked.
OrderApi__Is_Inventoried__c Is Inventoried Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled with inventory tracking options and controls. Defaults unchecked.
OrderApi__Is_Publication__c Is Publication Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled with extra publication specific controls and features. Defaults unchecked.
OrderApi__Is_Service__c Is Service Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled with service billing options and controls. Defaults unchecked.
OrderApi__Is_Subscription__c Is Subscription Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled with extra subscription related controls and features. Defaults unchecked.
OrderApi__Is_Tax_Deductible__c Is Tax Deductible Checkbox false
Check if the item class is a tax deductible donation. The cost per unit will drive the tax deductible amount on the sales order.
OrderApi__Is_Tax__c Is Tax Checkbox false
Identifies the Item Class used for taxes rates applied to taxable items.
OrderApi__Is_Taxable__c Is Taxable Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled for tax and VAT options and controls. Defaults unchecked.
OrderApi__Is_Shipping_Carrier__c Is Shipping Carrier Checkbox false
Checkbox to create a Shipping Carrier.
OrderApi__Refresh__c Refresh Checkbox false
Refresh will copy all the values for every field that is similar to its children Item field records.
OrderApi__Require_Assignments__c Require Assignments Checkbox false
When checked, Items linked to the Item Class by default will require Assignment prior to posting a Sales Order. Defaults unchecked.
OrderApi__Require_Shipping__c Require Shipping Checkbox false
When checked, Items created that are associated with this Item Class will automatically be enabled with extra shipping/delivery options and controls. Defaults unchecked.
OrderApi__Revenue_Recognition_Date__c Revenue Recognition Date Date false
Revenue recognition Date for deferred Revenue When Specific Date is selected for Recognition Rule
OrderApi__Revenue_Recognition_Rule__c Revenue Recognition Rule Picklist false
Deferred Revenue is recognized either over time or on specific date.
OrderApi__Revenue_Recognition_Term_Rule__c Revenue Recognition Term Rule Picklist false
How you want recognize revenue over time.
OrderApi__Shipping_GL_Account__c Shipping GL Account LookupOrderApi__GL_Account__c false
Identifies the Shipping GL Account.
OrderApi__Sold_Inventory__c Sold Inventory Number false
** System Calculated ** Identifies the number of items sold related to this class.
OrderApi__Subscription_Plan_Display_Label__c Subscription Plan Display Label Text 255 false
The label to display in the wizard for the step related to selecting a subscription plan.
OrderApi__Tax_Class__c Tax Class LookupOrderApi__Item_Class__c false
Populate this field for items that need to apply tax.
OrderApi__Use_Default_Tax_Rate__c Use Default Tax Rate Checkbox false
Select this checkbox when using the same tax rate for items regardless of the purchaser's locale.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to related Event.
EventApi__Is_Event_Session__c Is Event Session Checkbox false
When checked, Items linked to this Item Class may only be purchased if they are the direct child of a "Registration" record related to an "Active" Event. Defaults unchecked.
EventApi__Is_Schedule_Item_Class__c Is Schedule Item Class Checkbox false
** System Calculated ** Checked if Item Class is related to Event Ticket Type.
EventApi__Is_Sponsor_Class__c Is Sponsor Class Checkbox false
** System Calculated ** Checked if Item Class is related to Event Sponsor Package.
EventApi__Is_Ticket_Type_Class__c Is Ticket Type Class Checkbox false
** System Calculated ** Checked if Item Class is related to Event Ticket Type.

OrderApi__Item_Subscription_Plan__c

Item Subscription Plan
Links a "Subscription" Item to a Subscription Plan to enable the linked Item to be sold in conjunction with the linked Subscription Plan.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Is_Default__c Is Default Checkbox false
Defines the default Subscription Plan for related Item.
OrderApi__Item__c Item MasterDetail false
** Required ** Link to the Item enabled for the related Subscription Plan.
OrderApi__Subscription_Plan__c Subscription Plan MasterDetail false
** Required ** Link to the Subscription Plan that the related Subscription Item is being enabled for.

OrderApi__Item__c

Item
Items store all products, services and funds an organization uses to generate revenue.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Adjustment_Account__c Adjustment Account LookupOrderApi__GL_Account__c false
The debit account to use when posting invoice adjustments to invoices that have already posted to A/R.
OrderApi__AR_Account__c A/R Account LookupOrderApi__GL_Account__c false
Identifies the GL Account used for A/R transactions.
OrderApi__Invoice_Payment_Priority__c Payment Priority Number false
If populated, this field is used to identify the order in which partial payments are applied to an invoice.
OrderApi__Assign_to_Item__c Assign to Item Checkbox false
** System Calculated Override ** Derived from parent Item Class.
OrderApi__Assignments_Display_Label__c Assignments Display Label Text 255 false
The label to display in the wizard for the step related to assigning people to a subscription.
OrderApi__Assignment_SObject__c Assignment SObject Text 255 false
** System Calculated ** The API name of the custom object to create when a "Assignable" Item is purchased. Automatically calculated from the "Assignment SObject" field on the parent Item Class.
OrderApi__Assignment_Badge_Types_CSV__c SYSTEM Text 255 false
SYSTEM
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
Items can be related to Business Groups to separate business lines and/or legal entities on transactional (sales) and financial reports.
OrderApi__Cost__c Item Cost Currency false
The cost per unit for the item.
OrderApi__Defer_Revenue__c Defer Revenue Checkbox false
When checked, the deferred revenue recognition rules will be considered when posting transactions.
OrderApi__Deferred_Revenue_Account__c Deferred Revenue Account LookupOrderApi__GL_Account__c false
OrderApi__Deferred_Revenue_Term__c Deferred Revenue Term (In Months) Number false
OrderApi__Description__c Description LongTextArea 32768 false
Product description.
OrderApi__Disable_Price_Rules__c Disable Price Rules Checkbox false
When checked the system will not create Price Rules for the Item and will not attempt to auto-calculate the price for the Item when it is added to a Sales Order, Invoice, or Receipt. Default unchecked.
OrderApi__Disable_Scheduling__c Disable Scheduling Checkbox false
Disables scheduling when you buy this item
OrderApi__Discount_Account__c Discount Account LookupOrderApi__GL_Account__c false
The account to debit when discounting a sale related to the Item.
OrderApi__Display_Name__c Display Name Text 255 false
** System Calculated Override ** The name of the Item as you would like it to display when published to customers. Defaults to the same value of the "Item Name" field.
OrderApi__Download_File_Location__c Download File Location Text 255 false
** Conditionally Required ** Reference to the file location related to this downloadable item
OrderApi__Download_File_Name__c Download File Name Text 255 false
** Conditionally Required ** Defines to the file name of related to this downloadable item
OrderApi__Download_File_Type__c Download File Type Picklist false
** Conditionally Required ** Reference to the file type, related to this downloadable item.
OrderApi__EAN__c EAN Text 13 false
An EAN (European Article Number) is a unique 13-digit Global Trade Item Number for identifying non-book products in Europe.
OrderApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked, the Item will only be made available to purchase when the purchasing Contact or Account meets the criteria set in the "Access Permissions" related list. Unchecked by default.
OrderApi__Enable_Assignments__c Enable Assignments Checkbox false
** System Calculated ** When checked, the Item can be assigned to Contacts indicating benefit or ownership over goods and services. Automatically calculated based on the parent Item Class "Type".
OrderApi__Features_List__c Features List LongTextArea 1000 false
Enter a list of features for display. Each feature should be separated by a line break
OrderApi__Flex_Day_of_the_Month__c Flex Day of the Month Number false
OrderApi__Form__c Interview Form LookupPagesApi__Form__c false
Link to related item interview form.
OrderApi__ISBN__c ISBN Text 13 false
An ISBN (International Standard Book Number) is a unique 10 or 13-digit Global Trade Item Number used to identify books and publications.
OrderApi__Image_Path__c Image URL Text 255 false
URL path of the image you want to display for this item
OrderApi__Income_Account__c Income Account LookupOrderApi__GL_Account__c false
The credit account to use when posting revenue in a A/R transaction.
OrderApi__Interview_Form_Display_Label__c Interview Form Display Label Text 255 false
The label to display in the wizard for the step related to completing the interview form questions.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, the Item is considered available for sale and will be made available for selection against Invoice, Sales Order, Receipt, and EPayment Lines. Defaults checked.
OrderApi__Is_Contribution__c Is Contribution Checkbox false
** System Calculated Override ** Enable contribution (donation) related controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Is_Default_Tax_Rate__c Is Default Tax Rate Checkbox false
Select this checkbox when using the same tax rate for items regardless of the purchaser's locale.
OrderApi__Is_Downloadable__c Is Downloadable Checkbox false
** System Calculated Override ** Enable downloadable specific controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Is_Event__c Is Event Checkbox false
** System Calculated Override ** Enable event specific controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Is_Inventoried__c Is Inventoried Checkbox false
** System Calculated Override ** Enable Inventoried specific controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Is_Publication__c Is Publication Checkbox false
** System Calculated Override ** Enable publication specific controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Is_Service__c Is Service Checkbox false
** System Calculated Override ** Enable service specific controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Is_Subscription__c Is Subscription Checkbox false
** System Calculated Override ** Enable Subscription specific controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Is_Tax_Deductible__c Is Tax Deductible Checkbox false
Check if the item is a tax deductible donation. The cost per unit will drive the tax deductible amount on the sales order.
OrderApi__Is_Tax__c Is Tax Checkbox false
Identifies the Item to be used as a taxes rate to be applied to taxable items.
OrderApi__Is_Taxable__c Is Taxable Checkbox false
** System Calculated Override ** Enable tax specific controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Is_Default_Shipping_Rate__c Is Default Shipping Rate Checkbox false
Checkbox to make this the Default Shipping Rate.
OrderApi__Is_Shipping_Rate__c Is Shipping Rate Checkbox false
Checkbox to create a Shipping Rate.
OrderApi__Shipping_Method__c Delivery Method LookupOrderApi__Shipping_Method__c false
Lookup to select a Delivery Method associated with this rate.
OrderApi__Shipping_Region__c Shipping Region LookupOrderApi__Shipping_Region__c false
Lookup to select the Shipping Region associated with this rate.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** Required ** Link to related Item Class
OrderApi__Item_Weight_UOM__c Item Weight UOM Picklist false
** Conditionally Required ** The UOM (Unit of Measure) used to calculate the value of the "Item Weight" field. Required when "Requires Shipping" is checked.
OrderApi__Item_Weight__c Item Weight Number false
** Conditionally Required ** The weight of one Item unit. Required if "Requires Shipping" is checked.
OrderApi__Maximum_Weight__c Maximum Weight Number false
Defines the high end of the range of item weights this shipping rate applies to.
OrderApi__Minimum_Weight__c Minimum Weight Number false
Defines the low end of the range of item weights this shipping rate applies to.
OrderApi__Minimum_Value__c Minimum Value Currency false
Set the low end of the range of item values this shipping rate applies to.
OrderApi__Maximum_Value__c Maximum Value Currency false
Set the high end of the range of item values this shipping rate applies to.
OrderApi__Line_Description__c Line Description Text 255 false
The description for the item as it should appear on related receipts and invoices. This field is limited to 255 characters.
OrderApi__Maximum_Number_of_Assignments__c Maximum Number of Assignments Number false
** Conditionally Required ** If "Restrict Number of Assignments" is checked, a maximum number of assignments must be defined.
OrderApi__Maximum_Number_of_Downloads__c Maximum Number of Downloads Number false
** Conditionally Required ** The value of this field will be used to restrict the number of times a customer can access a downloadable file via the API. Valid for "Is Downloadable" Items. Required when "Restrict Number of Downloads" is checked.
OrderApi__Not_For_Individual_Sale__c Not For Individual Sale Checkbox false
When checked, the Item will be restricted to only being included in sales as part of a Package Item. Defaults unchecked.
OrderApi__Package_Items__c Package Items Summary false
This field aggregates the total number of package items.
OrderApi__Price__c Item Price Currency false
The default price for the item will be used to automatically create the default price rule which can only be edited by updating the price of the item.
OrderApi__Refund_Account__c Refund/Credit Account LookupOrderApi__GL_Account__c false
The account to debit when refunding/crediting customers who have purchased this Item.
OrderApi__Require_Assignments__c Require Assignments Checkbox false
When checked, a user will be unable to complete a sale for an Item until all assignments available have been entered. Defaults unchecked.
OrderApi__Require_PreAuthorized_Payment__c Require PreAuthorized Payment Checkbox false
** Used with extended applications ** By checking this field, purchasing this item will required pre-authorization before being charged by a subsequent action.
OrderApi__Require_Shipping__c Require Shipping Checkbox false
** System Calculated Override ** Enable delivery specific controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
OrderApi__Required_Package_Items__c Required Package Items Summary false
This field aggregates the total number of required package items needed to fulfill a sales order with this item.
OrderApi__Restrict_Number_of_Assignments__c Restrict Number of Assignments Checkbox false
When checked, the system will limit the number of assignments allowed based on the value of the "Maximum Number of Assignments" field. Defaults unchecked.
OrderApi__Restrict_Number_of_Downloads__c Restrict Number of Downloads Checkbox false
When checked, the customer will have access restricted if the downloadable file has been accessed more than the allowed amount defined in the "Maximum Number of Downloads" field. Defaults unchecked.
OrderApi__Revenue_Recognition_Date__c Revenue Recognition Date Date false
OrderApi__Revenue_Recognition_Rule__c Revenue Recognition Rule Picklist false
OrderApi__Revenue_Recognition_Term_Rule__c Revenue Recognition Term Rule Picklist false
OrderApi__SKU__c SKU Text 255 false
A SKU (Stock Keeping Unit) is a unique Item identifier that references attributes associated with the Item and that distinguish it from all other Items primarily used for inventory control and management.
OrderApi__Subscription_Plan_Display_Label__c Subscription Plan Display Label Text 255 false
The label to display in the wizard for the step related to selecting a subscription plan.
OrderApi__Tax_Class__c Tax Class LookupOrderApi__Item_Class__c false
Populate this field for an item that needs to apply a tax.
OrderApi__Tax_Locale__c Tax Locale LookupOrderApi__Tax_Locale__c false
Links the Item to the tax locale.
OrderApi__Tax_Percent__c Tax Percent Percent false
The rate to be used to calculate the tax amount assigned to taxable items.
OrderApi__UPC__c UPC Text 12 false
A UPC (Universal Product Code) is a 13 digit catalog number uniquely assigned to an Item required to generate UPC barcodes.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to related Event.
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c false
** System Calculated ** Link to Schedule Item (Circular Reference) do not manually update.
EventApi__Sponsor_Package__c Sponsor Package LookupEventApi__Sponsor_Package__c false
** System Calculated ** Link to the sponsor package that reflects the configurations of this Item.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
** System Calculated ** Link to Ticket Type (Circular Reference) do not manually update.

OrderApi__Known_Address__c

Known Address
Known Addresses allows Contacts and Accounts to have multiple related address records.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Name__c Name Text 255 false
Name used as reference for this address.
OrderApi__Street__c Street TextArea false
Address Street
OrderApi__City__c City Text 255 false
Address City
OrderApi__Province__c State Text 255 false
Address State
OrderApi__Postal_Code__c Postal Code Text 255 false
Address Zip/Postal Code
OrderApi__Country__c Country Text 255 false
Address Country
OrderApi__Additional_Details__c Additional Details LongTextArea 131072 false
Any additional information about the Address (Buzz number, gate code, etc.)
OrderApi__Is_Default__c Is Default Checkbox false
When checked, this will be the pre-populated address when a user is checking out. Only one address can be checked for a contact at any given time.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
Relates the known address to a contact.

OrderApi__Log__c

Log
Logs track important events related to any "Assignment" object. Subscriptions use Logs to track all transaction and status change related events.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
** System Calculated Override ** Link to the related Account.
OrderApi__Assignment__c Assignment LookupOrderApi__Assignment__c false
** System Calculated Override ** Link to the Subscription related to the Log.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
** System Calculated Override ** Link to the related Contact.
OrderApi__Date__c Date Date false
** System Calculated Required Override ** The date the Log was generated.
OrderApi__Description__c Description Text false
** System Calculated ** Derived from the conditions of linked records related to the Log.
OrderApi__Invoice__c Invoice LookupOrderApi__Invoice__c false
** System Calculated Override ** Link to related Invoice.
OrderApi__Is_Customer_Generated__c Is Customer Generated Checkbox false
** System Calculated ** Checked when the Log was generated by a customer, partner, or public (unauthenticated) user.
OrderApi__Item__c Item LookupOrderApi__Item__c false
** System Calculated Override ** Link to the related Item.
OrderApi__Payment_Method__c Payment Method LookupOrderApi__Payment_Method__c false
** System Calculated Override ** Link to the related Payment Method.
OrderApi__Receipt_Line__c Receipt Line LookupOrderApi__Receipt_Line__c false
** System Calculated Override ** Link to related Receipt Line.
OrderApi__Receipt__c Receipt LookupOrderApi__Receipt__c false
** System Calculated Override ** Link to related Receipt.
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
** System Calculated Override ** Link to related Sales Order Line.
OrderApi__Sales_Order__c Sales Order LookupOrderApi__Sales_Order__c false
** System Calculated Override ** Link to related Sales Order.
OrderApi__Scheduled_Payment__c Scheduled Payment LookupOrderApi__Scheduled_Payment__c false
** System Calculated Override ** Link to the related Scheduled Payment.
OrderApi__Subscription_Line__c Subscription Line LookupOrderApi__Subscription_Line__c false
** System Calculated Override ** Link to the related Subscription Line.
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
** System Calculated Override ** Link to related Subscription Plan.
OrderApi__Subscription_Upgrade_Item__c Subscription Upgrade Item LookupOrderApi__Item__c false
** System Calculated Override ** Link to the related Item that the Subscription was upgraded too.
OrderApi__Subscription__c Subscription LookupOrderApi__Subscription__c false
Link to the Subscription related to the Log.
OrderApi__System_Message__c System Message Text 255 false
** System Calculated ** System generated message that provides context for the Log - the value of this field is used when generating the "Description" for the Log and is populated by a system trigger.
OrderApi__Type__c Type Picklist false
** System Calculated Required Override ** The Type of Log.
OrderApi__User__c User LookupOrderApi__User false
** System Calculated Required Override ** The User that generated the Log. Defaults to the same User as the "Created By" User for the same Log.

OrderApi__Package_Item__c

Package Item
Package Items allow one Item to bundle other Items.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Calculate_Pricing__c Calculate Pricing Checkbox false
Denotes a required Package Item Price has to be calculated.
OrderApi__Display_Button_Label__c Add To Cart Button Label Text 255 false
The label to display for the "Add to Cart" button in the shopping cart. Defaults to "Add to Cart".
OrderApi__Display_Instructions__c Display Instructions LongTextArea 131072 false
The shopping cart instructions displays above the package item view.
OrderApi__Display_Label__c Display Label Text 255 false
The shopping cart label replaces the default "Package Item" label which will render if no other label is provided.
OrderApi__Display_Order__c Display Order Number false
The integer value of the order the system will use to render the package item views in the shopping cart.
OrderApi__Is_Required__c Is Required Checkbox false
Denotes a required Package Item when the Package (Item) is selected in the parent Sales Order Line.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
Link to the Item Class that contains Items that are either required or optional for selection as part of a sale of the Package Item. The requirement for selection of the Item related to the Item Class is controlled by the "Is Optional" field.
OrderApi__Item__c Item LookupOrderApi__Item__c false
** Conditionally Required ** Link to the Item that is included in the Package.
OrderApi__Maximum_Quantity_Per_Item__c Maximum Quantity Per Item Number false
** For Package Item for Item Classes only ** Identifies the maximum quantity of a single Item that can be selected when selecting Items from this Item Class. Defaults 0. The value of 0 is infinite.
OrderApi__Maximum_Quantity__c Maximum Quantity Number false
Identifies the maximum quantity of Packaged Items that can be selected when selecting this Item or Items from this Item Class. Defaults 0. The value of 0 is infinite.
OrderApi__Minimum_Quantity__c Minimum Quantity Number false
Identifies the minimum quantity of Packaged Items that must be selected when selecting this Item or Items from this Item Class. Defaults 0. The value of 0 has no minimum.
OrderApi__Package__c Package (Item) MasterDetail false
** Required ** The Item that packages the Item linked in the "Packaged Item" field.
EventApi__Event__c RESERVED LookupEventApi__Event__c false
RESERVED
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c false
** System Calculated ** Link to related schedule item.
EventApi__Sponsor_Package__c Sponsor Package LookupEventApi__Sponsor_Package__c false
Link to related Sponsor Package.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
** System Calculated ** Link to the related Ticket Type. Derived, required and restricted to Package Items linked to parent Item that has a relationship with a Ticket Type.

OrderApi__Payment_Gateway__c

Payment Gateway
Payment gateways store configuration data for all connected Fonteva payment gateways in your organization.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__AVS_Configuration__c AVS Configuration Picklist false
AVS fields that are required when a payment is made.
OrderApi__Attempt_3DS__c Enable 3D Secure Checkbox false
When selected, 3D Secure will be enabled for the related payment gateway. Displayed only if a payment gateway supports 3D Secure.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**Required** Link to the related business group.
OrderApi__Company_Name__c Company Name Text 255 false
The name of the payment gateway company.
OrderApi__Supported_Credit_Cards_Image__c Supported Credit Cards Image Text 255 false
Image URL to show the supported credit cards for gateway.
OrderApi__Deposit_Account__c Deposit Account LookupOrderApi__GL_Account__c false
Link to related GL Account to use for the Deposit Account.
OrderApi__Enable_AVS_Zip_Code_Only__c Enable AVS Zip Code Only Checkbox false
**System Caluclated** specifies whether to verify zip code on payment or not
OrderApi__Enable_AVS__c Enable AVS Checkbox false
**System Caluclated** Checked if AVS is enabled
OrderApi__Gateway_Type__c Gateway Type Text 255 false
**System Calculated** The type of gateway used by the business group for credit card and e-check processing (not supported for all customers, check with your administrator if you have any questions).
OrderApi__Homepage__c Homepage Text 255 false
The url for the payment gateway company website.
OrderApi__Is_Enabled__c Is Enabled Checkbox false
The gateway is enabled for payment processing.
OrderApi__Is_Offsite__c Is Offsite Checkbox false
**System Calculated** - When a payment gateway is an offsite payment gateway.
OrderApi__Is_Test__c Is Test Checkbox false
The gateway is a test gateway and not to be used for production environments.
OrderApi__Post_Orders_in_Procesing__c Post Orders in Processing Checkbox false
If selected, the offsite payment which have not been funded yet will be posted.
OrderApi__Require_CVV__c Require CVV Checkbox false
Checking this field will require the card's verification value (CVV) at the time of payment.
OrderApi__Require_Email__c Require Email Checkbox false
Requires a valid email when executing a payment
OrderApi__Require_Phone__c Require Phone Checkbox false
Requires a valid phone when executing a payment
OrderApi__State__c State Text 255 false
** System Calculated ** The current state of the payment gateway connection.
OrderApi__Supported_Countries__c Supported Countries Text 255 false
** System Calculated ** Full list of supported countries for the Payment Gateway.
OrderApi__Supported_Regions__c Supported Regions Text 255 false
The payment gateway's supported geographic regions.
OrderApi__Supports_3DS_Purchase__c Supports 3DS Purchase Checkbox false
System field that indicates the related payment gateway supports 3DS purchases.
OrderApi__Supports_Authorize__c Supports Authorize Checkbox false
**System Calculated** Gateway supports credit card authorizations.
OrderApi__Supports_Capture__c Supports Capture Checkbox false
**System Calculated** Gateway supports credit card capture.
OrderApi__Supports_Credit_Card__c Supports Credit Card Checkbox false
When checked, the Gateway will be enabled for credit card payment processing.
OrderApi__Supports_Credit__c Supports Credit Checkbox false
**System Calculated** Gateway supports credit transactions. A credit is like a void, except it actually reverses a charge instead of just canceling a charge that hasn’t yet been made.
OrderApi__Supports_Offsite_Authorize__c Supports Offsite Authorize Checkbox false
**System Calculated** - When an offsite payment gateway supports Authorize
OrderApi__Supports_Verify__c Supports Verify Checkbox false
The payment gateway supports a verification only transaction that does not result in any charge to the customer.
OrderApi__Supports_Void__c Supports Void Checkbox false
**System Calculated** Gateway supports ability to void transactions.
OrderApi__Supports_eCheck__c Supports eCheck Checkbox false
When checked, the Gateway will be enabled for eCheck (EFT/ACH/Direct Debit) processing.
OrderApi__Token__c Token Text 255 false
**System Calculated/Override** The token used by the business group to process credit card and e-checks (not supported for all customers, check with your administrator if you have any questions).
OrderApi__Use_Offsite__c Enable Offsite Checkbox false
When selected, the related payment gateway will use the offsite payment method. Displayed only if a payment gateway is a test gateway.
OrderApi__Gateway_Specific_Fields__c SYSTEM LongTextArea 32768 false
Gateway specific fields to send part of every transaction.

OrderApi__Payment_Method__c

Payment Method
Credit Card and E-Check tokens stored for accounts and contacts.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
**System Calculated/Override** Link to the Billing Account for the Payment Method if Entity = "Account" otherwise the Billing Contact's Parent Account will be linked to the Payment Method.
OrderApi__API_Response__c API Response LongTextArea 131072 false
**System Calculated** API Response from the callout to create/cancel a payment method.
OrderApi__Bank_Account_Holder_Type__c Bank Account Holder Type Text 255 false
Bank account holder type for the echeck or direct debit payment method (when supported by your payment gateway).
OrderApi__Bank_Account_Type__c Bank Account Type Text 255 false
The bank account type for echeck or direct debit payments (when supported by your payment gateway).
OrderApi__Bank_Name__c Bank Name Text 255 false
The bank name for echeck or direct debit payments (when supported by your payment gateway).
OrderApi__Bank_Routing_Number__c Bank Routing Number Text 255 false
The bank account routing number for echeck or direct debit payments (when supported by your payment gateway).
OrderApi__Billing_City__c Billing City Text 255 false
Billing City for the customer's Payment Method.
OrderApi__Billing_Country__c Billing Country Text 255 false
Billing Country for the customer's Payment Method.
OrderApi__Billing_Postal_Code__c Billing Postal Code Text 255 false
Billing Postal Code for the customer's Payment Method.
OrderApi__Billing_State__c Billing State Text 255 false
Billing State for the customer's Payment Method.
OrderApi__Billing_Street__c Billing Street Text 255 false
Billing Street for the customer's Payment Method.
OrderApi__Card_Type__c Card Type Text 20 false
**System API Calculated** Visa, MasterCard, American Express, etc...
OrderApi__Contact__c Contact LookupOrderApi__Contact false
**System Calculated/Override** Link to the Billing Contact for the Payment Method.
OrderApi__Customer_ID__c Customer ID Text false
** System Calculated ** The Salesforce Record ID of the Contact or Account linked to the Payment Method.
OrderApi__Customer__c Customer Text false
**System Calculated** Link to the customer's record, controlled by the "Entity" field.
OrderApi__Custom_Payment_Type__c Custom Payment Type LookupOrderApi__Custom_Payment_Type__c false
**System Calculated** Link to the custom payment associated with this payment method
OrderApi__Description__c Description Text false
**System Calculated** The description of the customer payment method.
OrderApi__Is_Third_Party__c Is Third Party Checkbox false
When checked, payment method will not be displayed during checkout and credit card payment methods. Defaults unchecked.
OrderApi__Eligible_for_Card_Updater__c Eligible for Card Updater Checkbox false
When checked, the payment method is available for the Card on File Updater service where Fonteva will update any expired or changed cards in your ePayment vault so that any future transactions are processed uninterrupted.
OrderApi__Email__c Email Text 255 false
**System Calculated** The email address of the customer used to transact with the api.
OrderApi__Entity__c Entity Picklist false
**Required** Select "Account" if the invoice should be billed to the related account, select "Contact" if the invoice should be sent to the related "Contact".
OrderApi__Exp_Date__c Expiration Date Date false
**System Calculated** Credit Card Expiration Date.
OrderApi__First_Six_Digits__c First Six Digits Text 6 false
The first six (6) digits of the payment method (credit card or bank account number).
OrderApi__Full_Name__c Full Name Text 255 false
**System Calculated** The full name of the customer.
OrderApi__Is_Active__c Is Active Checkbox false
**System API Calculated** Checked when the Payment Method is deemed as a valid payment method by your Gateway (Payment Processor). Default checked.
OrderApi__Is_Declined__c Is Declined Checkbox false
Checked when the last transaction for the Payment Method was declined by your Payment Gateway. Default unchecked.
OrderApi__Is_Restricted__c Is Restricted Checkbox false
Restircts the payment methods display to only purchased items. Default unchecked.
OrderApi__Is_Expired__c Is Expired Checkbox false
**System Calculated** Checked if the Payment Method Type is Credit Card and Today's Date is past the Card Expiration Date. Default unchecked.
OrderApi__Is_Valid__c Is Valid Checkbox false
Checked when the Payment Method is deemed valid by your Payment Gateway otherwise unchecked. Default checked.
OrderApi__Last_Four_Digits__c Last Four Digits Text 4 false
The last four (4) digits of the payment method (credit card or bank account number).
OrderApi__Month__c Month Number false
**System Calculated** MM value for the Credit Card Expiration Month.
OrderApi__Number__c Number Text 255 false
**System Calculated** Masked account number displaying X for all but the last four characters which are visible. Example: XXXX-XXXX-XXXX-1234
OrderApi__Override_Edit__c Override Edit Text 255 false
URL field that overrides the default behavior of edit. If this filed populated, user will be redirected to provided url
OrderApi__Payment_Method_Token__c Payment Method Token Text 255 false
**System API Calculated** API Token for the Payment Method.
OrderApi__Payment_Method_Type__c Payment Method Type Text 255 false
**System API Calculated** The type of payment method formatted for API transactions.
OrderApi__Phone__c Phone Phone false
**System Calculated** The phone number sent to the gateway (optional/additional customer data)
OrderApi__Year__c Year Number false
**System Calculated** YYYY value for the Credit Card Expiration Year.

OrderApi__Payment_Terms__c

Payment Terms
Custom Payment Terms for Invoices.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**Required** Link to the related Business Group.
OrderApi__Display_Message__c Display Message LongTextArea 32768 false
The displayed message to the customer for the Payment Terms.
OrderApi__Display_Name__c Display Name Text 255 true
The displayed name (to the customer) for the Payment Terms. Defaults to the name value of the record.
OrderApi__Variable__c Variable Number true
**Required** The number of days to add to the Invoice Date to use to calculate due date.

OrderApi__Price_Rule_Variable__c

Price Rule Variable
Create conditional Price Rules based on a field located on the Account or Contact object.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Field__c Field Text 255 true
**Required** The API Name of the Field used to evaluate for the Price Rule Variable.
OrderApi__Object__c Object Text 255 true
**Required** The API Name of the Object evaluated for the Price Rule Variable.
OrderApi__Operator__c Operator Picklist false
**Required** The operator in a filter is like the verb in a sentence. Use an operator to specify the conditions the Price Rule Variable will use to evaluate whether a Contact or Account matches the condition.
OrderApi__Price_Rule__c Price Rule MasterDetail false
**Required** Price Rule Variables hold a Master-Detail relationship to Price Rules.
OrderApi__Value__c Value Text 255 true
**Required** The value of the Field to evaluate against the Customer to determine Price availability. (Used in conjunction with Type)

OrderApi__Price_Rule__c

Price Rule
Flexible price rules allow you to configure custom price scenarios for items based on a variety of different rules.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Current_Num_Available__c Current Num Available Number false
A running total of the number of times this rule can be used prior to the rule expiring (if applicable).
OrderApi__End_Date__c End Date Date false
If a pricing rule is date-driven what date does this rule expire and become an inactive price for the product?
OrderApi__Is_Active__c Is Active Checkbox false
When checked the Price Rule is considered available for assignment and is considered when auto-calculating the appropriate price for a Item on Invoices, Sales Orders, Receipts, and EPayments. Defaults checked.
OrderApi__Is_Default__c Is Default Checkbox false
All products must have one and only one default price assigned. This is used as the catch all when calculating the appropriate price to charge customers when purchasing the product.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
Link to the Item Class -- only valid if the Price Rule is not linked to a Item. When linked to a Item Class the Price Rule will automatically be created for all Items created as a child of the Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
The item the price rule record is assigning a price for.
OrderApi__Limit_Per_Account__c Limit Per Account Number false
Limits the total number of times the price rule can be used by the account or any contacts on the account.
OrderApi__Limit_Per_Contact__c Limit Per Contact Number false
Limits the number of times the price rule can be used by each contact.
OrderApi__Max_Num_Available__c Max Num Available Number false
The maximum number of times this rule can be used. Typically used to incentivize customers to purchase products early or for flash/date-driven sales. Leave blank if you do not want to limit the number of times the rule can be applied.
OrderApi__Max_Quantity__c Max Quantity Number false
Enter the maximum quantity that can not be exceeded for this rule to apply to be valid for any given transaction scenario. Leave blank to disable max quantity as a constraint for the rule.
OrderApi__Min_Quantity__c Min Quantity Number false
Enter the minimum quantity that must be purchased for this rule to apply to a purchase of the item. Leave blank to not constrain rule assignement by minimum quantity.
OrderApi__Max_Assignments__c Max Assignments Number false
Enter the maximum quantity that can be assigned for this rule to apply to a purchase of the item. Leave blank to not constrain rule by maximum assignments.
OrderApi__Min_Assignments__c Min Assignments Number false
Enter the minimum quantity that must be assigned for this rule to apply to a purchase of the item. Leave blank to not constrain rule by minimum assignments.
OrderApi__Num_Times_Used__c Num Times Used Number false
The number of times this rule has been applied as the price rule for the product on a transaction.
OrderApi__Price__c Price Currency true
Enter the price for the pricing rule.
OrderApi__Required_Badge_Types__c Required Badge Types LongTextArea 32768 false
Comma separated list of Badge Types required to be considered eligible for the Price Rule.
OrderApi__Required_Subscription_Plans__c Required Subscription Plans LongTextArea 32768 false
Select the Subscription Plan that must be selected for this rule to apply to the purchase of the item. Leave blank to not constrain rule by Subscription Plan.
OrderApi__Required_Source_Codes__c Required Source Codes LongTextArea 32768 false
Comma separated list of Source Codes required to be considered eligible for the Price Rule.
OrderApi__Start_Date__c Start Date Date false
If a pricing rule is date-driven what date does this rule become an active/available price for the item?
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c false
Link to related Schedule Item.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
Link to related Ticket Type.
EventApi__Is_Early_Bird_Price__c SYSTEM Checkbox false
When checked, denotes this price rule as the early bird price.
EventApi__Is_On_Site_Price__c SYSTEM Checkbox false
When checked, denotes this price rule as the on site price.

OrderApi__Receipt_Line__c

Receipt Line
Receipt Lines apply cash related to either refunds or payments to Invoices or Items.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Tax_Override__c Tax Override Checkbox false
This field is used to override any tax calculations by the system.
OrderApi__Tax_Percent__c Tax Percent Percent false
Combined with the Parent Receipt Line's Sales Price, this field is used to calculate the tax amount for the related item.
OrderApi__Is_Tax__c Is Tax Checkbox false
Defines the Receipt Line that is being used for tax.
OrderApi__Is_Shipping_Rate__c Is Shipping Rate Checkbox false
Defines the Receipt Line that is being used for shipping.
OrderApi__Receipt_Line__c Parent Receipt Line LookupOrderApi__Receipt_Line__c false
Link to related parent Receipt Line.
OrderApi__Activation_Date__c Activation Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be activated is calculated based on conditions set on the related Subscription Plan and can be manually over-ridden if "Auto Calculate Activation Date" is unchecked.
OrderApi__Auto_Calculate_Activation_Date__c Auto Calculate Activation Date Checkbox false
** System Calculated Override ** Valid if the Receipt Line is related to a "Subscription" Item. When checked, the system will automatically calculate the "Activation Date" based on conditions set on the selected "Subscription Plan". Defaults checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Link to the related Business Group.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
This field is populated to show the related contact.
OrderApi__Calculate_Shipping_Details__c Calculate Shipping Details Checkbox false
Default checked. Copies the shipping information from the receipt.
OrderApi__End_Date__c End Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be ended is calculated based on conditions set on the related Subscription Plan and Activation Date.
OrderApi__GL_Account__c GL Account LookupOrderApi__GL_Account__c false
**System Calculated/Required/Override** Link to the related GL Account.
OrderApi__Invoice_Balance_Due__c Invoice Balance Due Currency false
**System Calculated** The balance due for the linked Invoice (if applicable).
OrderApi__Invoice_Customer_Link__c Invoice Customer Text false
**System Calculated** The customer for the linked Invoice (if applicable).
OrderApi__Invoice_Due_Date__c Invoice Due Date Date false
**System Calculated** The due date for the linked Invoice (if applicable).
OrderApi__Invoice__c Invoice LookupOrderApi__Invoice__c false
Link to related Invoice that the customer is paying.
OrderApi__Invoice_Line__c Invoice Line LookupOrderApi__Invoice_Line__c false
Relates the receipt line to the invoice line.
OrderApi__Is_Refund__c Is Refund Checkbox false
**System Calculated** Checked when the parent Receipt is a "Refund"
OrderApi__Is_Renewal__c Is Renewal Checkbox false
When checked, related Receipt Line is considered as "Subscription Renewal".
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated / Override ** Link to the related Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
**Required** Link to related Item.
OrderApi__Line_Description__c Line Description Text 255 false
**System Calculated/Override** The line description by default populates with general information from either the linked Item or the linked Invoice.
OrderApi__List_Price__c List Price Currency false
**System Calculated** The value of the "Price" field for the related Item.
OrderApi__Price_Override__c Price Override Checkbox false
When checked, the system will derive the Sale Price from the most appropriate Price Rule. Default checked.
OrderApi__Price_Rule__c Price Rule LookupOrderApi__Price_Rule__c false
**System Calculated/Override** Link to related Price Rule applied for the related Item.
OrderApi__Quantity__c Quantity Number false
**Required** Quantity of Items. Default 1.
OrderApi__Receipt__c Receipt MasterDetail false
**Required** All Receipt details require a parent receipt that summarizes all receipt lines.
OrderApi__Sale_Price__c Sale Price Currency false
**System Calculated/Override** The Sale Price (per unit) for the related Item. Default 0.00.
OrderApi__Shipping_City__c Shipping City Text 255 false
Optional shipping city for the item's ordered on the receipt line. If left blank, the value of this field will be updated with the value of the parent receipt's "Shipping City" field.
OrderApi__Shipping_Contact__c Shipping Contact Text 255 false
Optional shipping contact for the item's ordered on the receipt line. If left blank, the value of this field will be updated with the value of the parent receipt's "Shipping Contact" field.
OrderApi__Shipping_Country__c Shipping Country Text 255 false
Optional shipping country for the item's ordered on the receipt line. If left blank, the value of this field will be updated with the value of the parent receipt's "Shipping Country" field.
OrderApi__Shipping_Postal_Code__c Shipping Postal Code Text 255 false
Optional shipping postal code for the item's ordered on the receipt line. If left blank, the value of this field will be updated with the value of the parent receipt's "Shipping Postal Code" field.
OrderApi__Shipping_State__c Shipping State Text 255 false
Optional shipping state for the item's ordered on the receipt line. If left blank, the value of this field will be updated with the value of the parent receipt's "Shipping State" field.
OrderApi__Shipping_Street__c Shipping Street Text 255 false
Optional shipping street for the item's ordered on the receipt line. If left blank, the value of this field will be updated with the value of the parent receipt's "Shipping Street" field.
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
** Conditionally Required ** Link to the related plan that controls Activation and Expiration dates related to any Subscription Item. Required when the Receipt Line is linked to a Item that is the child of a "Subscription" Item Class.
OrderApi__Subscription__c Subscription (Upgrade/Renew) LookupOrderApi__Subscription__c false
Link to the Subscription that is being upgraded or renewed.
OrderApi__Subtotal__c Subtotal Currency false
**System Calculated** Sale Price * Quantity
OrderApi__Total__c Total Currency false
**Required** Total amount for the Receipt Line. Default is 0.00.

OrderApi__Receipt__c

Receipt
Receipts track Customer Payments and Refunds.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
**System Calculated/Override/Required** The account the payment was received from or the refund was sent to.
OrderApi__Action_Information__c Action Information LongTextArea 2500 false
JSON Field that will store action information such as custom links that may need to be displayed.
OrderApi__Applied_Amount__c Applied Amount Summary false
**System Calculated** The total amount of the payment that has been applied to transactions.
OrderApi__Balance__c Balance Currency false
**System Calculated** The difference between the Payment Amount and the Applied Amount.
OrderApi__Batch__c Batch LookupOrderApi__Batch__c false
**Best Practice** Associate all receipts with a financial batch.
OrderApi__Billing_City__c Billing City Text 255 false
The value of this field will be updated with the Account's Billing City or Contact's Mailing City, based on "Entity" if not defined on record entry.
OrderApi__Billing_Contact__c Billing Contact Text 255 false
The value of this field will be updated with the Account or Contact, based on "Entity" if not defined on record entry.
OrderApi__Billing_Country__c Billing Country Text 255 false
The value of this field will be updated with the Account's Billing Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
OrderApi__Billing_Postal_Code__c Billing Postal Code Text 255 false
The value of this field will be updated with the Account's Billing Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
OrderApi__Billing_State__c Billing State Text 255 false
The value of this field will be updated with the Account's Billing State or Contact's Mailing State, based on "Entity" if not defined on record entry.
OrderApi__Billing_Street__c Billing Street Text 255 false
The value of this field will be updated with the Account's Billing Address or Contact's Mailing Address, based on "Entity" if not defined on record entry.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override/Required** Link to the related Business Group auto-populates if not specified on record creation based upon the user's "Default Business Group" setting on the custom settings object.
OrderApi__Calculate_Billing_Details__c Calculate Billing Details Checkbox false
When checked the system will calculate billing details automatically. If entity is "Contact" the mailing address of the contact is used, otherwise the account's billing address is used. The contact on the invoice will populate the billing contact field.
OrderApi__Calculate_Memo__c Calculate Memo Checkbox false
When checked the system will populate the memo for the receipt making it easy to have helpful memo's to both customers and accountants.
OrderApi__Calculate_Shipping_Details__c Calculate Shipping Details Checkbox false
If checked the system will calculate shipping details automatically. If entity is "Contact" the mailing address of the contact is used, otherwise the account's shipping address is used. The contact on the receipt will populate the shipping contact field.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
**System Calculated/Override/Required** The contact the payment was received from or the refund is being sent to.
OrderApi__Customer_Link__c Customer Text false
**System Calculated** A link to the record the system considers the "Customer" as determined by the "Entity" field.
OrderApi__Date__c Date Date false
**Required** The Date the Receipt was processed. Default's to the Date the Entry was created.
OrderApi__Deposit_Account__c Deposit Account LookupOrderApi__GL_Account__c false
**Required** The GL account associated with the bank account the funds will be deposited into.
OrderApi__EPayment__c E-Payment (Source) LookupOrderApi__EPayment__c false
**System Calculated** When receipts are created from payment activities the source a link to the source payment activity will populate in this field.
OrderApi__Entity__c Entity Picklist false
**Required** The entity the system should consider the "Customer" related to the record.
OrderApi__Is_Payment__c Is Payment Checkbox false
**System Calculated** Checked when the Receipt is related to a customer payment.
OrderApi__Is_Posted__c Is Posted Checkbox false
Default unchecked. When checked, the receipt will create a new cash transaction (journal entry) and the posted date will populate with the value of today's date.
OrderApi__Is_Refund__c Is Refund Checkbox false
Checked when the Receipt is for a customer refund
OrderApi__Memo__c Memo Text 255 false
Customer-facing memo for the receipt.
OrderApi__Gateway_Transaction_Id__c Gateway Transaction Id Text 255 false
** System Calculated ** The transaction ID reported from your payment gateway. Use this key as a unique key for payment reconciliation between your merchant services provider and our database.
OrderApi__Payment_Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
Lookup to payment gateway, populates automatically for all epayment transactions.
OrderApi__Payment_Method_Description__c Payment Method Description Text false
** System Calculated ** Derived from the source ePayment.
OrderApi__Payment_Method__c Payment Method LookupOrderApi__Payment_Method__c false
Use a saved payment method for the customer without having to enter in a new credit card or bank account (not supported for all gateways - check with your administrator to see if you are using a gateway that supports this functionality).
OrderApi__Payment_Type__c Payment Type Picklist false
**Required** The payment type (Check, Credit Card, EFT, or Other).
OrderApi__Posted_Date__c Posted Date Date false
**System Calculated/Override** Populates with the value of the date the "Is Posted" flag is checked.
OrderApi__Process_Refund__c Process Refund Checkbox false
Checking this flag will process the refund.
OrderApi__Receipt__c Receipt LookupOrderApi__Receipt__c false
**System Caluclated** Lookup to the reciept for which you are refunding.
OrderApi__Reference_Number__c Reference Number Text 255 false
**Required** The check number or credit card/bank authorization code related to the payment.
OrderApi__Refund__c Refund Checkbox false
Checking this flag will create a refund record.
OrderApi__Sales_Order__c Sales Order LookupOrderApi__Sales_Order__c false
**System Calculated/Override** Link to related Sales Order.
OrderApi__Shipping_City__c Shipping City Text 255 false
The value of this field will be updated with the Account's Shipping City or Contact's Mailing City, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Contact__c Shipping Contact Text 255 false
The value of this field will be updated with the Account or Contact, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Country__c Shipping Country Text 255 false
The value of this field will be updated with the Account's Shipping Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Postal_Code__c Shipping Postal Code Text 255 false
The value of this field will be updated with the Account's Shipping Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
OrderApi__Shipping_State__c Shipping State Text 255 false
The value of this field will be updated with the Account's Shipping State or Contact's Mailing State, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Street__c Shipping Street Text 255 false
**System Calculated/Conditional** Shipping Street derives from the Contact Mailing Street or the Account Billing Street when Calculate Shipping Details is checked.
OrderApi__Source_Code__c Source Code LookupOrderApi__Source_Code__c false
Optional source code for the receipt. This will populate on all invoices related to the receipt. If a source code is already on an invoice the receipt is applied to, the original source code will not be updated with the value of the source code on the receipt.
OrderApi__Total__c Total Currency false
**Conditionally Required** Receipt Total, required to post receipt to GL (Transactions).
OrderApi__Type__c Type Picklist false
**Required/Do Not Modify Picklist Values** "Cash Receipt" receipts are used to record inbound cash such as customer payments. "Cash Payment" receipts are used to record outbound cash such as refunds.

OrderApi__Renewal_Path_Variable__c

Renewal Path Variable
Create conditional Renewal Path Rules based on a field located on the Account or Contact object.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Field__c Field Text 255 true
**Required** The API Name of the Field used to evaluate for the Renewal Path Variable.
OrderApi__Object__c Object Text 255 true
**Required** The API Name of the Object evaluated for the Renewal Path Rule Variable.
OrderApi__Operator__c Operator Picklist false
**Required** The operator in a filter is like the verb in a sentence. Use an operator to specify the conditions the Renewal Path Variable will use to evaluate whether a Contact or Account matches the condition.
OrderApi__Renewal_Path__c Renewal Path MasterDetail false
**Required** Renewal Path Variables hold a Master-Detail relationship to Renewal Paths.
OrderApi__Value__c Value Text 255 true
**Required** The value of the Field to evaluate against the Customer to determine Item availability.

OrderApi__Renewal_Path__c

Renewal Path
Defines the available set of items/rules , a subscription can be renewed.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Is_Default__c Is Default Checkbox false
When checked, the subscription item will be the default renewal path for system-processed renewals.
OrderApi__Item__c Item LookupOrderApi__Item__c false
**Required** Defines the subscription item that will have a renewal path.
OrderApi__Renew_Into_Item__c Renew Into Item LookupOrderApi__Item__c false
**Required** Defines the subscription item(s) that can be renewed into.
OrderApi__Rule_Type__c Rule Type Picklist false
Defines whether the renewal path is triggered by the number of completed terms, or by a property of the subscriber’s account/contact.
OrderApi__Term__c Term Number false
Defines the number of terms that must be completed to trigger the renewal path.

OrderApi__Renewal__c

Term
Terms track the Subscription terms, dates for all Customer Subscriptions.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Grace_Period_End_Date__c Grace Period End Date Date false
This date is calculated by the Term End Date plus the number of days defined on the Subscription Plan's Grace Period field.
OrderApi__Renewed_Date__c Paid Date Date false
** System Calculated Required Override ** The date the customer renewed the Subscription.
OrderApi__Is_Active__c Is Active Checkbox false
Defines the active subscription term.
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
** System Calculated ** Related Sales Order Line(source).
OrderApi__Sales_Order__c Sales Order LookupOrderApi__Sales_Order__c false
** System Calculated ** Related Sales Order (source).
OrderApi__Subscription__c Subscription MasterDetail false
** System Calculated Required ** Link to related Subscription
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
** System Calculated ** Link to related Subscription Plan
OrderApi__Term_End_Date__c Term End Date Date false
** System Calculated Required Override ** The date the term ends.
OrderApi__Term_Start_Date__c Term Start Date Date false
** System Calculated Required Override ** The date the term begins.

OrderApi__Sales_Order_Line__c

Sales Order Line
Sales Order Lines track the Items associated with Sales Orders.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
** Conditionally Required System Calculated Override ** Link to the Account that is assigned to the Sales Order Line -- valid if the linked "Item" "Enable Assignments" is checked, and the "Entity" is set to "Account". Defaults to the Sales Order "Account".
OrderApi__Activation_Date__c Activation Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be activated is calculated based on conditions set on the related Subscription Plan and can be manually over-ridden if "Auto Calculate Activation Date" is unchecked.
OrderApi__Active_Assignments__c Active Assignments Number false
** System Calculated ** Number of Active Assignments. Valid and restricted to Items where "Enable Assignments" is checked. Defaults 0 if no Assignments found.
OrderApi__Assignments_Allowed__c Assignments Allowed Number false
** System Calculated ** If the Item "Enable Assignments" and "Restrict Number of Assignments" fields are checked, the Item "Maximum Number of Assignments" x the Line "Quantity" is set. Otherwise no value is set.
OrderApi__Is_Required_Package_Item__c Is Required Package Item Checkbox false
** System Calculated ** Checked when the sales order line is linked to a package item where "Is Required" is also checked.
OrderApi__Assignments_Available__c Assignments Available Number false
** System Calculated ** If the Item "Restricts Number of Assignments" then Assignments Allowed - Active Assignments is set. Otherwise the value is null.
OrderApi__Auto_Assign_Account_Contacts__c Auto Assign Account Contacts Checkbox false
Checked when a Auto Assign Rule set "All Account Contacts"
OrderApi__Auto_Assign_Contact__c Auto Assign Contact Checkbox false
Checked when Auto Assignment Rule set to "Contact"
OrderApi__Do_Not_Collect_Payment__c Requires PreAuthorize Payment Checkbox false
When checked, the related Sales Order Line will not be added to the EPayment and Receipt. Customer will not be charged for this Sales Order Line.
OrderApi__Auto_Assign_Rule__c Auto Assign Rule Picklist false
Defines the Assignment creation rule for related Account or Contact.
OrderApi__Auto_Assign__c Auto Assign Checkbox false
When it is checked, assignment records will be created depending on "Auto Assign Rule".
OrderApi__Auto_Calculate_Activation_Date__c Auto Calculate Activation Date Checkbox false
** System Calculated Override ** Valid if the Sales Order Line is related to a "Subscription" Item. When checked, the system will automatically calculate the "Activation Date" based on conditions set on the selected "Subscription Plan". Defaults checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Default value is mapped from the parent sales order. The Business Group controls what items are available to associate with the order line. If no value exists, all active items will be allowed to be associated.
OrderApi__Calculate_Shipping_Details__c Calculate Shipping Details Checkbox false
Default checked. Copies the shipping information from the sales order.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
** Conditionally Required System Calculated Override ** Link to the Contact who is the primary assignee of the Item purchased on the Sales Order Line. Required if "Enable Assignments" is checked on the related Item. Defaults to the Sales Order Contact.
OrderApi__Disable_Scheduling__c Disable Scheduling Checkbox false
Scheduling is disabled for this line and the total is added as a line to the first installment.
OrderApi__Enable_Auto_Renew__c Enable Auto Renew Checkbox false
When checked, the subscription will automatically attempt to renew itself by charging the related Payment Method. Defaults unchecked.
OrderApi__End_Date__c End Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be ended is calculated based on conditions set on the related Subscription Plan and Activation Date.
OrderApi__Entity__c Entity Picklist false
** Conditionally Required ** Select "Account" to assign the Item on the Sales Order Line to the linked "Account" field -- otherwise select "Contact". Defaults to the value of the same field on the Sales Order.
OrderApi__GL_Account__c GL Account LookupOrderApi__GL_Account__c false
**System Calculated/Required/Override** Link to the related GL Account.
OrderApi__Is_Amendment__c Is Amendment Checkbox false
When checked, related Sales Order Line is considered as "Subscription Amendment"
OrderApi__Is_Installment_Calculated__c Is Installment Calculated Checkbox false
**System Calculated** Checked if sol type is installment and if the amount is Calculated.
OrderApi__Is_Posted__c Is Posted Checkbox false
When checked all Invoices related to the Sales Order will post an receivable transaction to the GL.
OrderApi__Is_Renewal__c Is Renewal Checkbox false
When checked, related Sales Order Line is considered as "Subscription Renewal".
OrderApi__Is_Subscription__c Is Subscription Checkbox false
** System Calculated ** Checked when the Sales Order Line is linked to a "Subscription" Item.
OrderApi__Is_Tax__c Is Tax Checkbox false
Defines the Sales Order Line that is being used for tax.
OrderApi__Is_Valid__c Is Valid Checkbox false
When an Item that requires certain options or assignments is linked to the line, the line is considered "Invalid" until all requirements are met. Defaults checked for Items with no requirements, otherwise defaults unchecked.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated / Override ** Link to the related Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
Link to the item related to the sales order.
OrderApi__Line_Description__c Line Description Text 255 false
Optional line description will be added to sales orders, invoices, receipts, and detailed customer statements. If blank, the value of this field will match the value of the related item's "Line Description" field.
OrderApi__List_Price__c List Price Currency false
**System Calculated** The standard price for the item selected on the sales order line.
OrderApi__Package_Item__c Package Item LookupOrderApi__Package_Item__c false
** System Calculated / Conditionally Required ** Creates a relationship to the Package Item when the Sales Order Line is created as a result of purchasing the parent package item.
OrderApi__Payment_Method__c Payment Method LookupOrderApi__Payment_Method__c false
** Conditionally Required ** Required if a Subscription Item and Subscription Plan configuration has "Require Valid Payment Method" checked. The Payment Method must also be related to the purchasing/subscribing Account or Contact.
OrderApi__Price_Override__c Price Override Checkbox false
Overrides the calculation of price based on the most appropriate price for the purchasing customer. Default is unchecked.
OrderApi__Price_Rule__c Price Rule LookupOrderApi__Price_Rule__c false
The price rule related to the sales order line. When added or changed, the unit price will reflect the price defined on the price rule.
OrderApi__Quantity__c Quantity Number false
**Conditionally Required** The quantity (number of units) of the item related to the sales order line. Required when an Item is linked that does not have "Disable Price Rules" checked. Default 1.
OrderApi__Required_Package_Items__c Required Package Items Number false
This field aggregates the total number of required package items needed to fulfill a sales order with this item.
OrderApi__Sale_Price__c Sale Price Currency false
**System Calculated/Override** The price per-unit for the item sold on the sales order line.
OrderApi__Sales_Order_Line__c Parent Sales Order Line LookupOrderApi__Sales_Order_Line__c false
Sales Order Lines that link to "Package" Items will include the Items into the Sales Order as new Sales Order Lines which will have a parent/child relationship with the Sales Order Line that links to the "Package" Item.
OrderApi__Sales_Order__c Sales Order MasterDetail false
**Required** All Sales Order Lines require a linked Sales Order.
OrderApi__Shipping_City__c Shipping City Text 255 false
Optional shipping city for the item's ordered on the order line. If left blank, the value of this field will be updated with the value of the parent order's "Shipping City" field.
OrderApi__Shipping_Contact__c Shipping Contact Text 255 false
Optional shipping contact for the item's ordered on the sales order line. If left blank, the value of this field will be updated with the value of the parent sales order's "Shipping Contact" field.
OrderApi__Shipping_Country__c Shipping Country Text 255 false
Optional shipping country for the item's ordered on the order line. If left blank, the value of this field will be updated with the value of the parent order's "Shipping Country" field.
OrderApi__Shipping_Postal_Code__c Shipping Postal Code Text 255 false
Optional shipping postal code for the item's ordered on the order line. If left blank, the value of this field will be updated with the value of the parent order's '"Shipping Postal Code" field.
OrderApi__Shipping_State__c Shipping State Text 255 false
Optional shipping state for the item's ordered on the order line. If left blank, the value of this field will be updated with the value of the parent order's "Shipping State" field.
OrderApi__Shipping_Street__c Shipping Street TextArea false
Optional shipping street for the item's ordered on the order line. If left blank, the value of this field will be updated with the value of the parent order's "Shipping Street" field.
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
** Conditionally Required ** Link to the related plan that controls Activation and Expiration dates related to any Subscription Item. Required when the Sales Order Line is linked to a Item that is the child of a "Subscription" Item Class.
OrderApi__Subscription__c Subscription (Upgrade/Renew) LookupOrderApi__Subscription__c false
Link to the Subscription that is being upgraded or renewed.
OrderApi__Subtotal__c Subtotal Currency false
**System Calculated** Sale Price * Quantity
OrderApi__System_Override__c SYSTEM Checkbox false
**SYSTEM** Overrides the calculation of price and Price rule. Default is unchecked.
OrderApi__Tax_Override__c Tax Override Checkbox false
This field is used to override any tax calculations by the system.
OrderApi__Tax_Percent__c Tax Percent Percent false
Combined with the Parent Sale Order Line's Sales Price, this field is used to calculate the tax amount for the related item.
OrderApi__Total__c Total Currency false
**System Calculated** Total amount of Sales Order Line
OrderApi__Total_Installment_Price__c SYSTEM Currency false
**System Calculated** Total amount of all the installments created as a result of this sales order line.
OrderApi__Is_Shipping_Rate__c Is Shipping Rate Checkbox false
Defines the Sales Order Line that is being used for shipping.
OrderApi__Shipping_Method__c Shipping Method LookupOrderApi__Shipping_Method__c false
Lookup to select a Shipping Method associated with the Sales Order Line.
OrderApi__Shipping_Tracking_Number__c Shipping Tracking Number Text 255 false
Field for admins to input a Shipping Tracking Number.
EventApi__Attendee__c Attendee LookupEventApi__Attendee__c false
Link to related Attendee.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to related Event.
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c false
Link to related Schedule Item.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
Link to related Ticket Type.
EventApi__Sponsor_Package__c Sponsor Package LookupEventApi__Sponsor_Package__c false
Link to related Sponsor Package.
EventApi__Is_Required_Schedule_Item__c SYSTEM Checkbox false
When checked, the schedule item is required with ticket.

OrderApi__Sales_Order__c

Sales Order
Sales Orders are the primary object for all sales related transactions.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
**System Calculated/Override** Link to the customer's account record. Auto-populates with the related contact's parent account if not defined prior to entry.
OrderApi__Billing_City__c Billing City Text 255 false
The value of this field will be updated with the Account's Billing City or Contact's Mailing City, based on "Entity" if not defined on record entry.
OrderApi__Billing_Contact__c Billing Contact Text 255 false
The value of this field will be updated with the Account or Contact, based on "Entity" if not defined on record entry.
OrderApi__Billing_Country__c Billing Country Text 255 false
The value of this field will be updated with the Account's Billing Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
OrderApi__Billing_Postal_Code__c Billing Postal Code Text 255 false
The value of this field will be updated with the Account's Billing Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
OrderApi__Billing_State__c Billing State Text 255 false
The value of this field will be updated with the Account's Billing State or Contact's Mailing State, based on "Entity" if not defined on record entry.
OrderApi__Billing_Street__c Billing Street Text 255 false
**System Calculated/Conditional** Billing Street derives from the Contact Mailing Street or the Account Billing Street when Calculate Billing Details is checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Link to the business group record - business groups will auto-populate if not defined on entry.
OrderApi__Calculate_Billing_Details__c Calculate Billing Details Checkbox false
When checked the system will calculate billing details automatically. If entity is "Contact" the mailing address of the contact is used, otherwise the account's billing address is used. The contact on the order will populate the billing contact field.
OrderApi__Calculate_Shipping_Details__c Calculate Shipping Details Checkbox false
When checked the system will calculate shipping details automatically. If entity is "Contact" the mailing address of the contact is used, otherwise the account's shipping address is used. The contact on the order will populate the shipping contact field.
OrderApi__Campaign_Page__c Campaign Page LookupOrderApi__Campaign_Page__c false
OrderApi__Cancelled_Date__c Cancelled Date Date false
The date the contract or subscription was cancelled.
OrderApi__Closed_Date__c Closed Date Date false
The date the Sales Order was closed.
OrderApi__Proforma_Invoice_Email_Sent_Date__c Proforma Invoice Email Sent Date Date false
** SYSTEM FIELD ** Automatically updated to the date time the last proforma invoice email was sent related to this sales order. If no proforma invoice email was sent the value of this field will remain empty.
OrderApi__Proforma_Invoice_Email_Sent__c Proforma Invoice Email Sent Checkbox false
** SYSTEM FIELD ** Automatically checked when a proforma invoice email has been sent from this sales order.
OrderApi__Auto_Send_Proforma_Invoice_Emails__c Auto Send Proforma Invoice Emails Checkbox false
When checked system will send proforma invoice automatically.
OrderApi__Closed_Status__c Closed Status Picklist false
**System Calculated/Conditional/Override** A status description for "Closed" Sales Orders.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
**System Calculated/Override** Link to the customer's contact record. Auto-populates with the related account's primary contact if not defined prior to entry.
OrderApi__Created_by_Customer__c Created by Customer Checkbox false
Checked when a Sales Order was created from the front-end shopping cart.
OrderApi__Customer_Link__c Customer Text false
**System Calculated** Link to the customer's record, controlled by the "Entity" field.
OrderApi__Customer_Reference_Number__c Customer Reference Number Text 255 false
The customer reference number, typically a purchase order number, included on quotes and invoices generated from the sales order.
OrderApi__Date__c Date Date false
The date the Sales Order was created. Default value is today's date.
OrderApi__Description__c Description LongTextArea 32768 false
Internal facing descriptions will not appear and should not be included in customer-facing communications.
OrderApi__EPayment__c E-Payment (Source) LookupOrderApi__EPayment__c false
**System Calculated/Override** Link to related Payment Activity.
OrderApi__Source_Code__c Source Code LookupOrderApi__Source_Code__c false
**System Calculated/Override** Link to Source Code.
OrderApi__End_Date__c Schedule End Date Date false
The date when the subscription ends. This date will always be the current term end date or the subscription cancelled date where appropriate.
OrderApi__Entity__c Entity Picklist false
**Required** Select "Account" if the related the account is responsible payment of the customer order, Select "Contact" if the related contact is responsible payment of the customer order.
OrderApi__Has_Installments__c Has Installments Checkbox false
OrderApi__Has_Subscription__c Has Subscription Checkbox false
** System Calculated ** Checked when the Sales Order contains a Sales Order Line that is linked to a Subscription.
OrderApi__Invoice_Date__c Invoice Date Date false
**System Calculated/Conditional/Override** The date to use as the Invoice Date for any Invoice generated from the Sales Order only applies to Sales Orders where Is Scheduled is not set to true.
OrderApi__Is_Active__c Is Active Checkbox false
**System Calculated/Override** Checked when a recurring order or contract is active.
OrderApi__Processing_Changes__c SYSTEM Checkbox false
Processing Changes on the Sales Order so payment can be locked down.
OrderApi__Is_Cancelled__c Is Cancelled Checkbox false
Checked when a Sales Order is cancelled.
OrderApi__Is_Closed__c Is Closed Checkbox false
**System Calculated/Override** Checked when the Sales Order is closed. Sales Orders close automatically when paid in full by the customer, when a contract expires, or when a contract/recurring Sales Order is cancelled.
OrderApi__Is_Evergreen__c Is Evergreen Checkbox false
**System Calculated/Override** Checked when a Sales Order is charged to the customer on a recurring, never-ending basis. These "Standing Sales Orders" are never closed until cancelled.
OrderApi__Is_Invoiced__c Is Invoiced Checkbox false
**System Calculated/Conditional/Override** Checked when the Sales Order has generated Invoices as a means to collect payment. Default unchecked. Automatically checked if "Posting Entity" is set to "Invoice".
OrderApi__Is_Pending_Payment__c Is Pending Payment Checkbox false
When checked, the related Sales Order is pending payment due to offsite payment or shippable items.
OrderApi__Is_Posted__c Is Posted Checkbox false
When checked all Invoices related to the Sales Order will post an receivable transaction to the GL.
OrderApi__Is_Recurring__c Is Recurring Checkbox false
Checked when the Sales Order is recurring and the customer is charged repeatedly based on the Billing Frequency and Billing Frequency UOM calculation.
OrderApi__Is_Scheduled__c Is Scheduled Checkbox false
**System Calculated/Override** Checked when the Sales Order has generated/scheduled Invoices or E-Payments. Default unchecked.
OrderApi__Is_Suspended__c Is Suspended Checkbox false
Checked when a recurring Sales Order is suspended. When a Sales Order is suspended the customer will not be charged until the box is unchecked.
OrderApi__Item_Count__c Item Count Summary false
**System Calculated** Count of the number of items related to the sales order.
OrderApi__Memo__c Memo LongTextArea 32768 false
Optional memo that displays on the sales order sent to the customer as well as on customer statements.
OrderApi__Number_of_Installments__c Number of Installments Number false
**Required Conditionally** The number of invoices or scheduled payments to create for the payment schedule. Required for Sales Orders with Scheduled Payments with Schedule Type of "Termed Recurring" or "Installment".
OrderApi__Payment_Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
**System Calculated** The related payment gateway.
OrderApi__Payment_Method__c Payment Method LookupOrderApi__Payment_Method__c false
The stored Payment Method to use as payment for charges made against the Sales Order.
OrderApi__Payment_Terms__c Payment Terms LookupOrderApi__Payment_Terms__c false
The payment terms for the sales order. If not defined on record creation the default terms defined in the admin settings are used.
OrderApi__Posted_Date__c Posted Date Date false
**System Calculated/Override** The date the Sales Order posted Invoices to the GL.
OrderApi__Posting_Entity__c Posting Entity Picklist false
**System Calculated/Override** The entity the Sales Order posted too. Sales Orders either post through an Invoice(s) or through a single Receipt as a Cash Sale.
OrderApi__Posting_Status__c Posting Status Picklist false
**System Calculated/Conditional/Override** The posting status for the Sales Order represents the posting status of related Invoices or the posting status of the Cash Sale Receipt, depending on the Posting Entity.
OrderApi__Require_Payment_Method__c Require Payment Method Checkbox false
When checked,Payment to the sales order requires an active and valid Payment Method on file. Defaults unchecked.
OrderApi__Schedule_Frequency__c Schedule Frequency Picklist false
The frequency to Invoice or auto-charge a customer for the Sales Order. Valid values include "Daily", "Weekly", "Semi-Monthly", "Monthly", "Semi-Annually", or "Annually".
OrderApi__Schedule_Status__c Schedule Status Picklist false
**System Calculated/Conditional/Override** A status/description for Sales Orders that hold a schedule of either Invoices (Installment/Termed Recurring) or E-Payments (Recurring/Standing).
OrderApi__Schedule_Type__c Schedule Type Picklist false
Select "Recurring" to automatically charge a credit card or bank account for the total amount of the Sales Order on a set schedule, select "Installment" to Invoice the customer for a portion of the Sales Order on a set schedule.
OrderApi__Shipping_City__c Shipping City Text 255 false
The value of this field will be updated with the Account's Shipping City or Contact's Mailing City, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Contact__c Shipping Contact Text 255 false
The value of this field will be updated with the Account or Contact, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Country__c Shipping Country Text 255 false
The value of this field will be updated with the Account's Shipping Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Postal_Code__c Shipping Postal Code Text 255 false
The value of this field will be updated with the Account's Shipping Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
OrderApi__Shipping_State__c Shipping State Text 255 false
The value of this field will be updated with the Account's Shipping State or Contact's Mailing State, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Street__c Shipping Street Text 255 false
**System Calculated/Conditional** Shipping Street derives from the Contact Mailing Street or the Account Shipping Street when Calculate Shipping Details is checked.
OrderApi__Start_Date__c Schedule Start Date Date false
The date when the subscription starts. This date indicates when the customer first purchased the subscription and isn't necessarily the same as the current term start date.
OrderApi__Status__c Status Picklist false
The status of the Sales Order.
OrderApi__Subscription_Lines__c Subscription Lines Summary false
** System Calculated ** Counts the number of Sales Order Lines where a Subscription Item is present.
OrderApi__Subtotal__c Subtotal Summary false
**System Calculated** Rollup summary of Sales Order Lines "Subtotal" field.
OrderApi__Suspended_Date__c Suspended Date Date false
**System Calculated/Override** The date the recurring order or contract was suspended.
OrderApi__Suspended_Reason__c Suspended Reason Picklist false
**System Calculated/Conditionally Required** If a Standing/Recurring Sales Order is Suspended, Suspended Reason may be required depending on how your environment was configured.
OrderApi__System_Refresh__c Refresh Checkbox false
Check this box to refresh the Sales Order and related Sales Order lines, Invoices, Invoice Lines, and Scheduled Payments as appropriate.
OrderApi__Total__c Total Currency false
**System Calculated**. Subtotal +
OrderApi__Valid_Payment_Method__c Valid Payment Method Checkbox false
**System Calculated/Override** Checked when a charge is attempted and accepted by your payment gateway service.
OrderApi__Preferred_Email__c SYSTEM Email false
System field used for proforma invoice emails. Auto populated from related contact record's preferred email
OrderApi__Mass_Proforma_Email_Subject__c SYSTEM Text 240 false
Subject field used for mass proforma emails. Populated from related Subscription Plan or Business Group.
OrderApi__JSON_Data__c SYSTEM LongTextArea 32768 false
Stores availabe badge types for related Sales Order Lines as JSON format.

OrderApi__Scheduled_Payment_Line__c

Scheduled Payment Line
Scheduled Payment Lines track the Items associated with Scheduled Payment.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Activation_Date__c Activation Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be activated is calculated based on conditions set on the related Subscription Plan and can be manually over-ridden if "Auto Calculate Activation Date" is unchecked.
OrderApi__Auto_Calculate_Activation_Date__c Auto Calculate Activation Date Checkbox false
** System Calculated Override ** Valid if the SPL is related to a "Subscription" Item. When checked, the system will automatically calculate the "Activation Date" based on conditions set on the selected "Subscription Plan". Defaults checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Link to the related Business Group.
OrderApi__End_Date__c End Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be ended is calculated based on conditions set on the related Subscription Plan and Activation Date.
OrderApi__GL_Account__c GL Account LookupOrderApi__GL_Account__c false
**System Calculated/Required/Override** Link to the related GL Account.
OrderApi__Invoice_Line__c Invoice Line LookupOrderApi__Invoice_Line__c false
Link to the related Invoice Line.
OrderApi__Is_Renewal__c Is Renewal Checkbox false
Defines the related line that is being used for renewal.
OrderApi__Is_Shipping_Rate__c Is Shipping Rate Checkbox false
Defines the Scheduled Payment Line that is being used for shipping.
OrderApi__Is_Tax__c Is Tax Checkbox false
Defines the Scheduled Payment Line that is being used for tax rate.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
Link to related Item Class
OrderApi__Item__c Item LookupOrderApi__Item__c false
Link to related Item.
OrderApi__List_Price__c List Price Currency false
**System Calculated** The value of the "Price" field for the related Item.
OrderApi__Price_Override__c Price Override Checkbox false
When checked, the system will derive the Sale Price from the most appropriate Price Rule. Default checked.
OrderApi__Price_Rule__c Price Rule LookupOrderApi__Price_Rule__c false
**System Calculated/Override** Link to related Price Rule applied for the related Item.
OrderApi__Quantity__c Quantity Number false
**Required** Quantity of Items. Default 1.
OrderApi__Sale_Price__c Sale Price Currency false
**System Calculated/Override** The Sale Price (per unit) for the related Item. Default 0.00.
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
Link to the related Sales Order Line.
OrderApi__Scheduled_Payment_Line__c Scheduled Payment Line LookupOrderApi__Scheduled_Payment_Line__c false
Link to parent Scheduled Payment Line.
OrderApi__Scheduled_Payment__c Scheduled Payment MasterDetail false
Link to the related Scheduled Payment.
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
** Conditionally Required ** Link to the related plan that controls Activation and Expiration dates related to any Subscription Item. Required when the Scheduled Payment Line is linked to a Item that is the child of a "Subscription" Item Class.
OrderApi__Subscription__c Subscription LookupOrderApi__Subscription__c false
Link to the Subscription that is being upgraded or renewed.
OrderApi__Subtotal__c Subtotal Currency false
**System Calculated** Quantity * Sale Price
OrderApi__Tax_Override__c Tax Override Checkbox false
This field is used to override any tax calculations by the system.
OrderApi__Tax_Percent__c Tax Percent Percent false
Combined with the Parent Scheduled Payment Line's Sales Price, this field is used to calculate the tax amount for the related item.
OrderApi__Total__c Total Currency false
**Required** The amount (currency) for payment for the Scheduled Payment Line. Default value is 0.00.

OrderApi__Scheduled_Payment__c

Scheduled Payment
Scheduled Payments track the status and details around recurring and scheduled invoice E-Payments related to a Sales Order.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__API_Response__c API Response LongTextArea 131072 false
**System Calculated** API Response from the callout made for processing the payment
OrderApi__Amount__c Amount Currency false
**System Calculated** The amount charged successfully against the Scheduled Payment.
OrderApi__Custom_Scheduled_Payment__c Custom Scheduled Payment Checkbox false
When checked these scheduled payments wont run as part of the OrderApi ScheduledPaymentBatchable.cls ** Defaults unchecked **
OrderApi__EPayment_Created__c E-Payment Created Checkbox false
Checked if the system has generated an E-Payment regardless of the result.
OrderApi__Has_Errors__c Has Errors Checkbox false
**System Calculated** Checked if the Scheduled Payment was processed with errors.
OrderApi__Invoice__c Invoice LookupOrderApi__Invoice__c false
Link to the Invoice scheduled for payment.
OrderApi__Is_Cancelled__c Is Cancelled Checkbox false
**System Calculated/Override** Checked when the Scheduled Payment has been cancelled.
OrderApi__Is_Processed__c Is Processed Checkbox false
**System Field** Do not manually update/override. Checked when the system has processed the API transaction for the scheduled payment.
OrderApi__Payment_Description__c Payment Description Text false
** System Calculated ** Description formula for scheduled payments.
OrderApi__Payment_Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
** Required ** Link to the Payment Gateway to use for the Scheduled Payment.
OrderApi__Payment_Method__c Payment Method MasterDetail false
**Required** Master-detail Payment Method. Link to the E-Payment Method that will be used/has been used for the Schedule Payment.
OrderApi__Is_Payment_Processed__c Is Payment Processed Checkbox false
**System Calculated** checked if a callout is made and the payment is processed
OrderApi__Processed_Date__c Processed Date Date false
**System Field** Do not manually update/override. The date the Scheduled Payment was processed.
OrderApi__Sales_Order__c Sales Order LookupOrderApi__Sales_Order__c false
**Required** Link to related Sales Order.
OrderApi__Scheduled_Date__c Scheduled Date Date false
**System Calculated/Override** The date scheduled for the charge against the linked Payment Method.
OrderApi__Subscription__c Subscription LookupOrderApi__Subscription__c false
** System Calculated Override ** Link to the related Subscription
OrderApi__Succeeded__c Succeeded Checkbox false
**System Field** Do not manually update/override. Checked when the schedule payment has been successfully charged.
OrderApi__System_Message__c System Message LongTextArea 32768 false
**System Calculated** API/Gateway Message for decline/success descriptions.
OrderApi__Token__c Token Text false
**System Calculated** Token used for API transactions.

OrderApi__Shipping_Method__c

Delivery Method
The delivery method that the carrier provides to ship item.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Description__c Description LongTextArea 32768 false
Description for Delivery Method.
OrderApi__Display_Name__c Display Name Text 255 false
Display Name For Delivery Method.
OrderApi__Is_Default__c SYSTEM Checkbox false
The default delivery method for shipping an item.
OrderApi__Shipping_Carrier_Item_Class__c Shipping Carrier LookupOrderApi__Item_Class__c false
Identifies the related Shipping Carrier.

OrderApi__Shipping_Region__c

Shipping Region
Shipping Regions are used to define Shipping Rates, or areas that the organization Will Not Ship to.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Address_Field_Values_CSV__c Address Field Values (CSV) LongTextArea 32768 false
Comma separated address field values.
OrderApi__Description__c Description LongTextArea 32768 false
Description for related Shipping Region.
OrderApi__Display_Name__c Display Name Text 255 false
Display name for the specific Shipping Region.
OrderApi__Will_Not_Ship_Message__c Will Not Ship Message LongTextArea 32768 false
This message is displayed in the checkout UI when the buyer enters a shipping destination that is in a Will Not Ship region.
OrderApi__Will_Not_Ship__c Will Not Ship Checkbox false
Checkbox that makes this a Will Not Ship region.
OrderApi__Is_Default_Region__c Is Default Region Checkbox false
The default region will match any shipping destination that is not explicitly defined in another region. Leave the Address Field Values (CSV) field blank when enabling this feature.

OrderApi__Source_Code__c

Source Code
Source Codes link Receipts to marketing activities.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Active__c Active Checkbox false
Only active Source Codes can be linked to new Cash Entries/Invoices.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Required/Override** Link to the related Business Group.
OrderApi__Channel__c Channel Picklist false
**Required** Choose the most appropriate channel for the Source Code.

OrderApi__Spreedly_Core__c

Spreedly Core

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Debug__c Debug Checkbox false
OrderApi__Key__c Key Text 255 false
OrderApi__Secret__c Secret Text 255 false
OrderApi__Signed_Secret__c Signed Secret Text 100 false
The signed secret to preform signature validations

OrderApi__Store__c

Store
Primary control object for publishing online stores

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account_Match_Criteria__c Account Match Criteria Picklist false
Defines the matching rule for an account. If "All Accounts" is selected, the user can search by "Account Search Result Fields CSV". If "Domain Matching" is selected, the system will automatically find an account for the contact using the given email.
OrderApi__Additional_Payment_Types__c Additional Payment Types LongTextArea 131072 false
Json structured list of additional payment types displayed on the checkout page. [ { "label" : "<Name of the tab>", "link" : "<link where the page has to be navigated>", "button_label" : "<label of the button>" } ]
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
** System Calculated Required Override ** Link to the related Business Group.
OrderApi__Account_Search_Result_Fields_CSV__c Account Search Result Fields CSV LongTextArea 32768 false
Result fields will be displayed when searching for an account.
OrderApi__New_Contact_Parent_Account_Rule__c New Contact Parent Account Rule Picklist false
** Conditionally Required ** The account to use as the parent of new contacts created when checking out as a guest in this store. Required when the store is configured to enable guest checkout.
OrderApi__Contact_Match_Custom_Field__c Contact Match Custom Field Text 255 false
Specify any field on the Contact object (custom fields accepted) that you wish to use to match unauthenticated users to existing Contact records.
OrderApi__Contact_Match_Rule__c Contact Match Rule Picklist false
Select the contact match rule to use when matching unauthenticated users to existing Contact records.
OrderApi__New_Contact_Account_Owner__c New Contact/Account Owner LookupOrderApi__User false
** Conditionally Required ** The user to be assigned as the owner of any new account or contact created when checking out as a guest in this store. Required when the store is configured to enable guest checkout.
OrderApi__Default_Checkout__c Default Checkout Picklist false
Specifies whether customers will see guest checkout ("Guest Checkout") or login to account ("Account Login") as their first option during checkout.
OrderApi__Description__c Description LongTextArea 32768 false
Optional Store description
OrderApi__Enable_Access_Permissions__c RESERVED Checkbox false
When checked access to the Store is controlled by the related user-defined Access Permissions. Defaults unchecked - essentially enabling all public and authenticated Users access to the Store and related content.
OrderApi__Enable_Account_Search__c Enable Account Search Checkbox false
When this field is checked, users can either search for an account or have their domain matched to an account. This is available for new user/contact functionality on authentication pages only.
OrderApi__Enable_Guest_Checkout__c Enable Guest Checkout Checkbox false
Enables the Guest Checkout
OrderApi__Enable_Guest_Save_Payment__c Enable Guest Save Payment Checkbox false
Enable the ability to save payment on a guest checkout
OrderApi__Enable_Invoice_Payment_Option__c Enable Invoice Payment Option Checkbox false
When checked, users will be allowed to select Invoice Me as a method of payment for an order.
OrderApi__Enable_Proforma_Invoice_Payment_Option__c Enable Proforma Invoice Payment Option Checkbox false
When checked, enables a portal user to send a proforma invoice email.
OrderApi__Guest_Checkout_Account__c Guest Checkout Account LookupOrderApi__Account false
Lookup to the Account Record for Guest Checkout Contacts to be linked to
OrderApi__New_Contact_Fieldset_CSV__c New Contact Fieldset(s) CSV Text 255 false
The API Name of the Contact Object Fieldsets to display to users checking out as a guest/unauthenticated user. Note! First Name, Last Name, and Email are displayed by default.
OrderApi__New_User_Profile_ID__c New User Profile ID Text 18 false
OrderApi__Payment_Confirmation_Message_HTML__c Payment Confirmation Message HTML Html 100000 false
Enter a message to display to users after successfully processing payment on the checkout page. Custom HTML or plain text are acceptible forms of input.
OrderApi__Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
Link to default Payment Gateway for related Store.
OrderApi__Require_Contact_Match_Custom_Field__c Require Contact Match Custom Field Checkbox false
Whenc checked, the field defined in the Contact Match Custom Field will be required when checking out as a guest/unauthenticated user.
OrderApi__Theme__c SYSTEM LookupPagesApi__Theme__c false

OrderApi__Subscription_Line__c

Subscription Line
Subscription Lines allow more than one Item to be assigned to a Subscription.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Activated_Date__c Activated Date Date false
** System Calculated Required Override ** The date the Subscription Line was activated.
OrderApi__Active_Assignments__c Active Assignments Number false
** System Calculated ** Number of Active Assignments. Valid and restricted to Items where "Enable Assignments" is checked. Defaults 0 if no Assignments found.
OrderApi__Assignments_Allowed__c Assignments Allowed Number false
** System Calculated ** If the Item "Enable Assignments" and "Restrict Number of Assignments" fields are checked, the Item "Maximum Number of Assignments" x the Line "Quantity" is set. Otherwise no value is set.
OrderApi__Assignments_Available__c Assignments Available Number false
** System Calculated ** If the Item "Restricts Number of Assignments" then Assignments Allowed - Active Assignments is set. Otherwise the value is null.
OrderApi__Invoice_Line__c Invoice Line LookupOrderApi__Invoice_Line__c false
Link to related Invoice Line record.
OrderApi__Invoiced_Date__c Invoiced Date Date false
** System Calculated ** Automatically populated when Invoice generated for related Subscription Line Item.
OrderApi__Is_Amendment__c Is Amendment Checkbox false
When checked, the related Subscription Line is considered as a "Subscription Amendment".
OrderApi__Is_Invoiced__c Is Invoiced Checkbox false
** System Calculated ** Automatically checked when Invoice generated for related Subscription Line Item.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated / Override ** Link to the related Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
** Required ** Link to the related "Subscription" Item.
OrderApi__Line_Description__c Line Description Text 255 false
Optional line description will be added to if blank, the value of this field will match the value of the related item's "Line Description" field.
OrderApi__List_Price__c List Price Currency false
** System Calculated ** The value of the related Item's "Price" (Default)
OrderApi__Price_Override__c Price Override Checkbox false
When checked the "Price Rule" will no longer drive the "Sale Price" and the system will allow manually entry into the "Sale Price" field.
OrderApi__Price_Rule__c Price Rule LookupOrderApi__Price_Rule__c false
** Conditionally Required System Calculated Override ** Link to the Price Rule that sets the "Sale Price" for the Subscription Line - automatically calculated from the linked Item's "Price Rules" if "Price Override" is unchecked.
OrderApi__Quantity__c Quantity Number false
** Required ** The number of Items for the Subscription Line. Defaults to 1.
OrderApi__Receipt_Line__c Receipt Line LookupOrderApi__Receipt_Line__c false
Link to related Receipt Line record.
OrderApi__Sale_Price__c Sale Price Currency false
** System Calculated Required Override ** The price per unit for the Subscription Line "Item".
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
Link to related Sales Order Line.
OrderApi__Subscription_Line__c Parent Subscription Line LookupOrderApi__Subscription_Line__c false
Link to parent Subscription Line.
OrderApi__Subscription__c Subscription MasterDetail false
** Required ** Link to the related Subscription.
OrderApi__Subtotal__c Subtotal Currency false
** System Calculated ** Quantity * Sale Price
OrderApi__Total__c Total Currency false
** System Calculated Required Override ** Defaults to the "Subtotal".

OrderApi__Subscription_Plan__c

Subscription Plan
Subscription Plans control the subscription dates with "Termed", "Evergreen", and "Calendar" options.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Auto_Renew_Option__c Auto Renew Option Picklist false
** Required ** Select "Disabled" to turn off auto-renew for all related Subscriptions, select "Enabled" to allow related Subscriptions to optionally enable auto-renew, select "Required" to enable auto-renew without option.
OrderApi__Auto_Send_Proforma_Invoice_Emails__c Auto Send Proforma Invoice Emails Checkbox false
When checked an email will be sent using the configurations defined on the Subscription Plan record related to Proforma Invoice Emails
OrderApi__Bill_Cycle_Day__c Bill Cycle Day Number false
** Conditionally Required ** If "Bill Cycle" selected as "CUSTOM" need to define specific day for Bill Cycle.
OrderApi__Bill_Cycle__c Bill Cycle Picklist false
** Required ** Bill Cycles drive the day of month a subscriber is invoiced/auto-charged for a subscription. Select "AUTO" to derive the day of month based upon the Activation/Last Renewal Date. Select "CUSTOM" to specify a specific "Bill Cycle Day".
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
** System Calculated Override ** Link to related Business Group. Derived from the user's "Business Group" (App Config) custom setting if not defined on record creation.
OrderApi__Calendar_End_Day__c Calendar End Day Picklist false
Select the end day for the calendar term. If it is not specified, last day of the month will be used.
OrderApi__Calendar_End_Month__c Calendar End Month Picklist false
** Conditionally Required ** Select the end month for the calendar term. Required for all "Calendar" Subscription Plans.
OrderApi__Description__c Description LongTextArea 32768 false
Optional description for the Subscription Plan.
OrderApi__Disable_Renew__c Disable Renew Checkbox false
When checked, cannot renew subscription due to custom business process. Defaults unchecked.
OrderApi__Enable_Schedule__c Enable Schedule Checkbox false
When checked, subscribers will pay for subscriptions in installments - the frequency/amount is driven by the schedule options configuration fields. Defaults unchecked.
OrderApi__Grace_Period__c Grace Period Number false
Defines the number of days after the subscription by which a member can renew a subscription without losing benefits.
OrderApi__Enable_Proration__c Enable Proration Checkbox false
When checked, the system will prorate new subscribers depending upon the "Proration Rule". Defaults unchecked. Valid only for "Calendar" Subscription Plan Types.
OrderApi__Initial_Term_Months__c Initial Term (Months) Number false
** Conditionally Required ** The initial term, in number of months, for new subscribers of the plan. Required for termed subscription plans. Required for all non-calendar Subscription Plan types.
OrderApi__Invoice_Days_Variable__c Invoice Days Variable Number false
The Invoice Days Variable is used to automatically invoice subscribers "X" number of days prior to subscription expiration.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, the Subscription Plan will be made available for selection - as configured for Subscription Plan Items.
OrderApi__Number_Of_Installments__c Number Of Installments Number false
** Required Conditionally ** The number of invoices to create for the payment schedule.
OrderApi__Payment_Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
** System Calculated / Override / Conditionally Required ** Link to related Payment Gateway. Required when "Auto Renew Option" defined as "Enabled" or "Required".
OrderApi__Payment_Terms__c Payment Terms LookupOrderApi__Payment_Terms__c false
Link to Payment Terms to use for "Invoice" installment schedules.
OrderApi__Proforma_Invoice_Authentication_Required__c Proforma Invoice Authentication Required Checkbox false
When checked, the customer paying a proforma invoice will be forced to authenticate prior to accepting payment.
OrderApi__Proforma_Invoice_Email_Body__c Proforma Invoice Email Body Html 32768 false
The default message used as part of the "Send Proforma Email" Workflow
OrderApi__Proforma_Invoice_Email_From_Address__c Proforma Invoice Email From Address Text 255 false
The email address of the sender of the proforma invoice email sent to your customers. Your user's email will be used if this field is left blank.
OrderApi__Proforma_Invoice_Email_From_Name__c Proforma Invoice Email From Name Text 255 false
The name of the sender of the proforma invoice email as it will display to your customers. Your user's first name and last name will be used if this field is left blank.
OrderApi__Proforma_Invoice_Email_Subject__c Proforma Invoice Email Subject Text 240 false
The default subject of the proforma invoice email sent to your customers. Your user's email will be used if this field is left blank.
OrderApi__Proforma_Invoice_Footer__c Proforma Invoice Footer Html 32768 false
The contents of this field will display inside the header of all proforma invoice documents generated from Sales Orders linked to this Business Group
OrderApi__Proforma_Invoice_Header__c Proforma Invoice Header Html 32768 false
The contents of this field will display inside the header of all proforma invoice documents generated from Sales Orders linked to this Business Group
OrderApi__Enable_Automatic_Invoice_Payment__c Enable Automatic Invoice Payment Checkbox false
When checked, system will create scheduled payments against invoices. "Require Payment Method" field will automatically be checked.
OrderApi__Proration_Rule__c Proration Rule Picklist false
** Conditionally Required ** Select the "Proration Rule" to use for prorating the total charges for new subscribers of a "Calendar" Subscription Plan. Required when "Enable Proration" is checked.
OrderApi__Renewal_Term_Months__c Renewal Term (Months) Number false
** System Calculated Override ** The "Renewal Term (Months)" defaults to the "Initial Term (Months)" if no other value is specified.
OrderApi__Require_Payment_Method__c Require Payment Method Checkbox false
When checked, subscribers will be required to maintain an active and valid Payment Method on file. Defaults unchecked.
OrderApi__Schedule_Frequency__c Schedule Frequency Picklist false
** Conditionally Required ** Select the frequency to invoice/charge a subscriber. Required when "Enable Payment Schedule" is checked.
OrderApi__Schedule_Type__c Schedule Type Picklist false
** Conditionally Required ** Select "Invoice" to invoice the subscriber for each installment. Select "Automatic Payment" to automatically charge the subscriber using a stored Payment Method. Select "User Option" to allow the customer to choose.
OrderApi__Type__c Type Picklist false
** Required ** Select the most appropriate option for the Subscription Plan Type.
OrderApi__Advanced_Calendar_Days__c Advanced Calendar Days Number false
Number of days before the start of the next calendar term, during which new subscriptions are automatically extended to include the next term.
OrderApi__Advanced_Calendar_Free_Paid__c Advanced Calendar Free/Paid Picklist false
Determines whether Advanced Calendar Days are free or paid. Paid days are automatically prorated based on the subscription price.

OrderApi__Subscription__c

Subscription
Subscriptions track the activation, expiration, and renewal dates for all Customer Subscriptions.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
** System Calculated Conditionally Required ** Link to the subscribing Account. Required if the Subscription "Subscribing Entity" is "Account". Defaults to the same Account assigned to the Sales Order Line that created the Subscription.
OrderApi__Activated_Date__c Activated Date Date false
** System Calculated Required Override ** The date the Subscription was activated.
OrderApi__Active_Assignments__c Active Assignments Number false
** System Calculated ** The count of related Assignments where "Is Active" is checked.
OrderApi__Assignments_Allowed__c Assignments Allowed Number false
** System Calculated ** Max number of assignments allowed according to related. Rolling up from related Subscription Line's "Assignments Allowed" filed.
OrderApi__Billing_City__c Billing City Text 255 false
The value of this field will be updated with the Account's Billing City or Contact's Mailing City, based on "Entity" if not defined on record entry.
OrderApi__Billing_Contact__c Billing Contact Text 255 false
The value of this field will be updated with the Account or Contact, based on "Entity" if not defined on record entry.
OrderApi__Billing_Country__c Billing Country Text 255 false
The value of this field will be updated with the Account's Billing Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
OrderApi__Billing_Postal_Code__c Billing Postal Code Text 255 false
The value of this field will be updated with the Account's Billing Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
OrderApi__Billing_State__c Billing State Text 255 false
The value of this field will be updated with the Account's Billing State or Contact's Mailing State, based on "Entity" if not defined on record entry.
OrderApi__Billing_Street__c Billing Street Text 255 false
**System Calculated/Conditional** Billing Street derives from the Contact Mailing Street or the Account Billing Street when Calculate Billing Details is checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
** System Calculated ** Link to related Business Group.
OrderApi__Calculate_Billing_Details__c Calculate Billing Details Checkbox false
When checked the system will calculate billing details automatically. If entity is "Contact" the mailing address of the contact is used, otherwise the account's billing address is used. The contact on the order will populate the billing contact field.
OrderApi__Calculate_Shipping_Details__c Calculate Shipping Details Checkbox false
If checked the system will calculate shipping details automatically. If entity is "Contact" the mailing address of the contact is used, otherwise the account's shipping address is used. The contact on the subscription will populate the shipping contact field.
OrderApi__Cancelled_Date__c Cancelled Date Date false
** System Calculated Override ** Defaults to the value of today's date when the Subscription "Is Cancelled" is checked.
OrderApi__Cancelled_Reason__c Cancelled Reason Picklist false
** Conditionally Required ** Select the most appropriate reason for cancelling the Subscription. Required when a Subscription "Status" equals "Cancelled".
OrderApi__Contact__c Contact LookupOrderApi__Contact false
** System Calculated Conditionally Required ** Link to the subscribing Contact. Required if the Subscription "Subscribing Entity" is "Contact". Defaults to the same Contact assigned to the Sales Order Line that created the Subscription.
OrderApi__Current_Term_End_Date__c Current Term End Date Date false
** System Calculated Required Override ** The end date (Expiration Date) for the current subscription term.
OrderApi__Current_Term_Start_Date__c Current Term Start Date Date false
** System Calculated Required Override ** The start date for the current subscription term.
OrderApi__Customer_Link__c Customer Text false
** System Calculated ** Link to the subscribing entity record -- either the related Account or Contact.
OrderApi__Assignment_Badge_Types_CSV__c SYSTEM Text false
SYSTEM
OrderApi__Days_To_Lapse__c Days to Lapse Number false
** System Calculated ** The number of days until the Subscription will expire.
OrderApi__Description__c Description LongTextArea 32768 false
Optional Subscription description
OrderApi__Enable_Auto_Renew__c Enable Auto Renew Checkbox false
When checked, the subscription will automatically attempt to renew itself by charging the related Payment Method. Defaults unchecked.
OrderApi__Entity__c Entity Picklist false
** System Calculated Required Override ** Select "Account" if the primary subscriber is the linked Account, otherwise select "Contact". Defaults to the value of the same field on the Sales Order Line that created the Subscription.
OrderApi__Expired_Date__c Expired Date Date false
** System Calculated Required Override ** The date the Subscription expires. Automatically calculated from rules defined on the related Subscription Plan.
OrderApi__Grace_Period_End_Date__c Grace Period End Date Date false
This date is calculated by the Paid Through Date plus the number of days defined on the Subscription Plan's Grace Period field.
OrderApi__In_Grace_Period__c In Grace Period Checkbox false
OrderApi__Is_Active__c Is Active Checkbox false
When checked the Subscription is considered "Active". Defaults checked.
OrderApi__Is_Cancelled__c Is Cancelled Checkbox false
When checked, the system will inactivate all related Subscribers and unassign any related benefits.
OrderApi__Is_Expired__c Is Expired Checkbox false
Checked when the Subscription has expired.
OrderApi__Is_Pending__c Is Pending Checkbox false
When checked the Subscription is considered "Pending". Defaults unchecked.
OrderApi__Is_Suspended__c Is Suspended Checkbox false
Checked if the Subscription is suspended. Subscriptions can be suspended to prevent automatic payment via Payment Method on file or to revoke benefits (Badges, etc...) granted by the Subscription Item.
OrderApi__Is_Upgraded__c RESERVED Checkbox false
RESERVED
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated ** Link to related Item Class.
OrderApi__Next_Scheduled_Renewal_Date__c Next Scheduled Renewal Date Date false
** System Calculated Override ** The date the next renewal is scheduled to be processed for the Subscription, defaults to the Current Term End Date. Valid only for Subscriptions where Auto Renew is enabled and a valid payment method is linked.
OrderApi__Item__c Item (Primary) LookupOrderApi__Item__c false
** System Calculated Required Override ** Link to the primary "Subscription" Item
OrderApi__Last_Amendment_Date__c Last Amendment Date Date false
** System Calculated Override ** The date the Subscription was amended.
OrderApi__Last_Renewed_Date__c Last Renewed Date Date false
** System Calculated Override ** The date the Subscription was last renewed.
OrderApi__Last_System_Run__c Last System Run Date false
** SYSTEM FIELD DO NOT UPDATE **
OrderApi__Line_Count__c Line Count Summary false
** System Calculated ** Count of related Subscription Lines.
OrderApi__Paid_Through_Date__c Paid Through Date Date false
Defines the last active date of the subscription including all subscription renewals.
OrderApi__Payment_Method__c Payment Method LookupOrderApi__Payment_Method__c false
** Conditionally Required ** Link to the related Payment Method on file for the subscribing customer - used for automatic payment charges. Required if the parent Subscription Plan "Require Payment Method" field is checked.
OrderApi__Renewals__c Terms Summary false
** System Calculated ** Rollup Summary field, counts number of Renewals.
OrderApi__Sales_Order_Line__c Sales Order Line (Source) LookupOrderApi__Sales_Order_Line__c false
** System Calculated ** The source Sales Order Line that created the Subscription.
OrderApi__Shipping_City__c Shipping City Text 255 false
The value of this field will be updated with the Account's Shipping City or Contact's Mailing City, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Contact__c Shipping Contact Text 255 false
The value of this field will be updated with the Account or Contact, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Country__c Shipping Country Text 255 false
The value of this field will be updated with the Account's Shipping Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Postal_Code__c Shipping Postal Code Text 255 false
The value of this field will be updated with the Account's Shipping Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
OrderApi__Shipping_State__c Shipping State Text 255 false
The value of this field will be updated with the Account's Shipping State or Contact's Mailing State, based on "Entity" if not defined on record entry.
OrderApi__Shipping_Street__c Shipping Street Text 255 false
**System Calculated/Conditional** Shipping Street derives from the Contact Mailing Street or the Account Shipping Street when Calculate Shipping Details is checked.
OrderApi__Status__c Status Picklist false
** System Calculated Required ** The status of the Subscription.
OrderApi__Subscription_Dues_Total__c Subscription Dues Total Summary false
** System Calculated ** The sum of the "Total" field for all related Subscription Lines.
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
OrderApi__Suspended_Date__c Suspended Date Date false
The date the Subscription was suspended.
OrderApi__Suspended_Reason__c Suspended Reason Picklist false
** Conditionally Required System Calculated Override ** Select the most appropriate reason for suspending the Subscription. Required when a Subscription status is "Suspended".
OrderApi__System_Refresh__c Refresh Checkbox false
Refresh Subscription fields with updated data as well as update related Invoices and Scheduled Payments (if applicable) related to the Subscription.
OrderApi__Upgraded_Date__c Upgraded Date Date false
** System Calculated Override ** The date the Subscription was upgraded to another "Subscription" Item.
OrderApi__Upgraded_Subscription__c Upgraded Subscription LookupOrderApi__Subscription__c false
** System Calculated Override ** Defines the related upgraded subscription.
OrderApi__Valid_Payment_Method__c Valid Payment Method Checkbox false
Valid if the linked Payment Method is valid -- determined by Payment Method expiration and the result (Success or Decline) of the last E-Payment related to the Payment Method. Defaults unchecked if no Payment Method linked.

OrderApi__Tax_Locale__c

Tax Locale
Along with the Item Class and Item, this object is used to help calculate the tax rate for taxable items. This object defines the Tax GL Account and Tax Locales for Tax Classes.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
Links the Tax Locale to a Business Group.
OrderApi__Tax_GL_Account__c Default Tax Account LookupOrderApi__GL_Account__c false
This field defines the tax liability account to be used as the credit entry of the Order's Transaction. Populated as the income account on the Tax Item by Default.
OrderApi__Tax_Locale_Field__c Tax Locale Field Text 255 false
In this field, enter the API name of the Sales Order Line field the system is to evaluate for the tax locale. (Ex. OrderApi__Shipping_Country__c)
OrderApi__Locale_Values_CSV__c Locale Values (CSV) LongTextArea 32768 false
Enter the possible values for the field defined in the Tax Locale Field using comma separated values.

OrderApi__Transaction_Line__c

Transaction Line
Transaction Lines track the debits and credits associated with Transactions.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Activation_Date__c Activation Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be activated is calculated based on conditions set on the related Subscription Plan and can be manually over-ridden if "Auto Calculate Activation Date" is unchecked.
OrderApi__Auto_Calculate_Activation_Date__c Auto Calculate Activation Date Checkbox false
** System Calculated Override ** Valid if the Transaction Order Line is related to a "Subscription" Item. When checked, the system will automatically calculate the "Activation Date" based on conditions set on the selected "Subscription Plan". Defaults checked.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override** Business group will auto populate, if not defined on entry, to the running user's business group (assigned in custom settings).
OrderApi__Credit__c Credit Currency false
The credit amount for the transaction. Must be zero if the debit is not equal to zero.
OrderApi__Date__c Date Date false
**System Calculated** The value of the Date field on the parent Transaction.
OrderApi__Debit__c Debit Currency false
The debit amount for the transaction. Must be zero if the credit is not equal to zero.
OrderApi__End_Date__c End Date Date false
** System Calculated Override Conditionally Required ** The date the Subscription will be ended is calculated based on conditions set on the related Subscription Plan and Activation Date.
OrderApi__GL_Account__c GL Account LookupOrderApi__GL_Account__c false
**Required** The GL Account associated with the Transaction Line.
OrderApi__Invoice_Line__c Invoice Line LookupOrderApi__Invoice_Line__c false
**System Calculated/Override** The source Invoice Line record that generates the transaction line. The transaction line record inherits the Revenue GL Account related to the Item on the source Invoice Line record
OrderApi__Invoice__c Invoice LookupOrderApi__Invoice__c false
**System Calculated/Override** The source Invoice record that generates the transaction line. The transaction line record inherits the Accounts Receivable GL Account specified on the source Invoice record
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated / Override ** Link to the related Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
**System Calculated/Override** Link to the related Item record. Derived from the related Invoice Line (only populates on receivable transactions).
OrderApi__Memo__c Memo Text 255 false
**System Calculated/Override** The memo will auto-populate with information from the transaction line source from the source record memo or description.
OrderApi__Receipt_Line__c Receipt Line LookupOrderApi__Receipt_Line__c false
**System Calculated/Override** The source Receipt Detail record that generates the transaction line.
OrderApi__Receipt__c Receipt LookupOrderApi__Receipt__c false
**System Calculated/Override** The source Receipt record that generates the transaction line. The transaction line record inherits the GL account of the source Receipt record.
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
**System Calculated** Link to related Sales Order Line (where applicable).
OrderApi__Subscription_Line__c Subscription Line LookupOrderApi__Subscription_Line__c false
** System Calculated Override ** Link to the related Subscription Line.
OrderApi__Subscription_Plan__c Subscription Plan LookupOrderApi__Subscription_Plan__c false
** Conditionally Required ** Link to the related plan that controls Activation and Expiration dates related to any Subscription Item. Required when the Transaction Line is linked to a Item that is the child of a "Subscription" Item Class.
OrderApi__Subscription__c Subscription LookupOrderApi__Subscription__c false
** System Calculated Override ** Link to the related Subscription.
OrderApi__Transaction__c Transaction MasterDetail false
**Required** All Transaction Lines must be associated with a parent Transaction.
OrderApi__Type__c Type Text false
**System Calculated** The value of the Type field on the parent Transaction.

OrderApi__Transaction__c

Transaction
Transactions store all debits and credits for double-entry accounting.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
**System Calculated/Override** Inherited from the Account on the linked source record.
OrderApi__Batch__c Batch LookupOrderApi__Batch__c false
**System Calculated/Override** Link to the related Batch for the Transaction.
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated** Link to related Business Group.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
**System Calculated/Override** Inherited from the Contact on the linked source record.
OrderApi__Credit_Memo__c Credit Memo LookupOrderApi__Credit_Memo__c false
**System Calculated/Override** Link to the Credit Memo record, when an overpayment is made.
OrderApi__Credit_Memo_Line__c Credit Memo Line LookupOrderApi__Credit_Memo_Line__c false
**System Calculated/Override** Link to the Credit Memo Line record, when an overpayment is used.
OrderApi__Customer_Link__c Customer Text false
**System Calculated** Hyperlink to the customer detail record, either the Account or Contact as determined by the entity field.
OrderApi__Date__c Date Date false
The date the Transaction was posted.
OrderApi__Entity__c Entity Picklist false
**Required/Do not modify picklist values** Select either "Account" or "Contact" as the appropriate entity related to the Transaction.
OrderApi__Invoice__c Invoice LookupOrderApi__Invoice__c false
**System Calculated/Override** Link to the source Invoice for the Transaction.
OrderApi__Is_Valid__c Is Valid Checkbox false
**System Calculated** Validates that Total Debits = Total Credits for all Transaction Lines.
OrderApi__Memo__c Memo TextArea false
Transaction description or memo.
OrderApi__Num_Lines__c Num Lines Summary false
**System Calculated** COUNT of related Transaction Lines.
OrderApi__Receipt_Type__c Receipt Type Picklist false
**System Calculated** The value of the "Type" field for the linked receipt (where applicable).
OrderApi__Receipt__c Receipt LookupOrderApi__Receipt__c false
**System Calculated/Override** Link to the source Receipt for the Transaction.
OrderApi__Sales_Order__c Sales Order LookupOrderApi__Sales_Order__c false
Link to related Sales Order.
OrderApi__Source_Code__c Source Code LookupOrderApi__Source_Code__c false
Link to related Source Code.
OrderApi__Subscription__c Subscription LookupOrderApi__Subscription__c false
** System Calculated Override ** Link to the related Subscription.
OrderApi__Total_Credits__c Total Credits Summary false
**System Calculated** SUM of related "Credit" Transaction Lines.
OrderApi__Total_Debits__c Total Debits Summary false
**System Calculated** SUM of related "Debit" Transaction Lines.
OrderApi__Type__c Type Picklist false
**System Calculated/Override** A "Receivable" Transaction occurs when an Invoice is posted, a "Cash" Transaction occurs when payment is received for an Invoice or Sales Order. Paid Invoices will have at least one "Receivable" and one "Cash" Transaction.

OrderApi__User

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Shopping_Cart_ID__c FONTEVA SYSTEM FIELD Text 18 false

EventApi__Attendee__c

Attendee
Attendees track individuals registered for conference style or other "registration" style Events.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Account__c Account LookupEventApi__Account false
** System Calculated Override ** Link to the Account that the Attendee Contact is associated with.
EventApi__Assignment__c Assignment LookupOrderApi__Assignment__c false
Link to the related assignment that the attendee was created from
EventApi__Contact__c Contact LookupEventApi__Contact false
** Conditionally Required ** Link to the related Contact. Required only if "Require Contact Link for Attendees" is checked on the parent Event.
EventApi__Contact_Created_by_System__c Contact Created by System Checkbox false
This field will be automatically checked when the contact is created while registering for an event.
EventApi__Event__c Event MasterDetail false
** Required ** Master-detail link to event.
EventApi__First_Name__c First Name Text 255 false
Defines the first name of the attendee
EventApi__Last_Name__c Last Name Text 255 false
Defines the last name of the attendee
EventApi__Full_Name__c Full Name Text 255 false
** System Calculated Override ** The full name of the attendee as it should display on Event badges. Derives automatically from the First and Last Name fields on the linked Contact record.
EventApi__Email__c Email Text 100 false
Enter the email to use for communications sent to the Attendee related to the Event.
EventApi__Preferred_Email__c Email Email false
Email for the attendee
EventApi__Is_Registered__c Registered Checkbox false
When checked, the Attendee status will be updated to 'Registered'. Default unchecked.
EventApi__Is_Checked_In__c Checked In Checkbox false
When checked, the Attendee is considered to be/was in attendance for the Event. Default unchecked.
EventApi__Refund_Requested__c Refund Requested Checkbox false
When checked, indicates that the related attendee has requested for a ticket refund.
EventApi__Registration_Date__c Registration Date Date false
** System Calculated Override ** The date the Attendee registered for the Event. Defaults to the value of the "Transaction Date" if not defined on entry.
EventApi__Registration_Site_Url__c Register Site Url Url false
URL endpoint to be used for email registrants.
EventApi__Registration_Group__c Registration Group LookupEventApi__Registration_Group__c false
Link to related Registration Group.
EventApi__Registration_Total__c Registration Total Summary false
** System Calculated ** Total registration sales derived from the total of all child registration items.
EventApi__Sales_Order_Line__c Sales Order Line (Source) LookupOrderApi__Sales_Order_Line__c false
** System Calculated Override ** Link to the Sales Order Line item that created the Registration.
EventApi__Sales_Order__c Sales Order (Source) LookupOrderApi__Sales_Order__c false
** System Calculated Override ** Link to the Sales Order that created the registration.
EventApi__Seat__c Seat LookupEventApi__Seat__c false
Linked to the related seat.
EventApi__Send_Notification__c Send Notification Checkbox false
Send email notifications for event registration.
EventApi__Last_Invitation_Email_Sent__c Last Invitation Email Sent DateTime false
The most recent date an event invitation was sent to the related attendee. This date is displayed within the related attendee row in the Event Builder's Invitation Only tab.
EventApi__Send_Invitation_Email__c Send Invitation Email Checkbox false
When checked, triggers an email to be sent the related attendee from an Invitation Only Event Email Workflow.
EventApi__Is_Invitation_Not_Sent__c Is Invitation Not Sent Checkbox false
When checked, the related attendee has not been sent an invitation to the related Invitation Only event.
EventApi__Is_Invitation_Sent__c Is Invitation Sent Checkbox false
When checked, the attendee was sent an invitation to the related Invitation Only event.
EventApi__Is_Invitation_Accepted__c Is Invitation Accepted Checkbox false
When checked, the attendee has registered for the related Invitation Only event.
EventApi__Is_Invitation_Declined__c Is Invitation Declined Checkbox false
When checked, the attendee has declined the invitation to the related Invitation Only event.
EventApi__Max_Guests_Allowed__c Max Guests Allowed Number false
The maximum number of guests the related attendee is allowed to additionally register.
EventApi__Invitation_Status__c Invitation Status Picklist false
The state of the related attendee's invitation.
EventApi__Status__c Status Picklist false
** Required ** The current status of the Attendee Registration. Defaults to "Registered".
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
** Required ** Link to Ticket Type.

EventApi__Event_Builder_Tab__mdt

Event Builder Tab
Tabs for Event Builder.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Display_Order__c Display Order Number false
Defines the order the tile is to be displayed in the builder.
EventApi__Icon__c Icon Url false
The value populated in this field defines the image to be displayed for the tab's icon.
EventApi__Is_Enabled__c Is Enabled Checkbox false
Checking this field enables this tab to be viewed in the event builder.
EventApi__Lightning_Component__c Lightning Component Text 255 true
Defines the lightning component to be used for this event builder tab.
EventApi__Registration_Style__c Registration Style MetadataRelationship false
This defines the type of registration used that will display this tab.

EventApi__Event_Category__c

Event Category
Event Categories store the default presets and calendar display options unique to a group of Events.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
** System Calculated Required Override ** Link to related Business Group. Derived from User Preferences if not defined on record creation.
EventApi__Description__c Description LongTextArea 32768 false
Optional description to display on pages that publish a calendar of Events related to the Event Category.

EventApi__Event_Page_Component__c

Event Page Component
Components that make up the look and feel of each event page.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Component_Name__c Component Name Text 255 true
** REQUIRED ** API name of a Lightning component.
EventApi__Title__c Title Text 255 false
The name of the related lightning component.
EventApi__Config__c System LongTextArea 131072 false
** SYSTEM ** (LABEL = SYSTEM, API NAME = EventApi__Config__c)
EventApi__Event_Page__c Event Page LookupEventApi__Event_Page__c true
** REQUIRED ** Linked to the related event page.
EventApi__Order__c Order Number true
** REQUIRED ** Display order of Lightning components on a page.

EventApi__Event_Page__c

Event Page
Defines an individual page for a specific event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Navigation_Label__c Navigation Label Text 255 true
** REQUIRED ** The label used for each page in the event's navigation.
EventApi__Page_Name__c Page Name Text 255 true
** REQUIRED ** The page's heading will change based on the value of this field.

EventApi__Event_Registration_Style__mdt

Event Registration Style
Stores registration styles for events.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Is_Style_Enabled__c Is Enabled Checkbox false
When checked, this style will be available on the event builder.
EventApi__Target_Page__c Target Page Text 255 true
**REQUIRED** Name of the lightning/visualforce page that will be used to generate the event's URL.

EventApi__Event_Status_Page__c

Event Status Page
Dictates which pages show on the event based on the event's status.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Event_Page__c Event Page LookupEventApi__Event_Page__c true
** REQUIRED ** Linked to the related event page.
EventApi__Event_Status__c Event Status LookupEventApi__Event_Status__c true
** REQUIRED ** Linked to the related event status.
EventApi__Order__c Order Number true
** REQUIRED ** Page display order for the related event.
EventApi__Is_Published__c Is Published Checkbox false
When checked, the page becomes visible on the related event.
EventApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked, only badge types identified in the "Manage Permissions" related list will have access to this item.
EventApi__Required_Ticket_Types__c Required Ticket Types LongTextArea 32768 false
Comma separated list of Ticket Types required to be considered see Event Page.

EventApi__Event_Status_Template__mdt

Event Status Template
Templates for Lightning Event Statuses.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Is_Enabled_Editable__c Is Enabled Checkbox false
When checked, this record will be enabled as a template.
EventApi__Enable_Transition_for_Status__c Enable Transition for Status Checkbox false
When checked, enables an automatic transition to this status based on its Status Transition Criteria.
EventApi__Event_Registration_Style__c Event Registration Style MetadataRelationship true
**Required** Linked to related event registration style.
EventApi__Is_Enabled__c DEPRECATED Checkbox false
When checked, this record will become enabled as a template.
EventApi__Is_Event_Active__c Is Event Active Checkbox false
When the status is set as the current event status, the value of this field will be mapped to the Is Active field on the event.
EventApi__Is_Event_Published__c Is Event Published Checkbox false
When a status is set as the current event status, the value of this field will be mapped to the Is Published field on the event.
EventApi__Order__c Order Number true
** REQUIRED ** Defines the timeline for an event's statuses, automatic event transitions will only occur in ascending order.
EventApi__Status_Transition_Criteria__c Status Transition Criteria TextArea false
** CONDITIONALLY REQUIRED ** SOQL query WHERE clause for automating the transition to this status on the Event. A value for this field is required when the Enable Transition for Status checkbox is checked.
EventApi__Closed_Status_Text__c DEPRECATED Text 255 false
The text entered in this field will appear in bold in place of the register button when the registration is closed.
EventApi__Editable_Closed_Status_Text__c Closed Status Text Text 255 false
The text entered in this field will appear in bold in place of the register button when the registration is closed.

EventApi__Event_Status__c

Event Status
Represents the different stages of an event's life cycle, as well as changes the visual look of the event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Enable_Transition_for_Status__c Enable Transition for Status Checkbox false
When checked, enables an automatic transition to this status based on its Status Transition Criteria.
EventApi__Event__c Event LookupEventApi__Event__c true
** REQUIRED ** Link to related Event.
EventApi__Filter_Transition_Criteria__c System LongTextArea 131072 false
JSON field to save the Filter Condition, Filter Transition Criteria and Advanced Status.
EventApi__Is_Current_Status_for_Event__c Is Current Status for Event Checkbox false
** SYSTEM CALCULATED/OVERRIDE ** When checked, the status will be set as the current event status. The status field on the event will also be updated.
EventApi__Is_Event_Active__c Is Event Active Checkbox false
When the status is set as the current event status, the value of this field will be mapped to the Is Active field on the event.
EventApi__Is_Event_Published__c Is Event Published Checkbox false
When a status is set as the current event status, the value of this field will be mapped to the Is Published field on the event.
EventApi__Order__c Order Number true
** REQUIRED ** Defines the timeline for an event's statuses, automatic event transitions will only occur in ascending order.
EventApi__Status_Transition_Criteria__c Status Transition Criteria LongTextArea 131072 false
** CONDITIONALLY REQUIRED ** SOQL query WHERE clause for automating the transition to this status on the Event. A value for this field is required when the Enable Transition for Status checkbox is checked.
EventApi__Closed_Status_Text__c Closed Status Text Text 255 false
The text entered in this field will appear in bold in place of the register button when the registration is closed.

EventApi__Event__c

Event
Primary configuration object for all events.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Quantity_Remaining__c Tickets Remaining Number false
The capacity / ticket quantity on the event minus the tickets sold.
EventApi__Guest_Registrant_FieldSet_CSV__c Guest Registrant Field Sets (CSV) Text 255 false
Custom fieldset defined on the Assignment Object that is used to collect information during guest checkout. Use the API name of the fieldset and ensure that fields on the Assignment object mirror the fields on the Attendee object.
EventApi__Location_And_Date_Text__c Location and Date Text TextArea false
The value defined in this field will display in the upper right hand side of the navbar overriding the city, state, and date/time.
EventApi__Quantity_Sold__c Tickets Sold Number false
The sum of all sold tickets of any type.
EventApi__Agenda_HTML__c Agenda HTML Html 32768 false
Text appears at the top of the "Agenda" page.
EventApi__Agenda_Instructions_HTML__c Agenda Instructions Html 32768 false
The text that appears at the top of the "Agenda" page during registration.
EventApi__Attendee_Selection_Instructions_HTML__c Attendee Selection Instructions Html 32768 false
The text that at the top of the "Attendee Selection" page during registration.
EventApi__Group_Manager_HTML__c Group Manager HTML Html 32768 false
The text that appears at the top of the "Group Registration" page.
EventApi__Attendees__c Number of Registered Attendees Number false
** System Calculated ** The current number of registered attendees for your event.
EventApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
** System Calculated Required Override ** Link to related Business Group. Derived from User Preferences if not defined on record creation.
EventApi__Capacity__c Capacity Number false
Maximum number of tickets that can be sold for the event. Required if "Enable Waitlisting" is checked.
EventApi__Community_Group__c Community Group LookupPagesApi__Community_Group__c false
Community group that this event is linked to. The event will display on the group detail page.
EventApi__Contact_Search_Result_Fields_CSV__c Contact Search Result Fields CSV LongTextArea 32768 false
Result fields will be displayed when contact searching for attendees.
EventApi__Display_Name__c Display Name Text 255 false
Event name as you would like it to appear on registration pages, calendar reminders, and emails.
EventApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked, only badge types identified in the "Manage Permissions" related list will have access to this item.
EventApi__Enable_QR_Event_Pass__c Enable QR for Event Pass Checkbox false
Checking this field will show a QR code on the event pass.
EventApi__Event_Pass_Image_URL__c Event Pass Image URL Url false
URL for the image to display on the printable event pass.
EventApi__Logo_Image__c Logo Image URL Url false
The image defined in this field appears in the lefthand side of the navbar in the microsite. Recommended size 90px by 90px. (Image will be cropped to these dimensions)
EventApi__Custom_CSS__c Custom CSS LongTextArea 131072 false
Custom CSS is inserted before the closing html head ("</head>") tag into pages using this Theme.
EventApi__Lightning_Event_Style__c SYSTEM LongTextArea 131072 false
Generated Styles for Lightning Events.
EventApi__Primary_Button_Background_Color__c Primary Button Background Color Text 10 false
Background color of all primary buttons in the related event. Valid hexadecimal notation required.
EventApi__Primary_Button_Text_Color__c Primary Button Background Color Text 10 false
Text color of all primary buttons in the related event. Valid hexadecimal notation required.
EventApi__Heading_Color__c Heading Color Text 10 false
Color of all heading text in the related event. Valid hexadecimal notation required.
EventApi__Text_Color__c Text Color Text 10 false
Color of all text in the related event. Valid hexadecimal notation required.
EventApi__Link_Color__c Link Color Text 10 false
Color of all text links in the related event. Valid hexadecimal notation required.
EventApi__Navbar_Background_Color__c Navbar Background Color Text 10 false
Background color of the related event's navigation. Valid hexadecimal notation required.
EventApi__Navbar_Text_Color__c Navbar Text Color Text 10 false
Color of the related event's navigation text. Valid hexadecimal notation required.
EventApi__Hero_Text_Color__c Hero Text Color Text 10 false
Color used for the related event's banner text. Valid hexadecimal notation required.
EventApi__Hero_Button_Background_Color__c Hero Button Background Color Text 10 false
Background color of the related event's banner button. Valid hexadecimal notation required.
EventApi__Hero_Button_Text_Color__c Hero Button Text Color Text 10 false
Text color of the related event's banner button. Valid hexadecimal notation required.
EventApi__Body_Background_Color__c Body Background Color Text 10 false
The overall background of the related event. Valid hexadecimal notation required.
EventApi__Process_Bar_Foreground_Color__c Process Bar Foreground Color Text 10 false
Foreground color of the related event's registration process bar. Valid hexadecimal notation required.
EventApi__Process_Bar_Color__c Process Bar Color Text 10 false
Color of all text in the related event's registration process bar. Valid hexadecimal notation required.
EventApi__Disable_Attendee_Assignment__c Disable Attendee Assignment Checkbox false
By checking this field, the user will bypass the need to insert attendee names. This means all attendee records will have the name of the purchaser.
EventApi__Enable_Contact_Search__c Enable Contact Search Checkbox false
When checked, enables the primary registrant to search for contacts in the system. When unchecked, the primary registrant is not allowed to search for any contacts. The default behavior is to search within the primary registrant's account.
EventApi__Guest_Email_Optional__c Guest Email Optional Checkbox false
When checked, guest attendees will not need an email to register.
EventApi__Enable_Assigned_Seating__c Enable Assigned Seating Checkbox false
When checked, assigned seating is enabled on the related event.
EventApi__Invitation_Only__c Invitation Only Checkbox false
When checked, the related event's attendees can only be registered by invitation.
EventApi__Create_Contacts_for_Attendees__c Create Contacts for Attendees Checkbox false
Enables contact creation for that event. If "Enable Account Search" is not checked, contacts created will be added to the primary registrant's account or into an individual person account depending on if the "Enable Individual Accounts" setting is active.
EventApi__Enable_Event_Display_Name_Date_Time__c Enable Event Display Name and Date/Time Checkbox false
When unchecked, the Display name and event date and time will not display over the banner image. Defaults checked.
EventApi__Enable_Registration_Groups__c Enable Registration Groups Checkbox false
When checked, allows one person to register multiple attendees at the same time and pay for them together.
EventApi__Enable_Schedule_Items__c Enable Schedule Items Checkbox false
When checked, enables schedule items for event Registration Styles that support them.
EventApi__Enable_Sponsors__c Enable Sponsor Sales Checkbox false
When checked, enables sponsor package sales for event Registration Styles that support it.
EventApi__Enable_Waitlist__c Enable Waitlist Checkbox false
When checked, attendees will have the option to be added to a waitlist once tickets are sold out.
EventApi__End_Date__c End Date Date false
**Required** The event end date.
EventApi__End_Time__c End Time Text 8 false
**Required** The event end time (HH:MM).
EventApi__End_Date_Time__c End Date/Time DateTime false
**Required** The event end date and time (mm/dd/yyyy hh:mm:ss).
EventApi__Event_Category__c Event Category LookupEventApi__Event_Category__c false
The event category is a template for creating events that use the same information. Defined fields on the event category will pass down to the event and can be customized as needed.
EventApi__Event_Key__c Event Key Text 16 true
This field is used as a unique identifier for events. The value in this field will also be used to concatenate item class names to be easily identified in lookup searches.
EventApi__Image_URL__c Image URL Url false
Image displays on the event overview and registration pages.
EventApi__Is_Active__c SYSTEM Checkbox false
When checked, the Event is available for Sale and for publishing too registration pages. Defaults checked.
EventApi__Is_Closed__c SYSTEM Checkbox false
When checked the event will be closed and no longer available for sale through the api and/or any community that has access to the event.
EventApi__Is_Published__c SYSTEM Checkbox false
When checked, the Event and related details will be exposed on all supported APIs. Defaults unchecked.
EventApi__Overview_HTML__c Overview HTML Html 32768 false
Description of the event. Used on the event main page, in calendar reminders, and in emails.
EventApi__ETicket_Label_Color__c ETicket Label Color Text 7 false
The color of the text for the mobile e-ticket. This color will be used for the headings in each section of the e-ticket. Required format is #000000.
EventApi__ETicket_Value_Color__c ETicket Value Color Text 7 false
The color of the value fields for the mobile e-ticket. This color will be used for the values in each section of the e-ticket. Required format is #000000.
EventApi__Registration_Instructions__c Registration Instructions Html 32768 false
Text appears near ticket type selection on event registration page.
EventApi__Registration_Style__c Registration Style Picklist false
Determines which page layouts are used to display the event, as well as the settings available for ticketing and/or registration.
EventApi__Schedule_Item_Item_Class__c SYSTEM LookupOrderApi__Item_Class__c false
This field is a system field. Update at your own risk.
EventApi__Search_All_Contacts__c Search All Contacts Checkbox false
By selecting this field, any contact authenticated or unauthenticated will be able to search all contacts in the system. (Privacy settings considered)
EventApi__Individual_Pages__c Individual Pages Checkbox false
When checked all status pages can be configured individually.
EventApi__Speakers_HTML__c Speakers HTML Html 32768 false
Text appears at the top of the "Speakers" page.
EventApi__Calendar_Reminder_Text__c Calendar Reminder Text Html 32768 false
Replaces Event: Description. When the customer clicks an "Add to Calendar" link on the event, this text is the body of the calendar item. By default, the Event Name, Start Time, End Time, and Venue information are included.
EventApi__Email_Notification_Text__c Email Notification Text LongTextArea 32768 false
Replaces Event: Description. When attendees are registered by proxy, they receive an email notification about the event. This text is the body of that email. By default, the Event Name, Start Time, End Time, and Venue information are included.
EventApi__Sponsor_Item_Class__c SYSTEM LookupOrderApi__Item_Class__c false
This field is a system field. Update at your own risk.
EventApi__Sponsors_HTML__c Sponsors HTML Html 32768 false
Text appears at the top of the "Sponsors" page.
EventApi__Start_Date_Time__c Start Date/Time DateTime false
**Required** The event start date and time (mm/dd/yyyy hh:mm:ss).
EventApi__Start_Date__c Start Date Date false
**Required** The event start date.
EventApi__Start_Time__c Start Time Text 8 false
**Required** The event start time (HH:MM).
EventApi__Status__c Status Picklist false
Status of the event. Must be "active" to be visible in the Portal.
EventApi__Thumbnail_Image_URL__c Thumbnail Image URL Url false
Secondary image for the event.
EventApi__Ticket_Type_Sort_Field__c Ticket Type Sort Field Text 255 false
Use with Ticket Type Sort Order. Specifies the field that is used to organize tickets on the registration page. Use "EventApi__Price__c" for price and "Name" for name.
EventApi__Ticket_Type_Sort_Order__c Ticket Type Sort Order Picklist false
Use with Ticket Type Sort Field. Specifies whether tickets are shown in ascending or descending order.
EventApi__Ticket_Sales_Start_Date__c Ticket Sales Start Date Date false
The date ticket sales or registration begins for the event. Defaults to the "Active" date if left blank.
EventApi__Ticket_Type_Item_Class__c SYSTEM LookupOrderApi__Item_Class__c false
This field is a system field. Update at your own risk.
EventApi__Time_Zone__c Time Zone Picklist false
The time zone of the event location.
EventApi__Venue_HTML__c Venue HTML Html 32768 false
Text appears at the top of the "Venues" page.
EventApi__Description__c Description LongTextArea 32768 false
Optional event description.
EventApi__Waitlist_Entries__c RESERVED Number false
Number of people currently waitlisted for the event. Does not include people waitlisted for individual ticket types.
EventApi__Registration_Timer__c Registration Timer Number false
The time allowed for purchasing an event registration.
EventApi__Enable_Contact_Restriction__c Enable Contact Restriction Checkbox false
When checked, a contact cannot have more than one attendee under the event. This will restrict the contact to one registrant for the event.
EventApi__Sold_Out__c Sold Out Checkbox false
Identifies if number of registered attendee records are reached to event capacity.
EventApi__Auto_Sellout_Event__c Auto Sellout Event Checkbox false
When checked, system will update Sold Out field automatically when number of registered attendees have reached to event capacity.

EventApi__Lightning_Event_Component__mdt

Lightning Event Component
Registry of Lightning Components enabled for use as Event Page Components for Lightning Events.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Is_Enabled__c Is Enabled Checkbox false
When checked, this record will become enabled as a template.
EventApi__Lightning_Component_API_Name__c Lightning Component API Name Text 255 true
**REQUIRED** Name of the Lightning component that needs to be instantiated. Only provide the name of the component without namespace.
EventApi__Edit_Lightning_Component_API_Name__c Edit Lightning Component API Name Text 255 false
**Optional** Name of the Lightning component that needs to be instantiated to edit in Event Builder. Only provide the name of the component without namespace.

EventApi__Lightning_Event_Page_Template_Component__mdt

Lightning Event Page Template Component
Mapping of Lightning Event Component to Lightning Event Page Template.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Lightning_Event_Component__c Lightning Event Component MetadataRelationship true
** REQUIRED ** Linked to the related event component.
EventApi__Lightning_Event_Page_Template__c Lightning Event Page Template MetadataRelationship true
** REQUIRED ** Linked to the related event page.
EventApi__Is_Enabled__c Is Enabled (Deprecated) Checkbox false
Deprecated - please use Is_Active__c
EventApi__Is_Active__c Is Enabled Checkbox false
When checked, this record will become enabled as a template.
EventApi__Order__c Order Number true
** REQUIRED ** Display order of Lightning components on a page.

EventApi__Lightning_Event_Page_Template__mdt

Lightning Event Page Template
Templates for Lightning Event Pages.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Is_Enabled_Editable__c Is Enabled Checkbox false
When checked, this record will be enabled as a template.
EventApi__Event_Status_Template__c Event Status Template MetadataRelationship true
** REQUIRED ** Linked to the related Event Status Template MDT.
EventApi__Is_Enabled__c DEPRECATED Checkbox false
When checked, this record will become enabled as a template.
EventApi__Navigation_Label__c Navigation Label Text 255 true
** REQUIRED ** The label used for each page in the event's navigation.
EventApi__Order__c Order Number true
** REQUIRED ** Page display order for the related event.
EventApi__Page_Name__c Page Name Text 255 true
** REQUIRED ** The page's heading will change based on the value of this field.

EventApi__Registration_Group__c

Registration Group
Event "Registration Groups" track groups of participants for either corporate registrations, fundraising teams, or family members.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Account__c Account LookupEventApi__Account false
** Conditionally Required ** Link to related Account. Required if the Group is defined as a "Corporate Registration Group".
EventApi__Create_Contacts__c Create Contacts for Attendees Checkbox false
When checked, a new Contact record will be created for all group members that do not match an existing Contact (email used as the contact match identifier). The Contact will be linked automatically to the Account linked to the group. Defaults checked.
EventApi__Create_Standing_Sales_Order__c Create Standing Sales Order Checkbox false
A "Standing" Sales Order is created allowing group members to register for the Event without providing payment. The Primary Contact will be responsible for the total fees accrued during registration of related group members. Defaults unchecked.
EventApi__Description__c Description LongTextArea 32768 false
Optional description for the group to display on registration pages.
EventApi__Display_Registered_Members__c Display Registered Members Checkbox false
When checked, Attendees registered with the group will display on the group registration page. Defaults unchecked.
EventApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
Restrict access to the group on registration pages. Unchecked by default.
EventApi__Event__c Event LookupEventApi__Event__c false
** Required ** Link to related Event.
EventApi__Group_Logo_URL__c Group Logo URL Text 255 false
Secure ("https://") url where the group's logo image file is located.
EventApi__Register_Site_Url__c SYSTEM Text 255 false
URL endpoint to be used for email registrants.
EventApi__Invoice_Date__c Invoice Date Date false
The date to invoice the registration group's primary contact and/or company.
EventApi__Limit_Registrations__c Limit Registrations Checkbox false
When checked, the group size will restricted to the "Registration Limit". Defaults unchecked.
EventApi__Payment_Method__c Payment Method LookupOrderApi__Payment_Method__c false
A valid Payment Method may be linked to the Registration Group so that the Registration Group is automatically charged for all registration fees for group members the day after the "Sales Closed Date" on the Event.
EventApi__Payment_Status__c Payment Status Picklist false
** System Calculated ** The current status of payment for the Registration Group.
EventApi__Payment_Terms__c Payment Terms LookupOrderApi__Payment_Terms__c false
** Conditionally Required ** Select the payment terms to use for the registration group's invoice. Required if posting entity is set to "Invoice".
EventApi__Payment_Type__c Payment Type Picklist false
Registration Groups can pay for all group members at once either by Invoice or automatic Payment Method charge.
EventApi__Posting_Entity__c Posting Entity Picklist false
Select either Invoice or Receipt. Valid and restricted to Registration Groups where "Create Standing Sales Order" is checked.
EventApi__Primary_Contact__c Primary Contact LookupEventApi__Contact false
** System Calculated Override ** Link to related Primary Contact. Derived from the related Account's "Primary Contact".
EventApi__Registered_Attendees__c Registered Attendees Number false
** System Calculated ** Count of "Registered" Attendees related to the Registration Group.
EventApi__Registration_Code__c Registration Code AutoNumber false
** System Calculated External ID ** Auto Number "External ID" that allows a group to be "private" and only accessible with a "Registration Code".
EventApi__Registration_Instructions__c Registration Instructions Html 32768 false
Custom instructions to display on the Group Registration page.
EventApi__Registration_Limit__c Registration Limit Number false
The maximum number of Attendees allowed to register with the group. Required and restricted to Registration Groups where "Limit Registrations" is checked.
EventApi__Registration_Page_Header__c Registration Page Header Html 32768 false
The header content to insert into the group's registration page.
EventApi__Invitation_Email_Body__c Invitation Email Body LongTextArea 32768 false
Email Body for invitation
LightningLens__Invited_Attendee__c Invited Attendee LookupEventApi__Attendee__c false
Contains Invited Attendee reference for RSVP Event

EventApi__Registration_Item__c

Registration Item
Registration Items store the various products and break-out sessions for an Attendee.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Attendee__c Attendee MasterDetail false
** Required ** Master-detail link to the related Attendee.
EventApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
** System Calculated Required Override ** Link to related Business Group. Derived from User Preferences if not defined on record creation.
EventApi__Date__c Date Date false
** System Calculated ** The schedule date.
EventApi__Discount__c Discount Currency false
** System Calculated ** Item list price - sale price. (Disregard this field if the item is a tax)
EventApi__End_Time__c End Time Text false
** System Calculated ** The scheduled end time.
EventApi__Is_Checked_In__c Is Checked In Checkbox false
When checked, the Registration Item and correspondent Attendee is considered to be/was in attendance for the Event. Default unchecked.
EventApi__Is_Primary__c Is Primary Checkbox false
** System Calculated ** Indicates that the registration item is the attendees primary ticket type.
EventApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated ** Registration item class.
EventApi__Item__c Item LookupOrderApi__Item__c false
Link to the item purchased.
EventApi__Line_Description__c Line Description Text 255 false
** System Calculated ** Derived from the parent sales order line.
EventApi__List_Price__c List Price Currency false
** System Calculated ** The registration item's list price.
EventApi__Price_Override__c Price Override Checkbox false
** System Calculated ** Derived from the parent sales order line.
EventApi__Price_Rule__c Price Rule LookupOrderApi__Price_Rule__c false
** System Calculated ** The price rule applied when the attendee purchased the registration item.
EventApi__Quantity__c Quantity Number false
The quantity sold.
EventApi__Registration_Item__c Registration Item LookupEventApi__Registration_Item__c false
Links to related "Parent Registration Item".
EventApi__Sale_Price__c Sale Price Currency false
** System Calculated ** The sale price per unit for the registration item.
EventApi__Sales_Order_Line__c Sales Order Line (Source) LookupOrderApi__Sales_Order_Line__c false
Links to the source sales order line that created the registration item.
EventApi__Sales_Order_Number__c Sales Order Number Text false
** System Calculated ** The sales order number.
EventApi__Sales_Order__c Sales Order (Source) LookupOrderApi__Sales_Order__c false
Links to the source sales order that created the registration item.
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c false
Link to the related schedule item.
EventApi__Start_Time__c Start Time Text false
** System Calculated ** The scheduled start time.
EventApi__Subtotal__c Subtotal Currency false
** System Calculated ** Quantity * Sale Price.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
Link to the related Ticket Type.
EventApi__Total__c Total Currency false
** System Calculated ** The total price for the registration item.
EventApi__Transaction_Date__c Transaction Date Date false
** System Calculated ** The date the sales order was posted.
EventApi__Transaction_Type__c Transaction Type Text false
** System Calculated ** The transaction type, either "Invoice" or "Receipt".
EventApi__Transfer_Contact_Email__c Transfer Contact Email Email false
** Conditionally Required ** The email address for the contact the registration item is being transferred to. Required for transfer.
EventApi__Transfer_Contact_Name__c Transfer Contact Name Text 255 false
** Conditionally Required ** The name of the contact that the registration item is being transfered to. Required for transfer.
EventApi__Transfer_Fee__c Transfer Fee Currency false
Registration items may be enabled for transfer depending on your event configurations. If the registration item is transfered the appropriate fees will be defined in this field.
EventApi__Transfer__c Transfer Checkbox false
Check the box to transfer the registration item to another Attendee.
EventApi__Status__c Status Picklist false
** Required ** The current status of the Attendee Registration. Defaults to "Registered".

EventApi__Registration_Route__c

Registration Route
**PUBLIC** Route traffic for event registration to the proper campaign page

Custom Fields

API Name Label Type Length Required
Description
EventApi__Target__c Target Text 255 false

EventApi__Room__c

Room
Track the Rooms available for the Venues that host your Events and book them for Event Sessions.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Capacity__c Capacity Number false
** Required ** The maximum persons the room can accommodate at one time is used as the default inventory level for any Event Sessions booked to the Room.
EventApi__Description__c Description TextArea false
Optional description for the Room used to provide users context when booking Event Sessions for an Event that has access to the Room.
EventApi__Disabled_Access__c Disabled Access Checkbox false
When checked the Room is considered to be wheelchair accessible. Defaults unchecked.
EventApi__Drops__c Drops Number false
The number of network access ports available in the Room.
EventApi__Event__c Event LookupEventApi__Event__c false
** Required ** Link to related Event.
EventApi__Layout__c Layout Picklist false
** Required ** Select the option that best describes the Layout of the Room.
EventApi__Location_Description__c Location Description LongTextArea 32768 false
Enter a description that would be helpful for Attendees wanting to locate the Room.
EventApi__Location_Name__c Location Name Text 255 false
Location name defaults to the name of the Room but can be modified to match the Venue's internal room code to assist with planning and bookings.
EventApi__Minimum_Rental_Fee__c Minimum Rental Fee Currency false
The minimum fee amount required by the Venue to rent the Room.
EventApi__Podium__c Podium Checkbox false
When checked, the Room will be considered to include a Podium.
EventApi__Power_Outlets__c Power Outlets Number false
The number of three-pronged power outlets available for use in the Room. Defaults to 1.
EventApi__Rental_Rate_Basis__c Rental Rate Basis Picklist false
The basis used to calculate the expense of renting the Room.
EventApi__Rental_Rate__c Rental Rate Currency false
Rental fee rate for the Room.
EventApi__Square_Feet__c Square Feet Number false
The square footage (size) for the Room.
EventApi__Stage__c Stage Checkbox false
When checked, the Room is considered to have a permanent stage or similar stage/platform like structure.
EventApi__Target_Capacity__c Target Capacity Number false
The target or ideal capacity for the Room is usually slightly less than the "Capacity".
EventApi__Venue__c Venue LookupEventApi__Venue__c false
** Required ** Link to the related Venue for the Room.
EventApi__Wireless_Internet__c Wireless Internet Checkbox false
When checked, the Room is considered as having wireless internet (WiFi) accessibility.

EventApi__Schedule_Item__c

Schedule Item
Create and publish a schedule of activities configured for a given event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Adjustment_Account__c Adjustment Account LookupOrderApi__GL_Account__c false
The debit account to use when posting invoice adjustments to invoices that have already posted to A/R.
EventApi__AR_Account__c A/R Account LookupOrderApi__GL_Account__c false
Identifies the GL Account used for A/R transactions.
EventApi__Invoice_Payment_Priority__c Payment Priority Number false
If populated, this field is used to identify the order in which partial payments are applied to an invoice.
EventApi__Allow_Conflicts__c Allow Conflicts Checkbox false
When checked, system will allow another schedule item to overlap the time slot for this schedule item.
EventApi__Assignments_Display_Label__c RESERVED Text 255 false
The label to display in the wizard for the step related to assigning people to a subscription.
EventApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
** System Calculated Required Override ** Link to related Business Group. Derived from User Preferences if not defined on record creation.
EventApi__Cost__c Cost Currency false
The cost of the Schedule Item.
EventApi__Defer_Revenue__c Defer Revenue Checkbox false
When checked, the deferred revenue recognition rules will be considered when posting transactions.
EventApi__Deferred_Revenue_Account__c Deferred Revenue Account LookupOrderApi__GL_Account__c false
EventApi__Deferred_Revenue_Term__c Deferred Revenue Term (In Months) Number false
EventApi__Description__c Description LongTextArea 32768 false
EventApi__Disable_Registration__c Disable Registration Checkbox false
When checked, attendees cannot register for this schedule item. Useful for breaks, meals, and other schedule items that are not sessions.
EventApi__Discount_Account__c RESERVED LookupOrderApi__GL_Account__c false
This field has been reserved for future use.
EventApi__Display_Name__c Display Name Text 255 false
Schedule item name as you would like it to appear on the event pages.
EventApi__Duration__c Duration Text false
** System Calculated ** Duration in hours.
EventApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked, only badge types identified in the "Manage Permissions" related list will have access to this item.
EventApi__Enable_Assignments__c RESERVED Checkbox false
** System Calculated ** When checked, the Item can be assigned to Contacts indicating benefit or ownership over goods and services. Automatically calculated based on the parent Item Class "Type".
EventApi__Enable_Waitlist__c Enable Waitlist Checkbox false
When checked, attendees will have the option to be added to a waitlist once tickets are sold out (or capacity is reached) for this schedule item.
EventApi__End_Date__c End Date Date false
**Required** The event end date.
EventApi__Session_End_Time__c End Time Text 8 false
**Required** The event end time (HH:MM).
EventApi__End_Date_Time__c End Date/Time DateTime false
** Required ** Enter the end date and time for the schedule item.
EventApi__End_Time__c End Time Text false
** System Calculated ** The scheduled end time.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to the related event.
EventApi__Flex_Day_of_the_Month__c Flex Day of the Month Number false
EventApi__Form__c Schedule Item Form LookupPagesApi__Form__c false
Link to a form created in the "Form Builder" app. Customers will see the form when they select the schedule item.
EventApi__Hide_During_Registration__c Hide During Registration Checkbox false
Checking this field removes this session from the registration's agenda page.
EventApi__Image_Path__c Image URL Text 255 false
Image displays in the shopping cart and checkout page.
EventApi__Income_Account__c Income Account LookupOrderApi__GL_Account__c false
The credit account to use when posting revenue in a A/R transaction or from a cash sale receipt.
EventApi__Interview_Form_Display_Label__c Form Display Label Text 255 false
Text heading for the schedule item form.
EventApi__Is_Active__c Is Active Checkbox false
When checked, the schedule item is available for sale (if ticketed) and for publishing to the event.
EventApi__Is_Automatically_Added__c RESERVED Checkbox false
EventApi__Is_Contribution__c Is Contribution Checkbox false
** System Calculated Override ** Enable contribution (donation) related controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
EventApi__Is_Tax_Deductible__c Is Tax Deductible Checkbox false
Check if the item is a tax deductible donation. The cost per unit will drive the tax deductible amount on the sales order.
EventApi__Is_Taxable__c Is Taxable Checkbox false
** System Calculated Override ** Enable tax specific controls and features for this schedule item.
EventApi__Item_Class__c SYSTEM LookupOrderApi__Item_Class__c false
This field is a system field. Update at your own risk.
EventApi__Item__c SYSTEM LookupOrderApi__Item__c false
This field is a system field. Update at your own risk.
EventApi__Line_Description__c RESERVED Text 255 false
The description for the item as it should appear on related receipts and invoices. This field is limited to 255 characters.
EventApi__Maximum_Number_of_Assignments__c RESERVED Number false
** Conditionalbly Required ** If "Restrict Number of Assignments" is checked, a maximum number of assignments must be defined.
EventApi__Price__c Price Currency false
The list price of the schedule item, if applicable.
EventApi__Quantity_Available__c Capacity Number false
Maximum capacity of the room or number of tickets available for the session.
EventApi__Quantity_Remaining__c Tickets Remaining Number false
The capacity/ticket quantity minus the tickets sold.
EventApi__Quantity_Sold__c Tickets Sold Number false
The number of tickets sold for this schedule item.
EventApi__Refund_Account__c Refund Account LookupOrderApi__GL_Account__c false
The account to debit when refunding/crediting customers who have purchased this Item.
EventApi__Require_Assignments__c RESERVED Checkbox false
When checked, a user will be unable to complete a sale for an Item until all assignments available have been entered. Defaults unchecked.
EventApi__Required_for_Registration__c Required for Registration Checkbox false
Checking this field automatically includes this session for purchase during registration.
EventApi__Restrict_Number_of_Assignments__c RESERVED Checkbox false
When checked, the system will limit the number of assignments allowed based on the value of the "Maximum Number of Assignments" field. Defaults unchecked.
EventApi__Revenue_Recognition_Date__c Revenue Recognition Date Date false
EventApi__Revenue_Recognition_Rule__c Revenue Recognition Rule Picklist false
EventApi__Revenue_Recognition_Term_Rule__c Revenue Recognition Term Rule Picklist false
EventApi__Room__c Room/Location LookupEventApi__Room__c false
Link to the room that the schedule item is taking place in.
EventApi__SKU__c RESERVED Text 255 false
A SKU (Stock Keeping Unit) is a unique Item identifier that references attributes associated with the Item and that distinguish it from all other Items primarily used for inventory control and management.
EventApi__Start_Date__c Start Date Date false
**Required** The event start date.
EventApi__Session_Start_Time__c Start Time Text 8 false
**Required** The event start time (HH:MM).
EventApi__Start_Date_Time__c Start Date/Time DateTime false
** Required ** Enter the start date and time for the schedule item.
EventApi__Start_Time__c Start Time Text false
** System Calculated ** The scheduled start time.
EventApi__Tax_Class__c Tax Class LookupOrderApi__Item_Class__c false
Populate this field for a schedule item that needs to apply a tax.

EventApi__Seat__c

Seat
Seat for the related section.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Is_Assigned__c Is Assigned Checkbox false
When checked, the related seat is assigned to an attendee.
EventApi__Seat_Number__c Seat Number Text 80 false
An assigned number used for tracking purposes.
EventApi__Section__c Section MasterDetail false
**Required** Linked to the related section.

EventApi__Section_Ticket__c

Section Ticket
The tickets link to the related section.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Section__c Section LookupEventApi__Section__c true
**Required** Linked to the related section.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c true
**Required** Linked to the related ticket type.

EventApi__Section__c

Section
Section for the related event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Event__c Event LookupEventApi__Event__c true
**Required** Linked to the related event.
EventApi__Description__c Description Html 131072 false
Rich Text used for providing a unique description for the related section.
EventApi__Display_Order__c Display Order Number true
**Required** The display order for sections.
EventApi__Image__c Image Url false
The image used when viewing the related section in an event's registration. The provided image will also be cropped to fit a 200x200 pixel thumbnail.

EventApi__Site_Event_Category__c

Site Event Category
Control which events are displayed in which Sites for the portal.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Event_Category__c Event Category MasterDetail false
EventApi__Is_Default__c Is Default Checkbox false
EventApi__Site__c Site MasterDetail false

EventApi__Speaker_Schedule_Item__c

Speaker Schedule Item
Schedule Item Speakers track the various Sessions and Seminars a Speaker is scheduled to present for a Event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Is_Primary__c Is Primary Checkbox false
When checked, the Speaker is considered the lead or "primary" presenter for the Schedule Item.
EventApi__Role__c Role Picklist false
The speaker's role with respect to the related schedule item.
EventApi__Schedule_Item__c Schedule Item MasterDetail false
Link to the schedule item.
EventApi__Speaker__c Speaker LookupEventApi__Speaker__c false
Link to the speaker.

EventApi__Speaker__c

Speaker
Tracks speakers and maintains a list of all the schedule items the speaker will be featured and/or presenting.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Bio__c Bio LongTextArea 32768 false
Biographical information is displayed on the event with the speaker's name.
EventApi__Company_Name__c Company Name Text 255 false
The name of the company the Speaker would like to display on his/her Speaker page and name badge.
EventApi__Contact__c CRM Contact Link LookupEventApi__Contact false
Link to the speaker"s contact record.
EventApi__Display_Order__c Display Order Number false
Value in this field defines the order used to display speakers for featured speakers and speaker components.
EventApi__Email__c Email Email false
** System Calculated Override ** The email for the Speaker. Derived from the linked Contact's "Preferred Email" field.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to related event.
EventApi__Is_Featured__c Is Featured Checkbox false
When checked, the Speaker will display in the "Featured Speakers" component for Lightning Events.
EventApi__Large_Profile_Photo_URL__c Speaker Photo URL Text 255 false
Secure ("https://") location of an image that will display on the event with the speaker"s name and bio. Square images work best. Image should be at least 412px square and the file size should be less than 250 KB.
EventApi__Other_Phone__c Other Phone Phone false
Alternate phone for the Speaker.
EventApi__Phone__c Phone Phone false
** System Calculated Override ** The primary phone for the Speaker. Derived from the linked Contact's "Preffered Phone" field.
EventApi__Special_Requests__c Comments LongTextArea 32768 false
Other information or notes about the speaker.
EventApi__Status__c Status Picklist false
** Required ** The current Status for the Speaker.
EventApi__Title__c Title Text 255 false
The title the Speaker would like to display on his/her Speaker page and name badge.
LightningLens__Facebook_URL__c Facebook URL Url false
Link to Speaker's Facebook profile.
LightningLens__Is_Featured__c DEPRECATED Checkbox false
When checked, the Speaker will display in the "Featured Speakers" component for Lightning Events.
LightningLens__LinkedIn_URL__c LinkedIn URL Url false
Link to the Speaker's LinkedIn profile.
LightningLens__Twitter_URL__c Twitter URL Url false
Link to the Speaker's Twitter profile.

EventApi__Sponsor_Package__c

Sponsor Package
Sponsor packages track the benefits and levels of sponsorship available for an event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Adjustment_Account__c Adjustment Account LookupOrderApi__GL_Account__c false
The debit account to use when posting invoice adjustments to invoices that have already posted to A/R.
EventApi__AR_Account__c A/R Account LookupOrderApi__GL_Account__c false
Identifies the GL Account used for A/R transactions.
EventApi__Invoice_Payment_Priority__c Payment Priority Number false
If populated, this field is used to identify the order in which partial payments are applied to an invoice.
EventApi__Assignments_Display_Label__c RESERVED Text 255 false
RESERVED
EventApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
** System Calculated Required Override ** Link to related Business Group. Derived from User Preferences if not defined on record creation.
EventApi__Tax_Class__c Tax Class LookupOrderApi__Item_Class__c false
Populate this field for a sponsor package that needs to apply a tax.
EventApi__Is_Taxable__c Is Taxable Checkbox false
** System Calculated Override ** Enable tax specific controls and features for this sponsor package.
EventApi__Maximum_Number_of_Assignments__c RESERVED Number false
RESERVED
EventApi__Require_Assignments__c RESERVED Checkbox false
RESERVED
EventApi__Cost__c Item Cost Currency false
The cost per unit for the item.
EventApi__Revenue_Recognition_Date__c Revenue Recognition Date Date false
EventApi__Revenue_Recognition_Rule__c Revenue Recognition Rule Picklist false
EventApi__Revenue_Recognition_Term_Rule__c Revenue Recognition Term Rule Picklist false
EventApi__Restrict_Number_of_Assignments__c RESERVED Checkbox false
RESERVED
EventApi__Discount_Account__c RESERVED LookupOrderApi__GL_Account__c false
The account to debit when discounting a sale related to the Item.
EventApi__Display_Name__c Display Name Text 255 false
Sponsor package name as you would like it to appear in the Portal.
EventApi__Display_Order__c Display Order Number false
Enter the number for the order that the sponsor package should be displayed in.
EventApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked, only badge types identified in the "Manage Permissions" related list will have access to this item.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to the related event.
EventApi__Form__c Sponsor Package Form LookupPagesApi__Form__c false
Link to a form created in the "Form Builder" app. Customers will see the form when they select the sponsor package to purchase.
EventApi__Income_Account__c Income Account LookupOrderApi__GL_Account__c false
The credit account to use when posting revenue in a A/R transaction.
EventApi__Deferred_Revenue_Account__c Deferred Revenue Account LookupOrderApi__GL_Account__c false
EventApi__Deferred_Revenue_Term__c Deferred Revenue Term (In Months) Number false
EventApi__Defer_Revenue__c Defer Revenue Checkbox false
When checked, the deferred revenue recognition rules will be considered when posting transactions.
EventApi__Is_Tax_Deductible__c Is Tax Deductible Checkbox false
Check if the item is a tax deductible donation. The cost per unit will drive the tax deductible amount on the sales order.
EventApi__Is_Active__c Is Active Checkbox false
When checked, the item is considered available for sale and will be made available for selection against Invoice, Sales Order, Receipt, and EPayment Lines.
EventApi__Is_Contribution__c Is Contribution Checkbox false
** System Calculated Override ** Enable contribution (donation) related controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
EventApi__Item_Class__c RESERVED LookupOrderApi__Item_Class__c false
** System Calculated ** The Item Class for sponsor packages are auto-generated for each event and/or event category based on configurations.
EventApi__Item__c RESERVED LookupOrderApi__Item__c false
Relates the Sponsorship Package to the Sponsorship Item for its event.
EventApi__Line_Description__c Line Description Text 255 false
Short description that appears on receipts and invoices.
EventApi__Description__c Description LongTextArea 32768 false
Product description.
EventApi__Price__c Price Currency true
The list price of the sponsor package.
EventApi__Quantity_Available__c Quantity Available Number false
Maximum number of this sponsor packages of this type that can be sold for the event.
EventApi__Quantity_Remaining__c Quantity Remaining Number false
The quantity available minus the number sold.
EventApi__Quantity_Sold__c Quantity Sold Number false
The number of sponsor packages of this type sold.
EventApi__Refund_Account__c Refund/Credit Account LookupOrderApi__GL_Account__c false
The account to debit when refunding/crediting customers who have purchased this Item.
EventApi__SKU__c RESERVED Text 255 false
A SKU (Stock Keeping Unit) is a unique Item identifier that references attributes associated with the Item and that distinguish it from all other Items primarily used for inventory control and management.
EventApi__Enable_Assignments__c RESERVED Checkbox false
RESERVED
EventApi__Flex_Day_of_the_Month__c Flex Day of the Month Number false
EventApi__Image_Path__c Image URL Text 255 false
Image displays in the shopping cart and checkout page.
EventApi__Interview_Form_Display_Label__c Form Display Label Text 255 false
Text heading for the sponsor package form.

EventApi__Sponsor__c

Sponsor
Sponsors track the organizations who have purchased a "Sponsorship Package" for a Event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Account__c Account LookupEventApi__Account false
EventApi__Contact__c Contact LookupEventApi__Contact false
** System Calculated Override ** Link to related Contact. Derives from the Account "Primary Contact" field if no value defined.
EventApi__Description__c Description LongTextArea 32768 false
EventApi__Event__c Event LookupEventApi__Event__c false
Link to the sponsored event.
EventApi__Image_URL__c Image URL Text 255 false
Secure ("https://") location of an image or logo that will display the sponsor"s name. Image should be at least 250px in the smallest dimension and the file size should not exceed 250 KB.
EventApi__Is_Featured__c Is Featured Checkbox false
When checked, the Sponsor will display in the "Featured Sponsors" component for Lightning Events.
EventApi__Sponsor_Package__c Sponsor Package LookupEventApi__Sponsor_Package__c false
Link to the purchased sponsor package.
EventApi__Sponsor_Hyperlink__c Sponsor Hyperlink Url false
The value in this field will allow front end users to click on the sponsor image to navigate to the URL.
LightningLens__Is_Featured__c DEPRECATED Checkbox false
When checked, the Sponsor will display in the "Featured Sponsors" component for Lightning Events.

EventApi__Ticket_Block__c

Ticket Block
Link to related Ticket Block used for inventory tracking purposes.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Number_Of_Available_Tickets__c Number Of Available Tickets Number true
**Required** Identifies the maximum number of available ticket for ticket groups.
EventApi__Ticket_Block_Name__c Ticket Block Name Text 80 true
**Required** Name of Ticket Block.

EventApi__Ticket_Schedule_Item__c

Ticket Type Schedule Item
Junction object to configure Schedule Items and link them to ticket types.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Disable_Registration__c Disable Registration Checkbox false
When checked, attendees cannot register for this schedule item. Useful for breaks, meals, and other schedule items that are not sessions.
EventApi__Hide_During_Registration__c Hide During Registration Checkbox false
Checking this field removes this session from the registration's agenda page.
EventApi__Required_for_Registration__c Required for Registration Checkbox false
Checking this field automatically includes this session for purchase during registration.
EventApi__Schedule_Item__c Schedule Item MasterDetail false
This field relates the Ticket Type Scheduled Item to the Scheduled Item.
EventApi__Ticket_Type__c Ticket Type MasterDetail false
This field relates the Ticket Type Scheduled Item to the Ticket Type.

EventApi__Ticket_Type__c

Ticket Type
Tracks the various types of Tickets available for a Event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Adjustment_Account__c Adjustment Account LookupOrderApi__GL_Account__c false
The debit account to use when posting invoice adjustments to invoices that have already posted to A/R.
EventApi__AR_Account__c A/R Account LookupOrderApi__GL_Account__c false
Identifies the GL Account used for A/R transactions.
EventApi__Invoice_Payment_Priority__c Payment Priority Number false
If populated, this field is used to identify the order in which partial payments are applied to an invoice.
EventApi__Is_Taxable__c Is Taxable Checkbox false
** System Calculated Override ** Enable tax specific controls and features for this ticket.
EventApi__Cost__c Cost Currency false
The cost of the Ticket Type will be used to calculate the Tax-deductible donation amount that displays to on the Attendees receipt if "Is Tax Deductible" is checked.
EventApi__Description__c Description LongTextArea 32768 false
Displays with the ticket type on the registration page.
EventApi__Line_Description__c RESERVED Text 255 false
The description for the item as it should appear on related receipts and invoices. This field is limited to 255 characters.
EventApi__Discount_Account__c RESERVED LookupOrderApi__GL_Account__c false
The account to debit when discounting a sale related to the Item.
EventApi__Display_Available_Inventory__c Display Available Inventory Checkbox false
When checked, if a ticket quantity is specified, the number of tickets remaining will be shown next to the ticket type.
EventApi__Early_Bird_End_Date__c Early Bird End Date Date false
Requires "Enable Early Bird Price" to be checked. Specifies the date that early bird pricing ends.
EventApi__Early_Bird_Price__c Early Bird Price Currency false
Requires "Enable Early Bird Price" to be checked. Specifies the date that early bird pricing ends.
EventApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked, only badge types identified in the "Manage Permissions" related list will have access to this item.
EventApi__Enable_Early_Bird_Price__c Enable Early Bird Price Checkbox false
When checked, the Ticket Type will be sold for the amount defined in the "Early Bird Price" field until the date defined in the "Early Bird End Date".
EventApi__Enable_Waitlist__c Enable Waitlist Checkbox false
When checked, attendees will have the option to be added to a waitlist for this ticket type when it is sold out.
EventApi__Enable_Onsite_Price__c Enable On-site Price Checkbox false
When checked, the ticket type can be sold for a different price, defined in the "On-Site Price" field, on the day of the event.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to related Event.
EventApi__Form__c Ticket Type Form LookupPagesApi__Form__c false
Link to a form created in the "Form Builder" app. Customers will see the form when they select the ticket type.
EventApi__Group_Type__c Group Type Text 255 false
The value of this field will be matched to the related item's "Item Weight UOM" field.
EventApi__Income_Account__c Income Account LookupOrderApi__GL_Account__c false
The credit account to use when posting revenue in a A/R transaction or from a cash sale receipt.
EventApi__Inventory_Status__c RESERVED Picklist false
** System Calculated ** The current inventory status. Default is "In-stock".
EventApi__Is_Active__c Is Active Checkbox false
When checked, ticket is available for sale but must still be published to be visible on the registration page.
EventApi__Is_Group_Ticket_Type__c Is Group Ticket Type Checkbox false
When checked, the ability to assign multiple attendees to a single ticket will be enabled.
EventApi__Is_Published__c Is Published Checkbox false
When checked, ticket is visible and available for purchase on the registration page to contacts with access permissions.
EventApi__Is_Tax_Deductible__c Is Tax Deductible Checkbox false
When checked, the Ticket Type is considered as a Tax Deductible contribution and the Cost of the Ticket Type will be used when deriving the "Tax Deductible Donation Amount" on Attendee's Receipts. Defaults unchecked.
EventApi__Item_Class__c SYSTEM LookupOrderApi__Item_Class__c false
SYSTEM
EventApi__Item__c SYSTEM LookupOrderApi__Item__c false
SYSTEM
EventApi__Manage_Agenda_by_Ticket_Type__c Manage Agenda by Ticket Type Checkbox false
Checking this field will allow staff users to manage scheduled items by ticket type. The settings from the session will be overridden with the settings defined on the Ticket Type Scheduled Item.
EventApi__Onsite_Price__c On-site Price Currency false
Requires "Enable On-Site Price" to be checked. Specifies the ticket price on the day of the event.
EventApi__Price__c Price Currency false
The standard or list price of the ticket.
EventApi__Quantity_Available__c Ticket Quantity Number false
Maximum number of this ticket type that can be sold for the event. Required if "Enable Waitlist" is checked.
EventApi__Quantity_Remaining__c Tickets Remaining Number false
The ticket type quantity minus the tickets sold.
EventApi__Quantity_Sold__c Tickets Sold Number false
The number of tickets of this type sold.
EventApi__Refund_Account__c Refund Account LookupOrderApi__GL_Account__c false
The account to debit when refunding/crediting customers who have purchased this Item.
EventApi__SKU__c RESERVED Text 255 false
A SKU (Stock Keeping Unit) is a unique Item identifier that references attributes associated with the Item and that distinguish it from all other Items primarily used for inventory control and management.
EventApi__UOM__c RESERVED Picklist false
** Required ** Pick the unit of measure to display on registration pages.
EventApi__Defer_Revenue__c Defer Revenue Checkbox false
When checked, the deferred revenue recognition rules will be considered when posting transactions.
EventApi__Deferred_Revenue_Term__c Deferred Revenue Term (In Months) Number false
EventApi__Deferred_Revenue_Account__c Deferred Revenue Account LookupOrderApi__GL_Account__c false
EventApi__Enable_Assignments__c SYSTEM (ALWAYS TRUE FOR TICKET TYPE) Checkbox false
** System Calculated ** When checked, the Item can be assigned to Contacts indicating benefit or ownership over goods and services. Automatically calculated based on the parent Item Class "Type".
EventApi__Ticket_Block__c Ticket Block LookupEventApi__Ticket_Block__c false
Link to related Ticket Block used for inventory tracking purposes.
EventApi__Flex_Day_of_the_Month__c Flex Day of the Month Number false
EventApi__Image_Path__c Image URL Text 255 false
Image displays in the shopping cart and checkout page.
EventApi__Interview_Form_Display_Label__c Form Display Label Text 255 false
Text heading for the ticket type form.
EventApi__Is_Contribution__c Is Contribution Checkbox false
** System Calculated Override ** Enable contribution (donation) related controls and features for this Item. Defaults to the value of the same field on the Item's related Item Class.
EventApi__Tax_Class__c Tax Class LookupOrderApi__Item_Class__c false
Populate this field for an item that needs to apply a tax.
EventApi__Maximum_Number_of_Assignments__c Maximum Attendees Allowed Per Group Number false
**Conditionally Required** Defines the maximum number of attendees allowed per group. Field is required when "Is Group Ticket Type" field is set to true.
EventApi__Maximum_Sales_Quantity__c Maximum Sales Quantity Number false
Requires "Restrict Maximum Sales Quantity" to be checked. Specifies the maximum quantity of tickets that can be purchased in a single order.
EventApi__Min_Sales_Quantity__c Minimum Sales Quantity Number false
Specifies the minimum quantity of tickets that can be purchased in a single order.
EventApi__Require_Assignments__c RESERVED Checkbox false
When checked, a user will be unable to complete a sale for an Item until all assignments available have been entered. Defaults unchecked.
EventApi__Restrict_Number_of_Assignments__c SYSTEM (ALWAYS TRUE FOR TICKET TYPE) Checkbox false
When checked, the system will limit the number of assignments allowed based on the value of the "Maximum Number of Assignments" field. Defaults unchecked.
EventApi__Restrict_Maximum_Sales_Quantity__c Restrict Maximum Sales Quantity Checkbox false
When checked, restricts customers to a maximum quantity of tickets per order.
EventApi__Revenue_Recognition_Date__c Revenue Recognition Date Date false
EventApi__Revenue_Recognition_Rule__c Revenue Recognition Rule Picklist false
EventApi__Revenue_Recognition_Term_Rule__c Revenue Recognition Term Rule Picklist false
EventApi__Enable_Refund_Request__c Enable Refund Request Checkbox false
When checked, an attendee can request a refund and the attendee record will be updated to indicate he/she has cancelled.
EventApi__Refund_Request_Policy__c Refund Request Policy Html 32768 false
Enter rich text to display to the attendee when they request refunds from the Manage My Registration page.
EventApi__Ticket_Information__c Ticket Information Html 32768 false
Rich text to display to the attendee of any relevant event and ticket information.

EventApi__Track_Schedule_Item__c

Track Schedule Item
A junction object to link one schedule item to many tracks for a given event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c true
**Required** Linked the to related schedule item.
EventApi__Track__c Track LookupEventApi__Track__c true
**Required** Linked the to related track.

EventApi__Track__c

Track
Tracks enable users to filter and easily register for schedule items.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Event__c Event LookupEventApi__Event__c true
**Required** Linked the to related event.
EventApi__Track_Color__c Track Color Text 10 false
The value defined in this field defines the hex color used to display in the event micro site.

EventApi__Vendor__c

Vendor
Vendors track the various companies that provide services related to a Event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Account__c CRM Account Link LookupEventApi__Account false
Link to a CRM Account record related to the Vendor.
EventApi__Airports__c Nearest Airport(s) Text 255 false
Enter the nearest airport(s) for the hotel.
EventApi__Ameneties__c Amenities MultiselectPicklist false
Select the amenities that the hotel offers.
EventApi__City__c City Text 255 false
Enter the city/province used to send payment.
EventApi__Concierge_Phone__c Concierge Phone Phone false
Enter the phone number for the hotel's concierge.
EventApi__Contact_Email__c Contact Email Email false
** System Calculated Override ** Contact email for the Vendor. Derived from the related Primary Contact if defined.
EventApi__Contact_Name__c Contact Name Text 255 false
Enter the full name of the primary contact.
EventApi__Contact_Phone__c Contact Phone Phone false
Enter the primary contact's preferred phone number.
EventApi__Contact_Title__c Contact Title Text 255 false
Enter the title of the primary contact.
EventApi__Country__c Country Text 255 false
The country used to send payment.
EventApi__Description__c Description LongTextArea 32768 false
Optional description for the Vendor.
EventApi__Double_Room_Rate__c Double Room Rate Currency false
Estimated daily rate for a double room at the hotel.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to the related Event.
EventApi__Executive_Suite_Rate__c Executive Suite Rate Currency false
Estimated daily rate for a executive suite at the hotel.
EventApi__Family_Room_Rate__c Triple/Family Room Rate Currency false
Estimated daily rate for a family/triple room at the hotel.
EventApi__Front_Desk_Phone__c Front Desk Phone Phone false
Enter the front desk phone number for the hotel.
EventApi__Hotel_Ameneties_Description__c Hotel Amenities Description LongTextArea 2000 false
Describe the various amenities the hotel offers.
EventApi__Hotel_Cancellation_Policy__c Hotel Cancellation Policy LongTextArea 1000 false
Describe the hotel's cancellation policy.
EventApi__Hotel_Type__c Hotel Type Picklist false
** Conditionally Required ** Select the most appropriate type for the hotel. Required for all "Hotel" vendors.
EventApi__Is_Published__c Publish to Website Checkbox false
Display on the vendor page published on the event's website (if applicable).
EventApi__Local_Attractions__c Local/Historic Attractions LongTextArea 3000 false
Describe any local or historic attractions that are close to the hotel.
EventApi__Logo_Image_URL__c Logo Image URL Text 255 false
Secure ("https://") location of a logo image to use for the Vendor on the event website (if applicable) and/or printed materials related to the event.
EventApi__Number_of_Rooms__c Number of Rooms Number false
The number of rooms for the hotel.
EventApi__Phone__c Phone Phone false
** System Calculated Override ** Contact phone for the Vendor. Derived from the related Primary Contact if defined.
EventApi__Postal_Code__c Zip/Postal Code Text 255 false
The zip or postal code used to send payment.
EventApi__Preferred_Vendor__c Preferred Vendor Checkbox false
When checked, the Vendor should be considered the "Preffered Vendor". Best practice would be to limit the "Preffered Vendor" attribute to one Vendor per Vendor Category defined for an Event. Defaults unchecked.
EventApi__Room_Rates_Description__c Room Rate(s) Description TextArea false
Describe the rates and room options for the hotel.
EventApi__Single_Room_Rate__c Single Room Rate Currency false
Estimated daily rate for a single room at the hotel.
EventApi__Special_Discount_Information__c Special Discount Information LongTextArea 1000 false
Describe any event discounts the vendor is offering as a special/promotion for event attendees.
EventApi__Standard_Suite_Rate__c Standard Suite Rate Currency false
Estimated daily rate for a standard suite at the hotel.
EventApi__State__c State/Province Text 255 false
Enter the state or province used to send payment.
EventApi__Street__c Street TextArea false
The mailing street address used to send payment.
EventApi__Type__c Type Picklist false
** Required ** The Type of Vendor is used to categorize and plan for an Event's Budget.
EventApi__Vendor_Number__c Vendor Number Text 255 false
** Unique Case Insensitive ** Enter a code for the vendor for batch expense entry.
EventApi__Walking_Distance_Event__c Walking Distance to Event Checkbox false
Check the box if the hotel is within walking distance to the event.

EventApi__Venue__c

Venue
Manage Event Locations and Venues.

Custom Fields

API Name Label Type Length Required
Description
EventApi__City__c City Text 255 false
The physical address (city) for the venue.
EventApi__Description__c DEPRECATED LongTextArea 32768 false
Optional description for the Venue.
EventApi__Display_Map__c Display Map Checkbox false
When checked and the venue address is entered, displays a Google map on the event page as part of the venue information.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to the related event.
EventApi__Image_URL__c Image URL Url false
Image displays with the venue information.
EventApi__Is_Primary_Venue__c Is Primary Venue Checkbox false
When checked, the venue is displayed first.
EventApi__HTML_Description__c Description Html 32768 false
Optional description for the Venue.
EventApi__Phone__c Phone Phone false
The displayed phone number for the venue.
EventApi__Postal_Code__c Zip/Postal Code Text 255 false
The physical address (postal code) for the venue.
EventApi__State__c State/Province Text 255 false
The physical address (state/province/county) for the venue.
EventApi__Street__c Street Text 255 false
The physical street address for the venue.
EventApi__Country__c Country Text 255 false
The country where the venue is located.
EventApi__Website__c Website Url false
The displayed website for the venue.

EventApi__Waitlist_Entry__c

Waitlist Entry
Waitlist Entry store the Contact Information for people who want to be notified when any available ticket/registrations become open either for a Event or a Schedule Item at an Event.

Custom Fields

API Name Label Type Length Required
Description
EventApi__Contact__c Contact LookupEventApi__Contact false
** System Calculated Override ** Link to related Contact. Derived from email fields matching a Contact record through query.
EventApi__Date_Added__c Date Added Date false
** System Calculated Required Override ** The date the Waitlist Entry was added. Defaults to the day the record was created in the database.
EventApi__Email__c Email Email false
** System Calculated Required Override ** Email address to send related notifications to the Waitlist Contact. Derives from the linked Contact's "Preferred Email" address.
EventApi__Event__c Event LookupEventApi__Event__c false
** Conditionally Required ** Link to related Event. Required for "Event" Waitlist Entries.
EventApi__Full_Name__c Full Name Text 255 false
Displayed on Event Registration UI to allow registrant to input their name.
EventApi__Is_Registered__c Is Registered Checkbox false
Waitlist Entries that have registered for the Event or Schedule Item successfully after notification will have this checkbox checked automatically.
EventApi__Message__c Message LongTextArea 32768 false
Optional message that can be populated by the Waitlist Contact on Waitlist opt-in pages.
EventApi__Notification_Sent__c Notification Sent Checkbox false
When checked, the Waitlist Entry has been notified of tickets becoming available.
EventApi__Notified_Date_Time__c Notified Date/Time DateTime false
** System Calculated ** The date and time the Waitlist Entry was notified of availability.
EventApi__Other_Phone__c Other Phone Phone false
Optional alternate phone for the Waitlist Contact.
EventApi__Phone__c Phone Phone false
** System Calculated Required Override ** Primary Contact Phone. Derives from the linked Contact's "Preferred Phone".
EventApi__Priority__c Priority Picklist false
The priority of a Waitlist Entry determines who the system will notify first when tickets become available. Defaults "Medium".
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c false
** Conditionally Required ** Link to related Schedule Item. Required for "Schedule Item" Waitlist Entries.
EventApi__Status__c Status Picklist false
The current status of the Waitlist Entry. Defaults to "Waiting".
EventApi__Quantity_Requested__c Quantity Requested Number false
The number of tickets requested for purchase.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
** Conditionally Required ** Link to related Ticket Type. Required for "Ticket Type" Waitlist Entries.
LightningLens__Sales_Order__c SYSTEM LookupOrderApi__Sales_Order__c false
Linked the to related Sales Order.

Framework

API Name Categories Value
API Admin API
API_Documentation Admin API Documentation
API_Documentation_Description Admin I/O documents for Spark, including an example API Service integration with Twitter.
API_Endpoint Admin Endpoint
API_Field_API_Resource Admin API Field
API_Grouping Admin API Grouping
API_Groupings Admin API Groupings
API_Mapping Admin API Mapping
API_Mappings Admin API Mappings
API_Object Admin API Object
API_Object_Key_Field Admin API Object Key Field
API_Resource Admin API Resource
API_Resource_Api_Object Admin API Object
API_Resource_Api_Object_Key Admin API Object External ID
API_Resource_Name Admin API Resource Name
API_Resource_Target_SObject Admin Target Custom Object
API_Resource_Target_SObject_Key Admin Custom Object External ID
API_Resources Admin API Resources
API_Service API, Admin API Service
API_Service_ApexClass Admin Vendor Auth Apex Class
API_Service_AuthType Admin Auth Type
API_Service_Connection Admin API Service Connection
API_Service_Connection_Config Admin API Service Connection Config
API_Service_Connection_Configs Admin API Service Connection Configs
API_Service_Connections Admin API Service Connections
API_Service_Description Admin Manage API services, resources, and mappings. Connect external systems through configuration not code.
API_Service_Key Admin API Service Key
API_Service_Name Admin Display Name
API_Services Admin API Services
API_Variable Admin API Variable
API_Variables Admin API Variables
Access_Manager Admin Access Manager
Access_Manager_Description Admin Fix problems caused by Field Level Security, Apex Class Access, Visualforce Page Access, and CRUD permissions
Action Admin Action
Action_API_Resource Admin Action
Action_Applications Admin Action
Actions admin_rollups Actions
Activate admin_app Activate
Active Admin Active
Active_Applications Admin Active
Add Admin Add
Add_API_Resource Admin Add API Resource
Add_Header_Var Admin Add Header Var
Address_City address City
Address_Country address Country
Address_Enter_Manual_Address address Enter Address Manually
Address_Postal_Code address Zip Code
Address_Province address State
Address_Street address Street
Admin_MDAPI_Inspector Admin Metadata Inspector
Admin_MDAPI_RemoteSiteSetup Admin Remote Site Setup for Metadata API Access
Admin_MDAPI_Tools Admin Metadata Tools
Admin_Rollups_Description admin_rollups Description
Admin_Rollups_Run admin_rollups Run
Apex_Class Admin Apex Class
Apex_Component Admin Apex Component
Api_Router_Error_Message_Key framework_api_router message
App Admin App
Application_Analytics Admin Application Analytics
Application_Analytics_Description Admin Monitor and report on the performance and usage of any Framework app installed in your environment.
Apps Admin Apps
Apps_Description Admin Manage all Framework registered apps and associated configurations, services, and licenses.
Are_You_Sure framework_config Are You Sure?
Auth_Type Admin Auth Type
Authentication_Service Admin Authentication Service
Authorization_Code_URL Admin Authorization Code URL
Back Admin Back
Batched admin_rollups Batched
Browse file_upload Browse
Cancel Admin Cancel
Cannot_Instantiate_Api_Router_Class framework_api_router Cannot Instantiate Api Router Class
Child_Batch_Scope Admin Child Batch Scope
Child_Field Admin Child Field
Child_SObject Admin Child SObject
Clear Admin Clear
Clear_All_Button_Routing_Rules Admin Clear All Configurations
Clear_All_Configurations Admin Clear All Configurations
Clear_All_Configurations_Description Admin Clearing the configurations will cause applications running on Spark Framework to fail. Are you sure you want to clear all configurations?
Clear_Prompt_Header_Routing_Rules Admin Clear All Configurations?
Clear_Prompt_Message_Routing_Rules Admin Clearing the configurations will cause applications running on Spark Framework to fail. Are you sure you want to clear all configurations?
Client_ID Admin Client ID
Client_Secret Admin Client Secret
Close Admin Close
Configuration Admin Configuration
Configurations Admin Configurations
Configure Admin Configure
Connect Admin Connect
Connection_Name Admin Connection Name
Core_Config Admin Core Config
Create Admin Create
Create_URI Admin Create URI
Create_URI_Verb Admin Create URI Verb
Critical_Updates_Applications Admin Critical Updates
Custom_Domain Admin Custom Domain
Custom_Scripts Admin Custom Scripts
Custom_Scripts_Applications Admin Custom Scripts
Dashboard Admin Dashboard
Debug_Mode Admin Debug Mode
Del Admin Del
Delete Admin Delete
Delete_API_Mapping_API_Resource Admin Delete API Mapping
Delete_API_Mapping_Description_API_Resource Admin Would you like to delete the Api Mapping?
Delete_API_Variable_API_Resource Admin Delete API Variable
Delete_API_Variable_Description_API_Resource Admin Would you like to delete the Api Variable?
Delete_Config_Alert_Description framework_config This will delete all of the Framework configurations
Delete_Confirmation_Message Admin Are you sure you want to delete this Event?
Delete_URI Admin Delete URI
Delete_URI_Verb Admin Delete URI Verb
Deploy Admin Deploy
Description Admin Description
Description_Applications Admin Description
Description_Routing_Rules Admin Routing rules control the behavior of how the system routes logic for processing when objects are inserted, updated, and deleted from the database. Routing rules can be created to extend the behavior of out-of-the-box MemberNation functionality, or turned off all together.
Diagnostics Admin Diagnostics
Disable Admin Disable
Disabled Admin Disabled
Dismiss admin_app Dismiss
Dismissed admin_app Dismissed
Dismissed_Applications Admin Dismissed
Dispatch_Header_Variable Admin Dispatch Header Variable
Dispatch_Object Admin Dispatch Object
Dispatch_Objects Admin Dispatch Objects
Dispatcher_Blocked_Execution_Message_Prefix system messages The current user does not have permission to
Dispatcher_Blocked_Execution_Message_Suffix system messages records.
Dispatcher_Header_Variables Admin Dispatcher Header Variables
Display_Name Admin Display Name
Edit Admin Edit
Edit_API_Resource Admin Edit
Enable Admin Enable
Enable_Async_Rollups Admin Enable Async Rollups
Enable_Batching Admin Enable Batching
Enabled admin_rollups Enabled
Endpoint Admin Endpoint
ErrorAccessDenied Error Messages Access denied! You do not have permission to access this feature.
ErrorAppDisabled Error Messages A registered app that controls some or all of the operation you requested is currently disabled. Contact an administrator for support.
ErrorBadHTTPCall Error Messages A non 200 HTTP response code was returned from vendor webservice. Please contact your administrator for support.
ErrorCoreDisabled Error Messages Fonteva core services are currently disabled. Contact your administrator for support.
ErrorDatabaseSecurity Error Messages You do not have permission to perform this operation.
ErrorFieldLevelSecurity Error Messages Error! You do not have permission to access this field. Contact your administrator for support.
ErrorGovernorLimit Error Messages The system has met or exceeded a limit related to the operation you requested.
ErrorInvalidArgument Error Messages Invalid Argument passed into method
ErrorInvalidJSON Error Messages The JSON provided was invalid and could not be parsed. Please check the JSON to make sure it is of valid format.
ErrorNoResultsFound Error Messages No results found!
ErrorObjectDisabled Error Messages Disabled registered objects were sent for update or insert in your requested operation. Please contact your administrator for support.
ErrorRecordAccess Error Messages You do not have permission to access this record. Please contact your administrator for support.
ErrorTrialExpired Error Messages Your trial has expired, to continue using this feature contact your administrator and request license(s) to be purchased.
ErrorTriggersDisabled Error Messages Warning! Triggers are currently disabled. Performing this operation may cause unexpected results. If you have questions, contact your administrator for support.
ErrorUnregisteredApp Error Messages Unregistered application! You must register all apps that use the Fonteva API.
ErrorUnregisteredObject Error Messages Unregistered object! All custom or standard objects using the Fonteva API must be registered with Fonteva Services (via API) prior to use.
Execution_Order Admin Execution Order
Extend Admin Extend
Field_API_Name_API_Resource Admin Field API Name
Field_API_Value_API_Resource Admin Field API Value
File_Upload_Placeholder file_upload Browse for files or paste in a URL
Filter Admin Filter
Fonteva_Description Admin Fonteva's corporate website with information on products and solutions, news and events, and the Fonteva blog.
Fonteva_URL Admin Fonteva.com
Found Admin Found
Framework Admin Framework
FrameworkAdmin Admin Admin
Framework_Admin Admin Framework Admin
Framework_Settings_Description Admin Enable and disable Framework services by User, Profile, or for all Users in your environment.
FreeCurrencyValue Currency Free
HTTP_Method_For_Token Admin HTTP Method To Get Token
Header_Vars Admin Header Vars
Help Admin Help
Help_API_Endpoint Admin, Help Text The base endpoint for the API Service, used by default for all connections and resources that are linked to this service.
Help_API_Service_Key Admin, Help Text Unique alpha-numeric key for the api service.
Help_API_Service_Name Admin, Help Text User friendly name for the API Service - as it would appear to end users.
Help_Registered_App Admin, Help Text All Framework configurations are linked to a registered app. Select the app from the picklist that you would like to link the configuration too.
Help_Resources_Description Admin Access Framework API documentation, user guides, and support resources.
Hide_Active_Dismissed_Applications Admin Hide Active & Dismissed
Http_Verb Admin Http Verb
Icon_Image_URL Admin Icon Image URL
Install_Successfully_Run admin_app Package Installed Sucessfully
Is_Default Admin Is Default
Is_Enabled Admin Is Enabled
Is_Header Admin Is Header
Is_Managed Admin Is Managed
Is_Masked Admin Is Masked
Is_Token_Variable Admin Is Token Variable
Is_Variable Admin Is Variable
Key Admin Key
Label Admin Label
Label_Registered_App Admin Registered App
License_Usage Admin License Usage
Location Admin Location
Login Admin Login
Login_Dialog_URL Admin Login Dialog URL
Marketplace Admin Marketplace
MarketplaceMaintanencePagelabel1 Admin Marketplace is down for maintenance.
MarketplaceMaintanencePagelabel2 Admin Please check back later.
Marketplace_Description Admin Click to install any Framework app in the Framework Marketplace
Mission_Control Admin Mission Control
Multidrag_Error_HasMore Admin Group "{0}" has {1} more item(s) than allowed
Multidrag_Error_Required Admin Group "{0}" needs at least {1} item(s) to be added
Name admin_rollups Name
Name_Applications Admin Name
Namespace Admin Namespace
New Admin New
New_API_Mapping_API_Resource Admin New API Mapping
New_API_Service Admin New API Service
New_API_Variable_API_Resource Admin New API Variable
New_Object Admin New Object
New_Rollup_Summary_Fields Admin New Rollup Summary Fields
New_Routing_Rule_Button_Routing_Rules Admin New Routing Rule
Next Admin Next
No Admin No
Objects Admin Objects
Objects_Description Admin Manage custom objects registered with the Framework in your environment.
Online_Help Admin Online Help
Online_Help_Description Admin Comprehensive user and administrator documentation for all Fonteva apps.
Online_Helper Admin Online Helper
Operation Admin Operation
Parent_Batch_Scope Admin Parent Batch Scope
Parent_Field Admin Parent Field
Parent_SObject Admin Parent SObject
Password Admin Password
Please_Select_Dependent_Picklist dependent_picklist -- Please Select --
Please_select_the_API_Resource Admin Please select the API Resource
Preferences Admin Preferences
Quick_Links Admin Quick Links
Read_URI Admin Read URI
Read_URI_Verb Admin Read URI Verb
Refresh_Token_URL Admin Refresh Token URL
Registered_App Admin, Help Text Registered App
Registered_Apps Admin Registered Apps
Registered_Objects Admin Registered Objects
Relationship_Field Admin Relationship Field
Remove Admin Delete
Remove_API_Resource Admin Remove
Request_Token_URL Admin Request Token URL
Resources Admin Resources
Rich_Text_Source_Header rich_text Source Editor
Rich_Text_Upload_Image rich_text Image
Rich_Text_Upload_Image_Header rich_text Upload Image
Rich_Text_Upload_Image_Height rich_text Height
Rich_Text_Upload_Image_Width rich_text Width
Rollup_Summary_Field Admin Rollup Summary Field
Rollup_Summary_Fields Admin Rollup Summary Fields
Rollup_Summary_Fields_Description Admin Configure fields to aggregate data (Sum, Min, Max, Avg, and Count) from child objects through lookup relationships.
Routing_Rules Admin Routing Rules
Routing_Rules_Description Admin Configure logic processing and dispatch services for Framework objects.
Run Admin Run
SOQL_Limit Admin SOQL Limit
SObject_Name Admin SObject Name
Save Admin Save
Scope Admin Scope
Script_Successfully_Run admin_app Script has run successfully.
Select_None Admin -- None --
Services Admin Services
Settings Admin Settings
Settings_Pages Admin Settings Pages
Settings_Pages_Applications Admin Settings Pages
Setup_Object_API_Resource Admin Setup Object
Status_Applications Admin Status
Success admin_app Success
Summary Admin Summary
System_Logs Admin System Logs
Target_Field_API_Resource Admin Target Field
Target_Related_Lookup_Field Admin Target Related Lookup Field
Target_SObject Admin Target SObject
Target_SObject_Key_Field Admin Target SObject Key Field
Token_Order Admin Token Order
Tools Admin Tools
Trigger_Insert_Descriptor system messages insert
Trigger_Update_Descriptor system messages update
Triggers_Enabled Admin Triggers Enabled
URI_Mapping_API_Resource Admin URI Mapping
Update_URI Admin Update URI
Update_URI_Verb Admin Update URI Verb
Uploading_File_Upload file_upload Uploading...
Username Admin Username
Validation_Disabled Admin Validation Disabled
Value Admin Value
View_All Admin View All
WarningUnregisteredApp Warning Messages Unregistered App! No registered app configuration found for this object in Framework.
WarningUnregisteredObject Warning Messages Unregistered Object Sent for Dispatch! You must register all custom and standard objects prior to using them with the Framework!

PagesApi

API Name Categories Value
Add labels Add
Advanced_Settings common,misc,theme Advanced Settings
Allow_Delete_Mapped_Records Members Allow Users to Delete Mapped Records
Allow_Multiple_Entries Members Allow Multiple Entries
Attachment_Form_Validation_Message form Attachment Too Large. Must be less than 25 Mb.
Available_Components page builder Available_Components
Back_Label form Back
Back_To_Login social_login Back To Login
Body_Background_Color theme Body Background
Brand_Primary theme Brand Primary
Brand_Secondary theme Brand Secondary
Branding common,misc,theme Branding
Browser_Not_Supported portal_browser Please upgrade your browser
Browser_Not_Supported_Message portal_browser Unfortunately, your browser doesn't support the technologies we use for our pages. Download one of these browsers and you will be up to speed.
CSS common,misc,theme CSS
Calendar_Config_calendarInput_Description calendar,component descriptions ** Required ** List of CalendarInput Type data to render on Calendar
Calendar_Config_calendarInput_Label calendar,component labels Calendar Input
Calendar_Config_calendarStyleClass_Description calendar,component descriptions ** Optional ** The StyleClass for the Calendar
Calendar_Config_calendarStyleClass_Label calendar,component labels Calendar Styleclass
Calendar_Config_calendarType_Description calendar,component descriptions ** Optional ** - The type of calendar Default is full.
Calendar_Config_calendarType_Label calendar,component labels Calendar Type.
Calendar_Config_clickable_Description calendar,component descriptions ** Optional ** If the list is clickable
Calendar_Config_clickable_Label calendar,component labels Is Clickable?
Calendar_Config_contentHeight_Description calendar,component descriptions ** Optional ** The ContentHeight of the Calendar Component
Calendar_Config_contentHeight_Label calendar,component labels Content Height
Calendar_Config_height_Description calendar,component descriptions ** Optional ** The Height of the Calendar Component
Calendar_Config_height_Label calendar,component labels Height
Calendar_Config_pageTitle_Description calendar,component descriptions ** Optional ** The page title that will be displayed on the Calendar
Calendar_Config_pageTitle_Label calendar,component labels Page Totle
Calendar_Config_styleClass_Description calendar,component descriptions ** Optional ** The Styleclass for the Calendar Div
Calendar_Config_styleClass_Label calendar,component labels Style Class
Calendar_Config_width_Description calendar,component descriptions ** Optional ** The Width of the Calendar Component
Calendar_Config_width_Label calendar,component labels Width
Cancel misc Cancel
Cancel_Theme_Builder Theme_Builder Cancel
Cannot_Insert_Community_Group_Member Community_Group A active community group member with the same contact already exists.
Cannot_Publish_without_valid_Site Community_Group You cannot publish the group without a valid site.
Cannot_Show_without_Roster_Link media asset, admin Please fill in Group Roster Link and Label before showing it to the public.
Cannot_Update_Contact Community_Group You cannot update Contact lookup.If you would like to change the contact please delete and create a new one.
Cannot_Update_Group_Owner media asset, admin Group owner has to be a community group member.
Cannot_Update_Site Community_Group You cannot update the site. you can delete the group and add it to the corresponding site.
Cannot_Update_User Community_Group You cannot update User lookup.If you like to change the user update the contact.
Carousel_Config_assetsPerRow_Description Carousel, Component Description ** Required ** The Assets per Row. Default is 2
Carousel_Config_assetsPerRow_Label Carousel, Component Description Select Assets per a Row
Carousel_Config_assets_Description Carousel, Component Description ** Required ** The Media Asset Records.
Carousel_Config_assets_Label Carousel, Component Description Select the Media Asset Records
Carousel_Config_collectionId_Description Carousel, Component Description ** Required ** The Media Collection Record.
Carousel_Config_collectionId_Label Carousel, Component Label Select Media Collection Record
Carousel_Config_styleClass_Description Carousel, Component Description ** Optional ** Carousel Style Class.
Carousel_Config_styleClass_Label Carousel, Component Description The StyleClass for Carousel
Carousel_Config_title_Description Carousel, Component Description ** Optional ** The Carousel Title.
Carousel_Config_title_Label Carousel, Component Description Enter the title
Characters_Remaining_Max media asset, admin Maximum Characters
Characters_Remaining_Prefix media asset, admin You have
Characters_Remaining_Suffix media asset, admin characters left.
Chrome_Browser_Name portal_browser Chrome
Clear_Destinations_Button theme Clear Destinations
Close media asset, admin Close
Color_Scheme common,misc,theme Color Scheme
Comment Feed component Comment
Communities common Communities
Community_Builder common Community Builder
Community_Group_Name_Unique form Community Group Name should be unique.
Community_Not_Found site Community Not Found
Configuration_Options Page Element Settings
Confirmation_Message page builder Are you sure?
Contact_System_Admin_Login_Failed social_login Please Contact System Administrator.
Create_User_Account_Override_Button override_login Create User Account
Custom common,misc,theme Custom
CustomHTML_Config_html_Description CustomHTML, Component Description ** Required ** Custom HTML
CustomHTML_Config_html_Label CustomHTML, Component Description Enter Custom HTML
CustomHTML_Config_layout_Description CustomHTML, Component Description ** Optional ** Default is Block
CustomHTML_Config_layout_Label CustomHTML, Component Description Choose the Layout
CustomHTML_Config_styleClass_Description CustomHTML, Component Description ** Optional ** Styleclass for Custom HTML
CustomHTML_Config_styleClass_Label CustomHTML, Component Description Styleclass for Custom HTML
Custom_CSS theme Custom CSS
Custom_HTML_Default_Value CustomHTML, Component <p>Sample HTML for Custom Component</p>
Custom_Print_Stylesheet_URL theme Custom Print Stylesheet URL
Custom_Stylesheet_URL theme Custom Stylesheet URL
Database_Options Members Database Options
Datatable_Config_DefaultPageSize_Description datatable,component descriptions The number of records rendered in the body of the table by default is 10.
Datatable_Config_DefaultPageSize_Label datatable,component descriptions Default Page size.
Datatable_Config_FieldCSV_Description datatable,component descriptions ** Conditionally Required ** Fully qualified api name of the custom or standard fields you wish to display in the datatable. Each field should be separated by one comma and a space. If no Field Set Name configuration is given, this configuration is required in order to render the datatable correctly.
Datatable_Config_FieldCSV_Label datatable,component labels Comma Separated Fields.
Datatable_Config_FieldSetName_Description datatable,component descriptions ** Conditionally Required ** If fieldCSV is not defined use a Field Set to define the columns of the datatable.
Datatable_Config_FieldSetName_Label datatable,component label The Field Set name for the Datatable
Datatable_Config_PanelStyle_Description datatable,component descriptions Valid values include primary, warning, info, danger, and default. Based on Bootstrap 3 panel components.
Datatable_Config_PanelStyle_Label datatable,component descriptions Panel Style
Datatable_Config_SObjectName_Description datatable,component descriptions ** Required ** Fully qualified api name for the custom or standard object you wish to use as the subject for the datatable.
Datatable_Config_SObjectName_Label datatable,component label Name of the Object
Datatable_Config_Searchable_Description datatable,component descriptions Select true to enable users to search through the results, otherwise select false.
Datatable_Config_Searchable_Label datatable,component labels Enable Search
Datatable_Config_StyleClass_Description datatable,component descriptions CSS class to add to the outer-most html div element in the component.
Datatable_Config_StyleClass_Label datatable,component label Style class for outer div
Datatable_Config_TableHeading_Description datatable,component descriptions Optional title for the panel that renders around the datatable.
Datatable_Config_TableHeading_Label datatable,component label Table Heading
Datatable_Config_TableStyleClass_Description datatable,component descriptions CSS class to add to the html table element that renders inside the component.
Datatable_Config_TableStyleClass_Label datatable,component labels Table Style class
Delete misc Delete
Description theme Description
Detail_Config_StyleClass_Description detail, Component Description ** Optional ** The Adhoc Styleclass for the outer div
Detail_Config_StyleClass_Label detail, Component Labels Style Class
Detail_Config_columnsPerRow_Description detail, Component Description ** Required ** Number of columns per row
Detail_Config_columnsPerRow_Label detail, Component Labels Number of Columns per Row
Detail_Config_editable_Description detail, Component Description ** Optional ** If the detail page is editable
Detail_Config_editable_Label detail, Component Labels Is Editable?
Detail_Config_fieldSetNamesCSV_Description detail, Component Description ** Conditionally Required ** List of (or one) Field Set (s) to show up on detail page in the CSV Format.
Detail_Config_fieldSetNamesCSV_Label detail, Component Labels CSV format Field Set Names
Detail_Config_fieldSetNames_Description detail, Component Description ** Required ** List of (or one) Field Set (s) to show up on detail page
Detail_Config_fieldSetNames_Label detail, Component Labels List of Field Set Names
Detail_Config_onSaveComplete_Description detail, Component Description ** Optional ** Javascript to execute onSaveComplete
Detail_Config_onSaveComplete_Label detail, Component Labels Javascript method to execute on Save
Detail_Config_onSubmit_Description detail, Component Description ** Optional ** Javascript to execute on Form Submit
Detail_Config_onSubmit_Label detail, Component Labels Javascript method to execute on submit
Detail_Config_subjectId_Description detail, Component Description ** Required ** Record Id of the Sobject
Detail_Config_subjectId_Label detail, Component Labels Record Id
Details common,misc Details
Edit page builder Edit
Entity_type_cannot_be_changed Entity of the group having members cannot be changed.
Error_Fieldset_Not_Provided groups Fieldset Name provided is not found
Error_Retrieving_Groups groups Error retrieving the groups
Error_Search_has_atleast_two_Chars form builder Search text must have a minimum of two characters.
Exit form Exit
Favicon_URL Members Favicon URL
Field_Required site This field is required.
File Feed component File
File_Upload media asset, admin 2. File Upload
Filters_Applied_Label groups Filters Applied
Firefox_Browser_Name portal_browser Firefox
Fonteva_Controller_Loading fonteva_controller Loading...
Footer theme Footer
Form_Add_Response_Button_Label form builder Add Entry
Form_Builder form builder Form Builder
Form_Builder_Heading theme Form Builder
Form_Builder_Page_Title Admin, Form Builder Form Builder
Form_Close_Response_Button_Label form builder Close
Form_Hidden_Value_Invalid_Format_Message form Invalid format for hidden field variable!
Form_Response_Table_Action_Column_Label form builder Action
Form_Response_Table_Empty_Message form builder No Entries Found
Form_Return_To_Form_Button_Label form Go back to Form
Form_Submit_Success_Message form Your form was successfully submitted!
GroupMembers_Config_Searchable groups Searchable
GroupMembers_Config_Searchable_Description groups If the component is searchable.
GroupMembers_Config_SubjectId groups SubjectId
GroupMembers_Config_SubjectId_Description groups Id of the parent record id with which the search has to be filetered.
GroupMembers_Config_defaultpagesize groups Default Page Size
GroupMembers_Config_defaultpagesize_Description groups ** Optional ** The page size of a table.
GroupMembers_Config_defaultsortfield groups Default Sort Field
GroupMembers_Config_defaultsortfield_Description groups ** Optional ** The Sort field for members.
GroupMembers_Config_defaultsortorder groups Default Sort Order
GroupMembers_Config_defaultsortorder_Description groups ** Optional ** The Sort Order for members.
GroupMembers_Config_descriptionFieldsCSV groups Description Fields CSV
GroupMembers_Config_descriptionFieldsCSV_Description groups ** Optional ** The fields displayed on the detail view.
GroupMembers_Config_filterfieldset groups Filter Field Set
GroupMembers_Config_filterfieldset_Description groups Fieldset which has the list of fields used for filters.
GroupMembers_Config_imageField groups Image field
GroupMembers_Config_imageField_Description groups ** Optional ** The image field
GroupMembers_Config_modaldescriptionfieldcsv groups Modal Description Field CSV
GroupMembers_Config_modaldescriptionfieldcsv_Description groups Fields to be displayed in the modal popup.
GroupMembers_Config_modalsubtitlefield1 groups Modal Sub-Title Field1
GroupMembers_Config_modalsubtitlefield1_Description groups ** Optional ** The sub title field1 on modal.
GroupMembers_Config_modalsubtitlefield2 groups Modal Sub-Title Field2
GroupMembers_Config_modalsubtitlefield2_Description groups ** Optional ** The sub title field2 on modal.
GroupMembers_Config_modaltitlefield groups Modal Title Field
GroupMembers_Config_modaltitlefield_Description groups ** Optional ** The title field on modal.
GroupMembers_Config_no_results_found_message groups No Results Found Message
GroupMembers_Config_no_results_found_message_Description groups Message Displayed when no results are found.
GroupMembers_Config_showfilters groups Show Filters
GroupMembers_Config_showfilters_Description groups Shows the filters.
GroupMembers_Config_showmodalonclick groups Show Modal On Click
GroupMembers_Config_showmodalonclick_Description groups ** Optional ** Show the Modal when card is clicked.
GroupMembers_Config_titlefield groups Title field
GroupMembers_Config_titlefield_Description groups ** Optional ** The Table heading to be displayed.
Group_Owner_cannot_be_a_Member site Group Owner must have Is Manager checked.
Group_Plural_Label form builder Groups
Group_Singular_Label Groups Group
HTML_Head theme HTML Head
Header theme Header
IE_Browser_Name portal_browser Internet Explorer
IE_Browser_Version portal_browser IE 10+
Invalid_Banner_URL form Banner URL is invalid. Please provide valid url.
Invalid_Phone_Format form Invalid Phone Format
Invalid_Site_Id groups Site Id provided is not valid
Invalid_URL Community_Group Please enter a valid URL.
Javascript common,misc,theme Javascript
Like Feed component Like
Link theme Link
Listz_Config_descriptionFieldsCSV_Description List, Component Description ** Optional ** Select the fields that show up on the description as comma separated list
Listz_Config_descriptionFieldsCSV_Label List, Component Description Enter the Description fields
Listz_Config_detailStyleClass_Description List, Component Description ** Required ** detailStyleClass that needs to be displayed in the list
Listz_Config_detailStyleClass_Label List, Component Description Selected detailStyleClass for List
Listz_Config_filter_Description List, Component Description ** Required Conditionally ** The filter clause to filter the list records.
Listz_Config_filter_Label List, Component Label Filter Clause
Listz_Config_headerStyleClass_Description List, Component Description ** Required ** headerStyleClass that needs to be displayed in the list
Listz_Config_headerStyleClass_Label List, Component Description Selected headerStyleClass for List
Listz_Config_itemStyleClass_Description List, Component Description ** Required ** itemStyleClass that needs to be displayed in the list
Listz_Config_itemStyleClass_Label List, Component Description Selected itemStyleClass for List
Listz_Config_listStyleClass_Description List, Component Description ** Required ** listStyleClass that needs to be displayed in the list
Listz_Config_listStyleClass_Label List, Component Description Selected listStyleClass for List
Listz_Config_orderByFields_Description List, Component Description ** Optional ** The fields that are used to order the list
Listz_Config_orderByFields_Label List, Component Description The order by fields
Listz_Config_ordered_Description List, Component Description ** Optional ** List is ordered by default
Listz_Config_ordered_Label List, Component Description Is list Ordered?
Listz_Config_pageSize_Description List, Component Description ** Optional ** List Page size
Listz_Config_pageSize_Label List, Component Description Page Size
Listz_Config_recordLimit_Description List, Component Description ** Conditionally Required ** Limit the number of records to query
Listz_Config_recordLimit_Label List, Component Label Record Limit
Listz_Config_records_Description List, Component Description ** Required ** Records that needs to be displayed in the list
Listz_Config_records_Label List, Component Description Selected Records for List
Listz_Config_refStyleClass_Description List, Component Description ** Required ** refStyleClass that needs to be displayed in the list
Listz_Config_refStyleClass_Label List, Component Description Selected refStyleClass for List
Listz_Config_searchable_Description List, Component Description ** Optional ** Is the list Searchable default to true
Listz_Config_searchable_Label List, Component Description Is List Searchable?
Listz_Config_sobjectName_Description List, Component Description ** Required ** The object name for which the list must be displayed
Listz_Config_sobjectName_Label List, Component Label Object Name
Listz_Config_sortOrder_Description List, Component Description ** Optional ** sortOrder either ASC or DESC
Listz_Config_sortOrder_Label List, Component Description Select the Sorting Order
Listz_Config_styleClass_Description List, Component Description ** Required ** styleClass that needs to be displayed in the list
Listz_Config_styleClass_Label List, Component Description Selected styleClass for List
Listz_Config_titleField_Description List, Component Description ** Optional ** The title field for the list
Listz_Config_titleField_Label List, Component Description Select the Title Field
Login_Override_Button override_login Login
Logo common,misc,theme Logo
Logo_Destination_URL Members Logo Destination URL
Logo_Size_Type_Help common,misc,theme For best results, use a png or gif image no more than 300px in width and 135px in height. Currently SVG, JPG, PNG, and GIF file types are supported.
Logo_Text theme Logo Text
Logo_URL Members Logo URL
Logout Community Logout
Media_Asset_Action media_asset ACTION
Media_Asset_Copy_Url media_asset Copy URL
Media_Asset_Exit media_asset Exit
Media_Asset_Path media_asset Media Asset
Media_Asset_Short_Description media_asset Short Description
Media_Asset_Title media_asset Title
Media_Asset_Upload_To media_asset Upload Media Asset to
Media_Asset_Uploaded_File_Url media_asset UPLOADED FILE URL
Member_Plural Members Members
Member_Singular Members Member
Menu common Menu
Most_Reset_Stable_Version portal_browser Most Recent Stable Version
Name theme Name
NavList_Config_displayInPanel_Description NavList, Component Description ** Optional ** Brand Redirect
NavList_Config_displayInPanel_Label NavList, Component Label Displayed in Panel?
NavList_Config_elementStyleClass_Description NavList, Component Description ** Optional ** Brand Redirect
NavList_Config_elementStyleClass_Label NavList, Component Label Element Styleclass
NavList_Config_name_Description NavList, Component Description ** Optional ** Brand Redirect
NavList_Config_name_Label NavList, Component Label Name for Navlist
NavList_Config_panelType_Description NavList, Component Description ** Optional ** Brand Redirect
NavList_Config_panelType_Label NavList, Component Label Panel Type
NavList_Config_styleClass_Description NavList, Component Description ** Optional ** Brand Redirect
NavList_Config_styleClass_Label NavList, Component Label Styleclass
NavList_Config_title_Description NavList, Component Description ** Optional ** Brand Redirect
NavList_Config_title_Label NavList, Component Label Title for Navlist
NavList_Config_ulStyleClass_Description NavList, Component Description ** Optional ** Brand Redirect
NavList_Config_ulStyleClass_Label NavList, Component Label The List Styleclass
Navbar_Background_Color theme Navbar Background
Navbar_Config_brandLogo_Description Navbar, Component Description ** Optional ** Brand Logo
Navbar_Config_brandLogo_Label Navbar, Component Label Brand Logo URL
Navbar_Config_brandRedirect_Description Navbar, Component Description ** Optional ** Brand Redirect
Navbar_Config_brandRedirect_Label Navbar, Component Label Brand Redirect
Navbar_Config_brandTitle_Description Navbar, Component Description ** Optional ** The Brand Title
Navbar_Config_brandTitle_Label Navbar, Component Label Brand Title
Navbar_Config_name_Description Navbar, Component Description ** Required ** The name of the Navbar Menu
Navbar_Config_name_Label Navbar, Component Label Menu Name
Navbar_Config_navStyleClass_Description Navbar, Component Description ** Optional ** Nav Styleclass
Navbar_Config_navStyleClass_Label Navbar, Component Label Navbar Styleclass
Navbar_Config_styleClass_Description Navbar, Component Description ** Optional ** Styleclass
Navbar_Config_styleClass_Label Navbar, Component Label Menu Style class for Navbar
Navbar_Config_ulStyleClass_Description Navbar, Component Description ** Required ** refStyleClass that needs to be displayed in the list
Navbar_Config_ulStyleClass_Label Navbar, Component Label Unordered List Styleclass
Navbar_Link theme Navbar Link
New_Field Members New Field
New_Field_Group Members New Field Group
No_Collection_Found media_asset Media Asset Collection Not Found.
No_Preview_Available media_asset No Preview Available
Opera_Browser_Name portal_browser Opera
Page_Element_Builder page builder Page_Element_Builder
Percent_Form_Validation_Message form This value should be greater than or equal to 0.This value should be lower than or equal to 100.
Post Feed component Post
Preview misc Preview
Preview_Mode_Message_Body form Some features may not work as expected.
Preview_Mode_Message_Heading form You're currently in preview mode.
ProfileTabs_Config_fieldSetNamesCSV_Description ProfileTabs, Component Description **Required** The Field Set names
ProfileTabs_Config_fieldSetNamesCSV_Label ProfileTabs, Component Label Comma seperated Field Set names
ProfileTabs_Config_userId_Description ProfileTabs, Component Description **Required** User Id
ProfileTabs_Config_userId_Label ProfileTabs, Component Label User Id
Profile_Page_Link_Anchor site My Profile
Reference_Fields_Not_Supported form builder Reference Fields Not Currently Not Supported
Refresh misc Refresh
Remove labels Remove
Reply Feed component Reply
Reports labels Reports
Required_Field_Validation_Field_Type form Type is a required field!
Safari_Browser_Name portal_browser Safari
Safari_Browser_Version portal_browser 5.x+
Save misc Save
Save_And_Exit form Save & Exit
Save_Exit_Theme_Builder Theme_Builder Save & Exit
Save_Theme_Builder Theme_Builder Save
Select page builder Select
Selected_Page_Elements page builder Selected_Page_Elements
Share Feed component Share
Site_Cookie_Prompt_Accept cookie_prompt Accept
Site_Cookie_Prompt_Body cookie_prompt This site uses cookies to function. Please accept use of cookies to proceed.
Site_Cookie_Prompt_Decline cookie_prompt Decline
Site_Cookie_Prompt_Header cookie_prompt Accept Cookie Usage
Site_Cookie_Redirect_Url_Required cookie_prompt Site Cookie Redirect URL is required if cookie prompt is enabled
Site_Create_Button_Site_Wizard form Create Site
Site_Description_Site_Wizard form Site Description
Site_Name_Site_Wizard form Site Name
Site_Not_Found site Site Not Found
Site_Wizard_Confirm_Configurations_Instructions site wizard Review your setup and configuration selections for your new site and then click the create button.
Site_Wizard_Confirm_Configurations_Title site wizard Advanced Configuration Options
Site_Wizard_Error_Description site wizard We have experienced a problem creating your site. Please contact your administrator and inform them of the following system message:
Site_Wizard_Error_Title site wizard Error!
Site_Wizard_Failure_Description site wizard We have experienced a problem creating your site. Please contact your administrator and inform them of the following system message:
Site_Wizard_Failure_Title site wizard Failure!
Site_Wizard_Required_Field_Missing_Validation site wizard Required field missing.
Site_Wizard_Step_1_Instructions site wizard In order to create a new site, at least one Salesforce Community must be set up in your organization.
Site_Wizard_Step_1_Title site wizard Select a Salesforce Community
Site_Wizard_Step_2_Instructions site wizard Fonteva Sites can be created from scratch or from a template, select the option that best suits your needs from the list provided below.
Site_Wizard_Step_2_Title site wizard Choose a Template
Site_Wizard_Step_3_Instructions site wizard Enter a name (required), and description (optional), for your new site.
Site_Wizard_Step_3_Title site wizard Name your Site
Site_Wizard_Step_4_Instructions site wizard Fill out additional configurations for your site (optional).
Site_Wizard_Step_4_Title site wizard Advanced Configuration Options
Site_Wizard_Success_Description site wizard We are now creating your site. In a few moments you will be redirected to the site detail page.
Site_Wizard_Success_Title site wizard Success!
Site_Wizard_Title site wizard Site Setup
SkipLogic_Field_Label_Validation_Message misc Field Label is required for this field to be used as a destination for skip logic.
Skip_Logic_Button theme Skip Logic
Skip_Logic_Destination theme Destination
Skip_Logic_Modal_Header theme Skip Logic
Skip_Logic_Question theme Question
Skip_Logic_Warning theme This field has associated skip logic. Any changes made may affect the skip logic.
Social_Login_Failed social_login Login Failed
Submit_Button_Label form builder Submit
Supernav theme Supernav
Supernav_Background theme Supernav Background
Supernav_HTML_Position_1 theme Supernav HTML Position 1
Supernav_HTML_Position_2 theme Supernav HTML Position 2
Supernav_HTML_Position_3 theme Supernav HTML Position 3
Supernav_Link theme Supernav Link
Supernav_Login global,supernav Login
Supernav_Logout global,supernav Logout
Supernav_Register global,supernav Register
Supernav_Text theme Supernav Text
Text theme Text
Theme theme Theme
Theme_Name theme Theme Name
Theme_Not_Found base_component Could not query Theme.
Toggle_Navigation template Toggle Navigation
Unknown_Error_Login social_login Unknown Error Occurred During Login
Unlike Feed component Unlike
Upload media asset, admin Upload
UserProfilePhoto_Config_height_Description UserProfilePhoto, Component Label **Optional** Height of Profile Photo
UserProfilePhoto_Config_height_Label UserProfilePhoto, Component Label Height
UserProfilePhoto_Config_inputFileStyleClass_Description UserProfilePhoto, Component Label **Optional** InputFile Styleclass
UserProfilePhoto_Config_inputFileStyleClass_Label UserProfilePhoto, Component Label Input File Styleclass
UserProfilePhoto_Config_styleClass_Description UserProfilePhoto, Component Label **Optional** Styleclass
UserProfilePhoto_Config_styleClass_Label UserProfilePhoto, Component Label StyleClass
UserProfilePhoto_Config_userId_Description UserProfilePhoto, Component Label **Required** User Id
UserProfilePhoto_Config_userId_Label UserProfilePhoto, Component Label User Id
UserProfilePhoto_Config_width_Description UserProfilePhoto, Component Label **Optional** Default is auto. Width of the Profile Photo
UserProfilePhoto_Config_width_Label UserProfilePhoto, Component Label Width of the Profile Photo
User_Not_Found_Query base_component Could not query user. Please contact System Administrator
Validation_Filters_Required_Group groups You must populate the Member Search Filter Fields (CSV) field prior to enabling search filters.
Validation_Filters_Required_Site groups You must populate the Group Search Filters (CSV) field prior to enabling search filters.
Validation_Group_Search_Results_Greater_Than_zero media_asset Group search results should be greater than zero.
Validation_Invalid_group_Fields form builder An API name provided in this field is not a valid field for the Community Group custom object. Please ensure that the field name is spelled correctly and is a valid field in the object.
Validation_Invalid_group_member_FieldSets form builder An API name provided in this field is not a valid Field Set for the Community Group Member object. Please ensure that the field name is spelled correctly and is a valid Field Set (without Namespace) in the object.
Validation_Invalid_group_member_Fields form builder An API name provided in this field is not a valid field for the Community Group Member object. Please ensure that the field name is spelled correctly and is a valid field in the object.
Validation_Published_Site_Theme_Required theme Theme required when publishing Site
Validation_Site_Community_Network_Name_Required_Field calendar,component descriptions Community Network Name is required.
Validation_only_accounts_Allowed social_login Only a group member of type account is required.
Validation_only_contacts_Allowed social_login Only a group member of type contact is required.
Validation_only_groups_Allowed social_login Only a group member of type group is required.
View common,misc View
feed_default_text groups What are you working on?
feed_file_default_text groups Say Something
feed_load_more_comments groups Load More
feed_load_more_comments_with_number groups load all {0} comments
feed_load_more_feeds groups Load More
groupmembers_error form builder Error retrieving the group members.
load_more groups Load More
no_results_found_message groups No Results returned.
please_wait groups Please Wait..
please_wait_message groups Fetching Search Results
search_placeholder groups Search...
success groups Success
success_message groups Your Search Results

OrderApi

API Name Categories Value
ACD_Validation invoice write_off validation You can not set Advanced Calendar fields for Termed type Subscription Plan
AVS_Configuration payment_gateway AVS Configuration
Access_Benefits_Login validation to access your benefits
Access_Permissions_Drag_Drop_Label access_permissions Drag groups to the right to enable access
Access_Permissions_First_List_Label access_permissions Restrict Access
Access_Permissions_For access_permissions Access Permissions for
Access_Permissions_Second_List_Label Access_Permissions_Second_List_Label Enable Access
Account_Contact_Preferences admin_app_config Account & Contact Preferences
Account_Holder_Name epayments Account Holder Name
Accounting_Preferences admin_app_config Accounting Preferences
Add misc, common Add
Add_Rule backend + Add Rule
Address_Missing checkout Please enter a complete shipping address.
Address_Optional known_address Address is optional.
Adjustment_Invoice_lines_Readjusted proforma Adjustment invoice lines cannot be readjusted.
Alteast_One_Warning Please select at least one catalog item
Amount_Paid invoice_payment Amount Paid
App_Preferences epayments App Preferences
Apply_Credit_To_Payment_Invoice_Payment invoice_payment Apply Credit to Payment
Apply_Credit_to_Payment customer_look_up Apply Credit to Payment
Apply_Discount_Code Discount,Checkout Apply
Apply_Payment invoice_payment Apply Payment
Apply_Payment_Invoice_Payment invoice_payment Apply
Apply_Sales_Order sales_order Apply
Attempt_3ds epayments Enable 3D Secure
Available_Credit customer_look_up Available Credit
Available_Credit_Invoice_Payment invoice_payment Available Credit
Available_Items backend Available Items
Badge_ACCOUNT_Label contact_badges Account
Badge_AWARDED_Label contact_badges Awarded
Badge_Action_Label contact_badges Action
Badge_Badges_Label contact_badges Badges
Badge_Del_Label contact_badges Del
Badge_Direct_Label contact_badges Direct
Badge_ENGAGEMENT_SCORE_Label contact_badges Engagement Score
Badge_EXPIRES_Label contact_badges Expires
Badge_Edit_Label contact_badges Edit
Badge_Flowdown_Label contact_badges Flowdown
Badge_Go_Back_Label contact_badges Go Back
Badge_Inherited_Label contact_badges Inherited
Badge_NAME_Label contact_badges Name
Badge_New_Badge_Label contact_badges New Badge
Badge_Relationship_Label contact_badges Relationship
Badge_Type_Name_Validation contact_badges Badge Type Name cannot contain Comma Separated Values
Badge_View_All_Label contact_badges View All
Balance_Due_Invoice_Payment invoice_payment Balance Due
Batch_Amount_Closed_Posted_Validation batch expected amount validation The Expected Amount for the Batch does not match the Actual Amount. You may not close and post the batch until the Actual Amount and Expected Amount are equal to each other.
Batch_Count_Closed_Posted_Validation batch expected count validation The number of items entered for the Batch does not match the expected amount. You may not close and post the batch until the Actual Count and Expected Count are equal to each other.
Batch_Error_Receipt payment Whoops! Looks like you are attempting to save a RECEIPTNAME with invalid data. Please ensure all required fields are populated as well as at least 1 RECEIPTLINENAME.
Batch_Expected_Amount_Validation batch expected amount validation Expected amount should be positive.
Batch_Expected_Count_Validation batch expected count validation Expected count should be positive.
Batch_Invoice_Payment invoice_payment Batch
Batch_Modify_Closed_Validation batch expected closed validation You do not have permission to modify closed batches.
Bill_Cycle_Validation_Error subscription_plan This is an invalid value. This field takes in a value that's defined within the number of days available in any given month.
Bill_To misc,ebusiness Bill To
Bill_To_Invoice Invoice Bill To
Billing_Address epayment, ebusiness, common Billing Address
Billing_Address_CC ui elements, button labels, epayments, misc Billing Address
Billing_Address_Missing checkout Please enter a complete billing address.
Billing_To checkout Billing To
Billing_Zip ui elements, button labels, epayments, misc Billing Zip
Business epayments business
Business_Group_Invoice_Payment invoice_payment Business Group
Business_Group_Own_Site campaign page Error! Business Group must own at least one Site that is published and linked to a Store.
Business_Group_Required_For_Store campaign page Error! Business Group required if Store is provided
Business_Information_Label sales_order Business Information
Business_group_Label sales_order Business Group
Bypass_Address_Sync_HelpText spark_admin Unchecked, Spark Framework will automatically sync the Shipping Address for an Account into the Billing Address when the Billing Address is blank. Checking the box disables this behavior.
CSV_Invoice_Payment invoice_payment CSV
CVV ui elements, button labels, epayments, misc CVV
Campaign_Page_Component_Render_Error_Message campaign page Error! Unable to render component. No catalogs setup in your environment.
Campaign_Page_Title campaign page builder Campaign Page Builder
Cancel Action Labels, Common Cancel
Cancel_Button_Text Cancel.
Cancel_Package_Item Package_Item Cancel
Cancel_Payment_Gateway Payment_Gateway Cancel
Cancel_Plan backend Cancel
Cancel_Price_Rule price_rules Cancel
Cannot_Accept_3DS payment_methods Cannot Accept 3DS
Cannot_Accept_3DS_Message payment_methods 3DS enabled credit cards are not supported in the back office.
Cannot_Credit_Non_Paid_Invoices proforma There is not an Overpayment on the Invoice to credit the entity.
Cannot_De_Activate_Sub_Plan checkout_page A default Subscription plan cannot be disabled.
Cannot_Ship_Label Proforma Invoice No available shipping options.
Cannot_Update_Scheduled_Payment checkout You cannot update the amount for scheduled payment that is paying a Sales Order with a \'Receipt\' Posting Entity.
Card_Holder_Name ui elements, button labels, epayments, misc Card Holder Name
Card_Holder_Name_Invoice_Payment invoice_payment Card Holder Name
Card_Number ui elements, button labels, epayments, misc Card Number
Card_Number_Ending_In Receipt Card Number: Ending in
Card_Number_Invoice_Payment invoice_payment Card Number
Cart_Updated_Successfully Your cart has been successfully updated.
Catalog_Checkbox_Display_Config_MaxSelected_Description ui elements Max Checkbox Selected That Can To Be Selected
Catalog_Checkbox_Display_Config_MaxSelected_Label ui elements Max Checkbox Selected
Catalog_Checkbox_Display_Config_MinSelected_Description ui elements Min Checkbox Selected That Need To Be Selected
Catalog_Checkbox_Display_Config_MinSelected_Label ui elements Min Checkbox Selected
Catalog_Display_Config_Add_Cart_Description ui elements Button label for add to cart
Catalog_Display_Config_Add_Cart_Label ui elements Add To Cart Label
Catalog_Display_Config_Catalog_Description ui elements Catalog to show items for
Catalog_Display_Config_Catalog_Label ui elements Catalog
Catalog_Display_Config_ImageHeight_Description ui elements, catalogtile Enter Image Height
Catalog_Display_Config_ImageHeight_Label ui elements, catalogtile Image Height
Catalog_Display_Config_ImageWidth_Description ui elements, catalogtile Enter Image Width
Catalog_Display_Config_ImageWidth_Label ui elements, catalogtile Image Width
Catalog_Display_Config_Instructions_Description ui elements Instructions for adding to cart
Catalog_Display_Config_Instructions_Label ui elements Instructions
Catalog_Display_Config_JSCallback_Description campaign page builder Enter a JS Callback function that is on the page when called Salesorder updated
Catalog_Display_Config_JSCallback_Label campaign page builder JS Callback Function
Catalog_Display_Config_Least_One_Item_Required ui elements At Least One Item Required
Catalog_Display_Config_Maximum_Items_Required ui elements You have selected more than max items allowed
Catalog_Display_Config_Minimum_Items_Required ui elements The minimun number of items have not been selected
Catalog_Display_Config_Select_Label ui elements Select
Catalog_Display_Config_Styleclass_Description ui elements, catalogtile Enter Style class, leave blank if none
Catalog_Display_Config_Styleclass_Label ui elements, epayments Style class
Catalog_Display_Config_Title_Description ui elements Title of the new input display
Catalog_Display_Config_Title_Label ui elements Title
Catalog_Pricing_Table_Display_Config_HighlightText_Description ui elements Highlighted Item Callout Text
Catalog_Pricing_Table_Display_Config_HighlightText_Label ui elements Highlighted Item Callout Text
Catalog_Tile_Config_Callback_Description campaign page builder Callback Javascript function when Salesorder is created
Catalog_Tile_Display_Config_MaxSelected_Description ui elements Max quantity that can be selected
Catalog_Tile_Display_Config_MaxSelected_Label ui elements Max Quantity
Catalog_Tile_Display_Config_MinSelected_Description ui elements Min quantity that must be selected
Catalog_Tile_Display_Config_MinSelected_Label ui elements Min Quantity
Change_Address checkout Change Address
Change_Billing_Address_Cancel known_address Cancel
Change_Billing_Address_Confirm_Header known_address Confirm New Billing Address
Change_Billing_Address_Line_1 known_address Changing the billing address will update your saved payment method with the new address.
Change_Billing_Address_Line_2 known_address Click "Save" to confirm this change.
Change_Billing_Address_Save known_address Save
Check misc,ebusiness Check
Check_Amount_Text invoice_payment Check Amount
Checking epayments checking
Checkout estore Checkout
Checkout_As_Guest ui elements Checkout as Guest
Checkout_Free_Label shopping_cart Complete Transaction
Checkout_Guest validation Checkout
Checkout_Invoice_Payment_Button_Label shopping_cart Complete Transaction
Checkout_Invoice_Payment_Option_Label shopping_cart Invoice me
Checkout_Page_Select_Saved_Payment_Method_Label checkout,payment methods Pay with a saved payment method
Checkout_Proforma_Text checkout Pay for Sales Order
Checkout_Proforma_Title checkout Sales Order Information
Checkout_Returning_User_Prompt ui elements, checkout page Already have an account?
Checkout_Shopping_Cart_Empty_Message shopping cart Your shopping cart is empty.
Checkout_Summary_Update_Quantity shopping cart Update Cart
City address, common City
Close_And_Post_Invoice customer_look_up Close & Post Invoice
Close_Invoice customer_look_up Close Invoice
Company ui elements Company
Complete_Payment checkoutSummary Complete Payment
Completed_Terms backend Completed Terms
Confirm misc, common Confirm
Confirm_Button_Text Yes, remove the item.
Confirm_Message Are you sure?
Connect_Payment_Gateway Payment_Gateway Connect
Connect_Test_Payment_Gateway Payment_Gateway Connect to a Test Gateway
ContactListTemplate <div class="col-xs-12 col-sm-2"> <img src="{{orderdev1__Contact_Image__c}}" alt="{{Name}}" class="img-responsive img-circle" /> </div> <div class="col-xs-12 col-sm-10"> <span class="name">{{Name}}</span><br/> <span class="glyphicon glyphicon-map-marker text-muted c-info" data-toggle="tooltip"></span> <span class="visible-xs"> <span class="text-muted">{{MailingCity}} {{MailingState}} {{MailingPostalCode}}</span><br/></span> <span class="glyphicon glyphicon-earphone text-muted c-info" data-toggle="tooltip" title="{{Phone}}"></span> <span class="visible-xs"> <span class="text-muted">{{Phone}}</span><br/></span> </div>
Continue ui elements Continue
Continue_Refund Refund Receipt Continue
Continue_Shopping shopping cart Continue Shopping
Continue_as_Guest user prompt Continue as Guest
Copyright misc Copyright
Country address, common Country
Create_Account ui elements Create an Account
Create_Invoice customer_look_up Create Invoice
Create_New_Contact customer_look_up Create New Contact
Create_New_Variable price_rules Add Rule
Create_Password ui elements Create Password
Create_Proforma_Invoice customer_look_up Create Proforma Invoice
Credit_Applied invoice credit Credit Applied
Credit_Card ui elements, button labels, epayments, misc Credit Card
Credit_Card_Edit backend Edit Credit Card
Credit_Card_Ending_In payment_methods Ending In
Credit_Card_New backend New Credit Card
Credit_Card_Type payment_methods Card Type
Credit_Cards payment_methods Credit Cards
Credit_Memo customer_look_up Credit Memo
Credit_Memo_Account_Not_Populated proforma Credit Memo Account on the associated business group is not populated.
Credit_Remaining customer_look_up Credit Remaining
Current_Subs_Term_Completed backend Current subscription has completed the following number of terms:
Custom_Fieldset ui elements Custom Fieldset
Customer Global Customer
CustomerLookupLabel misc Customer (Entity)
Customer_Information_Invoice_Payment invoice_payment Customer (Entity)
Customer_Information_Sales_Order sales_order Customer Information
Customer_Receipt_Sold_To Invoice Sold To:
Customer_Reference_Number shopping_cart Customer Reference Number
Default backend Default
Deferred_Revenue_Term_Validation Validation Term Cannot be negative
Delete misc, common Delete
Delete_Payment_Method payment method, scheduled payments Delete Payment Method
Delivery_Options checkout Delivery Options
Deposit_Account_Label sales_order Deposit Account
Deposit_Date Deposit/Posted Date
Deposit_Date_Invoice_Payment invoice_payment Deposit/Posted Date
Disable_Save_Payment_Method payemnt Disable Save Payment Method Option
Discount_Code Discount,Checkout Discount Code
Discount_Code_Sales_Order sales_order Discount Code
DueDate_InvoiceDate Validation,Invoice Due date cannot be earlier than invoice date
Due_Date_Invoice_Payment invoice_payment Due Date
ECheck_Bank_Name payment_methods Bank Name
ECheck_Bank_Number payment_methods Bank Number
ECheck_Manage_Methods payment_methods Manage E-Check payment methods.
ECheck_Methods payment_methods E-Check
Edit misc, common Edit
Email ui elements E-Mail
Email_Address_Invalid proforma Email Address is Invalid.
Email_Already_Exists_Validation_Message Email Already Exists
Email_Not_Found_In_OrgWideEmailAddress backend Email address not found in Organization-Wide Email Address
Email_Sent_Failure proforma Email Send Failed.
Email_Sent_Successfully proforma Email Successfully Sent.
Enable_Assignment_On_Require_Assignment_Validation item validation Enable Assignment must be true if Require Assignment is checked.
ErrorInvalidArgument Error Messages Invalid Argument passed into method
Error_Check_System_Log_And_Or_Please_Try_Again Error Messages Check system logs and/or please try again.
Error_Inserting_Record Error Messages Error inserting record.
Error_No_Id_Found_For_Parent_SObject Error Messages No id found for parent SObject!
Error_Saving_Record Error Messages Error saving record
Error_Updating_Record Error Messages Error updating record
Error_VF_Page_Load_Error_Panel_Title Error Messages Error Loading Page
Existing_User ui elements Existing User
Exit_Invoice_Payment invoice_payment Exit
Exit_Sales_Order sales_order Exit to Sales Order
Exp_Month ui elements, button labels, epayments, misc Exp Month
Exp_Month_Invoice_Payment invoice_payment Exp. Month
Exp_Year ui elements, button labels, epayments, misc Exp Year
Exp_Year_Invoice_Payment invoice_payment Exp. Year
Field_Not_On_SOL_Validation validation Field does not exist on Sales Order Line.
First_Name ui elements First Name
Flex_Day_Of_Month_Validation Validation Flex Day of Month must be within the range the calendar allows.
Following_Are_True backend All the following are true:
Forgot_Password portal,login Forgot Password?
Free_Cost event_reg Free
GUEST_CHECKOUT_ACCOUNT_PREFIX eStore, Guest Checkout Guest Checkout Account
Go_Back backend, payment Go Back
Grant_Access_To access permissions, admin Grant Access to
Guest ui Guest
Guest_Checkout ui elements Guest Checkout
Guest_Login_Link validation Log in
Guest_User ui elements Guest User
Has_Charge_Package_Item Package_Item Calculate pricing
Inactive_Source_Code_Used sales_order validation Invalid Discount Code
Invalid_CC_CVV_Msg ui elements, button labels, epayments, misc Please provide 3 or 4 digits CVV.
Invalid_CC_Month_Msg ui elements, button labels, epayments, misc Please provide Card Expiration Month in MM format.
Invalid_CC_Msg ui elements, button labels, epayments, misc Please provide 16 digits credit card number in XXXXXXXXXXXXXXXX format.
Invalid_CC_Year_Msg ui elements, button labels, epayments, misc Please provide Card Expiration Year in YYYY format.
Invalid_Calendar_Days_Subscription_Validation subscription_plan validation Invalid end day for selected month
Invalid_Discount_Code Discount,Checkout Invalid Discount Code
Invalid_Receipt_Header_FieldSet_Validation backend Please enter valid Fieldset csv values.
Invalid_Receipt_Lines_FieldSet_Validation backend Invalid FieldSet value.
Invoice_Adjustment_Invoice_Posted_Error invoice_adjustments_page Invoice must be posted in order to create an Adjustment Line.
Invoice_Adjustments_Go_Back Invoice Adjestments Go Back
Invoice_Adjustments_Item_has_defer Invoice Adjestments Cannot calculate deferred revenue adjustment for items that do not have deferred revenue configured.
Invoice_Adjustments_need_Dates Invoice Adjestments Deferred Adjustment should have Activation and End Dates populated.
Invoice_Already_Paid Validation,Invoice Invoice already posted and paid.
Invoice_Credit_Memo_Cannot_Be_Negative business_group validation Invoice credit memo limit cannot be negative
Invoice_Date customer_look_up Invoice Date
Invoice_Due_Date invoice_payment Invoice Due Date
Invoice_Line_ID invoice_payment Invoice Line ID
Invoice_Line_Validation schedule payment validation Invoice Line Required.
Invoice_Not_Found Invoice Not Found
Invoice_Number_Invoice_Payment invoice_payment Invoice
Invoice_Payment_Receipt_Memo_Prefix Payment Applied to Invoice #
Invoice_Payment_Title invoice_payment Apply Payment
Invoice_Terms customer_look_up Invoice Information
Invoice_WriteOff_Continue Are you sure, you want to write-off this invoice?
Invoice_Write_Cannot_Be_Negative business_group validation Invoice write off limit cannot be negative
Invoice_Write_Off_Paid_validation invoice write_off validation Cannot write off paid invoice.
Invoice_not_Posted Invoice Invoice status must be either Posted or Overdue in order to apply payment.
Is_Required_Match_Rule validation Is Required
Item Checkout Item
Item_Class backend Item Class
Item_Has_To_Be_Subscription_Item validation Item has to be Subscription Item
Item_Removed_Message The selected item will be removed from your cart.
Item_RenewalPath_Validation backend Please select an active Subscription Item.
Item_Renewal_Path_Validation backend Item must be an active subscription item.
Item_Renewal_Path_Validation_Close_Button backend Close
Item_Successfully_Removed The item has been removed from your cart.
Items checkout Items
Items_Invoice Invoice Items
Items_Need_To_Be_Shipped checkout Some items in your order need to be shipped.
Items_Need_To_Be_Taxed checkout Some items in your order need to be taxed.
Keep_Me_Logged_In ui elements Keep me logged in
Known_Address_Additional_Details known_address Additional Details
Known_Address_Address_Field known_address Address
Known_Address_Billing_Address_Required known_address Billing Address Required
Known_Address_Cancel_Modal_Button known_address Cancel
Known_Address_Change_Summary_Link known_address Change
Known_Address_Create_Address_Button known_address Create Address
Known_Address_Delete_Confirmation known_address Are you sure you want to delete this address?
Known_Address_Edit_Address_Modal_Header known_address Edit Address
Known_Address_Edit_Billing_Address known_address Edit Billing Address
Known_Address_Is_Default known_address_modal Is Default
Known_Address_Name_Field known_address Name
Known_Address_New_Address_Button known_address New Address
Known_Address_New_Address_Modal_Header known_address New Address
Known_Address_New_Billing_Address known_address New Billing Address
Known_Address_None_Found known_address No address found. Please create a new address to process payment.
Known_Address_One_Default known_address One address must be marked as default.
Known_Address_Save_Modal_Button known_address Save
Last_Name ui elements Last Name
LifeTime_Membership_Can_Not_Be_Renewed validation LifeTime Membership can not be renewed.
Log_In_To_Your_Account Login Log In to Your Account
Login ui elements Login
Login_Failed validation Login Failed
Login_Not_Recognized checkout_page Login not recognized.
Logout ui elements Logout
Lookup_Contact_Account_Invoice_Payment invoice_payment Searching for existing contact or account
Manage_Credit_Cards payment_methods Manage Credit Card payment methods.
Manage_Payment_Methods_Delete payment_methods Delete
Manage_Payment_Methods_Edit payment_methods Edit
Max_Quantity_Reached item_quantity Item Quantity Cannot be more than 5000 in a single order.
Memo_Invoice_Payment invoice_payment Memo
Message proforma_invoice_composer Message
Min_Price_Validation_Message item Price must be greater than or equal to
Missing_Login_Credentials ui elements, checkout page No username and password?
Multiple_Default_Renewal_Path_Validation_Error Only one default renewal path is allowed.
NO_Charge_Package_Item Package_Item At no additional charge
Name Campaign Name
New misc, common New
NewRefundCreated A new refund has been created for the receipt.
New_Address checkout New Address
New_Settings admin_app_config New Settings
New_User ui elements New User
Next_Step checkout Next Step
No_Api_Response Scheduled Payments No API response received from gateway.
No_Invoice_Lines_Selected invoice_adjustments_page Must select an invoice line to create an adjustment line.
No_Items_In_Cart_Body checkout No Items In The Cart.
No_Items_In_Cart_Heading checkout No Items In Cart
No_Payment_text checkoutSummary There is no payment due. Click the button below to complete your order.
No_Saved_Payment_Methods_Found portal,checkout No saved payment methods found.
NotFoundLabel not_found Visualforce page Page Not Found
Not_Individual_Sale_Validation_SOL Salesorderline Cannot purchase item that is marked not individual sale.
Not_Valid_EAN_Code item barcode Not valid data for EAN barcode!
Not_Valid_UPC_Code item barcode Not valid data for UPC barcode!
Not_a_Refund epayments Not a Refund Receipt
Offline_Invalid_Format payment Invalid Format. Must contain 1 or more characters.
Offline_Invoice_Payment invoice_payment Offline
Offline_Payment Offline Payment Offline Payment
Offline_Payment_Amount_On_CC_EFT_Other OfflinePayment Payment Amount
Offline_Payment_Amount_On_Check OfflinePayment Amount on Check
Offline_Payment_Check_Date OfflinePayment Receipt/Check Date
Offline_Payment_Check_Number OfflinePayment Check Number
Offline_Payment_Date Offline Payment Date
Offline_Payment_Memo OfflinePayment Memo
Offline_Payment_Reference_Number invoice_payment Reference Number
Offline_Sales_Order sales_order Offline
Online_Payment epayments Online Payment
Online_Payment_Transaction_Num epayments Online Payment Transaction #
Order_In_Processing payment Your order is being processed
Order_Includes_Invoice_Payment invoice_payment Order Includes
Order_Processed payment Your order has been successfully processed.
Order_Summary_Delete_SOL Validation,OrderSummary Order updated successfully
Order_Total checkout Order Total
Over_Payment customer_look_up Overpayment
Overpayment_From_Invoice_Payment invoice_payment Overpayment From
Override_Invoice_Payment_Prioritization invoice_payment Override Invoice Payment Prioritization
Package_Item_Default_Add_To_Cart_Button_Label package_item.page Add to Cart
Package_Item_Group_of_Items package_item.page Group of Items
Package_Item_Heading Package_Item Package Items for
Package_Item_Or_Item_Class_Question package_item.page Would you like to package a single item or a group of items?
Package_Item_Page_Error Checkout Whoops! we had a problem saving the record!
Package_Item_Per_Item_Limit package_item.page Limit the quantity per Item allowed. Enter 0 to not enforce a limit
Package_Item_Picklist Package_Item Single Item or Group of Items?
Package_Item_Required_Item_Class_Label package_item.page Require at least one Item in the group to be purchased as part of this package
Package_Item_Required_Item_Label package_item.page Always include this Item as part of the package
Package_Item_Single_Item package_item.page Single Item
PageNotFoundDescription not_found Visualforce page Please press the back button on your browser and try again.
PageNotFoundTitle not_found Visualforce page Whoops! The page you requested could not be found!
Paid Paid
Paid_In_Full customer_look_up PAID IN FULL
Parent_Business_Group_Validation backend When unchecked, a Parent Business Group must be designated.
Password ui elements Password
Password_Reset portal,login Password Reset
Password_Reset_Email_Sent portal,login Password Reset Email Sent
Password_Validation_Message portal,checkout,parsley Password must be at least 8 characters in length.
Pay ui elements, buttons, epayments Pay
PayPal_Methods payment_methods PayPal
PayPal_Methods_Description payment_methods Manage PayPal payment methods.
PayPal_Name payment_methods Name
Pay_Now_Invoice_Payment invoice_payment Pay Now
Pay_Now_Sales_Order sales_order Pay Now
Pay_with Pay with
Pay_with_Check Pay with Check
Payment epayments Payment
Payment_Amount_Invoice_Payment invoice_payment Payment Amount
Payment_Amount_Text invoice_payment Payment Amount
Payment_Date OfflinePayment Payment Date
Payment_Date_Invoice_Payment invoice_payment Payment Date
Payment_Description_Prefix_Invoice scheduled payments Invoice #
Payment_Description_Prefix_Sales_Order scheduled payments Recurring Payment
Payment_Description_Prefix_Subscription scheduled payments Auto-Renewal for
Payment_Gateway Payment_Gateway Payment Gateway
Payment_Gateway_Label backend Payment Gateway
Payment_Gateway_Not_Enabled checkout_page Payment Gateway is not enabled for the gateway.
Payment_Gateway_Not_Found backend Payment gateway not found.
Payment_Gateway_is_Required Please select a payment gateway
Payment_Information shopping cart Payment Information
Payment_Information_Invoice_Payment invoice_payment Payment Information
Payment_Information_Sales_Order sales_order Payment Information
Payment_Invoice_Payment invoice_payment Payment
Payment_Method_Address backend Address
Payment_Method_Billing_Address backend Billing Address
Payment_Method_Cancel backend Cancel
Payment_Method_Card_Holder_Name backend Card Holder Name
Payment_Method_Delete backend Delete Payment Method
Payment_Method_Delete_Button backend Delete
Payment_Method_Delete_Close_Button backend Close
Payment_Method_Delete_Confirm payment method Are you sure you want to delete the Payment Method?
Payment_Method_Delete_Message_1 backend Delete payment method
Payment_Method_Delete_Message_2_part_1 backend is being used for scheduled payments.
Payment_Method_Delete_Message_2_part_2 backend To continue with deletion, you must reassign scheduled payments to another payment method.
Payment_Method_Delete_Message_3_part_1 backend Payment Method
Payment_Method_Delete_Message_3_part_2 backend cannot be deleted because it is being used for schedule payments.
Payment_Method_Delete_Reassign backend Reassign scheduled payments to:
Payment_Method_Delete_Reassign_Button backend Delete & Reassign
Payment_Method_Edit backend Edit Payment Method
Payment_Method_Email backend Email
Payment_Method_Exit backend Exit
Payment_Method_Expiration backend Expiration
Payment_Method_Full_Name backend Full Name
Payment_Method_Has_Scheduled_Payment_Message scheduled payments You cannot delete this payment method until the following scheduled payments are updated with an alternative, valid payment method.
Payment_Method_Header backend Payment Methods for
Payment_Method_Invoice_Payment invoice_payment Payment Method
Payment_Method_Is_Not_Valid checkout_page Payment Method Being used is Invalid.
Payment_Method_MM payment MM
Payment_Method_New backend New Payment Method
Payment_Method_Number backend NUMBER
Payment_Method_Offline_Payment OfflinePayment Payment Method
Payment_Method_Phone backend Phone
Payment_Method_Save backend Save
Payment_Method_Unable_To_Delete payment method, scheduled payments Unable to delete Payment Method
Payment_Method_Unable_To_Delete_Message scheduled payments You cannot delete this payment method because it is associated with one or more scheduled payments. Please create a new payment method and try again.
Payment_Method_YYYY payment YYYY
Payment_Methods ui elements, button labels, epayments, misc Payment Methods
Payment_Methods_Error_No_Customer_Found Error Messages No customer found!
Payment_Processing payemnt Payment Processing...
Payment_Terms customer_look_up Payment Terms
Payment_Type_Invoice_Payment invoice_payment Payment Type
Payments_Invoice Invoice Payments
PendingStatusError Sales Order cannot be "pending" in an "open" status
Personal epayments personal
Phone ui elements Phone
Placeholder_Text campaign page builder Drag a component here
Plan backend Plan
Please_Wait_Msg Please Wait!
Position_Order_Label campaign page builder Position -
Post_Orders_in_Processing Post Orders in Processing
PostedStatusError Sales Order cannot be "posted" in an "open" status
Preview campaign page builder Preview
Preview_Mode misc You are currently in preview mode, some functionality may not work correctly and/or be disabled.
Preview_Mode_Cancel misc Return to Staff View
Previous_Sales_Order sales_order Return to Previous Page
Price Campaign Price
PriceRuleQuantityError PriceRules.cls Minimum quantity cannot be greater than maximum quantity
Price_Rule price_rules Price Rule
Price_Rule_Badge_Types price_rules Customer Badge Type
Price_Rule_Display_Name backend Price Rule Display Name
Price_Rule_End_Date_Value price_rules End Date
Price_Rule_Field price_rules Field
Price_Rule_Limit_Per_Account price_rule Limit per account must be greater than zero.
Price_Rule_Limit_Per_Account_Contact price_rule Limit per contact cannot be greater than limit per account.
Price_Rule_Limit_Per_Contact price_rule Limit per contact must be greater than zero.
Price_Rule_Max_Available price_rules Total Limit for All Orders
Price_Rule_Max_Quantity price_rules Max. Items Per Order
Price_Rule_Min_Quantity price_rules Min. Items Per Order
Price_Rule_Name price_rules Name
Price_Rule_Object price_rules Object
Price_Rule_Operator price_rules Operator
Price_Rule_Price price_rules Price
Price_Rule_Source_Code price_rules Source Code
Price_Rule_Start_Date price_rules Start Date
Price_Rule_Subscription_Plans price_rules Subscription Plans
Price_Rule_Value price_rules Value
Price_Rule_Variables price_rules Price Rule Variables
Price_Rules price_rules Price Rules for
Print misc Print
Prioritization_Number invoice_payment Prioritization #
Process_Payment ui elements, button labels, epayments Process Payment
Process_Payment_Sales_Order sales_order Process Payment
Processing_Changes_Payment payment Processing Changes
Proforma_Addressed_To proforma_invoice_email_pdf Addressed to:
Proforma_Balance_Due proforma_invoice_email_pdf Balance Due
Proforma_Description proforma_invoice_email_pdf Description
Proforma_Email_Composer_Close proforma_invoice_composer Close
Proforma_Email_Sent proforma_invoice_composer Your Email Has Been Sent.
Proforma_Heading proforma_invoice_email_pdf PROFORMA INVOICE
Proforma_Invoice_Customer_Info proforma_invoice_composer Customer Information
Proforma_Invoice_Email_Header proforma_invoice PROFORMA INVOICE
Proforma_Invoice_Email_Sent_Successfully proforma Proforma Invoice Email Sent Successfully
Proforma_Invoice_Message customer_look_up Proforma Invoice Message
Proforma_Invoice_Sales_Order_Info proforma_invoice_composer Sales Order Information
Proforma_Invoice_Sales_Order_Lines_Info proforma_invoice_composer Sales Order Line Items
Proforma_Invoice_Subject Proforma Invoice Proforma Invoice
Proforma_Invoice_Title proforma_invoice_composer Invoice
Proforma_Invoice_Total proforma_invoice_email_pdf INVOICE TOTAL:
Proforma_Line_Total proforma_invoice_email_pdf Line Total
Proforma_Link_Payment_Name backend Click here to make a payment
Proforma_Qty proforma_invoice_email_pdf Qty
Proforma_SF_Limit_Exceeded proforma_invoice_composer Single Email Limit Exceeded
Proforma_SO_ErrMsg proforma_invoice_composer Proforma invoices can only be sent to customers from a Sales Order in a status of 'Closed' with a posting entity set to 'Receipt'.
Proforma_SO_NoEmail_ErrMsg proforma_invoice_composer Contact/Primary Contact's Preferred Email field is blank.
Proforma_SO_PDF_ErrMsg proforma_invoice_composer To print Proforma Invoice, you must select at least one Sales Order with 'Closed' status and posting entity set to 'Receipt'.
Proforma_Sale_Price proforma_invoice_email_pdf Sale Price
Proforma_Shipping proforma_invoice_email_pdf Shipping:
Proforma_Tax proforma_invoice_email_pdf Tax
Proforma_Unit_Price proforma_invoice_email_pdf Unit Price
Publish campaign page builder Publish
QTY backend QTY
Quantity Campaign Quantity
Quantity_Package_Item backend Quantity
Quantity_Sales_Order sales_order Quantity
Quantity_Whole_Number_Shopping_Cart shopping_cart Quantity Must Be Greater Than Zero.
Receipt misc,ebusiness Receipt
Receipt_Header_FieldSet_Validation backend Atleast One Fieldset Required.
Receipt_Lines_FieldSet_Validation backend Only One FieldSet Allowed.
Receipt_Not_Found Receipt Not Found
Receipt_Number_Invoice_Payment invoice_payment Receipt #
Reference_Number invoice Reference Number
Reference_Number_Invoice Invoice Reference #
Refund epayments Refund
RefundAlreadyCreatedError A refund has already been created for this receipt. Wish to continue?
Refund_Already_Processed epayments Refund already processed
Refund_Processed epayments Refund has been processed
Refund_Sales_Price Receipt Refund Price
Register_Now ui elements Register Now
Remove Action Labels, Common Remove
Renew_Into backend Renew Into
Renew_Into_Items backend Renew Into Items
Renewal_Path_For backend Renewal Path for
Renewal_Path_Select_Instruction backend Drag items to the right to select for renewal path:
Renewal_Path_Trigger_Instruction backend The renewal path will be triggered when:
Renewal_Rule backend Renewal Rule
Require_CVV payment_gateway Require CVV
Require_Email payment_gateway Require Email
Require_Phone payment_gateway Require Phone
Require_Shipping Checkout Require Shipping
Required_Package_Item Package_Item Always include this item as part of the package
Required_Package_Item_Class Package_Item Customer must purchase at least one item in group
Required_Shipping_Sales_Order sales_order These Items Require Shipping
Reset_Password_Description portal,login Enter your username which usually is the same as your email address.
Restrict_Access_To access permissions, admin Restrict Access to
Review_Items_And_Shipping_Method checkout Shipping Items
SO_Payment_Active_Subscription_Plan_Validation backend One of the sales order line items has inactive subscription plan.
SalesOrderInvoicePostederror To create a payment a closed Sales Order, or one/many posted Invoices are required!
Sales_Order sales_order Edit Sales Order
Sales_Order_Already_Posted Checkout Sales Order is already posted
Sales_Order_Invoiced Checkout Sales Order status is invoiced
Sales_Order_Not_Closed Checkout Sales Order is not closed
Sales_Order_Payment_Title Sales_Order_Payment Process Payment
Sales_Order_Total_Zero Checkout Sales Order Total is 0
Save ui elements, button labels, misc Save
Save_And_Close_Price_Rule price_rules Save & Exit
Save_And_New_Price_Rule price_rules Save & New
Save_Package_Item ui elements, button labels, misc Save Package Item
Save_Package_Item_Button Package_Item Save & Close
Save_Payment_Gateway Payment_Gateway Save & Close
Save_Payment_Method payemnt Saving Payment Method
Save_Payment_Method_Checkbox_Label portal,checkout Would you like to save this payment method for future use?
Save_Payment_Method_Invoice_Payment invoice_payment Save Payment Method
Save_Plan backend Save
Save_Price_Rule price_rules Save
Saved_Methods ui elements, button labels, epayments, misc Saved Payment Methods
Saved_Payment_Methods_List_Label portal,checkout Use this Payment Method
Saving_Payment_Method payemnt Saving Payment Method...
Savings epayments savings
Scheduled_Payment_Catch_All_Payment_Description scheduled payments Other Payment
Search_Existing_Contact_Account_Sales_Order sales_order Search for existing contact or account
Select_A_Site proforma_invoice_composer Select A Site
Select_Default backend Select Default
Select_Item Select Item
Select_Item_Class_To_Package package_item.page Select the Item Class that contains the group of Items you wish to package
Select_Item_To_Package package_item.page Select an Item to package
Select_One_Warning Please select a catalog item.
Select_Package_Item Package_Item Select Item
Select_Package_Item_Class Package_Item Select Item Class
Select_Plan backend Select
Selected_Components_Label campaign page builder Selected Components
Send_Email proforma_invoice_composer Send Email
Send_Proforma_Invoice proforma Send Proforma Invoice
Separate_Tax_Address_Sales_Order sales_order Separate Tax Address
Ship_To ui elements, sales orders, misc Ship To
Ship_To_Invoice Invoice Ship To
Shipping checkout Shipping
Shipping_Address checkout Shipping Address
Shipping_Address_Sales_Order sales_order Shipping/Tax Address
Shipping_And_Billing checkout Shipping & Billing
Shipping_And_Payment_Information checkout Shipping and Payment Information
Shipping_Information_Sales_Order sales_order Shipping Information
Shipping_Method_Sales_Order sales_order Shipping Method
Shipping_Only_Address_Sales_Order sales_order Shipping Address
Shipping_Payment_Information shopping cart Shipping & Payment Information
Shipping_Region_Not_Found checkout Shipping Region Not Found
Shipping_Tax_Validation_Item item validation Cannot mark item as shipping carrier and tax.
Shipping_To checkout Shipping To
Shipping_Total checkout Shipping Total
Shopping_Cart shopping cart Shopping Cart
Shopping_Cart_Empty_Message shopping cart Your cart is empty.
Shopping_Cart_Item_Count_Suffix_Plural shopping cart Items in Cart
Shopping_Cart_Item_Count_Suffix_Singular shopping cart Item in Cart
Shopping_Cart_Modal_Close_Button_Label shopping cart Close
Shopping_Cart_Modal_Discount_Price_Prefix shopping cart Your Price
Sign_Into_Account ui elements Sign in to your account
Sign_up ui elements Sign Up
SimpleInvoiceInstallmentError Number of Installments should not be populated for Sales Orders with "Simple Invoice" schedule type.
Social_User_Reset_Password site You did not create a password in this system. Please reset your password in your social media account.
Standard_Components_Label campaign page builder Standard Components
State address, common State
Store_Child_Business_Group campaign page Error! Store Must Be Child Of Selected Business Group
Store_Label sales_order Store
Store_Required_Site_EStore site_validation A Store is required when Enable eStore is checked.
Street address, common Street
Street2 address, common Bldg/Apt/Suite #
Sub_Plan_Invoice_Automatic_Payment_Sub subscription_plan Cannot add Automatic Payment Subscription Plan to Invoice Sales Order
Sub_Plan_Lifetime_Deferred_Revenue_Error subscription_plan Cannot enable deferred revenue if lifetime subscription plan associated to item.
Sub_Plan_Lifetime_Enable_Deferred_Revenue_Error subscription_plan Cannot enable Lifetime type because one or more items with deferred revenue are linked to this plan.
Sub_Plan_Proration_Schedule_Error subscription_plan Cannot enable proration and schedule on Subscription Plan
Sub_Plan_Validation_Automatic_Payment subscription_plan Must set Type to 'Lifetime' if Automatic Payment is selected
Sub_Total proforma Subtotal
Subject proforma_invoice_composer Subject
Submit misc, common Submit
Subscription_Plan_Installment_Non_Zero_Validation subscription_plan validation Number of Installments cannot be less than zero
Subscription_Plan_Installment_Too_Large_Validation subscription_plan validation Number of Installments cannot be greater than 500
Subscription_Plans_For backend Subscription Plans for
Success_Msg Success!
Summary section headings, misc Summary
Supports_Authorize payment_gateway Support Authorize
Supports_Capture payment_gateway Support Capture
Supports_Credit payment_gateway Support Credit
Supports_Credit_Card payment_gateway Support Credit Card
Supports_Void payment_gateway Support Void
Supports_eCheck payment_gateway Support eCheck
Tax checkout Tax
Tax_Address_Sales_Order sales_order Tax Address
Thank_You Receipt THANK YOU!
ThreeDS_Form_Body epayments Please complete the form to continue the transaction
ThreeDS_Form_Title epayments 3DS Security
To_Address proforma_invoice_composer Send To
To_HelpText proforma_invoice_composer One or More Email addresses with comma separated values
Total checkout Total
Total_Adjustments Invoice Total Adjustments
Total_Adjustments_Invoice Invoice Total Adjustments
Total_Due Invoice TOTAL DUE
Total_Items Invoice Total Items
Total_Items_Receipt Receipt Total Items
Total_Paid Receipt TOTAL PAID:
Total_Payments Invoice Total Payments
Total_Refund Receipt TOTAL REFUND:
Total_Refund_Receipt Receipt Total Refund
Transaction_ID_Invoice_Payment invoice_payment Transaction ID
Unable_To_Send_Proforma_Invoice proforma Unable to send Proforma Invoice
Underpayment customer_look_up UNDERPAYMENT
Unsupported_Feature_For_Payment_Gateway payment gateway, epayments Warning! You are attempting to use a feature that is not supported by your payment gateway. Contact Fonteva support to learn more about what is supported with your gateway.
Update_Email_Alert Update Email
Update_Payment_Gateway Payment_Gateway Save & Close
Update_Scheduled_Payments scheduled payments Update Scheduled Payments
Updating_Cart Your cart is being updated...
Use_For_Billing_Address checkout Use for Billing Address as well.
Use_For_Shipping_Address checkout Use for Shipping Address as well.
Use_Offsite ui elements Enable Offsite
User_Aleady_Exists_Alert_Message Please Login Or Use Different Email
User_Aleady_Exists_Alert_Title User Already Exists
Username ui elements Username
Validate_Default_Subscription_Plan A default subscription plan is required on an item of type subscription for the item to be active.
Validate_EPayment_Amount Amount is higher than source EPayment amount.
Validate_EPayment_Cancelled Process Payment cannot be checked if the epayment is Cancelled.
Validate_EPayment_EPayment_Source A valid epayment of type Authorize must be populated if process payment is checked.
Validate_EPayment_Payment_Method_Token A valid payment method token is required if process payment is checked.
Validate_EPayment_SalesOrder_Status In order to process payment, related SalesOrder must be closed.
Validate_EPayment_Succeeded Process Payment cannot be checked if the epayment is Succeeded.
Validate_EPayment_Transaction_Token A valid transaction token is required if process payment is checked.
Validate_Enable_Proforma_Or_Invoice Validation Only one of Invoice Payment or Proforma Invoice Payment can be marked true.
Validation_Assignment_Role_Has_Active_Assignments validation The Assignment Role can not be deactivated until all "Active" assignments linked to the role are inactivated or deleted.
Validation_Assignment_Role_Is_Not_Active validation Assignment Role is not active.
Validation_Assignments_Required validation Enable Assignments must be checked in order to Require Assignments.
Validation_At_Least_1_Default_Subscription_Plan_Required validation At least 1 default Subscription Plan is required
Validation_Badge_Type_Name_Unique contact_badges Names of Badges must be unique
Validation_Business_Group_Is_Not_Matching_With_Item_Business_Group validation Business Group on the related item does not match on this record.
Validation_Cancelled_Invoice_Status Validation A cancelled invoice can only be modified to draft status.
Validation_Customer_Does_Not_Have_Permission validation Customer does not have permission to purchase this item
Validation_Default_Subscription_Plan validation Only 1 Default Subscription Plan is permitted.
Validation_Default_Subscription_Plan_Required Validation Need to assign Default Subscription Plan prior to Activate this Item.
Validation_Defer_Revenue_Required Defer Revenue should be enabled on both item and item class.
Validation_Deferred_Required You must populate the Deferred Revenue Account and the Revenue Recognition Rule fields when the Defer Revenue field is checked.
Validation_Failed_Advance_Calendar_Days subscription_plan calendar_days Advance calender days cannot be negative.
Validation_Failed_Price_Rules price_rules Validation Failed On One or More Price Rules
Validation_Field_Required validation Field Required
Validation_FlexDay_Required You must specify the Flex Day of the Month when using the Flex Day Revenue Recognition Term Rule.
Validation_Greater_Than_Zero validation Value must be greater than 0.
Validation_Invalid_Input validation Invalid Input
Validation_Invoice_Already_Paid Validation,Invoice Invoice already posted and paid. In order to add new line Invoice status should be open.
Validation_Invoice_Post_Without_Line_Items Validation,Invoice Only invoices that have line items can be posted.
Validation_Invoice_Posted Validation,Invoice This Invoice is Posted. You can only add adjustment lines.
Validation_Invoice_Sales_Order_Posting Validation,Invoice To post the invoice, you must first post the parent Sales Order.
Validation_Invoice_Voided Validation,Invoice This Invoice is Voided. In order to add new Invoice Line status should be open.
Validation_Invoice_With_Payments_Can_Not_Be_Voided Validation,Invoice You may not void an Invoice that has a payment applied. Instead, consider posting an adjustment line.
Validation_Invoices_Status_Cannot_be_Changed Validation You can not modify a voided invoice.
Validation_Item_Cannot_Be_Tax_And_Taxable Validation Item cannot be taxable and tax rate
Validation_Item_Class_Cannot_Be_Tax_And_Taxable Validation Item Class cannot be taxable and tax rate
Validation_Item_Class_Default_Assignment_Role validation Item class can only have one default Assignment Role.
Validation_Item_Class_Has_No_Assignment_Role validation Item classes enabled for assignment require at least one active assignment role prior to activating.
Validation_Item_Class_Is_Not_Matching validation Item Class is not matching
Validation_Item_Class_Must_Have_Is_Tax_Checked Validation Item Class must have Is Tax checked to enable Default Tax Rate.
Validation_Item_Class_Needs_Assignment_Role validation Item class enabled for Assignments needs at least 1 Active Assignment Role.
Validation_Item_Class_Taxable backend Item Class cannot be enabled as Taxable and Tax at the same time.
Validation_Item_Is_Not_A_Child_of_Selected_Item_Class validation Item is not a child of selected Item Class.
Validation_Item_Is_Not_Active validation Item is not Active.
Validation_Item_Not_Available_For_Individual_Sale validation This item is not available for individual sale.
Validation_Item_or_Item_Class_required validation Item or Item Class required.
Validation_Name_Payment_Method Validation Name should have at least two words.
Validation_No_Business_Group_For_User Validation,Invoice No Business Group configured for your user. Please contact your system administrator for support.
Validation_No_Records_Selected Validation Invalid input, no record(s) selected.
Validation_Not_Allowed_To_Delete_Default_Price_Rule validation You are not allowed to delete Default Price Rule.
Validation_Only_1_Primary_Role_Allowed validation Primary Role already defined for this Item Class. Only 1 Primary Role Allowed.
Validation_Only_One_Default_Shipping_Rate Validation,Shipping Only one default shipping rate is allowed per shipping carrier.
Validation_Only_One_Default_Tax_Rate Validation Only one default tax rate per Item Class.
Validation_Only_One_Item_Can_Be_Related Validation Only one item can be related to the item class.
Validation_OverTime_Required You must select a Revenue Recognition Term Rule when deferring revenue Over Time.
Validation_Package_Item_Class_Required You need to select atleast one item.
Validation_Package_Items_Required There are some required items that have to be added to complete the transaction.
Validation_Parent_Invoice_Line Validation,Invoice Negative adjustments must have a parent invoice line.
Validation_Parent_Item_Class_Is_Not_Enabled_for_Assignment validation The parent Item Class is not enabled for assignment.
Validation_Payment_Method_Is_Not_Valid validation Payment Method is not valid.
Validation_Price_Rule_Is_Not_Active validation Price Rule is not active.
Validation_Reached_Max_Number_Of_Active_Assignment validation You have reached the maximum number of allowed assignments. To add an additional active assignment, you must deactivate another.
Validation_Related_Item_Class_Has_No_Available_Assignment_Inventory validation You have reached the maximum number of available assignments for related Item Class.
Validation_Related_Item_Class_Is_Not_Enabled_For_Assignment validation The related Item Class is not enabled for assignment.
Validation_SpecificDate_Required You must specify a Revenue Recognition Date when deferring revenue to a Specific Date.
Validation_Subscription_Plan_Is_Not_Active validation Subscription Plan is not active.
Validation_TaxLocale_Required You must select a Tax Locale
Validation_Tax_Class_Required_For_Tax Item Tax_Validation Tax Class required if taxable is enabled
Validation_Tax_Sales_Order_Lines_Must_Be_Child_Of_Another_Line Validation Tax Sales Order Lines can only be created as a child of another Sales Order Line.
Validation_You_Can_Not_Associate_Region Validation,Shipping The default shipping rate cannot have a shipping region.
Validation_You_Can_Not_Define_Tax_Class_For_Tax_Rates Validation,Shipping You can not define Tax Class for Tax Rates. Tax Class is for Taxable Items.
Validation_You_Can_Not_Update_Subscription_Line validation You cannot update the Subscription Line record that hosts the related Subscriptions Primary Item.
View_Refund_Receipt View Refund
Warning Warning!
Web_Invoice_Address_To Invoice Addressed To:
Web_Invoice_Adjustment_Amount Invoice Amount
Web_Invoice_Adjustment_Description Invoice Description
Web_Invoice_Adjustment_Reason Invoice Reason
Web_Invoice_Adjustment_Reference Invoice Reference No.
Web_Invoice_Balance_Due Invoice Balance Due:
Web_Invoice_Component Invoice INVOICE
Web_Invoice_Date Invoice Date:
Web_Invoice_DueDate Invoice Due Date:
Web_Invoice_Item Invoice Item:
Web_Invoice_Line_Total Invoice Line Total:
Web_Invoice_Number Invoice Invoice Number:
Web_Invoice_Posted_Date Invoice Posted Date
Web_Invoice_Qty Invoice QTY:
Web_Invoice_Sale_Price Invoice Sale Price:
Web_Invoice_Ship_To Invoice Ship To:
Web_Invoice_Total_Adjustment Invoice Total Adjustments:
Web_Invoice_Total_Items Invoice Total Items:
Web_Invoice_Total_Payment Invoice Total Payments:
Web_Invoice_Unit_Price Invoice Unit Price:
Welcome user prompt Welcome
Write_Off customer_look_up Write Off
Write_off_Account_Not_Populated proforma Write-offs must first be configured on the business group.
You_Cant_Specify_Address_Field_Value checkout The default region cannot have any address field values.
Zip address, common Zip
eCheck ui elements, epayments eCheck
invoice_adjustments_posted Invoice Adjestments The related Invoice is not posted, only posted invoices can be adjusted.
price_rule_end_date A Price Rule End Date must not be before the Price Rule Start Date. A Price Rule End Date requires the Price Rule Start Date and vice-versa. A Price Rule can not be active if the Price Rule End Date is in the past.
price_rule_max_num_available Your must increase the Max Num Available prior to activating this rule. If you wish to remove Price Rule Inventory tracking set the Max Num Available to 0 and then activate the Price Rule.

EventApi

API Name Categories Value
AR_Account_Event_Builder event_builder A/R Account
Access_Directions_Event_Builder event_builder Drag groups to the right to grant access
Access_Permission_Event_Builder event_builder Access Permission
Access_Permissions event_builder Access Permissions
Access_Permissions_Event_Builder event_builder Access Permissions
Access_Permissions_Select_Badge_Types events,validation Select Badge Types
Access_To_Item_Event_Builder event_builder Access to this Item
Access_To_This_Item_Event_Builder event_builder Access to this Item
Accounting_Event_Builder event_builder Accounting
Actions_Event_Builder event_builder Actions
Active_Event_Builder event_builder Active
Add_Invitee event_reg Add Invitee
Add_Invitees event_reg Add Invitees
Add_New_Speaker_Event_Builder event_builder Create a new speaker
Add_New_Sponsor_Package_Event_Builder event_builder Create a new sponsor package
Add_New_Statuses_Event_Builder event_builder Create a new status
Add_New_Tickets_Event_Builder event_builder Create a new ticket type
Add_Section_Event_Builder event_builder New Section
Add_Speaker_Event_Builder event_builder New Speaker
Add_Sponsor_Packages_Event_Builder event_builder Add Sponsor Package
Add_To_Calendar event Add To Calendar
Add_To_Waitlist validation Add To Waitlist
Add_Venue_Event_Builder event_builder Add Venue
Address_Event_Builder event_builder Address
Adjustment_Account_Event_Builder event_builder Adjustment Account
After_Event_Builder event_builder After
Agenda_Builder event_reg Agenda Builder
Agenda_Capacity_Ticket_Quantity Capacity/Ticket Quantity:
Agenda_Editor_Accounting_Tab Accounting
Agenda_Editor_Attach_Tab Attach Form
Agenda_Editor_Description_Tab Description
Agenda_Enable_Schedule_Items Enable Schedule Items
Agenda_Event_Builder event_builder Agenda
Agenda_Overview Agenda Overview
Agenda_Package_Info_Event_Builder event_builder Add new or edit existing package items. Click "+ Package Item" or the "Edit" icon within the package item table to configure a package item's settings.
Already_Published_Event_Message event_builder The selected event is already published so any changes made will be reflected in the Portal instantly.
Already_Published_Event_Title event_builder Event Already Published
Alternate_Pricing_Event_Builder event_builder Alternate Pricing
At_Least_One_Invitee_Selected event_reg At Least One Invitee Must Be Selected
At_Least_One_SC_Selected event_reg At Least One Schedule Item Must Be Selected
Attach_Event_Community_Event_Builder event_builder Attach Event to Community Group
Attach_Form_Event_Builder event_builder Attach Form
Attend_The_Event event_reg Attend The Event
Attendee_Already_Checked_In event checkin Already Checked In
Attendee_Checked_In event checkin Checked In
Attendee_Info validation Attendee Info
Attendee_Not_Found event checkin Attendee Not Found
Attendee_Ticket_Cancelled event checkin Ticket Cancelled
Attendees event_reg_email Attendees
Attendees_Per_Group event_builder Attendees Per Group
Auto_Sell_Out_Event Auto Sell Out Event
Badge_Type_Event_Builder event_builder Badge Type
Badge_Types_Event_Builder event_builder Badge Types
Badges_Event_Builder event_builder Badges
Banner_Image_Event_Builder event_builder Banner Image
Build_Agenda event_reg_email BUILD AGENDA
Building_Agenda_Please_Wait event_reg Building Agenda Please Wait...
Building_Event_Loader event_builder Building
Built_Event_Loader event_builder Built
Calendar_Reminder_Text_Event_Builder event_builder Calendar Reminder Text
Cancel event_reg Cancel
Cannot_Change_Event_Style event_validation Cannot change event style after it is set. Please create a new event.
Cannot_Delete_Active_Event_Status event_builder Cannot delete the current active status for an event.
Cannot_Enable_Seating_After_Registration event_builder Cannot enable assigned seating after registration has occurred against the event.
Cannot_Find_Event event No Event Found
Cannot_Render_Preview event_reg Cannot Render Preview
Change_Event_Category event_builder Change Event Category
Choose_The_Event_You_Want_To_Clone event_builder Choose the event you want to clone
City_Event_Builder event_builder City
Clone event_builder Clone
Clone_Early_Bird_Date_Cannot_Be_Cloned event_builder Ticket Type has early bird pricing enabled.
Clone_Event_Event_Builder event_builder Clone Event
Clone_Event_Help_Text event_builder Select an event that will be cloned. All related objects will also be cloned as well.
Clone_an_Existing_Event event_builder Clone an existing event
Close_Event_Builder event_builder Close
Close_Event_registration_Message event_builder When the event is closed, it is no longer visible on the Portal and users cannot register or purchase tickets. Do you want to close event registration?
Close_Event_registration_Title event_builder Close Event Registration
Closed_Event_Status_Button event_builder Closed
Community_Group_Event_Builder event_builder Community Group
Community_Group_Tie_To_Event_Help_Text event_builder When a community group is specified, the event will display on the group detail page for that community.
Company_Event_Builder event_builder Company
Company_Name_Event_Builder event_builder Company Name
Component_Deprecated event_reg Component Deprecated!!!
Component_Title_Event_Builder simple_event Component Title
Confirmed_Event_Builder event_builder Accepted
Contact_Record_Event_Builder event_builder Contact Record
Continue event_reg Continue
Continue_With_Waitlist_Tickets_Button event_reg Complete
Continue_With_Waitlist_Tickets_Only event_reg Continue With Waitlist Tickets Only
Cost event_reg Cost
Cost_Label event_reg COST
Country_Event_Builder event_builder Country
Create_Event_Builder event_builder Create
Create_Event_From_Scratch event_builder Create event from scratch
Create_Event_Status_Event_Builder event_builder Create Event Status
Create_New_Event_Event_Builder event_builder Create New Event
Create_New_Form_Event_Builder event_builder Create New Form
Create_New_Schedule_Item_Event_Builder event_builder New Schedule Item
Create_New_Sponsor_Package_Event_Builder event_builder Create New Sponsor Package
Create_New_Venues_Event_Builder event_builder Create a new venue
Create_Sponsor_Package_Event_Builder event_builder Create Sponsor Package
Create_Ticket_Type_Event_Builder event_builder Create Ticket Type
Create_Venue_Event_Builder event_builder Create Venue
Create_Venues_Event_Builder event_builder Create Venues
Creating_Event_Event_Builder event_builder Creating Event
Date_And_Or_Time_Might_Not_Be_Populated event_builder Date and/or Time fields might not be configured properly
Days_Repeat_Event_Builder event_builder Days
Days_To_Event event Days To Event
Dear event_reg Dear
Default_Attendee Event Default Attendee
Default_Component event_builder Lightning Components
Default_Component_Event_Builder simple_event Default Component
Default_Component_Help_text event_builder Please select a component below and click Add
Default_Custom_Event_Builder simple_event Default Custom
Defer_Revenue_Event_Builder event_builder Defer Revenue
Deferred_Revenue_Account_Event_Builder event_builder Deferred Revenue Account
Delete_Event_Builder event_builder Delete
Delete_Invitees_Link_Label event_reg Delete
Delete_Package_Item_Confirmation_Event_Builder event_builder Are you sure you want to delete the package item "{0}"?
Delete_Package_Item_Event_Builder event_builder Delete Package Item
Delete_Ticket_Type event_builder Delete Ticket Type
Delete_Ticket_Type_Event_Builder event_builder Delete
Deregister event_reg,agenda_builder Remove
Description_Event_Builder event_builder Description
Description_Label event_reg,agenda_builder Description
Details event_reg Details
Disable_Last_Current_Event_Status_For_Event event_builder An event should always have one active status for an event
Display_Instructions_Event_Builder event_builder Display Instructions
Display_Label_Event_Builder event_builder Display Label
Display_Map_Event_Builder event_builder Display Map
Drag_Drop_Component_Event_Builder simple_event Drag and Drop Lightning Component
Duration_24_Hour 24-Hour Time
Duration_End_Date End Date
Duration_End_Time End Time
Duration_Event_Builder event_builder Duration
Duration_Start_Date Start Date
Duration_Start_Time Start Time
Duration_Time_Zone Time Zone
Early_Bird_End_Date_Validation event_builder Early Bird End Date cannot be before the Event ticket sales start date.
Early_Bird_End_Event_Builder event_builder Early-Bird End Date
Early_Bird_Event_Builder event_builder Early-Bird Price
Edit_Event_Status_Event_Builder event_builder Edit Event Status
Edit_Package_Item_Event_Builder event_builder Edit Package Item
Edit_Preferences event_reg,agenda_builder Edit Preferences
Edit_Price_Rules_Ticket_Type event_builder Edit Price Rules
Edit_Speaker_Event_Builder event_builder Edit Speaker
Edit_Sponsor_Event_Builder event_builder Edit Sponsor
Edit_Sponsor_Package_Event_Builder event_builder Edit Sponsor Package
Edit_Ticket_Type event_builder Edit Ticket Type
Edit_Ticket_Type_Event_Builder event_builder Edit Ticket Type
Edit_Venue_Event_Builder event_builder Edit Venue
Ellipsis_Event_Builder event_builder
Email_Notification_Text_Event_Builder event_builder Email Notification Text
Enable_Early_Bird_Event_Builder event_builder Enable Early-Bird Price
Enable_Early_Bird_Price_Help_Text event_builder When checked, the Ticket Type will be sold for the amount defined in the "Early Bird Price" field until the date defined in the "Early Bird End Date".
Enable_On_Site_Price_Event_Builder event_builder Enable On-Site Price
Enable_On_Site_Price_Help_Text event_builder When checked, the ticket type can be sold for a different price, defined in the "On-Site Price" field, on the day of the event.
Enable_Refund_Request event_builder Enable Refund Request
Enable_Ticket_Waitlisting_Event_Builder event_builder Enable Ticket Waitlisting
Enable_Transaction_Event_Builder simple_event Enable Transition for Status
End_Date_Required event End Date Required.
End_Date_Time_Required event End Date Time Required.
End_Time_Invalid_Format event Invalid Format, Must Be (HH:MM AM|PM) Or (HH:MM).
End_Time_Required event End Time Required.
Ends_Event_Builder event_builder Ends
Event event_builder Event
Event_Access_Permission_Builder event_builder Event:
Event_Agenda event EVENT AGENDA
Event_Builder event_builder Event Builder
Event_Builder_Access_Permissions event_builder Access Permissions
Event_Builder_Add_Schedule_Item_Caption Add Schedule Item
Event_Builder_Add_Track event_builder Add New Track
Event_Builder_Agenda_Active_When_Event_Active event_builder When checked, the Schedule Item will publish when the Event is in the Registration Open status.
Event_Builder_Agenda_Advanced_DisableRegistration event_builder DISABLE REGISTRATION
Event_Builder_Agenda_Advanced_DisplayName event_builder Display Name
Event_Builder_Agenda_Advanced_HelpText_1 event_builder On this tab, you can manage sessions to behave differently for individual tickets. There are 3 settings you can control:
Event_Builder_Agenda_Advanced_HelpText_2 event_builder The "HIDE DURING REGISTRATION" checkbox controls whether the schedule item displays during registration.
Event_Builder_Agenda_Advanced_HelpText_3 event_builder The "DISABLE REGISTRATION" checkbox removes the ability to purchase the schedule item during registration.
Event_Builder_Agenda_Advanced_HelpText_4 event_builder The "REQUIRED FOR REGISTRATION" checkbox controls whether the schedule item is required for purchase.
Event_Builder_Agenda_Advanced_HideduringRegistration event_builder HIDE DURING REGISTRATION
Event_Builder_Agenda_Advanced_ManageAgenda event_builder Manage Agenda by Ticket Type
Event_Builder_Agenda_Advanced_ManageAgenda_HelpText event_builder Checking this field will allow staff users to manage scheduled items by ticket type. The settings from the session will be overridden with the settings defined on the Ticket Type Scheduled Item.
Event_Builder_Agenda_Advanced_RequiredforRegistration event_builder REQUIRED FOR REGISTRATION
Event_Builder_Agenda_Advanced_TicketType_HelpText event_builder Please select the ticket type to setup schedule item configuration
Event_Builder_Agenda_Advanced_TicketTypes event_builder Ticket Types
Event_Builder_Agenda_Allow_Conflicts event_builder When checked, this session will be able to be purchased even if the user has selected another session in the same time frame.
Event_Builder_Agenda_Attendees Attendees
Event_Builder_Agenda_Capacity Capacity
Event_Builder_Agenda_Day Day
Event_Builder_Agenda_Description event_builder The description of the session that will display in the portal.
Event_Builder_Agenda_Enable_Schedule_Items event_builder If checked, the event will be enabled to utilize the Agenda functionality.
Event_Builder_Agenda_Enable_Waitlist event_builder This allows user to be put on the session waitlist if it sells out.
Event_Builder_Agenda_Filter_By Filter By
Event_Builder_Agenda_Filters_Applied Filters Applied
Event_Builder_Agenda_Hide_Schedule_Item_Filters Hide Schedule Item Filters
Event_Builder_Agenda_Instructions event_builder Agenda Instructions
Event_Builder_Agenda_Instructions_Help_Text event_builder The text that appears at the top of the "Agenda" page during registration.
Event_Builder_Agenda_Room_Location event_builder If rooms are enabled, the assigned room for the session.
Event_Builder_Agenda_Schedule_Item_Search Schedule Item Search
Event_Builder_Agenda_Search_and_Filter_Schedule_Items Search and Filter Schedule Items
Event_Builder_Agenda_Session_Search Session Search
Event_Builder_Agenda_Show_Schedule_Item_Filters Show Schedule Item Filters
Event_Builder_Agenda_Sort_By Sort By
Event_Builder_Agenda_Speaker Speaker
Event_Builder_Agenda_Track Track
Event_Builder_Attendee_Selection_Instructions event_builder Attendee Selection Instructions
Event_Builder_Attendee_Selection_Instructions_Help_Text event_builder The text that appears at the top of the "Attendee Selection" page during registration.
Event_Builder_Auto_Sell_Out event_builder When checked, the system will automatically check the Sold Out field when the number of registered attendees have reached the event capacity.
Event_Builder_Banner_Image event_builder Recommended size 1400px by 300px. (Image will be cropped to these dimensions)
Event_Builder_Browser_Label event_builder Browser Label
Event_Builder_Capacity_Ticket_Quantity event_builder The attendee capacity for an event. If the Auto Sell Out checkbox is checked, the event will be marked sold out when the number of registered attendees reach this number.
Event_Builder_Closed_Event_Status event_builder Closed Event Status
Event_Builder_Closed_Event_Status_Help event_builder The text entered in this field will appear in bold in place of the register button when the registration is closed.
Event_Builder_Color_Scheme_Tab Color Scheme
Event_Builder_Contact_Search_Fields_CSV event_builder This defines the fields which will be displayed when the primary registrant searches for Contacts on the "Select Attendee" screen.
Event_Builder_Custom_CSS_Tab Custom CSS
Event_Builder_Custom_Fields event_builder Custom Fields
Event_Builder_Delete_Page event_builder Delete
Event_Builder_Delete_Schedule_Item Delete Schedule Item
Event_Builder_Delete_Schedule_Item_Text Are you sure you want to delete this Schedule Item?
Event_Builder_Delete_Track Delete Track
Event_Builder_Delete_Track_Text Are you sure you want to delete this Track?
Event_Builder_Disable_Attendee_Assignment event_builder Disable Attendee Assignment
Event_Builder_Disable_Attendee_Assignment_Helptext event_builder By checking this field, the user will bypass the need to insert attendee names. This means all attendee records will have the name of the purchaser.
Event_Builder_Edit_In_Salesforce event_builder Edit In Salesforce
Event_Builder_Edit_Page event_builder Manage Components
Event_Builder_Edit_Schedule_Item Edit Schedule Item
Event_Builder_Edit_Schedule_Item_Caption Edit Schedule Item
Event_Builder_Enable_Assigned_Seating event_builder When checked, the event becomes an assigned seating event. The Seating tab will appear which allows a staff user to define seating sections for the event.
Event_Builder_Enable_Contact_Restriction event_builder When checked, this allows only one attendee record per contact for the event. This does not allow a contact to buy multiple tickets for themselves.
Event_Builder_Enable_Contact_Search event_builder When checked, event allows the primary registrant to search for other Contacts associated with their Account in the system.
Event_Builder_Enable_DisplayName_And_DT_HelpText event_builder When unchecked, the display name and event date and time will not show in the event's navbar.
Event_Builder_Event_Display_Name event_builder External event name.
Event_Builder_Event_Name event_builder Internal event name.
Event_Builder_Event_Pass_Image event_builder Event Pass Image
Event_Builder_Event_Pass_Image_Help_Text event_builder The value defined in this field will display as the image on the printable event pass. Defaults to null.
Event_Builder_Event_Pass_Settings event_builder Event Pass Settings
Event_Builder_Images_Tab Images
Event_Builder_Information_Additional_Information Additional Information
Event_Builder_Information_Contact_Attendee_Settings Contact/Attendee Settings
Event_Builder_Information_Event_Dates Event Dates
Event_Builder_Information_Event_Info_Details Event Info Details
Event_Builder_Information_Optional_Event_Types Optional Event Types
Event_Builder_Information_Validation_Message {0} is required.
Event_Builder_Invitation_Only event_builder When checked and the event is saved, the event becomes an invitation only event. The Invitation Only tab will appear in the left-side navigation to set up the invitations.
Event_Builder_Location_And_Time event_builder Location and Date Text
Event_Builder_Location_And_Time_Help event_builder The value defined in this field will display in the upper right hand side of the navbar overriding the city, state, and date/time.
Event_Builder_Manage_Package_Items Manage Package Items
Event_Builder_Manage_Package_Items_For Manage Package Items for <span class="strong">{0}<span>
Event_Builder_Navigation_Label event_builder Navigation Label
Event_Builder_Registration_Instructions event_builder This text will show above the tickets at the ticket selection screen.
Event_Builder_Schedule_Item_AccessPermissions Enable Access Permissions
Event_Builder_Schedule_Item_Allow_Conflicts Allow Conflicts
Event_Builder_Schedule_Item_Capacity Capacity
Event_Builder_Schedule_Item_Duration Duration
Event_Builder_Schedule_Item_Enable_Waitlist Enable Waitlist
Event_Builder_Schedule_Item_End_Date_Time End Date and Time
Event_Builder_Schedule_Item_Event_Active Active when the event is active
Event_Builder_Schedule_Item_Event_Not_Active Is Active
Event_Builder_Schedule_Item_Image_URL event_builder Image URL
Event_Builder_Schedule_Item_Name Schedule Item Name
Event_Builder_Schedule_Item_RoomLocation Room / Location
Event_Builder_Search_All_Contacts event_builder When checked, event allows the primary registrant to search all Contacts in the system regardless of their associated Account. Privacy settings for this can be configured separately on the Account and Contact objects.
Event_Builder_Search_Date Date
Event_Builder_Search_Schedule_Item Search Schedule Item
Event_Builder_Search_Track Track
Event_Builder_Seating_Ticket_Capacity_Doesnt_Match Cannot publish event. Total number of seats is not equal to the amount of available tickets for the event.
Event_Builder_Seating_Warning_Overbooked Total number of seats exceeds the event’s capacity by {0}.
Event_Builder_Seating_Warning_Underbooked Total number of seats is {0} less than the event’s capacity.
Event_Builder_Sold_Out event_builder When checked, this marks the event sold out and removes the registration button from the event.
Event_Builder_Speaker_Status event_builder Speaker will display in the portal only if the status value is Accepted.
Event_Builder_Sponsor_Package_Description event_builder Description of the package that will display in the portal.
Event_Builder_Sponsor_Package_Enable event_builder When checked, this enables sponsor packages for the event.
Event_Builder_Sponsor_Package_Image_Url event_builder Recommended size 100px by 100px. (Image will be cropped to these dimensions)
Event_Builder_Sponsor_Package_Is_Active event_builder When checked, this package will display in the portal.
Event_Builder_Thumbnail_Image event_builder Recommended size 265px by 265px. (Image will be cropped to these dimensions)
Event_Builder_Tickets_Attendees_Per_Group event_builder Maximum number of attendees that can be added to a single ticket.
Event_Builder_Tickets_Description event_builder Description of the ticket in the registration flow.
Event_Builder_Tickets_Enable_Refund event_builder When checked, the user is able to request a refund for the purchased ticket. Note: Approving the refund request is a separate manual process.
Event_Builder_Tickets_Enable_Waitlisting event_builder When checked, allows attendees to be added to a waitlist when the ticket is Sold Out.
Event_Builder_Tickets_Group_Type event_builder Name or type of the group. Ex. Table.
Event_Builder_Tickets_Image_URL event_builder Recommended size 100px by 100px. (Image will be cropped to these dimensions)
Event_Builder_Tickets_Is_Active event_builder When checked, the ticket can be purchased. If it is not checked, the ticket cannot be bought, including in the backend.
Event_Builder_Tickets_Is_Group_Ticket event_builder Group Ticket Types define the number of Attendees Per Group. Examples of Group Ticket Types include Reception Tables or Family Events. When checked, multiple attendees can be attached to 1 ticket.
Event_Builder_Tickets_Is_Published event_builder When checked, ticket appears in the portal.
Event_Builder_Tickets_Refund_Request_Policy event_builder The text that displays in the portal if a user requests a refund.
Event_Builder_Tickets_Restrict_Quantity_Order event_builder When checked, this will force the user to buy the amount the user specifies in the Min and Max quantities below.
Event_Builder_Tickets_Sales_Start_Date event_builder This field is only referenced if the Lightning event is positioning its statuses to automatically transition.
Event_Builder_Tickets_Show_Tickets_Remaining event_builder When checked, the remaining supply of tickets will display at the ticket selection screen.
Event_Builder_Tickets_Ticket_Information event_builder Ticket information text will be displayed in the PDF Ticket footer.
Event_Builder_Track_Color event_builder Track Color
Event_Builder_Tracks event_builder TRACKS
Event_Builder_Tracks_Description event_builder Assign existing schedule items to session tracks
Event_Builder_Venue_Description event_builder This will be the description shown for the venue in the event.
Event_Builder_Venue_Display_Map event_builder When checked, this will show a map with the entered address above in the middle of the map with a dropped pin.
Event_Builder_Venue_Primary_Venue event_builder When checked, this will populate the Primary Venue and Venue Map components configured on the Event Pages. There can only be one Primary Venue.
Event_Builder_Venue_Venue_Image_Url event_builder Recommended size 400px by 400px. (Image will be cropped to these dimensions)
Event_Category Event Category
Event_Category_Buckets_Help_Text event_builder The Event Category buckets similar events together. During clone you can change event listing by changing the category.
Event_Category_Tie_To_Event_Help_Text event_builder The event category is used to define similar types of events.
Event_Description_Event_Builder event_builder Description
Event_Description_Help_Text event_builder This field is displayed on the related event in the portal event search list view.
Event_Disabled event_reg Event is not open for registration.
Event_Display_Name_Event_Builder event_builder Event Display Name
Event_Duration_Help_Text event_builder Duration is calculated using a 31 day month and a 366 day year. For example, an event starting on 2/25 and ending on 3/28, has a total of 31 days, which the system calculates as a duration of 1 month.
Event_Duration_Validation event_builder Duration must be greater than 0.
Event_Email_Accepted event_email_notification Invitation has been accepted!
Event_Email_Declined event_email_notification Invitation has been declined.
Event_Email_Invitation_Button event_email_notification Respond to Invitation
Event_Email_Invited event_email_notification You have been invited!
Event_Email_Invited_Title event_email_notification Event Invitation
Event_Email_Manage_Button event_email_notification Manage My Registration
Event_Email_Registered event_email_notification You're Registered!
Event_Email_Registered_Title event_email_notification Group Registration Invite
Event_Email_Registration_Subject event_reg Invitation To Register For Event
Event_Email_View_Button event_email_notification View Event
Event_Enable_Waitlist event_builder Capacity must be greater than zero if enable waitlist is selected
Event_Event_Builder simple_event Event
Event_Includes_Event_Builder event_builder This event category includes:
Event_Info_Event_Builder event_builder Event Info
Event_Invitation_No_Records event_builder No records to display
Event_Invitation_Only_Status_Filter event_builder Invitation Status Filter
Event_Name_Event_Builder event_builder Event Name
Event_Not_Found event Event not found.
Event_Not_Found_Description event Error setting up group registration page for selected event..
Event_Or_Category_Required event Event or Event Category required
Event_Overview_Event_Builder event_builder Event Overview
Event_Sections event_builder Event Sections
Event_Speakers event,speaker EVENT SPEAKERS
Event_Status_Create_Filter event Create Transition Criteria
Event_Status_Filter_Condition simple_event Filter Condition
Event_Status_Filter_Field simple_event Field
Event_Status_Filter_Operator simple_event Operator
Event_Status_Filter_Value simple_event Value
Event_Status_Is_Advanced simple_event Advanced
Event_Status_Is_Advanced_Help_Text simple_event Checking this will enable you to use a text box to input the SOQL parameter instead of using the builder.
Event_Status_Name_Event_Builder event_builder Status Name
Event_Status_Selected_Filter_Criteria simple_event Selected Filter Criteria
Event_Status_Transition_Criteria simple_event Transition Criteria
Event_Statuses event_builder Event Statuses
Event_Ticket_Attendee_Name event ticket Attendee Name
Event_Ticket_Date_Time event ticket Date & Time
Event_Ticket_End_Date event ticket End
Event_Ticket_Name event ticket Event
Event_Ticket_Order_By event ticket Order by
Event_Ticket_Order_Information event ticket Order Information
Event_Ticket_Order_Number event ticket Order #
Event_Ticket_Start_Date event ticket Start
Event_Ticket_Ticket_Name event ticket Ticket
Event_Ticket_Venue_Name event ticket Venue
Event_Validation_Waitlist_Message events,validation Please enter a capacity.
Example_Event_Builder event_builder Example
Exit_Event_registration_Button event_builder Exit
Featured_Event_Builder event_builder Featured
Flex_Day_Of_Month_Event_Builder event_builder Flex Day of the Month
Form_Event_Builder simple_event Form
Form_Heading_Event_Builder event_builder Form Heading
Form_Open_Info_Event_Builder event_builder Forms will open in a new browser tab.
Free_Cost event_reg Free
Full_Legend_Label event_reg,agenda_builder Full
Go_Back event_builder Go Back
Group_Management event_reg Group Management
Group_Type event_builder Group Type
Has_Charge_Package_Item_Event_Builder event_builder Calculate pricing
In_Minutes event_builder in minutes
Income_Account_Event_Builder event_builder Income Account
Information_Event_Builder event_builder Information
Insert_HTML_Event_Builder simple_event Insert HTML
Interview_Questions validation Interview Questions
Invalid_Duration_Event_Builder event_builder Invalid Duration
Invalid_Schedule_Item_End_Date schedule_item End Date Time Outside Of Event Bounds
Invalid_Schedule_Item_Start_Date schedule_item Start Date Time Outside Of Event Bounds
Invalid_Status_Transition_Criteria event_builder Invalid SOQL WHERE clause, please check your syntax and refer to the documentation for examples of valid SOQL WHERE clauses.
Invitation_Only_Attendees_Event_Builder event_builder Invitation Only
Invite event_reg Invite
Invoice_Line_Payment_Priority event_builder Payment Priority
Is_Active_Event_Builder event_builder Is Active
Is_Active_Status_Event_Builder Registration Open
Is_Contribution_Event_Builder event_builder Is Contribution
Is_Group_Ticket_Type event_builder Is Group Ticket Type
Is_Published_Event_Builder event_builder Is Published
Is_Published_Status_Event_Builder Published To Portal
Is_Tax_Deductible_Event_Builder event_builder Is Tax-Deductible
Is_Taxable_Event_Builder event_builder Is Taxable
Item_And_Or_Item_Class_Might_Not_Be_Populated event_builder Item and/or Item Class fields might not be configured properly
Item_Class_Event_Builder event_builder Item Class
Item_Event_Builder event_builder Item
Join_Waitlist event_reg,agenda_builder Join Waitlist
List_Price_Colon_Event_Builder event_builder List Price:
List_Price_Event_Builder event_builder List Price
Loading_Event_Builder event_builder Loading ...
Loading_Text event_reg Loading... Please Wait...
Location_Event_Builder event_builder Location
Logo_Image_Help The image defined in this field appears in the lefthand side of the navbar in the microsite. Recommended size 90px by 90px. (Image will be cropped to these dimensions)
Logo_Image_Label Event Page Logo
Max_Per_Item_Event_Builder event_builder Maximum Quantity Per Item
Maximum_Quantity_Event_Builder event_builder Maximum Quantity
Message event_reg Message
Minimum_Quantity_Event_Builder event_builder Minimum Quantity
Minute event_builder minute
Name_Event_Builder event_builder Name
New_Event_Event_Builder event_builder New Event
New_Package_Item_Event_Builder event_builder New Package Item
New_Page_Event_Builder simple_event New Page
New_Sponsor_Package_Event_Builder event_builder New Sponsor Package
New_Status_Event_Builder simple_event New Status
New_Ticket_Types_Event_Builder event_builder New Ticket Type
No_Access_To_Item_Event_Builder event_builder No Access to this Item
No_Charge_Package_Item_Event_Builder event_builder At no additional charge
No_Event_Builder event_builder No
No_Package_Items_Event_Builder event_builder No package items created.
No_Schedule_Items_Available event_reg No Schedule Items Available
No_Schedule_Items_Available_Description event_reg No active schedule items for specified event or you do not have permission to access them.
No_Search_Results_Found event_reg No Search Results Found
No_Speakers_Event_Builder event_builder There are no speakers.
No_SponsorPackages_Event_Builder event_builder There are no sponsor packages.
No_Sponsors_Event_Builder event_builder There are no sponsors
No_Statuses_Event_Builder event_builder There are no statuses.
No_Ticket_Types_Available event_reg No Ticket Types Available
No_Ticket_Types_Available_Description event_reg No active ticket types for specified event or you do not have permission to access them.
No_Ticket_Types_Selected event_reg Plese Select Ticket Type
No_Tickets_Event_Builder event_builder There are no tickets.
No_Tracks_Event_Builder event_builder There are no tracks.
No_Venues_Event_Builder event_builder There are no venues.
Non_200_Response_Returned passbook Non 200 Response Returned
None_Schedule_Items_Found event,session None Schedule Item found for this Event.
Number_Of_Assignments_Required_Group_Ticket_Type ticket_type validation If Ticket Type is a group type, then maximum number of assignments is required.
Occurrences_Event_Builder event_builder Occurrences
On_Event_Builder event_builder On
On_Site_Price_Event_Builder event_builder On-Site Price
One_Status_Required event_builder At least one status is required for each event.
Options_Event_Builder event_builder Options
Order_Cannot_Be_Negative event_builder Order cannot be less than zero.
Package_Items_Event_Builder event_builder Package Items
Pages_Description_Info_Event_Builder event_builder Create and configure pages for your selected status.
Pages_Drag_Drop_Event_Builder event_builder Drag and drop pages in the order you want them to appear in your Event.
Pages_Event_Builder event_builder Pages
Passbook_Event_Name_Field passbook_events Event
Passbook_Location_Field passbook_events Location
Passbook_Name_Field passbook_events Attendee
Passbook_Ticket_Type_Field passbook_events Ticket Type
Planned_Event_Status_Button event_builder Draft
Preview_In_Event_Builder event_builder Preview In
Previous event_reg Previous
Previous_Agenda_Questions event_reg Previous
Price_Event_Builder event_builder Price
Primary_Attendee Event Primary Attendee
Primary_Event_Builder event_builder Primary
Primary_Venue_Event_Builder event_builder Primary Venue
Primary_Venue_Name_Event_Builder event_builder Primary Venue / Location Name
Publish_Event_Builder event_builder Publish
Publish_Event_Event_Builder event_builder Publish Event
Publish_Event_Info_Event_Builder event_builder This event will publish to:
Published_Event_Builder event_builder Published
Published_Event_Status event_builder Published
Quantity_Available_Event_Builder event_builder Quantity Available
Quantity_Event_Builder event_builder Quantity
Refresh_Event_Builder event_builder Refresh
Refund_Account_Event_Builder event_builder Refund Account
Refund_Request_Policy event_builder Refund Request Policy
Register event_reg,agenda_builder Add
Register_For_Event validation Register For Event
Register_Group_Button_Label event_reg Register Group
Register_Now event_reg Register Now
Register_Other_Users event_reg Register Other Users?
Register_Other_Users_Info event_reg Register a group of users that are attending the event.
Registered event,attendee Registered
Registration_Group_Name event_reg Registration Group Name
Registration_Timer event_builder Registration Timer (in minutes)
Registration_Type event_reg Type
Registration_URL_Required_Based_On_Reg_Type event Registration URL required based on registration type
Remove_Event_Builder event_builder Remove
Remove_Waitlist event_reg Remove Waitlist Entry
Remove_Waitlist_Button_Label event_reg Remove
Repeat_Event_Event_Builder event_builder Repeat Event
Repeats_Event_Builder event_builder Repeats
Repeats_Every_Event_Builder event_builder Repeats Every
Required_Event_Builder event_builder Required
Required_Package_Item_Class_Event_Builder event_builder Customer must purchase at least one item in group
Required_Package_Item_Event_Builder event_builder Always include this item as part of the package
Reserved_For_Future_Use event Reserved for future use.
Restrict_Event_Access event_builder Restrict who has access to this event.
Restrict_Event_Builder event_builder Restrict
Restrict_Quantity_Event_Builder event_builder Restrict Quantity Per Order
Restrict_ScheduleItem_Access event_builder Restrict who has access to individual schedule items.
Restrict_TicketType_Access event_builder Restrict who has access to individual ticket types.
Revenue_Recognition_Date_Event_Builder event_builder Revenue Recognition Date
Revenue_Recognition_Rule_Event_Builder event_builder Revenue Recognition Rule
Revenue_Recognition_Term_Rule_Event_Builder event_builder Revenue Recognition Term Rule
Save_Close_Event_Builder event_builder Save & Close
Save_Continue_Event_Builder event_builder Save & Continue
Save_Event event Save Event
Save_Event_Builder event_builder Save
Save_Exit_Event_Builder event_builder Save & Exit
Save_Filter_Criteria event Save
Save_Invitees event_reg Continue
Save_Publish_Event_Builder event_builder Publish
Save_Ticket_Type_Reg validation Proceed
Saving_Event_Builder event_builder Saving
Schedule_Item_Access_Permission_Builder event_builder Schedule Item:
Schedule_Item_Direction_Event_Builder event_builder Schedule Items object will open in a new browser tab.
Schedule_Items event_builder Schedule Item
Schedule_Items_Not_Enabled event,session Schedule Items are not enabled for this Event.
Schedule_Items_Not_Enabled_On_Event event_builder Schedule Items not enabled on Event
Schedule_Items_Plural_Event_Builder event_builder Schedule Items
Schedule_Items_Singular_Event_Builder event_builder Schedule Item
Scheduled_Legend_Label event_reg,agenda_builder Scheduled
Search_Results_Button event_reg Ok
Section_View_Only_Mode event_builder Sections are view-only when the current active status has “Registration Open” enabled.
Sections_Description_Event_Builder event_builder Drag and drop sections in the order you want them to appear in the event registration.
Sections_Event_Builder event_builder Seating
Sections_Title_Event_Builder event_builder Sections
Select_Badge_Types_Event_Builder event_builder Select Badge Types
Select_Invitees event_reg Select Invitees
Select_Package_Item_Class_Event_Builder event_builder Select Item Class
Select_Package_Item_Event_Builder event_builder Select Item
Select_Sections_to_Clone event_builder Select which sections you would like to clone
Select_Ticket event_reg Select Ticket
Select_Ticket_Type_Option event_reg Please Select Ticket Type
Select_Ticket_Type_Waitlist_Only event_reg Select Ticket Type
Sender_Name event_reg Event Registration
Session_Shopping_Cart_Instructions event, session Instructions
Session_Shopping_Cart_Label event, session Sessions
Show_Tickets_Remaining_Event_Builder event_builder Show Tickets Remaining
Simple_Event_Cancel_Button simple_event Cancel
Simple_Event_Change_Ticket_Quantity simple_event Change Quantity
Simple_Event_Change_Tickets simple_event Change Ticket Selection
Simple_Event_Checkout_Button_Label simple event page Checkout
Simple_Event_Join_Waitlist simple_event Join Waitlist
Simple_Event_No_Tickets_Selected_Message simple event page You must select at least 1 ticket to continue registration.
Simple_Event_On_Waitlist simple_event You are on the waitlist!
Simple_Event_Overview_Heading simple event page About the event
Simple_Event_Price_Rule_End_Date_Joiner simple event page ends
Simple_Event_Quantity_Remaining_Suffix simple event page remaining
Simple_Event_Register_Now simple_event Register Now
Simple_Event_Registration_Form_Heading simple event page Registration Form
Simple_Event_Sidebar_Heading simple event page When & Where
Simple_Event_Submit_Button simple_event Submit
Simple_Event_Ticket_Type_Sold_Out simple_event Sold Out!
Simple_Event_Ticket_Type_Table_Heading simple event page Select tickets
Single_Checkout event_reg Single Checkout
Single_Group_Event_Builder event_builder Single Item or Group of Items?
Single_Registration_Instructions event_reg Please click the link below to register for your event.
Site_Event_Builder event_builder Site
Sold_Out simple_event Sold Out
Some_Schedule_Items_Could_Not_Be_Cloned event_builder Some Schedule Items could not be cloned
Some_Ticket_Types_Could_Not_Be_Cloned event_builder Some Ticket Types could not be cloned
Someone_Else event_reg For Someone Else
Speaker_Bio_Event_Builder event_builder Speaker Bio
Speaker_Event_Builder event_builder Speaker
Speaker_Information_Not_Found event,speaker Speaker Information not found.
Speaker_Name_Event_Builder event_builder Speaker Name
Speaker_Photo_Url_Event_Builder event_builder Speaker Photo URL
Speakers event,speaker Speakers
Speakers_Drag_Drop_Event_Builder event_builder Drag and drop Speakers in the order you want them to appear on the Speaker and Featured Speaker components.
Speakers_Event_Builder event_builder Speakers
Speakers_Overview_Event_Builder event_builder Speakers Overview
Sponsor_HyperLink_Event_Builder event_builder Sponsor Hyperlink
Sponsor_HyperLink_HelpText_Event_Builder event_builder The value in this field will allow front end users to click on the sponsor image to navigate to the URL.
Sponsor_Information_Not_Found event,sponsor Sponsor Information not found.
Sponsor_Name_Event_Builder event_builder Sponsor Name
Sponsor_Package_Direction_Event_Builder event_builder Sponsor Package object will open in a new browser tab.
Sponsor_Package_Image_URL event_builder Image URL
Sponsor_Package_Name_Event_Builder event_builder Sponsor Package Name
Sponsor_Packages event_builder Sponsor Packages
Sponsor_Packages_Drag_Drop_Event_Builder event_builder Drag and drop Sponsor Packages in the order you want Sponsor to appear on the Sponsor page.
Sponsor_Packages_Event_Builder event_builder Sponsor Packages
Sponsor_Packages_Singular_Event_Builder event_builder Sponsor Package
Sponsors event,sponsor SPONSORS
Sponsors_Enable_Sponsor_Sales Enable Sponsor Sales
Sponsors_Event_Builder event_builder Sponsors
Sponsors_Overview Sponsors Overview
Sponsorships_Not_Enabled event,sponsor Sponsorships are not enabled for this event.
Start_Date_Cannot_Past_Event_Builder event_builder Start Date Cannot Be In The Past
Start_Date_Required event Start Date Required.
Start_Date_Time_Required event Start Date Time Required.
Start_Time_Invalid_Format event Invalid Format, Must Be (HH:MM AM|PM) Or (HH:MM).
Start_Time_Required event Start Time Required.
Starts_On_Event_Builder event_builder Starts On
State_Event_Builder event_builder State / Province / County
Status_Criteria_Required_For_Automatic_Transitions event_builder Status Transition Criteria required if automatic transition is enabled.
Status_Event_Builder event_builder Status
Status_Label_Event_Builder event_builder Status:
Status_Transition_Criteria_Event_Builder simple_event Status Transition Criteria
Statuses_Description_Info_Event_Builder simple_event Create and configure statuses for your event.
Statuses_Drag_Drop_Event_Builder simple_event Order statuses in the order that you want them to transition.
Statuses_Event_Builder event_builder Statuses
Street_Event_Builder event_builder Street
Subject event_reg Subject
Summary event_reg Summary
Tax_Class_Event_Builder event_builder Tax Class
Term_In_Months_Event_Builder event_builder Term (In Months)
Theme_Event_Builder Theme
Thumbnail_Image_Event_Builder event_builder Thumbnail Image
TicketType_No_AR_Account event_builder A/R Account is required to create a ticket type.
TicketType_No_Adjustment_Account event_builder Adjustment Account is required to create a ticket type.
TicketType_No_Income_Account event_builder Income Account is required to create a ticket type.
TicketType_No_Refund_Account event_builder Refund Account is required to create a ticket type.
Ticket_Image_URL_Event_Builder event_builder Ticket Image URL
Ticket_Information_Event_Builder event_builder Ticket Information
Ticket_Max_Quantity_Validation event_builder Maximum Quantity required if Restrict Quantity Per Order checked
Ticket_Min_Max_Validation event_builder Maximum Quantity cannot be less than Minimum Quantity.
Ticket_Min_Quantity_Validation event_builder Minimum Quantity required if Restrict Quantity Per Order checked
Ticket_Name_Event_Builder event_builder Ticket Name
Ticket_Quantity_Cannot_Be_Negative event_builder Ticket Quantity cannot be negative.
Ticket_Quantity_Event_Builder event_builder Ticket Quantity
Ticket_Quantity_WaitList_Entry There are waitlist entries present for this ticket/ticket block. The system will continue to restrict new purchases until the waitlist entries have been addressed.
Ticket_Sales_Begins_Event_Builder event_builder Ticket sales begin
Ticket_Sales_Start_Date_Cannot_Be_After_Start_Date events Ticket Sales Start Date Cannot Be After Start Date
Ticket_Sales_Start_Date_Cannot_Be_Before_Today events Ticket Sales Start Date Cannot Be In The Past
Ticket_Sold_Validation event Tickets Sold cannot be more than Ticket Quantity.
Ticket_Type validation Ticket Type
Ticket_Type_Access_Permission_Builder event_builder Ticket Type:
Ticket_Type_Sort_Field_Not_Valid event Ticket type sort field is not a valid field on the Ticket Type.
Ticket_Type_Sort_Field_Required event Ticket type sort field is Required.
Ticket_Types event_builder Ticket Types
Ticket_Types_Event_Builder event_builder Ticket Types
Ticket_Types_Singular_Event_Builder event_builder Ticket Type
Ticket_Types_To_Publish event_builder This event will publish with the following tickets:
Tickets event_reg Tickets
Tickets_Enable_Group_Reg Enable Group Registration
Tickets_Event_Builder event_builder Tickets
Tickets_Form Form
Tickets_Form_Heading Form Heading
Tickets_Group_Reg_Instructions Group Registration Instructions
Tickets_Guest_Reg_Field_Set_CSV Guest Registrant Field Set CSV
Tickets_Registration_Instructions Registration Instructions
Tickets_Ticket_Display_Order Ticket Display Order
Tickets_Ticket_Sales_Start_Date Ticket Sales Start Date
Tickets_eTicket_Label_Color eTicket Label Color
Tickets_eTicket_Value_Color eTicket Value Color
Title event_reg Select Ticket Type
Title_Event_Builder event_builder Title
To_These_Badge_Types_Event_Builder event_builder To these Badge Types
Total event Total
Transition_Criteria_Info_Event_Builder simple_event Transition Criteria allows you to automate when your event changes to this status
Unable_To_Display_Body_Event_Builder event_builder Please add this event category to a site.
Unable_To_Display_Header_Event_Builder event_builder Unable to display event preview.
Validation_Event_Is_not_Enabled_For_Schedule_Items validation Related event is not enabled for Schedule Items.
Validation_Event_Is_not_Enabled_For_Sponsor_Package validation Related event is not enabled for Sponsor Packages.
Validation_Event_Start_End_Date validation This event ends before it begins, please adjust the event start date time and end date time accordingly.
Validation_Only_Single_Primary_Venue_Allowed venue_event Only single primary venue allowed per event
Validation_Schedule_Item_Config validation Cannot disable and require registration on this item, please select only one option or go to Advance Settings to configure this item per ticket type
Vendor_Event_Builder event_builder Vendor
Vendors event_builder Vendors
Venue event,venue Venue
Venue_Details event,venue VENUE DETAILS
Venue_Event_Builder event_builder Venue
Venue_Image_Url_Event_Builder event_builder Venue Image URL
Venue_Information_Not_Found event,venue Venue Information not found.
Venue_Name_Event_Builder event_builder Venue Name
Venues event_builder Venues
Venues_Event_Builder event_builder Venues
Venues_Overview_Event_Builder event_builder Venues Overview
View_Reciept event_reg_email VIEW RECEIPT
Waitlist_Info validation Waitlist:
Waitlist_Legend_Label event_reg,agenda_builder Waitlist
Website_Event_Builder event_builder Website
Who_Is_Registering event_reg Who Is Registering?
Who_To_Invite event_reg Who would you like to Invite?
Yes_Event_Builder event_builder Yes
Yourself event_reg Yourself
Zip_Code_Event_Builder event_builder Zip / Postal Code

LightningLens

API Name Categories Value
Abandon_Registration event Are you sure you want to abandon the registration process?
Accept_Invitation event Accept Invitation
Account_Label event Company/Organization
Add_All_Sessions_Conflict_Message Login_Component One or more sessions conflict with other sessions. Please select the individual session you would like to attend.
Add_Group_Ticket_New_Attendees event New Ticket
Add_Ticket_New_Attendee event New Attendee
Add_To_Calendar event_calendar Add to Calendar
Add_To_Order event Add to Order
Address_Information event_payment Address Information
Agenda_Room event Room
Agenda_Speaker event Speaker
Agenda_Speakers event Speakers
All_Attendees_Required attendee selection All Attendees Required!
All_Tickets_On_Waitlist event_payment Please confirm waitlist tickets.
Apply_Sales_Order checkout Apply
At_Least_One_Ticket_Not_Selected event At Least One Ticket Should Be Selected.
Attendee_Information_Add_Button_label event Add Attendee
Attendee_Information_Header_Label event Attendee Information
Attendee_No_Information_Needed event No additional information required.
Attendee_Reg_Action_Cancel event Cancellation Request
Attendee_Reg_Action_Transfer event Transfer Registration
Attendee_Selection_Title event Attendee Selection
Attendee_Selector_Information event Select your attendee and fill out any additional information required.
Attendee_Selector_Label event Attendee
Attendee_Selector_Message event To change the attendee, delete this attendee from your order and add a new one.
Cancel_Add_Tickets_Message_First event Are you sure you wish to leave this screen?
Cancel_Add_Tickets_Message_Second event You will lose any unsaved changes.
Cancel_Attendee_Information_My_Reg event Close
Cancel_Reg_First Cancel Registration Are you sure you want to cancel your registration process?
Cancel_Reg_No Cancel Registration No
Cancel_Reg_Second Cancel Registration All information you have entered will be lost.
Cancel_Reg_Yes Cancel Registration Yes
Cancel_Registration_Header cancel reg Cancel Registration
Cancellation_Requested event CANCELLATION REQUESTED
Cannot_Register_Contact_Multiple_Times event Cannot register using the same contact multiple times.
Cant_Invite_More_Guests event Can't invite more guests
Cant_Load_Reg_Process event Error loading registration process. Please try again.
Cant_Remove_Invited_Attendee event Can't remove invited attendee
Confirm_Order event Confirm Order
Confirm_Waitlist event Confirm Waitlist
Contact_Already_Registered event Contact already registered
Create_User_Account_Override_Button login Create User Account
Decline_Invitation event Decline Invitation
Delete_Item_First_Line event Are you sure you want to delete
Delete_Item_Second_Line event This will remove any associated recommended items.
Delete_Ticket_First_Line event Are you sure you want to delete
Delete_Ticket_Second_Line event This will remove any associated sessions and recommended items.
Discount_Code_Sales_Order checkout Discount
Edit_Attendee_Information_My_Reg event my reg Edit Attendee Information
Edit_Order_Summary event Edit
Email_Attendee_Information_My_Reg event Email
Event_Add_All_Button event Add All
Event_Add_All_Description event To add all sessions displayed to the selected attendee, click the “Add All” button.
Event_Add_Individual_Description event To individually add session(s) to the selected attendee, click the “Add” button for that session(s).
Event_Add_To_Order event Add To Order
Event_Add_To_Waitlist event Add to Waitlist
Event_Agenda Event Agenda
Event_Attendee_AddTicket_Button event_manage Add
Event_Attendee_Remove event_manage Remove
Event_Attendee_Remove_Ticket event_manage Remove Ticket
Event_Attendee_Selection_Ticket_Select event_manage Add Attendee
Event_Attendee_Waitlist event_manage Waitlist
Event_Cancel_Button event Cancel
Event_Cancel_Order event Cancel Order
Event_Checkout checkout Checkout
Event_Featured_Speakers event,venue Featured Speakers
Event_Featured_Sponsors event,venue Featured Sponsors
Event_Forms_Title event Event Forms
Event_Invitation_Response event_payment Invitation Response
Event_Invitation_Waitlisted event will be added to the waitlist
Event_Invitation_Waitlisted_And event and
Event_Invitation_Waitlisted_Guests event guest(s)
Event_Invitation_Waitlisted_You event You
Event_Manage_Reg_Details_Cancel event Cancel
Event_Manage_Reg_Details_Save event Save
Event_Manage_Reg_Details_Validation_Header event Validation Failed
Event_Manage_Reg_Details_Validation_Message event All required fields must be completed before saving.
Event_Next_Button event Continue
Event_Not_Found event Event Not Found
Event_Not_Found_Message event The selected event was not found.
Event_Overview event Event Overview
Event_Package_Because_Purchase event Because you purchased
Event_Package_Item_Success event {0} was successfully added
Event_Previous_Button event Back
Event_Purchase_Date event Date:
Event_Purchase_Summary_Title event Event Purchase Summary
Event_Recommend_Items event Recommend Items
Event_Recommend_Items_Description event Add recommended items to the selected attendee.
Event_Recommended_Items event Recommended Items
Event_Register_Button event Register
Event_Register_Now_Button event Register Now
Event_Registration_Selection_Header event_manage Please provide all attendee information for the selected tickets.
Event_Required_Recommend_Message event Before continuing to checkout, The following attendees must purchase atleast one item from:
Event_Schedule_Item_Conflicts_Detected event Conflicts Detected
Event_Schedule_Item_NotAvailableforPurchase event Not available for Purchase
Event_Schedule_Item_RequiredWithPurchase event Required with Purchase
Event_Schedule_Item_Soldout event Sold Out
Event_Schedule_Item_Waitlist event Waitlist
Event_Seating_Navigation event Seating
Event_Seating_Save_Button event Save
Event_Session_Day event Day
Event_Session_Search event Session Search
Event_Session_Track event Track
Event_Sessions event Sessions
Event_Sold_Out event Sold Out!
Event_Speakers Event Speakers
Event_Sponsor_Package event,venue Sponsor Package
Event_Sponsors Event Sponsors
Event_Ticket_Registration event Registration
Event_Ticket_Remaining event ticket remaining
Event_Ticket_Selection_Price event Price
Event_Ticket_Selection_Quantity event Quantity
Event_Tickets_Remaining event tickets remaining
Event_Update_Order event Update Order
Event_Waitlist_Multiple_Overflow event attendees will be added to the waitlist
Event_Waitlist_Single_Overflow event attendee will be added to the waitlist
First_Name_Attendee_Information_My_Reg event First Name
Form_Add_Entry event,venue Add Entry
Form_Entries event,venue Entries
Form_Update_Entry event,venue Update Entry
Full_Name_Attendee_Information_My_Reg event Name
Google_Maps_Address_Error venue Google Maps is Unable to Get Location Information
Guest_Prefix event (Guest)
Invitation_Only_Already_Declined event You have declined the invitation.
Invitation_Only_Already_Registered event You are registered for this event.
Invitation_Only_Already_Responded event Attendee has already responded to the invitation
Invitation_Only_Button event RSVP
Invitation_Only_Decline_Description_Text event If you change your mind and would like to attend <br> please call 888-888-8888 for assistance.
Invitation_Only_Decline_Header_Text event We are sorry you cannot attend the event
Invitation_Only_Guests_Number event Number Of Guests
Invitation_Only_Guests_Prompt event Would you like to add any guests?
Invoice_Me_Payment event Submit Invoice
Last_Name_Attendee_Information_My_Reg event Last Name
Loading Loading Loading...
Login_Component_Cancel Login_Component Cancel
Login_Component_Create_User_Account Login_Component Create a user account
Login_Component_Email Login_Component Email
Login_Component_Email_Sent Login_Component Please check your email.
Login_Component_FirstName Login_Component First Name
Login_Component_ForgotPassword Login_Component Forgot Password?
Login_Component_ForgotPassword_Email_Label Login_Component Please enter your username below. We will email you with instructions on how to reset your password.
Login_Component_ForgotPassword_Header Login_Component Forgot Password
Login_Component_Forgot_Password_Submit_Label Login_Component Submit
Login_Component_Header Login_Component Login
Login_Component_LastName Login_Component Last Name
Login_Component_Login_BTN Login_Component Login
Login_Component_Login_Section_Header Login_Component Log In to Your Account
Login_Component_Password Login_Component Password
Login_Component_Password_Validation Login_Component Your password must contain at least one digit, one lower case, one upper case, one symbol from ths list @#$%!, and at least 8 characters
Login_Component_Register_Section Login_Component Register as Guest
Login_Component_Register_Submit_Button Login_Component Register
Login_Component_UserName Login_Component Username
Login_Failed_Username event Your login attempt has failed. Make sure the username and password are correct.
Login_Override_Button login Login
Login_Tab_Name event Login
Logout_Label event Logout
Logout_Tab_Name event Logout
Manage_Registration_Forms event Manage Registration Form
Manage_Registration_Tab_Name event Manage Registration
Max_Quantity_Validation_Message event Maximum quantity allowed:
More_Pages event More
Multiple_Accounts_Found event Multiple accounts found with the same name please choose the right one.
My_Attendees_Edit_Form event Edit Form
My_Reg_View_Ticket event View Ticket
My_Registration_Cancel_Button event Cancel
My_Registration_Cancel_Header event Cancellation Request
My_Registration_Cancel_Success_Body event Ticket cancellation has been successfully requested.
My_Registration_Cancel_Success_Header event Cancellation Requested
My_Registration_Close_Button event Close
My_Registration_Request_Button event Request
No_Accounts_Found event No accounts found.
No_Attendee_Exception_Message Sorry, but you can no longer register for the event.
No_Available_Sessions session_builder No Available Sessions
No_Available_Sessions_Description session_builder There is no available sessions to purchase for this attendee.
No_Available_Sessions_Submit session_builder Close
No_Payment_text checkout There is no payment due. Click the button below to complete your order.
No_Tickets_For_Purchase event No tickets available for purchase.
No_Tracks_Available event No Tracks Available
Not_Attending_Invitation_Event event No, I am not attending this event.
Package_Item_Update_Order event Update Order
Payment_Continue_To_Event checkout Continue to Event
Payment_Download_Invoice checkout View Invoice
Payment_Download_Receipt checkout View Receipt
Payment_Information checkout Payment Information
Primary_Venue event,venue Primary Venue
Process_Payment event_payment Process Payment
Process_Payment_Title event Process Payment
Processing_Changes event_payment Processing Changes
Purchase_More_Sessions event_manage Purchase New Sessions
RSVP_Ticket_Cancelled event You cannot register at this time.
Receipt_Title event Receipt
Reg_Process_Agenda event Agenda
Reg_Process_Payment event Process Payment
Reg_Process_Select_Tickets event Select Tickets
Registration_Edit_Order_Detail event Edit Order Detail
Registration_Form_Incomplete_Message event Please fill out all required fields
Registration_Form_My_Reg event Edit Registration Form
Registration_Forms event,venue Registration Form
Registration_Forms_Email_Forms event,venue Email all forms for attendees to fill out
Registration_Forms_Total event,venue Total
Registration_Forms_Total_Price event,venue Total
Registration_Manage_Side_Bar event Manage Registration
Registration_Selection event Registration Selection
Registration_Summary event Order Summary
Registration_Table_Attendee_Name event Attendee Name
Registration_Table_Edit_Attendee event Edit Attendee
Registration_Table_Email event Email
Registration_Table_Form_Name event Form Name
Registration_Table_Ticket_Type event Ticket Name
Registration_Timed_Out event Registration Session Expired
Registration_Timed_Out_Close_Button event Close
Registration_Timed_Out_Message event Your registration session has expired.
Save_Attendee_Information_My_Reg event Save
Schedule_Item_Update_Order event Update Order
Search_Attendee_Field_Label event Search Attendee
Seats_Assigned event Seats Assigned
Seats_Assigned_Count event Assigned :
Seats_Remaining_Count event Remaining :
Seats_To_Assign event Seats to Assign
Secondary_Venues event,venue Secondary Venues
Sections event Sections
Select_Ticket_To_Assign_Seats event Select tickets to assign seats
Subtotal checkout Subtotal
Successful_Invoice checkout Your invoice has been successfully processed.
Successful_Payment checkout Your payment has been successfully processed.
Successful_Processing_Payment checkout Your order is being processed.
Tax_Required_Field_Missing event_payment Tax address required field missing.
Theme_Not_Found base_component Could not query Theme.
Ticket_Max_Capacity_reached event Ticket has reached its maximum capacity.
Ticket_Max_Sales_Quantity_reached event Ticket has reached its maximum sales quantity per order.
Ticket_Selection_Title event Ticket Selection
Ticket_Selection_Validation registration Invalid ticket selection. Please review errors below.
Ticket_Type_Update_Order event Update Order
Timer_Line_1_Message event Please complete registration within TIME_TOKEN:00 minutes.
Timer_Line_2_Message event After TIME_TOKEN:00 minutes, the ticket reservation we're holding will be released for others to purchase.
Total_Price event Total
Total_Summary_Field summary Total
Transfer_Button event Transfer
Transfer_Registration event Transfer Registration
Transfer_Registration_Confirm_Message event Are you sure you want to transfer registration?
Transfer_Registration_Confirm_Title event Confirm Transfer Registration
Transfer_Registration_Description event Search for the attendee receiving this registration transfer.
User_Login_Already_Exists event,venue User with provided email already exists. Please try logging in or resetting your password
User_Not_Found_Query base_component Could not query user. Please contact System Administrator
View_Sessions event_manage View My Agenda
Waitlist_Attendees_Heading event attendees
Waitlist_Confirmation_Text event Successfully added to the event's waitlist
Waitlist_Confirmation_Title event Waitlist Confirmed
Waitlist_Heading event Waitlist
Yes_Attending_Invitation_Event event Yes, I am attending this event.