Retail Express API 2.1

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

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

Supplier

object

Supplier model

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Id

supplier_codestring

Supplier Code

>= 0 characters<= 20 characters

namestring

Supplier Name

>= 0 characters<= 50 characters

addressobject

Supplier address model

* Additional properties are NOT allowed.
Show Child Parameters
phonestring

Supplier Phone Number

>= 0 characters<= 20 characters

faxstring

Supplier Fax Number

>= 0 characters<= 20 characters

contact_namestring

Supplier Contact Name

>= 0 characters<= 50 characters

contact_emailstring(email)

Supplier Contact Email

>= 0 characters<= 120 characters

order_emailstring(email)

Supplier Order Email

>= 0 characters<= 120 characters

admin_only_ordersboolean

Admin Only Orders Flag

Default:false

deposit_requiredboolean

Deposit Required Flag

Default:false

shipping_portobject
* Additional properties are NOT allowed.
Show Child Parameters
country_of_originobject
* Additional properties are NOT allowed.
Show Child Parameters
shipping_termsstring

Supplier Shipping Terms

>= 0 characters<= 50 characters

payment_termsstring

Supplier Payment Terms

>= 0 characters<= 50 characters

commentsstring

Supplier Comments

Match pattern:^[^*|":<>[\]{}`\()';@&$#!-/?]+$

>= 0 characters<= 255 characters

purchase_order_templatestring

Supplier Purchase Order Template type

modified_onstring(date-time)

Modified On

Example