Retail Express API 2.1

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

SupplierReturnStatus

object

Supplier Return Status Model

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return Status Id.

namestring

Supplier Return Status name

Example

SupplierReturnStatus.PagingResponse

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

Supplier Return Status Model

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

SupplierShippingPort

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

Supplier shipping port id

namestring

Supplier shipping port name

>= 0 characters<= 100 characters

Example