--- title: "Get configuration" method: POST path: "/api/connector/v1/configuration/get" tags: ["Configuration"] --- # Get configuration `POST /api/connector/v1/configuration/get` Returns the enterprise configuration. For single-enterprise Access Tokens, this is the enterprise associated with the token. For [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), use the `EnterpriseId` parameter to specify which enterprise you want the configuration for. In the case of service scoped integrations, the operation returns the configuration associated with both the enterprise and the bookable service linked to the token. ## Request body - ConfigurationFilterParameters - `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. - `EnterpriseId` string, uuid, nullable — Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/#enterprise), defaults to the enterprise associated with the given access token. ## Response `200` OK - Configuration - `NowUtc` string, date-time, required — Current server date and time in UTC timezone in ISO 8601 format. - `Enterprise` Enterprise, required - `Id` string, uuid, required — Unique identifier of the enterprise. - `ExternalIdentifier` string, nullable — Identifier of the enterprise from external system. - `HoldingKey` string, nullable — Identifies an enterprise in the external system of a holding company. The holding company may administer multiple portfolios. - `ChainId` string, uuid, required — Unique identifier of the chain to which the enterprise belongs. - `ChainName` string, required — Name of the `Chain` to which the enterprise belongs. - `CreatedUtc` string, date-time, required — Creation date and time of the enterprise in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the enterprise in UTC timezone in ISO 8601 format. - `Name` string, required — Name of the enterprise. - `ShortName` string, nullable — Short name of the enterprise used in Manager Report exports. - `TimeZoneIdentifier` string, required — IANA timezone identifier of the enterprise. - `LegalEnvironmentCode` string, required — Unique identifier of the legal environment where the enterprise resides. - `AccommodationEnvironmentCode` string, required — Unique code of the accommodation environment where the enterprise resides. - `AccountingEnvironmentCode` string, required — Unique code of the accounting environment where the enterprise resides. - `TaxEnvironmentCode` string, required — Unique code of the tax environment where the enterprise resides. - `DefaultLanguageCode` string, required — Language-culture codes of the enterprise default `Language`. - `EditableHistoryInterval` string, required - `AccountingEditableHistoryInterval` string, required — Editable history interval for accounting data in ISO 8601 duration format. - `OperationalEditableHistoryInterval` string, required — Editable history interval for operational data in ISO 8601 duration format. - `BusinessDayClosingOffset` string, nullable — The offset value for the business day closing time, in ISO 8601 duration format. - `WebsiteUrl` string, uri, nullable — URL of the enterprise website. - `Email` string, email, nullable — Email address of the enterprise. - `Phone` string, tel, nullable — Phone number of the enterprise. - `LogoImageId` string, uuid, nullable — Unique identifier of the `Image` of the enterprise logo. - `CoverImageId` string, uuid, nullable — Unique identifier of the `Image` of the enterprise cover. - `Pricing` 'Gross' | 'Net', required — Gross (The enterprise shows amount with gross prices.) Net (The enterprise shows amount with net prices.) - `TaxPrecision` integer, nullable — Tax precision used for financial calculations in the enterprise. If `null`, `Currency` precision is used. - `AddressId` string, uuid, required — Unique identifier of the `Address` of the enterprise. - `Address` OldAddress, required - `Id` string, uuid — Unique identifier of the address. - `Line1` string, nullable — First line of the address. - `Line2` string, nullable — Second line of the address. - `City` string, nullable — The city. - `PostalCode` string, nullable — Postal code. - `CountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `CountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. `DE-BW`. - `Latitude` number, double, nullable — The latitude. - `Longitude` number, double, nullable — The longitude. - `GroupNames` string[], required — A list of the group names of the enterprise. - `Subscription` EnterpriseSubscription, required - `TaxIdentifier` string, nullable — Tax identifier of the `Enterprise`. - `Currencies` CurrencyAcceptance[], required — Currencies accepted by the enterprise. - `Currency` string, currency, required — ISO-4217 code of the `Currency`. - `IsDefault` boolean, required — Whether the currency is a default accounting currency. - `IsEnabled` boolean, required — Whether the currency is enabled for usage. - `AccountingConfiguration` AccountingConfiguration - `AdditionalTaxIdentifier` string, nullable — Organization number. - `CompanyName` string, nullable — Legal name of the company. - `BankAccountNumber` string, nullable — Bank account number. - `BankName` string, nullable — Name of the bank. - `Iban` string, nullable — International Bank Account Number. - `Bic` string, nullable — Business Identification Code. - `SurchargeConfiguration` SurchargeConfiguration, required - `SurchargeFees` object, required — Dictionary keys are `CreditCardType` and values are surcharging fees as a percentage. - `MasterCard` number, double - `Visa` number, double - `Amex` number, double - `Discover` number, double - `DinersClub` number, double - `Jcb` number, double - `Maestro` number, double - `UnionPay` number, double - `VPay` number, double - `RuPay` number, double - `Dankort` number, double - `Mir` number, double - `Verve` number, double - `Troy` number, double - `PostFinance` number, double - `Giro` number, double - `Bancomat` number, double - `Bc` number, double - `CarteBleue` number, double - `Eftpos` number, double - `Eps` number, double - `Interac` number, double - `Isracard` number, double - `Meps` number, double - `Nets` number, double - `Bancontact` number, double - `SurchargeServiceId` string, uuid, nullable — Unique identifier of the surcharging `Service`. - `SurchargeTaxCode` string, nullable — Surcharging fee `TaxCode`. - `EnabledExternalPaymentTypes` ExternalPaymentTypeEnum[], required — External payment types that are enabled for the enterprise and can be used in `payments/addExternal`. - `Options` AccountingConfigurationOptionEnum[], required — Accounting configuration options. - `IsPortfolio` boolean — Whether the enterprise is a Portfolio enterprise (see [Multi-property guidelines](https://mews-systems.gitbook.io/connector-api/guidelines/multi-property)). - `Service` Service - `Id` string, uuid, required — Unique identifier of the service. - `EnterpriseId` string, uuid, required — Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise). - `IsActive` boolean, required — Whether the service is still active. - `Name` string, required — Name of the service. - `Names` object, required — All translations of the name. - `StartTime` string, nullable - `EndTime` string, nullable - `Options` ServiceOptions, required — Options of the service. - `BillAsPackage` boolean, required — Products should be displayed as a single package instead of individual items. - `Promotions` Promotions - `BeforeCheckIn` boolean, required — Whether it can be promoted before check-in. - `AfterCheckIn` boolean, required — Whether it can be promoted after check-in. - `DuringStay` boolean, required — Whether it can be promoted during stay. - `BeforeCheckOut` boolean, required — Whether it can be promoted before check-out. - `AfterCheckOut` boolean, required — Whether it can be promoted after check-out. - `DuringCheckOut` boolean, required — Whether it can be promoted during check-out. - `Type` string, nullable - `Ordering` integer, required — Order value for presentation purposes. - `Data` object, required — Additional information about the specific service. - `Discriminator` 'Bookable' | 'Additional' - `Value` union - BookableServiceData - `StartOffset` string, required — Offset from the start of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the default start of the service; expressed in ISO 8601 duration format. - `EndOffset` string, required — Offset from the end of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the default end of the service; expressed in ISO 8601 duration format. - `OccupancyStartOffset` string, required — Offset from the start of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the occupancy start of the service; expressed in ISO 8601 duration format. 'Occupancy start' is used for availability and reporting purposes, it implies the time at which the booked resource is considered occupied. - `OccupancyEndOffset` string, required — Offset from the end of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the occupancy end of the service; expressed in ISO 8601 duration format. 'Occupancy end' is used for availability and reporting purposes, it implies the time at which the booked resource is no longer considered occupied. - `TimeUnit` 'Day' | 'Month' | 'Hour', required — Day Month Hour - `TimeUnitPeriod` 'Day' | 'Month' | 'Hour', required — Day Month Hour - AdditionalServiceData - `Promotions` Promotions, required - `BeforeCheckIn` boolean, required — Whether it can be promoted before check-in. - `AfterCheckIn` boolean, required — Whether it can be promoted after check-in. - `DuringStay` boolean, required — Whether it can be promoted during stay. - `BeforeCheckOut` boolean, required — Whether it can be promoted before check-out. - `AfterCheckOut` boolean, required — Whether it can be promoted after check-out. - `DuringCheckOut` boolean, required — Whether it can be promoted during check-out. - `ExternalIdentifier` string, nullable — Identifier of the service from external system. - `CreatedUtc` string, date-time, required — Creation date and time of the service in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the service in UTC timezone in ISO 8601 format. - `PaymentCardStorage` PaymentCardStorage - `PublicKey` string, required — Key for accessing PCI proxy storage. - `IsIdentityDocumentNumberRequired` boolean — Whether the identity documents for this enterprise include the value of identity document number as required by the legal environment. When `false`, the number is not required, and an empty string can be used in write operations. In read operations, an empty string is returned when an empty string was provided for the number. ## 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/versions/81933a8ff730/schema)