Rates
Get all rates
Returns all rates (pricing setups) and rate groups (condition settings) of the default service provided by the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/rates/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| array of string | required, max 1000 items | Unique identifiers of the Services from which the rates are requested. |
| array of Rates | optional, max 1000 items | Unique identifiers of the requested Rates. |
| optional, max length 3 months | Interval in which the Rates were updated. | |
| array of string | optional, max 1000 items | Identifiers of Rate from external systems. |
| array of string Activity state | optional | Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted will be returned. |
| required | Extent of data to be returned. | |
| required | Limitation on the quantity of data returned. |
Rate extent
Property | Type | Contract | Description |
---|---|---|---|
| bool | optional | Whether the response should contain rates. |
|
|
|
|
| bool | optional | Whether the response should contain availability block assignments. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Rate | required | Rates of the default service. |
|
|
|
|
| array of Availability block assignment | optional | Shows which rates relate to which availability blocks. |
| string | optional | Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. |
Rate
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the rate. |
| string | required | Unique identifier of Rate group where the rate belongs. |
| string | optional | Unique identifier of the base Rate. |
| string | optional | Unique identifier of the Business segment. |
| string | required | Unique identifier of the Service. |
| boolean | required | Whether the rate is still active. |
| boolean | required | Whether the rate is currently available to customers. |
| boolean | required | Whether the rate is publicly available. |
| required | Type of the rate | |
| string | required | Name of the rate (in the default language). |
| string | optional | Short name of the rate (in the default language). |
| optional | All translations of the external name of the rate. | |
| optional | All translations of the description of the rate. | |
| string | optional, max 255 characters | Identifier of the rate from external system. |
Rate type
Public
Private
AvailabilityBlock
...
Rate group
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the group. |
| string | required | Unique identifier of the Service. |
| boolean | required | Whether the rate group is still active. |
| string | required | Name of the rate group. |
| string | optional, max 255 characters | Identifier of the rate group from external system. |
Get rate pricing
Returns prices for a given rate for a specified time interval. Prices will be returned for all service time units that the specified time interval intersects. So, for example, an interval 1st Jan 23:00 UTC - 1st Jan 23:00 UTC
will result in one price for 2nd Jan
, while Interval 1st Jan 23:00 UTC - 2nd Jan 23:00 UTC
will result in two prices for 2nd Jan
and 3rd Jan
(assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see Time units.
The price in the response is dependent on the enterprise's pricing setting. If the enterprise is set to a Gross pricing environment, then the price returned is the gross price (inclusive of tax). If the enterprise is set to a Net pricing environment, the price returned is the net price (excluding tax). Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/rates/getPricing
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | required | Unique identifier of the Rate whose prices should be returned. |
| string | required | Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format. See Time units. |
| string | required | End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. See Time units. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO-4217 code of the Currency. |
| array of string | required | Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format. |
| array of Amount value | required | Base prices of the rates for each time unit covered by the time interval. |
| array of Resource category pricing | required | Resource category prices. |
| array of Resource category adjustment | required | Resource category adjustments. |
| decimal | required | Specific amount which shows the difference between this rate and the base rate. |
| decimal | required | Relative amount which shows the difference between this rate and the base rate. |
| decimal | required | Price adjustment for when the resource booked with this rate is not full to capacity. |
| decimal | required | Price adjustment for when the resource booked with this rate exceeds capacity. |
Resource category pricing
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Resource category. |
| array of Amount value | required | Prices of the rate for the resource category in the covered dates. |
Resource category adjustment
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the adjustment Resource category. |
| string | optional | Unique identifier of the parent Resource category that serves as a base price for the current category. |
| number | required | Relative value of the adjustment (e.g. |
| number | required | Absolute value of the adjustment (e.g. |
Add rates
Adds rates to the enterprise. Note this operation supports Portfolio Access Tokens. Rate type of AvailabilityBlock
cannot be created via this operation.
Request
[PlatformAddress]/api/connector/v1/rates/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise. |
| array of Rate parameters | required, max 1000 items | Information about rates to be created. |
Rate parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Service. |
| string | required | Unique identifier of the Rate group under which rate is assigned. |
| bool | optional | Whether the rate is available to customers. |
| required | Type of the rate. | |
| string | optional | Unique identifier of the Accounting category the rate belongs to. |
| string | optional | Unique identifier of the Business segment. |
| required | All translations of the name of the rate. | |
| optional | All translations of the short name of the rate. | |
| optional | All translations of the external name of the rate. | |
| optional | All translations of the description. | |
| string | optional, max 255 characters | Identifier of the rate from external system. |
| required | Discriminator in which field inside | |
| required | Contains additional data about pricing of the rate. |
Add Rate type
Public
Private
...
Pricing type
BaseRatePricing
DependentRatePricing
...
Rate pricing parameters
Property | Type | Contract | Description |
---|---|---|---|
| optional | Additional data for rate with base rate pricing. | |
| optional | Additional data for rate with dependent rate pricing. |
Base rate pricing parameters
Property | Type | Contract | Description |
---|---|---|---|
| required | Unit amount of the product. Note this overrides any previously defined amount. | |
| decimal | optional | This is the amount added to the price when occupancy of the space is less than the Space Category Capacity. To provide a discount price for under-occupancy, simply use a negative value. |
| decimal | optional | This is the amount added to the price when the Space Category Capacity is exceeded. |
Dependent rate pricing parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the rate on which this dependent rate is based. |
| decimal | optional | This value is multiplied by the base rate to calculate an adjustment added to the base rate, e.g. a value of |
| decimal | optional | This value is simply added to the base rate to obtain the new price. To subtract an amount, use a negative value. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Rate | required | Rates that have been added. |
Availability block assignment
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Rate. |
| string | required | Unique identifier of the Availability Block. |
Update rate price
Updates the prices for a given rate. You can make multiple price updates with one API call, and for each one specify the time interval for which the update applies, the price value and the applicable resource category. The price will be updated for all service time units that the specified time interval intersects. The price is per time unit, e.g. per day or per month. If the resource category CategoryId
is not specified, the updated price will apply to the base price for all resource categories. For more information on time units, see Time units.
Note that prices are defined daily, so when the server receives the UTC interval, it first converts it to the enterprise timezone and updates the price on all dates that the interval intersects. Only root rates can be updated (the rates that have no base rate, that have BaseRateId
set to null
). It is not permitted to update historical prices older than specified by EditableHistoryInterval
. Future prices may be updated up to 5 years in the future. The maximum size of time interval is 100 time units or 2 years, whichever is the shorter amount of time.
Request
[PlatformAddress]/api/connector/v1/rates/updatePrice
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | required | Unique identifier of the base Rate to update. |
| array of Price update | required, max 1000 items | Price updates. |
Price update
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | Unique identifier of the Resource category whose prices to update. If not specified, base price is updated. |
| string | required | Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format. See Time units. |
| string | required | End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. See Time units. |
| number | optional | New value of the rate on the interval. If not specified, removes all adjustments within the interval. |
Response
Last updated