Skip to main content
GET
/
v1
/
pricelist
/
{id}
/
period
/
active
Retrieves active price list period for given price list
curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/v1/pricelist/{id}/period/active' \
  --header 'Authorization: Basic <encoded-value>'
{
  "validFrom": "2022-05-12T13:18:05Z",
  "validTo": "2022-05-12T13:18:05Z",
  "value": 123,
  "priceListId": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the price list of which you want to fetch the active period

Query Parameters

​
atDateTime
string<date-time>

Point in time when the price list was active

​
auditUser
string
required

The audit user to log the request

Response

Successfully retrieved

​
validFrom
string<date-time>

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

Example:

"2022-05-12T13:18:05Z"

​
validTo
string<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

Example:

"2022-05-12T13:18:05Z"

​
value
number

The value of the price

​
priceListId
string

A id that uniquely identifies this price list

Maximum string length: 64
​
id
string

A id that uniquely identifies this price list period

Maximum string length: 64