idinteger(int32)required
Supplier Return id
note_idinteger(int32)required
Credit Note id
Gets a Credit Note with Credit Note Items by Supplier Return id and Credit Note id
Gets a Credit Note with Credit Note Items by Supplier Return id and Credit Note id
get
https://api.retailexpress.com.au/v2/supplierreturns/{id}/creditnotes/{note_id}
Path Parameters
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
application/json
Returns found Credit Note
SupplierReturnsCreditNote
Credit Note model for /supplierreturn/{id}/creditnotes endpoint
* Additional properties are NOT allowed.
idinteger | null(int32)
Credit Note id
supplier_return_idinteger | null(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 | null
Supplier reference
>= 0 characters<= 50 characters
include_taxboolean | null
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 | null[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
get/supplierreturns/{id}/creditnotes/{note_id}
Path Parameters
Headers
application/json
supplierreturnstatus
Searches Supplier Return Statuses by parameters
Searches Supplier Return Statuses by parameters
get
https://api.retailexpress.com.au/v2/supplierreturnstatus
Query Parameters
namestring | null
SupplierReturnStatus name.
order_bystring | null
Order by.
Available field name values: id, name.
Available direction values: asc, desc.
Example: id asc, name desc
page_numberinteger(int32)
Format - int32.
>= 1<= 100000
page_sizeinteger(int32)
Format - int32.
>= 1<= 2147483647
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
application/json
Paging Response with Supplier Return Statuses data
SupplierReturnStatus.PagingResponse
* Additional properties are NOT allowed.
dataarray | null[object]
Supplier Return Status Model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/supplierreturnstatus
Query Parameters
Headers
application/json
Gets specific Supplier Return Status by unique id
Gets specific Supplier Return Status by unique id
get
https://api.retailexpress.com.au/v2/supplierreturnstatus/{id}
Path Parameters
idinteger(int32)required
Supplier Return Status id
Example:1
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
application/json
Returns found Supplier Return Status
SupplierReturnStatus
Supplier Return Status Model
* Additional properties are NOT allowed.
idinteger | null(int32)
Supplier Return Status Id.
namestring | null
Supplier Return Status name
get/supplierreturnstatus/{id}
Path Parameters
Headers
application/json