POST
Add a pickup cost
Company space For: Buyer, Stock keeper · Permission: purchase_pickups.update, purchase_reception_costs.create Conditions
  • The pickup must still be editable: a draft pickup. A confirmed one is refused.
  • Both the reception’s update permission and purchase_reception_costs.create are required.
  • key and value are both required, even on update; key is at most 250 characters and value is 0 or more, in major units with at most the currency’s decimals.
What else happens
  • Stores the cost in minor units. It changes nothing else now: costs are spread over the lines only when the reception is confirmed.
Part of Receive purchased goods.

Authorizations

Authorization
string
header
required

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

Path Parameters

purchase_pickup
string
required

Identifier of the purchase pickup (27-character KSUID).

Query Parameters

response
enum<string>
default:none

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

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, reception_id, purchase_id, key, value, 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: .

Body

application/json
key
string
required

Label of the cost, up to 250 characters. Required.

Maximum string length: 250
value
number
required

Amount of the cost in major units, 0 or more, with at most the currency's decimals. Required, including on update.

Response

Resource (only with response=resource).

id

Identifier of the extra cost (27-character KSUID).

reception_id

Identifier of the delivery or pickup the cost belongs to.

purchase_id

Identifier of the purchase of that reception.

key

Label of the cost, for example freight or handling.

value
number

Amount of the cost in major units. It is spread over the lines when the reception is confirmed.

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).