PublicApi

Supplier

object

A supplier of merchandise

codestring

The reference for the supplier

order_email_addressstring

The email address for purchase orders to be sent to

last_modified_onstring(date-time)

The date and time the record was last modified

namestring

The name of the supplier

contact_detailsobject

Contact details for an entity

Show Child Parameters
idstring

The id of the supplier

Example

SupplierInvoice

object

A supplier invoice

supplier_invoice_linesarray[object]

A supplier invoice

Show Child Parameters
store_idstring

The ID of the store

datestring

The date the supplier invoice was received

supplier_invoice_idinteger

The id of the supplier invoice

purchase_order_idstring

The id of the purchase order

supplier_invoice_numberstring

The supplier invoice number

supplier_idstring

The ID of the supplier within this system

supplier_invoice_datestring

The supplier invoice date

Example

Payment Summary Response

object
summary_linesarray[object]

A summary of payments

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

Cash Variance Summary Response

object
summary_linesarray[object]

A summary of cash variances 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

Petty Cash Summary Response

object
summary_linesarray[object]

A summary of POS money in and out 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