Updates Credite Note by Supplier Return id and Credit Note id

Query Parameters

idsstring | null

Сredit note Ids. (comma separated)
Other properties are skipped, if used.
Example: 2,3,4

supplier_referencestring | null

Supplier reference.

created_sincestring | null(date-time)

Created since

modified_sincestring | null(date-time)

Modified since

filter_bystring | null

Filter by.
Available field name values: id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on.

In string values: ‘|’ and ‘,’ characters have to be escaped with slash, i.e. ‘\,’ ‘\|’

For operators that support multiple values (in, notin): multiple values are delimited using ‘|’ character

Available operators:

eq - Equal

neq - Not equals

lt - Less

lte - Less or equal

gt - Greater

gte - Greater or equal

in - In

notin - Not In

contains - Contains

isnull - Is Null

isnullorempty - Is Null Or Empty

isnotnull - Is Not Null

startswith - Starts with

endswith - Ends with

doesnotcontain - Does not contain

For non-nullable fields operators isnull and isnotnull are unavailable

For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable

For strings operators: lt, lte, gt, gte are unavailable

Example: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432

order_bystring | null

Order by.

Available field name values: id, supplier_return_id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on.

Available direction values: asc, desc.

Example: id asc, supplier_reference desc

page_numberinteger(int32)

>= 1<= 100000

page_sizeinteger(int32)

>= 1<= 2147483647

Path Parameters

idinteger(int32)required

Supplier Return id

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

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

Response

application/json

Returns Credit Notes with Credit Note Items

SupplierReturnsCreditNote.PagingResponse

* Additional properties are NOT allowed.

dataarray | null[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)

get/supplierreturns/{id}/creditnotes

Path Parameters

Query Parameters

Headers

Body

application/json

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 )

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

* 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

get/supplierreturns/{id}/creditnotes/{note_id}

Path Parameters

Query Parameters

Headers

Body

application/json

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}

Path Parameters

Query Parameters

Headers

Body

{}

application/json

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

Path Parameters

Query Parameters

Headers

Body

application/json

Searches Supplier Return Credit Notes by parameters

Query Parameters

Path Parameters

Headers

Response

SupplierReturnsCreditNote.PagingResponse

Path Parameters

Query Parameters

Headers

Body

Gets a Credit Note with Credit Note Items by Supplier Return id and Credit Note id

Path Parameters

Headers

Response

SupplierReturnsCreditNote

Path Parameters

Query Parameters

Headers

Body

Path Parameters

Headers

Body

EmptyExample

Response

SupplierReturnsCreditNote

Path Parameters

Query Parameters

Headers

Body

supplierreturnstatus

Searches Supplier Return Statuses by parameters

Query Parameters

Headers

Response

SupplierReturnStatus.PagingResponse

Path Parameters

Query Parameters

Headers

Body