Sales

Following is the data specification for a sale that is extracted from POS OSPs

The sales endpoint for a connection returns an array of sales. The data is the key for a sale.

Individual line items can be found for each sale under the line_items key.

Invoice

Field	Data Type	Description
transaction_outstanding_amount	number	Total outstanding invoice amount
currency_rate	number	Currency rate between the currency of the invoice and the base currency of the business
Currency rate between the currency of the invoice and the base currency of the business	date	Date on which the invoice was issued
transaction_due_date	date	Date on which the invoice is due
transaction_status	string	Status of the invoice (Paid, Unpaid)
transaction_reference	string	Unique identifier of the invoice on OSP's end
transaction_currency	string	Currency in which the invoice was issued
transaction_gross_value	number	Total invoice amount
transaction_net_value	number	invoice subtotal
line_items	LineItem[]	An array of line items as defined below

Field	Data Type	Description
product_name	string	Name of the product or service being sold
system_id	string	Unique identifier of the line item on 9Spokes' end
item_identifier	item_identifier	Unique identifier of the line item on the app's end
item_category	string	Account category under which the transaction item was originally listed
item_type	string	'invoice' when the osp is an accouting app and 'good-service' when the osp is a point of sale app
item_net_unit_sale_value	number	Net sale value per item
item_net_unit_discount_value	number	Net discount value per item
item_unit_tax_value	number	Tax value per item
item_price_list_reference	string	Reference to any pre-set discounting based upon specific price lists (specials, happy hour, etc.)
item_total_gross_value	item_total_gross_value	Total gross value of the item (before tax)
item_total_net_value	number	Net value of the item (after tax)
item_total_tax_value	number	Total tax value applied to the item