Following is the data specification for a invoice that is extracted from accounting OSPs.

The invoices endpoint for a connection returns an array of invoices. The data is the key for an invoice.

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


Field Data TypeData Type
transaction_outstanding_amountnumber Total outstanding invoice amount
currency_ratenumberCurrency rate between the currency of the invoice and the base currency of the business
transaction_datedateDate on which the invoice was issued
transaction_due_datedateDate on which the invoice is due
transaction_statusstringStatus of the invoice (Paid, Unpaid)
transaction_referencestringUnique identifier of the invoice on OSP's end
transaction_currencystringCurrency in which the invoice was issued
transaction_gross_valuenumberTotal invoice amount
transaction_net_valuenumberinvoice subtotal
line_itemsLineItem[]An array of line items as defined below

Line Item

FieldData TypeDescription
product_namestringName of the product or service being sold
system_idsystem_idUnique identifier of the line item on 9Spokes' end
item_identifierstringUnique identifier of the line item on the app's end
item_categorystringAccount category under which the transaction item was originally listed
item_typestring'invoice' when the osp is an accounting app and 'good-service' when the osp is a point of sale app
item_net_unit_sale_valuenumberNet sale value per item
item_net_unit_discount_valuenumberNet discount value per item
item_unit_tax_valuenumberTax value per item
item_price_list_referencestringReference to any pre-set discounting based upon specific price lists (specials, happy hour, etc.)
item_total_gross_valuenumberTotal gross value of the item (before tax)
Click Try It! to start a request and see the response here!