Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Get price lists

Retrieves given price list and it's periods

This operation will return all the periods for the given price list id

get/v1/pricelist/{id}/period

Path parameters

idstring required

The id of the price list of which you want to fetch the periods

Query parameters

auditUserstring required

The audit user to log the request

pageinteger

Current page

sizeinteger

How many periods should be returned per page, default is 30. Cannot be more than 100.

Response

Successfully retrieved

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

idstring

A id that uniquely identifies this price list period

Example response

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