Search
K
Retail Express API 2.1

Updates Credite Note by Supplier Return id and Credit Note id

Sample request:

 PUT /supplierreturns/1/creditnotes/1
 {
     "supplier_credited_on": "2022-11-18",
     "supplier_reference": "ref"
 }
put
https://api.retailexpress.com.au/v2.1/supplierreturns/{id}/creditnotes/{note_id}

Path Parameters

idinteger(int32)required

Supplier Return id

note_idinteger(int32)required

Credit Note id

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Body

application/json

Credit Note to be updated

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Returns updated 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
* Additional properties are NOT allowed.
Show Child Parameters
outletobject
* Additional properties are NOT allowed.
Show Child Parameters
supplier_referencestring | null

Supplier reference

>= 0 characters<= 50 characters

include_taxboolean | null

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 | null[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 | null(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
put/supplierreturns/{id}/creditnotes/{note_id}

Body

{}
 
application/json

supplierreturnstatus

Searches Supplier Return Statuses by parameters

Searches Supplier Return Statuses by parameters

get
https://api.retailexpress.com.au/v2.1/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)

>= 1<= 100000

page_sizeinteger(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

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
 
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.1/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

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}
 
application/json

suppliers