openapi: 3.0.4 info: title: Mews Booking Engine API (Distributor) Account notes API version: v1 description: The Mews Booking Engine API (historically the Distributor API, served from /api/distributor/v1) lets developers build guest-facing booking engines that create reservations directly in Mews. It exposes enterprise configuration, availability, pricing, products, vouchers, payment cards, and reservation group creation for front-end client consumption. x-generated-from: documentation x-source-url: https://api.mews.com/Swagger/distributor/swagger.json x-last-validated: '2026-06-02' servers: - url: https://api.mews.com description: Production - url: https://api.mews-demo.com description: Demo / sandbox security: - MewsClientToken: [] MewsAccessToken: [] tags: - name: Account notes paths: /api/connector/v1/accountNotes/getAll: post: tags: - Account notes summary: Mews Get All Account Notes description: 'Returns all account notes of an account, optionally filtered by activity state, account identifiers, specific account note identifiers or other filter parameters. 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).' operationId: accountNotes_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountNoteFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ChainIds: - 1df21f06-0cfc-4960-9c58-a3bf1261663e - 5fcd1933-22f2-40b9-84da-7db04cbecec2 AccountNoteIds: - 3ed9e2f3-4bba-4df6-8d41-ab1b009b6425 - 8a98965a-7c03-48a1-a28c-ab1b009b53c8 AccountIds: - a6738390-c241-45b7-8e46-14f47207abe5 - 435d4d5f-d14f-48dc-a47e-0481fc28ead0 UpdatedUtc: StartUtc: '2022-10-10T00:00:00Z' EndUtc: '2022-10-17T00:00:00Z' ActivityStates: - Active Limitation: Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountNoteResult' example: AccountNotes: - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e Content: Customer receives a free bottle of champagne during stay AccountType: Customer Classifications: - Gifts IsActive: true CreatorProfile: Discriminator: Enterprise EnterpriseProfile: ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13 UpdaterProfile: Discriminator: Integration EnterpriseProfile: null - Id: da34b396-41f7-47f6-8847-aecf00a3f19e AccountId: 5fcd1933-22f2-40b9-84da-7db04cbecec2 Content: Lactose intolerant AccountType: Customer Classifications: - FoodAndBeverage IsActive: true CreatorProfile: Discriminator: Enterprise EnterpriseProfile: ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13 UpdaterProfile: Discriminator: Integration EnterpriseProfile: null Cursor: da34b396-41f7-47f6-8847-aecf00a3f19e '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesGetAll400Example: summary: Default accountNotes_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesGetAll401Example: summary: Default accountNotes_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesGetAll403Example: summary: Default accountNotes_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: 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) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesGetAll408Example: summary: Default accountNotes_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesGetAll204Example: summary: Default accountNotes_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesGetAll429Example: summary: Default accountNotes_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesGetAll500Example: summary: Default accountNotes_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/connector/v1/accountNotes/add: post: tags: - Account notes summary: Mews Add Account Notes description: Adds account notes to an account of the enterprise chain. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: accountNotes_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleAccountNoteAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e AccountNotes: - AccountId: 8ddea57b-6a5c-4eec-8c4c-24467dce118e Content: Brother of the CEO Classifications: - FamilyRelations responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountNoteAdditionResult' example: AccountNotes: - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e Content: Brother of the CEO AccountType: Customer Classifications: - FamilyRelations IsActive: true CreatorProfile: Discriminator: Enterprise EnterpriseProfile: ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13 UpdaterProfile: Discriminator: Integration EnterpriseProfile: null '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesAdd400Example: summary: Default accountNotes_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesAdd401Example: summary: Default accountNotes_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesAdd403Example: summary: Default accountNotes_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: 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) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesAdd408Example: summary: Default accountNotes_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesAdd204Example: summary: Default accountNotes_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesAdd429Example: summary: Default accountNotes_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesAdd500Example: summary: Default accountNotes_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/connector/v1/accountNotes/update: post: tags: - Account notes summary: Mews Update Account Notes description: Updates information about the specified account notes. operationId: accountNotes_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleAccountNoteUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AccountNoteUpdates: - AccountNoteId: a58ff7cb-77e3-495a-bd61-aecf00a3f19d Content: Value: The AC in the room doesn't work anymore Classifications: Maintenance: Value: true Housekeeping: Value: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountNoteUpdateResult' example: AccountNotes: - Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e Content: The AC in the room doesn't work anymore AccountType: Customer Classifications: - Maintenance IsActive: true CreatorProfile: Discriminator: Enterprise EnterpriseProfile: ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13 UpdaterProfile: Discriminator: Integration EnterpriseProfile: null '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesUpdate400Example: summary: Default accountNotes_update 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesUpdate401Example: summary: Default accountNotes_update 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesUpdate403Example: summary: Default accountNotes_update 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: 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) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesUpdate408Example: summary: Default accountNotes_update 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesUpdate204Example: summary: Default accountNotes_update 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesUpdate429Example: summary: Default accountNotes_update 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesUpdate500Example: summary: Default accountNotes_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/connector/v1/accountNotes/delete: post: tags: - Account notes summary: Mews Delete Account Notes description: Deletes specified account notes. operationId: accountNotes_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleAccountNoteDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AccountNoteIds: - a58ff7cb-77e3-495a-bd61-aecf00a3f19d - da34b396-41f7-47f6-8847-aecf00a3f19e responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: AccountNotesDelete200Example: summary: Default accountNotes_delete 200 response x-microcks-default: true value: {} '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesDelete400Example: summary: Default accountNotes_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesDelete401Example: summary: Default accountNotes_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesDelete403Example: summary: Default accountNotes_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: 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) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesDelete408Example: summary: Default accountNotes_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesDelete204Example: summary: Default accountNotes_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesDelete429Example: summary: Default accountNotes_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: AccountNotesDelete500Example: summary: Default accountNotes_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: Unit: type: object additionalProperties: false AccountNoteAdditionResult: title: AccountNoteAdditionResult required: - AccountNotes type: object properties: AccountNotes: type: array items: $ref: '#/components/schemas/AccountNote' description: Added account notes. additionalProperties: false x-schema-id: AccountNoteAdditionResult EnterpriseProfileData: title: Enterprise profile data required: - ProfileId type: object properties: ProfileId: type: string description: Unique identifier of the profile. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: EnterpriseProfileData AccountNoteResult: title: AccountNoteResult required: - AccountNotes type: object properties: AccountNotes: type: array items: $ref: '#/components/schemas/AccountNote' description: The set of requested account notes. Cursor: type: string description: 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. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: AccountNoteResult TimeFilterInterval: title: Time interval type: object properties: StartUtc: type: string format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string format: date-time nullable: true example: '2026-06-02T14:30:00Z' additionalProperties: false description: "When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:\r\n\r\n- **Start equals End (equality mode)** \r\n If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\r\n \r\n ```\r\n CreatedUtc == StartUtc\r\n ```\r\n \r\n This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\r\n\r\n- **Start differs from End (interval mode)** \r\n If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\r\n \r\n ```\r\n StartUtc <= CreatedUtc < EndUtc\r\n ```\r\n \r\n In other words, the start is inclusive and the end is exclusive.\r\n\r\nMake sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted." x-schema-id: TimeFilterInterval MultipleAccountNoteDeleteParameters: title: MultipleAccountNoteDeleteParameters required: - AccessToken - AccountNoteIds - Client - ClientToken type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ChainId: type: string description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountNoteIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the account notes to be deleted. additionalProperties: false x-schema-id: MultipleAccountNoteDeleteParameters AccountNoteUpdateClassifications: title: Account note update classifications type: object properties: General: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Company and Customer: Boolean value defining the general classification for the account note (or `null` if the value should not be updated).' nullable: true example: string FoodAndBeverage: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the food and beverage classification for the account note (or `null` if the value should not be updated).' nullable: true example: string FrontOffice: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the front office classification for the account note (or `null` if the value should not be updated).' nullable: true example: string Reservations: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the reservations classification for the account note (or `null` if the value should not be updated).' nullable: true example: string Housekeeping: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the housekeeping classification for the account note (or `null` if the value should not be updated).' nullable: true example: string Maintenance: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the maintenance classification for the account note (or `null` if the value should not be updated).' nullable: true example: string PreviousStay: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the previous stay classification for the account note (or `null` if the value should not be updated).' nullable: true example: string FamilyRelations: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the family relations classification for the account note (or `null` if the value should not be updated).' nullable: true example: string Gifts: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the gifts classification for the account note (or `null` if the value should not be updated).' nullable: true example: string Accounting: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the accounting classification for the account note (or `null` if the value should not be updated).' nullable: true example: string Complaints: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the complaints classification for the account note (or `null` if the value should not be updated).' nullable: true example: string Other: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: 'Customer only: Boolean value defining the other classification for the account note (or `null` if the value should not be updated).' nullable: true example: string additionalProperties: false x-schema-id: AccountNoteUpdateClassifications AccountNoteAddParameters: title: Account note parameters required: - AccountId - Classifications - Content type: object properties: AccountId: type: string format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Content: maxLength: 1000 minLength: 1 type: string description: The content of the account note. example: string Classifications: maxItems: 1 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/AccountNoteClassificationEnum' description: Specifying the classifications of the note based on account type. additionalProperties: false x-schema-id: AccountNoteAddParameters ActivityStates: title: Activity state enum: - Deleted - Active type: string description: Activity states used for filtering. BooleanUpdateValue: title: Boolean update value type: object properties: Value: type: boolean description: Value which is to be updated. example: true additionalProperties: false x-schema-id: BooleanUpdateValue AccountNoteClassificationEnum: title: Account note classification enum: - General - FoodAndBeverage - FrontOffice - Reservations - Housekeeping - Maintenance - PreviousStay - FamilyRelations - Gifts - Accounting - Complaints - Other type: string description: ' General (For Company and Customer) FoodAndBeverage (Only Customer) FrontOffice (Only Customer) Reservations (Only Customer) Housekeeping (Only Customer) Maintenance (Only Customer) PreviousStay (Only Customer) FamilyRelations (Only Customer) Gifts (Only Customer) Accounting (Only Customer) Complaints (Only Customer) Other (Only Customer)' x-enumNames: - General - FoodAndBeverage - FrontOffice - Reservations - Housekeeping - Maintenance - PreviousStay - FamilyRelations - Gifts - Accounting - Complaints - Other x-enumDescriptions: - For Company and Customer - Only Customer - Only Customer - Only Customer - Only Customer - Only Customer - Only Customer - Only Customer - Only Customer - Only Customer - Only Customer - Only Customer x-extensible: true ProfileData: title: Profile data required: - Discriminator type: object properties: Discriminator: $ref: '#/components/schemas/ProfileDataDiscriminator' EnterpriseProfile: title: Enterprise profile data allOf: - $ref: '#/components/schemas/EnterpriseProfileData' description: Enterprise profile data. nullable: true example: string additionalProperties: false description: The profile data of the user who created or last updated the record. x-schema-id: ProfileData ProfileDataDiscriminator: title: Profile data discriminator enum: - Personal - Enterprise - Platform - Static - Integration type: string ConnectorApiExceptionResult: title: ConnectorApiExceptionResult type: object properties: Message: type: string nullable: true example: string RequestId: type: string nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: nullable: true example: string additionalProperties: false x-schema-id: ConnectorApiExceptionResult AccountNoteUpdateResult: title: AccountNoteUpdateResult required: - AccountNotes type: object properties: AccountNotes: type: array items: $ref: '#/components/schemas/AccountNote' description: Updated account notes. additionalProperties: false x-schema-id: AccountNoteUpdateResult Limitation: title: Limitation required: - Count type: object properties: Count: type: integer format: int32 example: 1 Cursor: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false description: Limitation on the quantity of data returned. x-schema-id: Limitation AccountNoteUpdateParameters: title: Account note update parameters required: - AccountNoteId - Classifications type: object properties: AccountNoteId: type: string description: Unique identifier of the account note. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Content: title: String update value maxLength: 1000 minLength: 1 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Content of the account note (or `null` if the content should not be updated). nullable: true example: string Classifications: title: Account note update classifications allOf: - $ref: '#/components/schemas/AccountNoteUpdateClassifications' description: Classification of the account note. example: string additionalProperties: false x-schema-id: AccountNoteUpdateParameters MultipleAccountNoteUpdateParameters: title: MultipleAccountNoteUpdateParameters required: - AccessToken - AccountNoteUpdates - Client - ClientToken type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ChainId: type: string description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountNoteUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/AccountNoteUpdateParameters' description: Account notes to be updated. additionalProperties: false x-schema-id: MultipleAccountNoteUpdateParameters AccountNote: title: Account note required: - AccountId - AccountType - Classifications - Content - CreatorProfile - Id - IsActive - UpdaterProfile type: object properties: Id: type: string description: Unique identifier of the account note. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the account. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Content: minLength: 1 type: string description: The content of the account note. example: string AccountType: title: Account type allOf: - $ref: '#/components/schemas/AccountTypeEnum' description: 'Specifying type of associated account. Company Customer' x-enumNames: - Company - Customer x-enumDescriptions: - '' - '' example: string Classifications: type: array items: $ref: '#/components/schemas/AccountNoteClassificationEnum' description: Specifying the classifications of the note based on account type. IsActive: type: boolean description: Whether the account note is still active. example: true CreatorProfile: title: Profile data allOf: - $ref: '#/components/schemas/ProfileData' description: The profile data of the user who created the account note. example: string UpdaterProfile: title: Profile data allOf: - $ref: '#/components/schemas/ProfileData' description: The profile data of the user who updated the account note. example: string additionalProperties: false x-schema-id: AccountNote AccountTypeEnum: title: Account type enum: - Company - Customer type: string description: 'A discriminator specifying the account type, e.g. `Customer` or `Company` Company Customer' x-enumNames: - Company - Customer x-enumDescriptions: - '' - '' MultipleAccountNoteAddParameters: title: MultipleAccountNoteAddParameters required: - AccessToken - AccountNotes - Client - ClientToken type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ChainId: type: string description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountNotes: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/AccountNoteAddParameters' description: Account notes to be added. additionalProperties: false x-schema-id: MultipleAccountNoteAddParameters AccountNoteFilterParameters: title: AccountNoteFilterParameters required: - AccessToken - Client - ClientToken - Limitation type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string ChainIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Chain`. If not specified, the operation returns data for all chains within scope of the Access Token. nullable: true AccountNoteIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Account note](https://mews-systems.gitbook.io/connector-api/operations/#account-note). nullable: true AccountIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the accounts ([Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) or [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company)). nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval of Account note's last update date and time. nullable: true x-max-interval-in-months: 3 example: string ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted or both records. nullable: true additionalProperties: false x-schema-id: AccountNoteFilterParameters StringUpdateValue: title: String update value type: object properties: Value: type: string description: Value which is to be updated. nullable: true example: string additionalProperties: false x-schema-id: StringUpdateValue securitySchemes: MewsClientToken: type: apiKey in: header name: ClientToken description: Mews authentication is performed by supplying ClientToken, AccessToken and Client as fields in the JSON request body (not as HTTP headers). This securityScheme is a tooling-compatible representation of the ClientToken credential. ClientToken is unique to your application and identifies the API client. MewsAccessToken: type: apiKey in: header name: AccessToken description: Tooling-compatible representation of the AccessToken credential, which is supplied in the JSON request body. AccessToken is unique to the connection with a property (enterprise) and identifies the property or properties whose data and services you can access. Portfolio Access Tokens enable multi-property access with a single token.