PublicApi

SupplierCredit

object

A supplier credit

store_idstring

The ID of the store

datestring

The date the supplier credit was received

supplier_credit_note_datestring

The supplier credit note date

credit_note_linesarray[object]

A supplier credit

Show Child Parameters
credit_note_idstring

The id of the credit note

supplier_referencestring

The supplier reference

supplier_return_idinteger

The id of the supplier return

supplier_idstring

The ID of the supplier within this system

Example

Page Size

integer

The maximum number of records in a single page

Cash Variance Summary

object

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

payment_method_idstring

The ID of the payment method within this system

transaction_typestring

The ID of the transaction type within this system

Example

Stock Adjustment Summary

object

A summary of stock adjustments 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 cost of the stock adjustment

transaction_typestring

The ID of the transaction type within this system

Example

Store

object

A retail store/outlet

countrystring

The country of the address

last_modified_onstring(date-time)

The date and time the record was last modified

email_addressstring

The email address of the store

post_codestring

The postcode of the address

external_referencestring

An external reference given to the store for external systems

timezone_idstring

The timezone identifier for the store

address_line_1string

The first line of the address

namestring

The name of the store

suburbstring

The suburb of the address

phone_numberstring

The phone number of the store

address_line_2string

The second line of the address

statestring

The state of the address

idstring

The ID of the store

Example