--- title: "Get all rates" method: POST path: "/api/connector/v1/rates/getAll" tags: ["Rates"] --- # Get all rates `POST /api/connector/v1/rates/getAll` Returns all rates (pricing setups) of the default service provided by the enterprise. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). ## Request body - RateFilterParameters - `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. - `Limitation` Limitation, required — Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable - `EnterpriseIds` string[], nullable — Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. - `Extent` RateExtent — Extent of data to be returned. - `Rates` boolean, nullable — Whether the response should contain rates. - `RateGroups` boolean, nullable — Whether the response should contain rate groups. - `AvailabilityBlockAssignments` boolean — Whether the response should contain availability block assignments. - `RateIds` string[], nullable — Unique identifiers of the requested [Rates](https://mews-systems.gitbook.io/connector-api/operations/rates/#rate). - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `ServiceIds` string[], required — Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service) from which the rates are requested. - `ExternalIdentifiers` string[], nullable — Identifiers of [Rate](https://mews-systems.gitbook.io/connector-api/operations/#rate) from external systems. - `ActivityStates` ActivityStates[], nullable — Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted will be returned. ## Response `200` OK - RateResult - `Rates` Rate[], required — Rates of the default service. - `Id` string, uuid, required — Unique identifier of the rate. - `GroupId` string, uuid, required — Unique identifier of `Rate Group` where the rate belongs. - `ServiceId` string, uuid, required — Unique identifier of the `Service`. - `BaseRateId` string, uuid, nullable — Unique identifier of the base `Rate`. - `IsBaseRate` boolean, required — Indicates if this is a base rate. - `BusinessSegmentId` string, uuid, nullable — Unique identifier of the `Business Segment`. - `IsActive` boolean, required — Indicates if this rate is active. - `IsEnabled` boolean, required — Indicates if this rate is currently available to customers. - `IsPublic` boolean, required — Indicates if this rate is publicly available. - `IsDefault` boolean, required — Indicates if this rate is the default rate for the service. Assigned automatically to the first rate of a service. - `Type` 'Public' | 'Private' | 'AvailabilityBlock', required — Public Private AvailabilityBlock - `Name` string, nullable — Name of the rate (in the default language). - `Names` object, required — All translations of the name. - `ShortName` string, nullable — Short name of the rate (in the default language). - `UpdatedUtc` string, date-time, required — Interval in which the rates were updated. - `ExternalNames` object, nullable — All translations of the external name of the rate. - `Description` object, nullable — All translations of the description of the rate. - `ExternalIdentifier` string, nullable — Identifier of the rate from external system. - `TaxExemptionReason` 'Unknown' | 'IT_N1' | 'IT_N2_1' | 'IT_N2_2' | 'IT_N3_4' | 'IT_N3_5' | 'IT_N4' | 'IT_N5' | 'PL_ZW' | 'PL_NP' | 'DE_NATO' | 'FR_261_7' | 'FR_262_00_BIS' | 'FR_293_B' — Unknown (Unknown tax exemption reason) IT_N1 (N1 - Escluse ex art.15) IT_N2_1 (N2.1 - Non soggette ad IVA ai sensi degli artt. da 7 a 7-septies del d.P.R. n. 633/72) IT_N2_2 (N2.2 - Non soggette – altri casi) IT_N3_4 (N3.4 - Non imponibili – operazioni assimilate alle cessioni all’esportazione) IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento) IT_N4 (N4 - Esenti) IT_N5 (N5 - Regime del margine / IVA non esposta in fattura) PL_ZW (ZW - Zwolniony) PL_NP (NP - Nie podlega) DE_NATO (NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen) FR_261_7 (Exonération de TVA, article 261, 7 du CGI) FR_262_00_BIS (Exonération de TVA, article 262-00 bis du CGI) FR_293_B (TVA non applicable, article 293 B du CGI) - `TaxExemptionLegalReference` string, nullable — Legal reference that states why this rate is exempt from tax. - `RateGroups` RateGroupOld[], required — Rate groups of the default service. - `Id` string, uuid — Unique identifier of the rate group. - `ServiceId` string, uuid — Unique identifier of the Service that the rate group belongs to. - `IsActive` boolean — Whether the rate group is still active. - `Name` string, nullable — Name of the rate group. - `ExternalIdentifier` string, nullable — External identifier of the rate group. - `RateRestrictions` RateRestrictionResult, required - `DateRestrictions` DateRestriction[], required — Date restrictions for the rate. - `Id` string, uuid — Unique identifier of the rate restriction. - `RateId` string, uuid — Unique identifier of the rate. - `IsInherited` boolean — Whether the rate restriction is inherited from the parent rate. - `StartUtc` string, nullable — Start of the rate restriction in UTC timezone in ISO 8601 format. - `EndUtc` string, nullable — End of the rate restriction in UTC timezone in ISO 8601 format. - `Days` string[], nullable — The restricted days of week. - `ExternalIdentifier` string, nullable — Identifiers of from external systems. - `EarlinessRestrictions` EarlinessRestriction[], required — Earliness restrictions for the rates that are only available up to before arrival. - `Id` string, uuid — Unique identifier of the rate restriction. - `RateId` string, uuid — Unique identifier of the rate. - `IsInherited` boolean — Whether the rate restriction is inherited from the parent rate. - `StartUtc` string, nullable — Start of the rate restriction in UTC timezone in ISO 8601 format. - `EndUtc` string, nullable — End of the rate restriction in UTC timezone in ISO 8601 format. - `Days` string[], nullable — The restricted days of week. - `ExternalIdentifier` string, nullable — Identifiers of from external systems. - `MinAdvance` string, nullable — The minimum time before the reservation starts, you can reserve in ISO 8601 duration format. - `MaxAdvance` string, nullable — The maximum time before the reservation starts, you can reserve in ISO 8601 duration format. - `LengthRestrictions` LengthRestriction[], required — Length restrictions for the rate. - `Id` string, uuid — Unique identifier of the rate restriction. - `RateId` string, uuid — Unique identifier of the rate. - `IsInherited` boolean — Whether the rate restriction is inherited from the parent rate. - `StartUtc` string, nullable — Start of the rate restriction in UTC timezone in ISO 8601 format. - `EndUtc` string, nullable — End of the rate restriction in UTC timezone in ISO 8601 format. - `Days` string[], nullable — The restricted days of week. - `ExternalIdentifier` string, nullable — Identifiers of from external systems. - `MinLength` string, nullable — Minimal reservation length in ISO 8601 duration format. - `MaxLength` string, nullable — Maximal reservation length in ISO 8601 duration format. - `Cursor` string, uuid, nullable — 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. ## 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)