• Entity Posting API
• >>
• Stock Disposal Recorded

Entity Posting API - Stock Disposal Recorded

If the StockDisposalID does not exist, a new Stock Disposal 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 Customer Entity:

• ID attribute: Unique identifier for Stock Disposal Record
  String
  (required)
• SiteID attribute: Unique identifier for site that the Stock Disposal Record applies to
  String
  (required)
• StockId attribute: Unique identifier for Stock Item (link to StockItem entity)
  String
  (required)
• Type: Base categorisation for stock disposal
  String
• Tags: User defined list of tags they might want to filter on
  String
• SaleLocationId: Unique identifier for where the stock disposal was performed (link to SaleLocation entity)
  String
• DisposalDate: DateTime when the stock disposal was performed
  ISO-8601 datetime
  (required)
• Reason: Description of why the stock items were disgarded
  String
• NumberItems: How many of the stock item were disposed of
  Integer
  (required)
• Currency: The Currency value that defines the value of the Stock Items disposed of (defaults to site's currency)
  ISO-4217 Code e.g. USD
• ItemCost: How much the quantity of stock items disposed of cost site to buy in
  Integer
  • Precision attribute: The number of decimal places in the ItemCost field
    Integer
    (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>
	<StockDisposals>
		<StockDisposal id="XXX" siteId="XXX">
			<StockId>XXX</StockId>
			<Type>XXX</Type>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<SaleLocationId>XXX</SaleLocationId>
			<DisposalDate>XXX</DisposalDate>
			<Reason>XXX</Reason>
			<NumberItems>XXX</NumberItems>
			<Currency>XXX</Currency>
			<ItemCost precision="XXX">XXX</ItemCost>
		</StockDisposal>
	</StockDisposals>
</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 StockDisposal, 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="StockDisposal">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>