Skip to content
Mews Open API

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, 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

Section titled “Request Body ”
ConfigurationFilterParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
EnterpriseId

Unique identifier of the Enterprise, defaults to the enterprise associated with the given access token.

string format: uuid
nullable
Example
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "EnterpriseId": "851df8c8-90f2-4c4a-8e01-a4fc46b25178"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Configuration
object
NowUtc
required

Current server date and time in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Enterprise
required
Enterprise

The enterprise (e.g. hotel, hostel) associated with the access token.

object
Id
required

Unique identifier of the enterprise.

string format: uuid
ExternalIdentifier

Identifier of the enterprise from external system.

string
nullable <= 255 characters
HoldingKey

Identifies an enterprise in the external system of a holding company. The holding company may administer multiple portfolios.

string
nullable <= 255 characters
ChainId
required

Unique identifier of the chain to which the enterprise belongs.

string format: uuid
ChainName
required

Name of the Chain to which the enterprise belongs.

string
>= 1 characters
CreatedUtc
required

Creation date and time of the enterprise in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Creation date and time of the enterprise in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Name
required

Name of the enterprise.

string
>= 1 characters
TimeZoneIdentifier
required

IANA timezone identifier of the enterprise.

string
>= 1 characters
LegalEnvironmentCode
required

Unique identifier of the legal environment where the enterprise resides.

string
>= 1 characters
AccommodationEnvironmentCode
required

Unique code of the accommodation environment where the enterprise resides.

string
>= 1 characters
AccountingEnvironmentCode
required

Unique code of the accounting environment where the enterprise resides.

string
>= 1 characters
TaxEnvironmentCode
required

Unique code of the tax environment where the enterprise resides.

string
>= 1 characters
DefaultLanguageCode
required

Language-culture codes of the enterprise default Language.

string
>= 1 characters
EditableHistoryInterval
required
string
>= 1 characters
AccountingEditableHistoryInterval
required

Editable history interval for accounting data in ISO 8601 duration format.

string
>= 1 characters
OperationalEditableHistoryInterval
required

Editable history interval for operational data in ISO 8601 duration format.

string
>= 1 characters
WebsiteUrl

URL of the enterprise website.

string format: uri
nullable
Email

Email address of the enterprise.

string format: email
nullable
Phone

Phone number of the enterprise.

string format: tel
nullable
LogoImageId

Unique identifier of the Image of the enterprise logo.

string format: uuid
nullable
CoverImageId

Unique identifier of the Image of the enterprise cover.

string format: uuid
nullable
Pricing
required
Pricing

Pricing of the enterprise.

Gross (The enterprise shows amount with gross prices.)

Net (The enterprise shows amount with net prices.)

string
Allowed values: Gross Net
TaxPrecision

Tax precision used for financial calculations in the enterprise. If null, Currency precision is used.

integer format: int32
nullable
AddressId
required

Unique identifier of the Address of the enterprise.

string format: uuid
Address
required
Address

Address of the enterprise.

object
Id

Unique identifier of the address.

string format: uuid
Line1

First line of the address.

string
nullable
Line2

Second line of the address.

string
nullable
City

The city.

string
nullable
PostalCode

Postal code.

string
nullable
CountryCode

ISO 3166-1 code of the Country.

string
nullable
CountrySubdivisionCode

ISO 3166-2 code of the administrative division, e.g. DE-BW.

string
nullable
Latitude

The latitude.

number format: double
nullable
Longitude

The longitude.

number format: double
nullable
GroupNames
required

A list of the group names of the enterprise.

Array<string>
Subscription
required
Enterprise subscription

Subscription information of the enterprise.

object
TaxIdentifier

Tax identifier of the Enterprise.

string
nullable
Currencies
required

Currencies accepted by the enterprise.

Array<object>
Accepted currency
object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
IsDefault
required

Whether the currency is a default accounting currency.

boolean
IsEnabled
required

Whether the currency is enabled for usage.

boolean
AccountingConfiguration
Accounting configuration

Configuration information containing financial information about the property.

object
AdditionalTaxIdentifier

Organization number.

string
nullable <= 50 characters
CompanyName

Legal name of the company.

string
nullable <= 100 characters
BankAccountNumber

Bank account number.

string
nullable <= 50 characters
BankName

Name of the bank.

string
nullable <= 100 characters
Iban

International Bank Account Number.

string
nullable <= 40 characters
Bic

Business Identification Code.

string
nullable <= 11 characters
SurchargeConfiguration
required
Surcharging fees configuration

Configuration for surcharging fees.

object
SurchargeFees
required
CreditCardTypeDecimalIDictionary

Dictionary keys are CreditCardType and values are surcharging fees as a percentage.

object
MasterCard
number format: double
Visa
number format: double
Amex
number format: double
Discover
number format: double
DinersClub
number format: double
Jcb
number format: double
Maestro
number format: double
UnionPay
number format: double
VPay
number format: double
RuPay
number format: double
Dankort
number format: double
Mir
number format: double
Verve
number format: double
Troy
number format: double
PostFinance
number format: double
Giro
number format: double
Bancomat
number format: double
Bc
number format: double
CarteBleue
number format: double
Eftpos
number format: double
Eps
number format: double
Interac
number format: double
Isracard
number format: double
Meps
number format: double
Nets
number format: double
Bancontact
number format: double
SurchargeServiceId

Unique identifier of the surcharging Service.

string format: uuid
nullable
SurchargeTaxCode

Surcharging fee TaxCode.

string
nullable
EnabledExternalPaymentTypes
required

External payment types that are enabled for the enterprise and can be used in payments/addExternal.

Array<string>
Allowed values: Unspecified BadDebts Bacs WireTransfer Invoice ExchangeRateDifference Complimentary Reseller ExchangeRoundingDifference Barter Commission BankCharges CrossSettlement Cash CreditCard Prepayment Cheque Bancontact IDeal PayPal GiftCard LoyaltyPoints ChequeVacances OnlinePayment CardCheck PaymentHubRedirection Voucher MasterCard Visa Amex Discover DinersClub Jcb UnionPay Twint Reka LoyaltyCard PosDiningAndSpaReward DirectDebit DepositCheck DepositCash DepositCreditCard DepositWireTransfer
IsPortfolio

Whether the enterprise is a Portfolio enterprise (see Multi-property guidelines).

boolean
Service

The reservable service (e.g. accommodation, parking) associated with the access token of the service scoped integration.

object
Id
required

Unique identifier of the service.

string format: uuid
EnterpriseId
required

Unique identifier of the Enterprise.

string format: uuid
IsActive
required

Whether the service is still active.

boolean
Name
required

Name of the service.

string
>= 1 characters
Names
required
Localized text

All translations of the name.

object
key
additional properties
string
StartTime
string
nullable
EndTime
string
nullable
Options
required
Service options

Options of the service.

object
BillAsPackage
required

Products should be displayed as a single package instead of individual items.

boolean
Promotions
object
BeforeCheckIn
required

Whether it can be promoted before check-in.

boolean
AfterCheckIn
required

Whether it can be promoted after check-in.

boolean
DuringStay
required

Whether it can be promoted during stay.

boolean
BeforeCheckOut
required

Whether it can be promoted before check-out.

boolean
AfterCheckOut
required

Whether it can be promoted after check-out.

boolean
DuringCheckOut
required

Whether it can be promoted during check-out.

boolean
Type
string
nullable
Ordering
required

Order value for presentation purposes.

integer format: int32
Data
required
Service data

Additional information about the specific service.

object
Discriminator
Service data discriminator
string
Allowed values: Bookable Additional
Value
One of:
Bookable service data
object
StartOffset
required

Offset from the start of the time unit which defines the default start of the service; expressed in ISO 8601 duration format.

string
>= 1 characters
EndOffset
required

Offset from the end of the time unit which defines the default end of the service; expressed in ISO 8601 duration format.

string
>= 1 characters
OccupancyStartOffset
required

Offset from the start of the time unit 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.

string
>= 1 characters
OccupancyEndOffset
required

Offset from the end of the time unit 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.

string
>= 1 characters
TimeUnit
required
Time unit period

Day

Month

Hour

string
Allowed values: Day Month Hour
TimeUnitPeriod
required
Time unit period

The length of time or period represented by a time unit, for which the service can be booked.

Day

Month

Hour

string
Allowed values: Day Month Hour
ExternalIdentifier

Identifier of the service from external system.

string
nullable <= 255 characters
CreatedUtc
required

Creation date and time of the service in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the service in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
PaymentCardStorage
Payment card storage

Contains information about payment card storage.

object
PublicKey
required

Key for accessing PCI proxy storage.

string
>= 1 characters
IsIdentityDocumentNumberRequired

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.

boolean
Example
{
  "NowUtc": "2018-01-01T14:58:02Z",
  "Enterprise": {
    "Currencies": [
      {
        "Currency": "GBP",
        "IsDefault": true,
        "IsEnabled": true
      },
      {
        "Currency": "USD",
        "IsDefault": false,
        "IsEnabled": true
      }
    ],
    "AccountingConfiguration": {
      "AdditionalTaxIdentifier": null,
      "CompanyName": "Connector API Hotel",
      "BankAccountNumber": "1234",
      "BankName": "Random bank",
      "Iban": "CZ7250517882393618329719",
      "Bic": "GIBACZPY",
      "SurchargeConfiguration": {
        "SurchargeFees": {
          "Amex": 3,
          "DinersClub": 4
        },
        "SurchargeServiceId": "2b9b0143-3135-485b-8064-76c90d1be69e",
        "SurchargeTaxCode": "US-HI-KA"
      },
      "EnabledExternalPaymentTypes": [
        "Invoice",
        "Cash",
        "GiftCard"
      ]
    },
    "IsPortfolio": false,
    "Id": "851df8c8-90f2-4c4a-8e01-a4fc46b25178",
    "ExternalIdentifier": null,
    "HoldingKey": "CA123",
    "ChainId": "8ddea57b-6a5c-4eec-8c4c-24467dce118e",
    "ChainName": "Connector API Chain",
    "CreatedUtc": "2015-07-07T13:33:17Z",
    "UpdatedUtc": "2015-07-07T13:33:17Z",
    "Name": "Connector API Hotel",
    "TimeZoneIdentifier": "Europe/Budapest",
    "LegalEnvironmentCode": "UK",
    "AccommodationEnvironmentCode": null,
    "AccountingEnvironmentCode": null,
    "TaxEnvironmentCode": null,
    "DefaultLanguageCode": "en-US",
    "EditableHistoryInterval": "P0M7DT0H0M0S",
    "AccountingEditableHistoryInterval": "P0M7DT0H0M0S",
    "OperationalEditableHistoryInterval": "P0M5DT0H0M0S",
    "WebsiteUrl": "https://en.wikipedia.org/wiki/St._Vitus_Cathedral",
    "Email": "charging-api@mews.li",
    "Phone": "00000 123 456 789",
    "LogoImageId": null,
    "CoverImageId": null,
    "Pricing": "Gross",
    "TaxPrecision": null,
    "AddressId": "c556f56e-713e-4102-9de5-0e853b5a8586",
    "Address": {
      "Id": "8c2c4371-5d42-40a9-b551-ab0b00d75076",
      "Line1": "I.P. Pavlova 5",
      "Line2": null,
      "City": "Prague",
      "PostalCode": "1200",
      "CountryCode": "CZ",
      "CountrySubdivisionCode": null,
      "Latitude": 14.429645,
      "Longitude": 50.075181
    },
    "GroupNames": [
      "Connector API Group"
    ],
    "Subscription": {
      "TaxIdentifier": "123456789 RC 0001"
    }
  },
  "Service": {
    "Id": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
    "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "IsActive": true,
    "Name": "Accommodation",
    "Names": {
      "en-GB": "Accommodation"
    },
    "StartTime": "PT14H",
    "EndTime": "PT12H",
    "Options": {
      "BillAsPackage": false
    },
    "Promotions": {
      "BeforeCheckIn": false,
      "AfterCheckIn": false,
      "DuringStay": false,
      "BeforeCheckOut": false,
      "AfterCheckOut": false,
      "DuringCheckOut": false
    },
    "Type": "Reservable",
    "Ordering": 0,
    "Data": null,
    "ExternalIdentifier": null,
    "CreatedUtc": "2023-10-01T11:48:57Z",
    "UpdatedUtc": "2023-10-28T11:48:57Z"
  },
  "PaymentCardStorage": null,
  "IsIdentityDocumentNumberRequired": true
}

204

Section titled “204 ”

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

400

Section titled “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).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

401

Section titled “401 ”

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

403

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

408

Section titled “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

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

429

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

500

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable