Retail Express API 2.1

CreditNote

object

Credit Note model

* 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

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

CreditNote.PagingResponse

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

Credit Note model

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

ProductAttributeValue

object
* Additional properties are NOT allowed.
idinteger(int32)

Attribute Value Id

namestring

Attribute Value Name

list_orderinteger(int32)

List order

Example

CreditNoteProduct

object

Product model for Credit Notes

* Additional properties are NOT allowed.
idinteger(int32)

Product id

supplier_skustring

Supplier SKU

manufacturer_skustring

Manufacturer SKU

supplier_sku2string

Supplier SKU 2

short_descriptionstring

Short Description

sizeobject
* Additional properties are NOT allowed.
Show Child Parameters
colourobject
* Additional properties are NOT allowed.
Show Child Parameters
modified_onstring(date-time)

Modified on

Example

CreditNoteItem

object

Credit Note model

* Additional properties are NOT allowed.
idinteger(int32)

Credit Note Item id

credit_note_idinteger(int32)

Credit Note id

supplier_return_item_idinteger(int32)

Supplier Return Item id

productobject

Product model for Credit Notes

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

Credit Quantity

credit_amount_exnumber(double)

Credit Amount Ex

total_credit_amount_exnumber(double)

Total Credit Amount Ex

applied_credit_quantityinteger(int32)

Applied Credit Quantity

applied_credit_taxnumber(double)

Applied Credit Tax

applied_credit_amount_incnumber(double)

Applied Credit Amount Inc

applied_credit_amount_exnumber(double)

Applied Credit Amount Ex

total_applied_credit_amount_exnumber(double)

Total Applied Credit Amount Ex

total_credit_amount_incnumber(double)

Total Credit Amount Inc

total_credit_amount_taxnumber(double)

Total Credit Amount Tax

total_applied_credit_amount_incnumber(double)

Total Applied Credit Amount Inc

total_applied_credit_taxnumber(double)

Total Applied Credit Tax

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