• Entity Posting API
• >>
• Fee Type Add/Update

Entity Posting API - Fee Type Add/Update

If the FeeID does not exist, a new Fee record will be created. If it does, it will be updated.

Triggered Updates:

• No other data effected

Standard ShowTimeAnalytics Message Parameters:

• DataSupplierID: Assigned unique identifier for your account
  String
  (required)
• MessageSequence: Unique sequence number incremented for each message posted
  Long
  (required)
• CallbackUrl: Dataprovider defined URL that result of processing the message is posted back to
  String

Fields for Fee Type Entity:

• ID attribute: Unique identifier for Fee Type
  String
  (required)

• SiteID attribute: Unique identifier for site that the fee type applies to. Only populated if fee type is local to the site
  String
• Name: Name for fee type
  String
  (required)
• Type: Base categorisation for fee type
  String
• Tags: User defined list of tags they might want to filter on
  String
• Currency: The Currency value that defines the amount field (defaults to site's default)
  ISO-4217 Code e.g. USD
• Amount: The amount charged by the fee
  Integer
  • Precision attribute: The number of decimal places in the amount field
    Integer
    (required)
• Rate: The percentage of the fee applied
  Integer
  • Precision attribute: The number of decimal places in the Rate field
    Integer
    (required)
• EffectiveFrom: DateTime when the fee type comes into effect
  ISO-8601 datetime
  (required)
• DistributorShared: Does the distributor get 0%, 100% or same % of the fee as performance. Acceptable values: DISTRIBUTOR_NONE (default), DISTRIBUTOR_SHARED, DISTRIBUTOR_ALL
  String
• IncludeInReporting: Should the fee be included in Revenue figures (true default) or only included in fee analysis (false)
  true/false

PLEASE NOTE: All field and attribute names are case sensitive

Message Structure - XML:

<?xml version="1.0" encoding="UTF-8"?>
<ShowTimeAnalytics dataSupplierId="XXX" messageSequence="XXX">
	<CallbackUrl>https://XXX</CallbackUrl>
	<FeeTypes>
		<FeeType id="XXX" siteId="XXX">
			<Name>XXX</Name>
			<Type>XXX</Type>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<Currency>XXX</Currency>
			<Amount precision="XXX">XXX</Amount>
			<Rate precision="XXX">XXX</Rate>
			<EffectiveFrom>XXX</EffectiveFrom>
			<DistributorShared>XXX</DistributorShared>
			<IncludeInReporting>XXX</IncludeInReporting>
		</FeeType>
	</FeeTypes>
</ShowTimeAnalytics>

Callback Post Fields:

• DataSupplierID: Unique identifier for your account, same as passed in post message
• MessageSequence: Unique sequence number for message, same as passed in post message
• ID attribute: Unique identifier for Fee Type, same as passed in post message
• Status: Processing result flag - ok/error
• Error: If the status flag is "error", list of warning messages during processing

Message Structure - XML:

<?xml version="1.0" encoding="UTF-8"?>
<ShowTimeAnalyticsResponse dataSupplierId="XXX" messageSequence="XXX">
    <Responses>
        <Response id="XXX" siteId="XXX" entity="FeeType">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>