Models

Model Definitions

Unless otherwise stated. Data reflects values as of time of data retrieval, not at time of transaction.

Attribute	Type	Description
id	string	The transactions unique identifier.
recordedAtUtc	DateTime	The date time the server recorded the transaction.
siteId	int	The ID of the site the transaction occurred at.
siteExternalId	string	An identifier that you, the user, may give to the site.
siteName	string	The name of the site at the time the the transaction occurred. This is a historical value as sites can be renamed or machines can be moved. As a result, this may not reflect the machine's current assignment.
machineId	int	The ID of the machine that generated the transaction.
machineExternalId	string	An identifier that you, the user, may give to the machine.
machineName	string	The name of the machine at the time the the transaction occurred. This is a historical value as machines can be renamed. As a result, this may not reflect the machine's current name.
machineModel	string	The machine's model number as reported by the machine.
totalPrice	decimal	The sum price of the transaction. This includes tax charged.
totalTax	decimal	The sum of all tax charged for this transaction.
lineItems	List[LineItem]	A list of items selected by the user in this transaction. Identical products may or may not have individual line items depending on your machine configuration. To confirm how many items vended, check the line item's quantity field.
paymentInformation	PaymentInformation	An object containing all payment information recorded during the transaction.

Unless otherwise stated. Data reflects values as of time of data retrieval, not at time of transaction.

Attribute	Type	Description
id	string	The line item's unique identifier.
selection	string	The historical selection number of the vended product.
vendOrder	int	Indicates when during the transaction the product was vended (1st, 2nd, 3rd).
productId	int	The ID of the vended product.
productName	string	The name of the vended product.
productUpc	string	The UPC of the vended product.
size	string	User specified descriptive sizing information about the product, such as "six pack".
taxRate	float	The tax rate charged on the specified product. 9% would be represented as `9`.
taxCharged	decimal	The amount of tax charged for this line item.
totalPrice	decimal	The amount charged for this line item. Note that this is a total based on the quantity vended in the line item, not the price per unit.
vendWasSuccessful	bool	Indicates if the line item successfully vended.
totalTax	decimal	The sum of all tax charged for this transaction.
recordedAtUtc	DateTime	The date and time that the server recorded the vending of the line items.
occurredAtUtc	DateTime	The date and time the machine vended the line item.
occurredAtLocal	DateTime	The local date and time the machine vended the line item.

Attribute	Type	Description
type	string	A string indicating the type of payment processed. Possible values are Credit, Cash, Account, Unknown.
creditInformation	CreditInformation?	If the sale was a credit sale this will contain all of the relevant information.
accountInformation	AccountInformation?	If the sale was an account sale this will contain all of the relevant information.

Attribute	Type	Description
gateway	string	The configured gateway for credit card information.
invoiceNumber	string	A unique identifier for this charge.
cardToken	string	Secure token that references the card used in the transaction.
authorizationNumber	string	An approval number generated by the gateway.
referenceNumber1	string	Identifier generated by the gateway.
referenceNumber2	string	Identifier generated by the gateway.
paymentStatus	string	Indicates the status of payment for this transaction. Valid values are authorized, charged, void, error, and unknown. Unknown will only be returned when a new type has been added to the database but is not yet supported by the api.

Attribute	Type	Description
accountNumber	string	The account number that was charged for the transaction.
nameOnAccount	string	The name of the payee as on the account.

Attribute	Type	Description
transactionId	int	The id of the transaction the metadata is associated with.
recordedAtUtc	DateTime	The date time that the transaction was recorded by the server.
tags	List[Tag]	Metadata associated with the transaction.
files	List[TransactionMetadataFile]	A list of objects containing information about the files (if any) related to the transaction.
lineItems	List[LineItemMetaData]	A list of metadata information about the transaction's line items.

Attribute	Type	Description
key	string	The name that describes the meaning of the value.
value	string	The value of the tag.

Attribute	Type	Description
id	int	The ID of the file.
type	string	The files type.
description	string	A description of the file.
createdAtUtc	DateTime	The date time that the file was created.

Attribute	Type	Description
lineItemId	int	The id of the line item the metadata is associated with.
recordedAtUtc	DateTime	The date time that the line item's vend was recorded by the server.
occurredAtUtc	DateTime	The date time that the line item's vend was recorded by the machine.
occurredAtLocal	DateTime	The local date time that the line item's vend was recorded by the machine.
tags	List[Tag]	Metadata associated with the line item.
files	List[TransactionMetadataFile]	A list of objects containing information about the files (if any) related to the line item.

Field Name	Type	Description
id	int	Records unique identifier.
eventType	string	Indicates what type of event the adjustment represents. Possible values are adjustment, take, stock.
adjustmentOccurredAt	DateTime	The UTC date time when the inventory adjustment was recorded.
takeOccurredAt	DateTime?	The UTC date time when the item was taken from the machine.
siteId	int	The ID of the site the event occurred at.
siteExternalId	string	The customer defined ID of the site the event occurred at.
machineId	int	The ID of the machine the adjustment event occurred at.
machineExternalId	string	The customer defined ID of the machine the adjustment event occurred at.
selection	string	Friendly selection number where the inventory adjustment occured.
productId	int	Unique internal product ID.
userId	int	The ID of the user who made the adjustment.
externalUserIdentifier	string	Placeholder for future use.
adjustmentSize	int	The amount of the change in inventory levels.
newStockLevel	int	The inventory level after the adjustment.

Name	Definition
take	Covers any time a customer dispenses an item and the quantity on hand (current count) decreases.
stock	Covers changes in quantity on hand (current count) as a result of a picklist restock.
adjustment	Covers any other manual change to quantity on hand (current count), primarily as a result of changes on the Adjust Inventory Levels tools on client.

Name	Definition
productId	Unique identifier for the product associated with the vend stats. Can be -1.
totalSalesInTimeFrame	The number of successful vends of the product in the requested time period.