vocabulary: 1.0.0
info:
  provider: Mews
  description: Unified operational and capability vocabulary for the Mews Connector and Booking Engine (Distributor) APIs — resources, actions, schemas, enums, authentication, and the Naftiko capability
    workflows that compose them.
  created: '2026-06-02'
  modified: '2026-06-02'
operational:
  apis:
  - name: Mews Booking Engine API (Distributor)
    namespace: mews-booking-engine-api
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Bills and Accounting
    namespace: mews-connector-api-billing
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Enterprise Configuration
    namespace: mews-connector-api-configuration
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Customers and Companies
    namespace: mews-connector-api-customers
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Operations and Messaging
    namespace: mews-connector-api-operations
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Payments and Cashiers
    namespace: mews-connector-api-payments
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Point of Sale Outlets
    namespace: mews-connector-api-pos
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Reservations and Availability
    namespace: mews-connector-api-reservations
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Resources and Spaces
    namespace: mews-connector-api-resources
    version: v1
    baseUrl: https://api.mews.com
    status: active
  - name: Mews Connector API — Services and Products
    namespace: mews-connector-api-services
    version: v1
    baseUrl: https://api.mews.com
    status: active
  resources:
  - name: accountNotes
    actions:
    - add
    - delete
    - getAll
    - update
  - name: accountingCategories
    actions:
    - getAll
  - name: accountingItems
    actions:
    - getAll
    - update
  - name: accounts
    actions:
    - addFile
    - merge
    - update
  - name: addresses
    actions:
    - add
    - delete
    - getAll
    - update
  - name: ageCategories
    actions:
    - getAll
  - name: availabilityAdjustments
    actions:
    - getAll
  - name: availabilityBlocks
    actions:
    - add
    - delete
    - getAll
    - update
  - name: billingAutomationPaymentPlans
    actions:
    - add
  - name: billingAutomations
    actions:
    - add
    - delete
    - getAll
    - update
    - updateAssignments
  - name: bills
    actions:
    - add
    - close
    - delete
    - getAll
    - getPdf
    - update
  - name: businessSegments
    actions:
    - getAll
  - name: cancellationPolicies
    actions:
    - getAll
    - getByRates
    - getByReservations
  - name: cashierTransactions
    actions:
    - getAll
  - name: cashiers
    actions:
    - getAll
  - name: commands
    actions:
    - addKeyCutter
    - addPaymentTerminal
    - addPrinter
    - getAllActive
    - getAllByIds
    - update
  - name: companies
    actions:
    - add
    - delete
    - getAll
    - update
  - name: companionships
    actions:
    - getAll
  - name: companyContracts
    actions:
    - add
    - delete
    - getAll
    - update
  - name: configuration
    actions:
    - get
  - name: counters
    actions:
    - getAll
  - name: countries
    actions:
    - getAll
  - name: creditCards
    actions:
    - addTokenized
    - charge
    - disable
    - getAll
  - name: currencies
    actions:
    - getAll
  - name: customers
    actions:
    - add
    - addFile
    - getAll
    - getOpenItems
    - getRelationships
    - merge
    - search
    - update
  - name: departments
    actions:
    - getAll
  - name: devices
    actions:
    - getAll
  - name: enterprises
    actions:
    - getAll
  - name: exchangeRates
    actions:
    - getAll
  - name: exports
    actions:
    - add
    - getAll
  - name: fiscalMachineCommands
    actions:
    - getAll
  - name: hotels
    actions:
    - get
    - getAvailability
    - getPaymentConfiguration
  - name: identityDocuments
    actions:
    - add
    - clear
    - delete
    - getAll
    - update
  - name: images
    actions:
    - getUrls
  - name: languages
    actions:
    - getAll
    - getTexts
  - name: ledgerBalances
    actions:
    - getAll
  - name: loyaltyMemberships
    actions:
    - add
    - delete
    - getAll
    - update
  - name: loyaltyPrograms
    actions:
    - add
    - delete
    - getAll
    - update
  - name: loyaltyTiers
    actions:
    - add
    - delete
    - getAll
    - update
  - name: messageThreads
    actions:
    - add
    - getAll
  - name: messages
    actions:
    - add
    - getAll
  - name: orderItems
    actions:
    - cancel
    - getAll
  - name: orders
    actions:
    - add
  - name: outletBills
    actions:
    - add
  - name: outletItems
    actions:
    - getAll
  - name: outlets
    actions:
    - getAll
  - name: paymentCards
    actions:
    - authorize
    - getAll
  - name: paymentMethodRequests
    actions:
    - add
  - name: paymentRequests
    actions:
    - add
    - cancel
    - getAll
  - name: payments
    actions:
    - addAlternative
    - addCreditCard
    - addExternal
    - getAll
    - refund
  - name: preauthorizations
    actions:
    - getAllByCustomers
  - name: productCategories
    actions:
    - getAll
  - name: productServiceOrders
    actions:
    - getAll
  - name: products
    actions:
    - delete
    - getAll
    - getPrices
    - getPricing
    - updatePrice
  - name: rateGroups
    actions:
    - getAll
  - name: rates
    actions:
    - add
    - delete
    - getAll
    - getPricing
    - set
    - updateCapacityOffset
    - updatePrice
  - name: reservationGroups
    actions:
    - create
    - get
    - getAll
  - name: reservations
    actions:
    - add
    - addCompanion
    - addProduct
    - cancel
    - confirm
    - deleteCompanion
    - getAll
    - getAllItems
    - getAll_2023-06-06
    - getChannelManagerDetails
    - getPricing
    - price
    - process
    - start
    - update
    - updateCustomer
    - updateInterval
  - name: resourceAccessTokens
    actions:
    - add
    - delete
    - getAll
    - update
  - name: resourceBlocks
    actions:
    - add
    - delete
    - getAll
  - name: resourceCategories
    actions:
    - getAll
  - name: resourceCategoryAssignments
    actions:
    - getAll
  - name: resourceCategoryImageAssignments
    actions:
    - getAll
  - name: resourceFeatureAssignments
    actions:
    - getAll
  - name: resourceFeatures
    actions:
    - getAll
  - name: resources
    actions:
    - getAll
    - getOccupancyState
    - update
  - name: restrictions
    actions:
    - clear
    - getAll
    - set
  - name: routingRules
    actions:
    - add
    - delete
    - getAll
    - update
  - name: rules
    actions:
    - getAll
  - name: serviceOrderNotes
    actions:
    - add
    - delete
    - getAll
    - update
  - name: serviceOverbookingLimits
    actions:
    - clear
    - getAll
    - set
  - name: services
    actions:
    - getAll
    - getAvailability
    - getAvailability_2024-01-22
    - getPricing
    - getPromotions
    - updateAvailability
  - name: sourceAssignments
    actions:
    - getAll
    - getAll_2024-09-20
  - name: sources
    actions:
    - getAll
  - name: tasks
    actions:
    - add
    - close
    - getAll
  - name: taxEnvironments
    actions:
    - getAll
  - name: taxations
    actions:
    - getAll
  - name: voucherCodes
    actions:
    - add
    - delete
    - getAll
  - name: vouchers
    actions:
    - add
    - delete
    - getAll
    - update
    - validate
  actions:
  - verb: get
    count: 104
    pattern: read
  - verb: add
    count: 40
    pattern: write
  - verb: update
    count: 28
    pattern: write
  - verb: delete
    count: 20
    pattern: destructive
  - verb: cancel
    count: 3
    pattern: destructive
  - verb: clear
    count: 3
    pattern: write
  - verb: set
    count: 3
    pattern: write
  - verb: price
    count: 2
    pattern: read
  - verb: close
    count: 2
    pattern: write
  - verb: merge
    count: 2
    pattern: write
  - verb: validate
    count: 1
    pattern: read
  - verb: authorize
    count: 1
    pattern: write
  - verb: create
    count: 1
    pattern: write
  - verb: search
    count: 1
    pattern: read
  - verb: charge
    count: 1
    pattern: write
  - verb: disable
    count: 1
    pattern: write
  - verb: refund
    count: 1
    pattern: write
  - verb: confirm
    count: 1
    pattern: write
  - verb: start
    count: 1
    pattern: write
  - verb: process
    count: 1
    pattern: write
  enums:
  - name: PaymentCardAuthorizationState
    values:
    - Authorized
    - Requested
    - Pending
    - Declined
    - Canceled
  - name: PaymentCardAuthorizationRequestedAction
    values:
    - Redirect
    - Show
    - Nothing
  - name: ProductPostingMode
    values:
    - Once
    - PerTimeUnit
  - name: BookingEngineTheme
    values:
    - Light
    - Dark
  - name: RestrictionType
    values:
    - ClosedToStay
    - ClosedToArrival
    - ClosedToDeparture
  - name: CreditCardTypes
    values:
    - MasterCard
    - Visa
    - Amex
    - Discover
    - DinersClub
    - Jcb
    - Maestro
    - UnionPay
    - VPay
    - RuPay
    - Dankort
    - Mir
  - name: TimeUnitPeriod
    values:
    - Day
    - Month
    - Hour
  - name: PaymentRequestState
    values:
    - Pending
    - Completed
    - Canceled
    - Expired
  - name: AgeCategoryClassification
    values:
    - Adult
    - Child
  - name: BookingEnginePaymentCardRequirement
    values:
    - NotRequired
    - NotRequiredForFullyPaidBookings
    - AlwaysRequired
    - NotRequiredForFullyOrPartiallyPaidBookings
  - name: BookingEngineRequiredFields
    values:
    - Telephone
  - name: ResourceCategoryType
    values:
    - Room
    - Bed
    - Dorm
    - Apartment
    - Suite
    - Villa
    - Site
    - Office
    - MeetingRoom
    - ParkingSpot
    - Desk
    - TeamArea
  - name: AmountPart
    values:
    - NetValue
    - TaxValue
    - GrossValue
  - name: ProductChargingMode
    values:
    - Once
    - PerTimeUnit
    - PerPersonPerTimeUnit
    - PerPerson
  - name: BookingEngineBookerReservationCustomerEmailInput
    values:
    - Required
    - Optional
  - name: PaymentState
    values:
    - Charged
    - Canceled
    - Pending
    - Failed
    - Verifying
  - name: PaymentCard3DsAuthorizationState
    values:
    - Authorized
    - Authorizable
    - Unauthorizable
  - name: PricingMode
    values:
    - Gross
    - Net
  - name: SettlementRuleType
    values:
    - Manual
    - Automatic
  - name: PaymentGatewayModel
    values:
    - MerchantOfRecord
    - PaymentFacilitator
    - Direct
  - name: SettlementRuleTrigger
    values:
    - Confirmation
    - Start
    - End
    - StartDate
    - EndDate
  - name: SettlementRuleAction
    values:
    - ChargeCreditCard
    - CreatePreauthorization
  - name: PromotedServiceAssignmentReservationIntervalLimit
    values:
    - SameAsParent
    - InsideParent
  - name: PromotedServiceAssignmentUnitCountLimit
    values:
    - PerReservation
    - PerSpace
    - PerGuest
    - NoLimit
  - name: PaymentCardStorageType
    values:
    - Adyen
    - Stripe
    - PciProxy
  - name: BillAssigneeDataDiscriminator
    values:
    - BillCustomerData
    - BillCompanyData
  - name: BillingAutomationPrepaymentEnum
    values:
    - All
    - Prepaid
  - name: BillType
    values:
    - Receipt
    - Invoice
  - name: AccountingCategoryClassificationEnum
    values:
    - Accommodation
    - FoodAndBeverage
    - Taxes
    - Payments
    - ExternalRevenue
    - SundryIncome
    - Wellness
    - Sport
    - Technology
    - Facilities
    - Events
    - Tourism
  - name: Title
    values:
    - Mister
    - Miss
    - Misses
  - name: RevenueTypeEnum
    values:
    - Service
    - Product
    - Additional
  - name: BillingAutomationOrderItemConsumptionPeriodTypeEnum
    values:
    - MonthBefore
    - SameMonthAndMonthBefore
    - SameMonth
    - SameMonthAndMonthAfter
    - MonthAfter
  - name: PaymentType
    values:
    - CreditCard
    - Invoice
    - Cash
    - Unspecified
    - BadDebts
    - WireTransfer
    - ExchangeRateDifference
    - ExchangeRoundingDifference
    - BankCharges
    - Cheque
    - Other
  - name: BillStateEnum
    values:
    - Open
    - Closed
  - name: BillCorrectionStateEnum
    values:
    - Bill
    - CorrectiveBill
  - name: BillCorrectionTypeEnum
    values:
    - Cancellation
    - Edit
    - CreditNote
    - Reinstatement
    - ReceivablePaymentsBalance
  - name: ProductTypeEnum
    values:
    - Product
    - Allowance
  - name: BillingAutomationAssignmentTargetTypeEnum
    values:
    - CompanyAsDetails
    - CompanyAsOwner
    - NoCompany
  - name: AccountingState
    values:
    - Open
    - Closed
    - Inactive
    - Canceled
  - name: BillPdfResultDiscriminator
    values:
    - BillPdfFile
    - BillPrintEvent
  authentication:
    scheme: Body Tokens
    fields:
    - Client
    - ClientToken
    - AccessToken
    placement: JSON request body
    notes: ClientToken identifies the partner application; AccessToken authorises against a property (enterprise); Portfolio Access Tokens grant multi-property access.
capability:
  workflows:
  - name: Mews Booking Engine API
    file: capabilities/booking-engine.yaml
    description: 'Booking Engine API — Mews Booking Engine API. 20 operations. Lead operation: Get Availability'
    toolCount: 20
    domains:
    - Booking-Engine
  - name: Mews Connector API — Bills and Accounting
    file: capabilities/connector-billing.yaml
    description: 'Connector API — Bills and Accounting. 24 operations. Lead operation: Get All Accounting Categories'
    toolCount: 24
    domains:
    - Bills and Accounting
  - name: Mews Connector API — Enterprise Configuration
    file: capabilities/connector-configuration.yaml
    description: 'Connector API — Enterprise Configuration. 8 operations. Lead operation: Get Configuration'
    toolCount: 8
    domains:
    - Enterprise Configuration
  - name: Mews Connector API — Customers and Companies
    file: capabilities/connector-customers.yaml
    description: 'Connector API — Customers and Companies. 39 operations. Lead operation: Get All Addresses'
    toolCount: 39
    domains:
    - Customers and Companies
  - name: Mews Connector API — Operations and Messaging
    file: capabilities/connector-operations.yaml
    description: 'Connector API — Operations and Messaging. 24 operations. Lead operation: Get All Account Notes'
    toolCount: 24
    domains:
    - Operations and Messaging
  - name: Mews Connector API — Payments and Cashiers
    file: capabilities/connector-payments.yaml
    description: 'Connector API — Payments and Cashiers. 16 operations. Lead operation: Get All Cashier Transactions'
    toolCount: 16
    domains:
    - Payments and Cashiers
  - name: Mews Connector API — Point of Sale Outlets
    file: capabilities/connector-pos.yaml
    description: 'Connector API — Point of Sale Outlets. 3 operations. Lead operation: Add Outlet Bills'
    toolCount: 3
    domains:
    - Point of Sale Outlets
  - name: Mews Connector API — Reservations and Availability
    file: capabilities/connector-reservations.yaml
    description: 'Connector API — Reservations and Availability. 44 operations. Lead operation: Get All Availability Adjustments'
    toolCount: 44
    domains:
    - Reservations and Availability
  - name: Mews Connector API — Resources and Spaces
    file: capabilities/connector-resources.yaml
    description: 'Connector API — Resources and Spaces. 15 operations. Lead operation: Get All Resource Access Tokens'
    toolCount: 15
    domains:
    - Resources and Spaces
  - name: Mews Connector API — Services and Products
    file: capabilities/connector-services.yaml
    description: 'Connector API — Services and Products. 24 operations. Lead operation: Get All Product Categories'
    toolCount: 24
    domains:
    - Services and Products
  personas:
  - id: integration-partner
    name: Integration Partner Developer
    description: Builds certified Mews Marketplace integrations against the Connector API.
  - id: booking-engine-developer
    name: Booking Engine Developer
    description: Builds guest-facing direct-booking flows on the Distributor/Booking Engine API.
  - id: pos-vendor
    name: POS Vendor
    description: Integrates restaurant and retail point-of-sale with guest folios.
  - id: revenue-analyst
    name: Revenue and BI Analyst
    description: Pulls reservation, billing, and payment data into BI and revenue tools.
  domains:
  - Reservations and Availability
  - Customers and Companies
  - Bills and Accounting
  - Payments and Cashiers
  - Services and Products
  - Resources and Spaces
  - Point of Sale Outlets
  - Operations and Messaging
  - Enterprise Configuration
  - Booking Engine
  namespaces:
  - consumed: booking-engine
    rest: booking-engine-rest
    mcp: booking-engine-mcp
  - consumed: connector-billing
    rest: connector-billing-rest
    mcp: connector-billing-mcp
  - consumed: connector-configuration
    rest: connector-configuration-rest
    mcp: connector-configuration-mcp
  - consumed: connector-customers
    rest: connector-customers-rest
    mcp: connector-customers-mcp
  - consumed: connector-operations
    rest: connector-operations-rest
    mcp: connector-operations-mcp
  - consumed: connector-payments
    rest: connector-payments-rest
    mcp: connector-payments-mcp
  - consumed: connector-pos
    rest: connector-pos-rest
    mcp: connector-pos-mcp
  - consumed: connector-reservations
    rest: connector-reservations-rest
    mcp: connector-reservations-mcp
  - consumed: connector-resources
    rest: connector-resources-rest
    mcp: connector-resources-mcp
  - consumed: connector-services
    rest: connector-services-rest
    mcp: connector-services-mcp
  binds:
  - env: MEWS_ACCESS_TOKEN
    description: Mews property AccessToken used by every capability.