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

Entity Posting API - Tax Type Add/Update

If the TaxTypeID does not exist, a new Tax Type 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 Tax Type Entity:

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

• SiteID attribute: Unique identifier for site that the tax type applies to. Only populated if tax type is local to the site
  String
• Name: Name for tax type
  String
  (required)
• Tags: User defined list of tags they might want to filter on
  String
• Rate: The percentage that the tax applies to the item being sold
  Integer
  • Precision attribute: The number of decimal places in the Rate field
    Integer
    (required)
• EffectiveFrom: DateTime when the tax type comes into effect
  ISO-8601 datetime
  (required)

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>
	<TaxTypes>
		<TaxType id="XXX" siteId="XXX">
			<Name>XXX</Name>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<Rate precision="XXX">XXX</Rate>
			<EffectiveFrom>XXX</EffectiveFrom>
		</TaxType>
	</TaxTypes>
</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 Tax 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="TaxType">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>