Retail Express API 2.1

SupplierReturnReasons.PagingResponse

object
* Additional properties are NOT allowed.
dataarray[object]

Supplier Return Reason model

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example

SupplierReturns

object

Supplier Returns VM

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return identifier

include_taxboolean

Include Tax

Default:true

supplierobject
* Additional properties are NOT allowed.
Show Child Parameters
outletobject
* Additional properties are NOT allowed.
Show Child Parameters
supplier_return_statusobject

Supplier Return Status Model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_addressobject

Supplier address model

* Additional properties are NOT allowed.
Show Child Parameters
total_return_quantityinteger(int64)

Total return quantity

total_claim_amount_exnumber(double)

Total claim amount ex

total_claim_amount_taxnumber(double)

Total claim amount tax

total_claim_amount_incnumber(double)

Total claim amount inc

total_credit_received_exnumber(double)

Total credit received ex

total_credit_received_incnumber(double)

Total credit received inc

notesstring

Notes

>= 0 characters<= 8000 characters

return_authorisationstring

Return Authorisation

>= 0 characters<= 100 characters

started_onstring(date-time)

Started on

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

finalised_onstring(date-time)

Finalised on

credit_notesarray[object]

Credit Note model

* Additional properties are NOT allowed.
Show Child Parameters
created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

SupplierReturns.PagingResponse

object
* Additional properties are NOT allowed.
dataarray[object]

Supplier Returns VM

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example

SupplierReturnsCreditNote

object

Credit Note model for ​/supplierreturn​/{id}​/creditnotes endpoint

* Additional properties are NOT allowed.
idinteger(int32)

Credit Note id

supplier_return_idinteger(int32)

Supplier Return id

supplierobject
* Additional properties are NOT allowed.
Show Child Parameters
outletobject
* Additional properties are NOT allowed.
Show Child Parameters
supplier_referencestring

Supplier reference

>= 0 characters<= 50 characters

include_taxboolean

Include tax

Default:false

rounding_adjustmentnumber(double)

Rounding Adjustment

total_credit_quantityinteger(int32)

Total credit quantity

total_credit_amount_exnumber(double)

Total Credit Amount Ex

total_credit_amount_taxnumber(double)

Total Credit Amount Tax

total_credit_amount_incnumber(double)

Total Credit Amount Inc

total_applied_credit_quantityinteger(int32)

Total Applied Credit Quantity

total_applied_credit_amount_exnumber(double)

Total Applied Credit Amount Ex

total_applied_credit_amount_incnumber(double)

Total Applied Credit Amount Inc

total_applied_credit_taxnumber(double)

Total Applied Credit Tax

credit_note_itemsarray[object]

List of Credit Note items

* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

supplier_credited_onstring(date-time)

Supplier Credited On

created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

SupplierReturnsCreditNote.PagingResponse

object
* Additional properties are NOT allowed.
dataarray[object]

Credit Note model for ​/supplierreturn​/{id}​/creditnotes endpoint

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example