idinteger(int32)required
Credit Note id
Example:1
item_idinteger(int32)required
Credit Note Item id
Example:1
Gets Credit Note Item by id
Gets Credit Note Item by id
get
https://api.retailexpress.com.au/v2/creditnotes/{id}/creditnoteitems/{item_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
CreditNoteItem
Credit Note model
* Additional properties are NOT allowed.
idinteger | null(int32)
Credit Note Item id
credit_note_idinteger(int32)
Credit Note id
supplier_return_item_idinteger | null(int32)
Supplier Return Item id
productobject
Product model for Credit Notes
* Additional properties are NOT allowed.
Show Child Parameters
credit_quantityinteger | null(int32)
Credit Quantity
credit_amount_exnumber | null(double)
Credit Amount Ex
total_credit_amount_exnumber | null(double)
Total Credit Amount Ex
applied_credit_quantityinteger | null(int32)
Applied Credit Quantity
applied_credit_taxnumber | null(double)
Applied Credit Tax
applied_credit_amount_incnumber | null(double)
Applied Credit Amount Inc
applied_credit_amount_exnumber | null(double)
Applied Credit Amount Ex
total_applied_credit_amount_exnumber | null(double)
Total Applied Credit Amount Ex
total_credit_amount_incnumber | null(double)
Total Credit Amount Inc
total_credit_amount_taxnumber | null(double)
Total Credit Amount Tax
total_applied_credit_amount_incnumber | null(double)
Total Applied Credit Amount Inc
total_applied_credit_taxnumber | null(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
get/creditnotes/{id}/creditnoteitems/{item_id}
Path Parameters
Headers
application/json
currencies
Searches Currencies by parameters
Searches Currencies by parameters
get
https://api.retailexpress.com.au/v2/currencies
Query Parameters
modified_sincestring | null(date-time)
Modified since search parameter
order_bystring | null
Order by.
Available field name values: id (default), currency_code, currency_name, modified_on
Available direction values: asc, desc.
Example: description asc, modified_on 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 Currencies data
Currency.PagingResponse
* Additional properties are NOT allowed.
dataarray | null[object]
Currencies model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/currencies
Query Parameters
Headers
application/json
Gets Currency by id
Gets Currency by id
get
https://api.retailexpress.com.au/v2/currencies/{id}
Path Parameters
idinteger(int32)required
Gets Currency by id
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 Currency
Currency
Currencies model
* Additional properties are NOT allowed.
idinteger | null(int32)
Currency Id
currency_codestring | null
Currency Code
currency_namestring | null
Currency Name
modified_onstring(date-time)
Last Modified On
get/currencies/{id}
Path Parameters
Headers
application/json