PublicApi

PaymentTypeListResponse

object
page_numberinteger

The current page number

total_recordsinteger

The total number of records in your query

total_pagesinteger

The total number of pages in your query

payment_typesarray[object]

A payment type

Show Child Parameters
page_sizeinteger

The maximum number of records in a single page

Example

Sales Summary

object

A summary of sales data for a given store on a given date

store_idstring

The ID of the store within this system

datestring(date)

The date of the summary

tax_type_idstring

The ID of the tax type within this system

amount_taxnumber

The tax chargeable on the transaction

amount_inclusivenumber

The value of the transaction, inclusive of tax

idstring

The ID of the sales summary record

amount_exclusivenumber

The value of the transaction, exclusive of tax

transaction_typestring

The ID of the transaction type within this system

Example

CreditNoteLine

object

A supplier credit

amount_taxnumber

The tax chargeable on the cost of the supplier credit

amount_inclusivenumber

The cost of the supplier credit, inclusive of tax

amount_exclusivenumber

The cost of the supplier credit, exclusive of tax

transaction_typestring

The type of supplier credit

Example

PurchaseOrderListResponse

object
page_numberinteger

The current page number

purchase_ordersarray[object]

A purchase order

Show Child Parameters
total_recordsinteger

The total number of records in your query

total_pagesinteger

The total number of pages in your query

page_sizeinteger

The maximum number of records in a single page

Example

PurchaseOrder

object

A purchase order

store_idstring

The ID of the store that the purchase order is for

datestring

The date the purchase order was received

purchase_order_idstring

The id of the purchase order

supplier_invoice_numberstring

The supplier invoice reference

supplier_idstring

The ID of the supplier within this system

purchase_order_linesarray[object]

A purchase order

Show Child Parameters
Example