GET
View a purchase return item
Company space For: Buyer, Stock keeper · Permission: purchase_return_items.retrieve Part of Return goods to suppliers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

purchase_return
string
required

Identifier of the purchase return (27-character KSUID string).

item
string
required

Identifier of the supplier return item (27-character KSUID string).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, return_id, purchase_item_id, stockable_unit_id, stock_sources, quantity, cost_total, stock_cost_total, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: purchaseItem, purchaseItem.stockable, purchaseItem.stockableUnit, stockableUnit, stockableUnit.uomUnit, stockableUnit.prices, stockableUnit.stockable.

Response

200 - application/json

Resource.

id

Identifier of the return line (27-character KSUID string).

return_id

Identifier of the supplier return the line belongs to.

purchase_item_id

Identifier of the purchase line being returned.

stockable_unit_id

Identifier of the unit the quantity is expressed in; defaults to the unit of the purchase line.

purchase_item
object

The purchase line. Present only when requested with include=purchaseItem.

stockable_unit
object

The unit of the quantity. Present only when requested with include=stockableUnit.

stock_sources
any[]

Where the goods are taken from: a list of {quantity, asset_id} or {quantity, group_id}. Empty for a line that is not stock-tracked.

quantity
integer

Quantity returned, in the line's unit.

cost_total
number

Commercial value of the returned quantity in major units (the minor-unit amount divided by 10 to the power currency_exponent), computed first-in-first-out from the received quantities. This is the amount that reduces the purchase balance when the return has a credit note.

stock_cost_total
number | null

Inventory cost of the stock that left when the return was confirmed in major units (the minor-unit amount divided by 10 to the power currency_exponent); null until confirmation and for lines that are not stock-tracked.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).