v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Update price lists

Update a price list period

Generally any field provided will be updated, with a few exceptions; If the given period is currently active you will only be able to update the validTo field. Neither will you be able to update a expired (validTo is less than current time) period.

patch/v1/pricelist/period/{id}

Path parameters

idstring required

The id of the period you want to update

Query parameters

auditUserstring required

The audit user to log the request

Request body

validFromstring date-time

The RFC 3339 format date and time from what time the price list should be active. Cannot be null

validTostring date-time

The RFC 3339 format date and time when this price list should stop to be active. Cannot be greater than 'validFrom' of any other price list with the same 'code'. Can be null, which means this price list is active until this field is set

valuenumber

The value of the price

priceListIdstring

A id that uniquely identifies this price list

Example request

{
  "validFrom": "2022-05-12T13:18:05Z",
  "validTo": "2022-05-12T13:18:05Z"
}

Response

Successfully updated the period

descriptionstring

Short description of the result of the action

idstring

Will contain the ID of the resource that has been created or updated