PublicApi

Total Page Count

integer

The total number of pages in your query

Petty Cash Summary

object

A summary of POS money in and out for a given store on a given date

datestring(date)

The date of the summary

store_idstring

The ID of the store within this system

amountnumber(double)

The value of the petty cash (money in or out)

transaction_typestring

The ID of the transaction type within this system

Example

Stock Adjustment Summary Response

object
summary_linesarray[object]

A summary of stock adjustments for a given store on a given date

Show Child Parameters
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

page_sizeinteger

The maximum number of records in a single page

Example

Stock Transfer Summary

object

A summary of stock transfers for a given store on a given date

datestring(date)

The date of the summary

store_idstring

The ID of the store within this system

amount_taxnumber

The tax chargeable on the cost of goods being transferred

transfer_type_idstring

The type of transfer

amount_inclusivenumber

The cost of goods being transferred, inclusive of tax

amount_exclusivenumber

The cost of goods being transferred, exclusive of tax

transfer_idstring

Empty for summaries

transaction_typestring

The ID of the transaction type within this system

directionstring

The direction of the transfer

Example

Supplier List Response

object
page_numberinteger

The current page number

suppliersarray[object]

A supplier of merchandise

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