--- title: "Get rate pricing" method: POST path: "/api/connector/v1/rates/getPricing" tags: ["Rates"] --- # Get rate pricing `POST /api/connector/v1/rates/getPricing` 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](https://mews-systems.gitbook.io/connector-api/concepts/time-units). ## Request body - RatePricingFilterParameters - `ClientToken` string, required — Token identifying the client application. - `AccessToken` string, required — Access token of the client application. - `Client` string, required — Name and version of the client application. - `RateId` string, uuid, required — Unique identifier of the `Rate`. - `ProductId` string, uuid, nullable — Unique identifier of the `Product`. - `FirstTimeUnitStartUtc` string, date-time, required — Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. - `LastTimeUnitStartUtc` string, date-time, required — End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), 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 24 months if months. ## Response `200` OK - RatePricing - `Currency` string, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `DatesUtc` string[], nullable - `TimeUnitStartsUtc` string[], required — Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format. - `BasePrices` number[], required - `BaseAmountPrices` Amount[], required — Base prices of the rates for each time unit covered by the time interval. - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `CategoryPrices` CategoryPricing[], required — Resource category prices. - `CategoryId` string, uuid, required — Unique identifier of the category. - `Prices` number[], required — Prices of the rate for the resource category in the covered dates. - `AmountPrices` Amount[], required — Prices of the rate for the resource category in the covered dates. - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `CategoryAdjustments` CategoryAdjustment[], required — Resource category adjustments. - `CategoryId` string, uuid, required — Unique identifier of the adjustment category. - `ParentCategoryId` string, uuid, nullable — Unique identifier of the parent category that serves as a base price for the current category. - `AbsoluteValue` number, double, required — Absolute value of the adjustment (e.g. `50` represents 50 EUR in case the rate currency is `EUR`). - `RelativeValue` number, double, required — Relative value of the adjustment (e.g. `0.5` represents 50% increase). - `AgeCategoryAdjustments` AgeCategoryAdjustment[], required — Assigns different pricing or occupancy based on the guest's age. - `AgeCategoryId` string, uuid, required — Unique identifier of the age category. - `AbsoluteValue` number, double, required — Absolute value of the adjustment (e.g. `50` represents 50 EUR in case the rate currency is `EUR`). - `Type` 'ExtraOccupancyAdjustment' | 'NegativeOccupancyAdjustment' | 'StandardOccupancyAdjustment', required — ExtraOccupancyAdjustment NegativeOccupancyAdjustment StandardOccupancyAdjustment - `RelativeAdjustment` number, double — Specific amount which shows the difference between this rate and the base rate. - `AbsoluteAdjustment` number, double — Relative amount which shows the difference between this rate and the base rate. - `EmptyUnitAdjustment` number, double — Price adjustment for when the resource booked with this rate is not full to capacity. - `ExtraUnitAdjustment` number, double — Price adjustment for when the resource booked with this rate exceeds capacity. ## Other responses - `204` — Server has successfully fulfilled the request and there is no additional information to send back. - `400` — Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). - `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. - `403` — Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. - `408` — Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) - `429` — Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). - `500` — Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). --- [API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/4bf95cbc375f/schema)