Retail Express API 2.1

SupplierReturnItem

object

Supplier Return Item

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return Item identifier

supplier_return_idinteger(int32)

Supplier Return id

productobject

Supplier Return Item Product Model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_return_reasonobject

Supplier Return Reason model

* Additional properties are NOT allowed.
Show Child Parameters
credit_note_itemobject

Supplier Return Item Credit Note Item Model

* Additional properties are NOT allowed.
Show Child Parameters
return_quantityinteger(int32)

Return Quantity

original_buy_exnumber(double)

Supplier price ex

total_original_buy_exnumber(double)

Total supplier buy ex

supplier_return_item_statusobject

Supplier Return Item Status Model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_return_item_sourceobject

Supplier Return Item Product Model

* Additional properties are NOT allowed.
Show Child Parameters
original_supplier_invoicestring

Supplier invoice number

claim_amount_exnumber(double)

Claim amount ex

supplier_return_item_notesstring

Notes

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

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

created_byobject

User Model

* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject

User Model

* Additional properties are NOT allowed.
Show Child Parameters
Example

SupplierReturnItem.PagingResponse

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

Supplier Return Item

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

SupplierReturnsCreditNoteItem

object

Supplier returns Credit Note item model

* Additional properties are NOT allowed.
idinteger(int32)

Credit Note Item id

supplier_return_item_idinteger(int32)

Supplier Return Item id

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

Supplier model for Credit Notes

* Additional properties are NOT allowed.
Show Child Parameters
outletobject

Outlet model for Credit Notes

* Additional properties are NOT allowed.
Show Child Parameters
supplier_referencestring

Supplier reference

>= 0 characters<= 50 characters

include_taxboolean

Include tax

Default:false

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]

Supplier returns Credit Note item model

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

Created on

modified_onstring(date-time)

Modified on

created_byobject

Credit Note User

* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject

Credit Note User

* 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