openapi: 3.0.4 info: title: Mews Connector API — Operations and Messaging description: General-purpose API that enables partners of Mews to access data and services in Mews Operations This modular spec covers the Operations and Messaging domain (24 operations). termsOfService: https://www.mews.com/en/terms-conditions/partners contact: name: Partner success email: partnersuccess@mews.com version: v1 x-generated-from: documentation x-source-url: https://api.mews.com/Swagger/connector/swagger.json x-last-validated: '2026-06-02' 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: - 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: 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: &id001 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: '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: *id001 /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: '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: *id001 /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: *id001 /api/connector/v1/accounts/update: post: tags: - Accounts summary: Mews Update Accounts description: Updates one or more existing accounts in the system. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: accounts_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleAccountUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AccountUpdates: - Id: 3ff104e6-3ba8-4dfc-8d35-b0ec00c5fd4c Discriminator: Company Customer: Company: Email: Value: example@example.com TaxIdentifier: Value: CZ8810310963 BillingCode: Value: AccountingCode: Value: Notes: Value: Example notes Name: Value: Example company MotherCompanyId: Value: 839e9d92-aa8b-48bf-8384-b0ec0081bb34 WebsiteUrl: Value: https://www.example.com InvoiceDueInterval: Value: CreditRatingBasic: Value: CreditOk Department: Value: Accounting DunsNumber: Value: '987654321' ReferenceId: Value: ExternalIdentifier: Value: COM-123 AdditionalTaxIdentifier: Value: XY00112233445 Contact: Value: Sample contact ContactPerson: Value: Sample person FiscalIdentifier: Value: FiscalIdentifier Iata: Value: PAO Telephone: Value: 111-222-333 SourceId: Value: F42098A0-8507-4963-ACC9-B0EC00821949 Classifications: Corporate: Value: true Internal: Value: true Private: Value: true OnlineTravelAgency: Value: true GlobalDistributionSystem: Value: true Marketing: Value: true Inactive: Value: true Options: Invoiceable: Value: 'true' AddFeesToInvoices: Value: 'true' - Id: 71db411f-c1d6-4e1c-9cd7-44e8bf45f936 Discriminator: Customer Company: Customer: Email: Value: example@example.com TaxIdentifier: Value: CZ8810310963 BillingCode: Value: AccountingCode: Value: Notes: Value: Example notes LastName: Value: Sample FirstName: Value: Sample SecondLastName: Value: BirthPlace: Value: Sample place Telephone: Value: 111-222-333 Occupation: Value: CarRegistrationNumber: Value: LoyaltyCode: Value: NationalityCode: Value: US CompanyId: Value: 839e9d92-aa8b-48bf-8384-b0ec0081bb34 BirthDate: Value: '2000-01-01' Sex: Value: Male Title: Value: Mister PreferredLanguageCode: Value: Options: SendMarketingEmails: Value: true Invoiceable: Value: true BillAddressObjection: Value: true Classifications: PaymasterAccount: Value: true Blacklist: Value: true Media: Value: true LoyaltyProgram: Value: true PreviousComplaint: Value: true Returning: Value: true Staff: Value: true FriendOrFamily: Value: true TopManagement: Value: true Important: Value: true VeryImportant: Value: true Problematic: Value: true Cashlist: Value: true DisabledPerson: Value: true Military: Value: true Airline: Value: true HealthCompliant: Value: true InRoom: Value: true WaitingForRoom: Value: true Student: Value: true LegalEntityIdentifiers: ItDestinationCode: Value: ItFiscalCode: Value: responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountResult' example: Accounts: - Id: 3ff104e6-3ba8-4dfc-8d35-b0ec00c5fd4c Discriminator: Company Customer: Company: ChainId: 79fa3c17-bec6-454f-b3be-b0ec00818acd CreatedUtc: '2024-01-03T07:52:20Z' UpdatedUtc: '2024-01-18T10:20:31Z' UpdaterProfileId: 93f03906-ed13-4a26-b8dc-b0ec0082194f Email: example@example.com TaxIdentifier: CZ8810310963 BillingCode: AccountingCode: Notes: Example notes Name: Example company MotherCompanyId: 839e9d92-aa8b-48bf-8384-b0ec0081bb34 WebsiteUrl: https://www.example.com InvoiceDueInterval: CreditRatingBasic: CreditOk Department: Accounting DunsNumber: '987654321' ReferenceId: ExternalIdentifier: COM-123 AdditionalTaxIdentifier: XY00112233445 Contact: Sample contact ContactPerson: Sample person FiscalIdentifier: FiscalIdentifier Iata: PAO Telephone: 111-222-333 SourceId: F42098A0-8507-4963-ACC9-B0EC00821949 Classifications: Corporate: true Internal: true Private: true OnlineTravelAgency: true GlobalDistributionSystem: true Marketing: true Inactive: true Options: Invoiceable: true AddFeesToInvoices: true - Id: 71db411f-c1d6-4e1c-9cd7-44e8bf45f936 Discriminator: Customer Customer: ChainId: 79fa3c17-bec6-454f-b3be-b0ec00818acd CreatedUtc: '2024-01-03T07:52:19Z' UpdatedUtc: '2024-01-18T10:25:41Z' UpdaterProfileId: 93f03906-ed13-4a26-b8dc-b0ec0082194f Email: example@example.com TaxIdentifier: CZ8810310963 BillingCode: AccountingCode: Notes: Example notes LastName: Sample FirstName: Sample SecondLastName: BirthPlace: Sample place Telephone: 111-222-333 Occupation: CarRegistrationNumber: LoyaltyCode: NationalityCode: US CompanyId: 839e9d92-aa8b-48bf-8384-b0ec0081bb34 BirthDate: '2000-01-01T00:00:00Z' Sex: Male Title: Mister PreferredLanguageCode: Options: SendMarketingEmails: true Invoiceable: true BillAddressObjection: true Classifications: PaymasterAccount: true Blacklist: true Media: true LoyaltyProgram: true PreviousComplaint: true Returning: true Staff: true FriendOrFamily: true TopManagement: true Important: true VeryImportant: true Problematic: true Cashlist: true DisabledPerson: true Military: true Airline: true HealthCompliant: true InRoom: true WaitingForRoom: true Student: true LegalEntityIdentifiers: ItDestinationCode: ItFiscalCode: Company: '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: AccountsUpdate400Example: summary: Default accounts_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: AccountsUpdate401Example: summary: Default accounts_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: AccountsUpdate403Example: summary: Default accounts_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: AccountsUpdate408Example: summary: Default accounts_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: AccountsUpdate204Example: summary: Default accounts_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: AccountsUpdate429Example: summary: Default accounts_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: AccountsUpdate500Example: summary: Default accounts_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/accounts/addFile: post: tags: - Accounts summary: Mews Upload and Link File to Account description: "Attaches the specified file to the account. \r\n\r\nAllowed MIME types: `application/pdf`, `image/bmp`, `image/gif`, `image/jpeg`, `image/png`, `image/tiff`.\r\n\r\nNote this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/guidelines/multi-property)." operationId: accounts_addFile requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountFileParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AccountId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: document.pdf Type: application/pdf ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddAccountFileResult' example: FileId: f039f5b4-ff18-4510-9086-92b14a68ed78 '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: AccountsAddFile400Example: summary: Default accounts_addFile 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: AccountsAddFile401Example: summary: Default accounts_addFile 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: AccountsAddFile403Example: summary: Default accounts_addFile 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: AccountsAddFile408Example: summary: Default accounts_addFile 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: AccountsAddFile204Example: summary: Default accounts_addFile 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: AccountsAddFile429Example: summary: Default accounts_addFile 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: AccountsAddFile500Example: summary: Default accounts_addFile 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/accounts/merge: post: tags: - Accounts summary: Mews Merge Accounts description: Merges two or more accounts of the same account type together. The given source accounts will be merged into the given target account and the merged account will keep the target account ID. operationId: accounts_merge requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleAccountMergeParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AccountMergeParameters: - AccountType: Company SourceAccountIds: - b0c10ced-34eb-44b4-92e8-af5b008f3fb4 - 5176d000-bf17-40be-b140-9041d2b70eee TargetAccountId: 51262225-8130-4320-8210-af5b008f64e5 - AccountType: Customer SourceAccountIds: - 7799f19a-c9c9-42bf-968f-a759e3ea1ea6 - bb926ffe-5310-48bc-8202-6165fa3bdcad TargetAccountId: 49b2abd4-df58-4f1d-bead-0fa6342f8a78 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: AccountsMerge200Example: summary: Default accounts_merge 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: AccountsMerge400Example: summary: Default accounts_merge 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: AccountsMerge401Example: summary: Default accounts_merge 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: AccountsMerge403Example: summary: Default accounts_merge 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: AccountsMerge408Example: summary: Default accounts_merge 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: AccountsMerge204Example: summary: Default accounts_merge 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: AccountsMerge429Example: summary: Default accounts_merge 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: AccountsMerge500Example: summary: Default accounts_merge 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/commands/getAllByIds: post: tags: - Commands summary: Mews Get All Commands by Ids description: Returns all commands by their identifiers. operationId: commands_getAllByIds requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceCommandFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 CommandIds: - aa20961f-6d9e-4b35-ad25-071213530aec responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeviceCommandResult' example: Commands: - Id: aa20961f-6d9e-4b35-ad25-071213530aec State: Pending CreatedUtc: '2015-09-02T19:25:44Z' Creator: FirstName: Sample LastName: User ImageUrl: '...' Device: Id: 63efb573-fc58-4065-b687-9bdd51568529 Name: Test Printer Type: Printer Data: CopyCount: 1 FileType: application/pdf FileData: '...' PrinterName: Printer PrinterDriverName: '' PrinterPortName: '' '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: CommandsGetAllByIds400Example: summary: Default commands_getAllByIds 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: CommandsGetAllByIds401Example: summary: Default commands_getAllByIds 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: CommandsGetAllByIds403Example: summary: Default commands_getAllByIds 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: CommandsGetAllByIds408Example: summary: Default commands_getAllByIds 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: CommandsGetAllByIds204Example: summary: Default commands_getAllByIds 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: CommandsGetAllByIds429Example: summary: Default commands_getAllByIds 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: CommandsGetAllByIds500Example: summary: Default commands_getAllByIds 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/commands/getAllActive: post: tags: - Commands summary: Mews Get All Commands description: Returns all commands the are still active from the client application point of view. That means commands that are in either `Pending` or `Received` state. operationId: commands_getAllActive requestBody: content: application/json: schema: $ref: '#/components/schemas/GetAllActiveCommandsParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeviceCommandResult' example: Commands: - Id: aa20961f-6d9e-4b35-ad25-071213530aec State: Pending CreatedUtc: '2015-09-02T19:25:44Z' Creator: FirstName: Sample LastName: User ImageUrl: '...' Device: Id: 63efb573-fc58-4065-b687-9bdd51568529 Name: Test Printer Type: Printer Data: CopyCount: 1 FileType: application/pdf FileData: '...' PrinterName: Printer PrinterDriverName: '' PrinterPortName: '' '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: CommandsGetAllActive400Example: summary: Default commands_getAllActive 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: CommandsGetAllActive401Example: summary: Default commands_getAllActive 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: CommandsGetAllActive403Example: summary: Default commands_getAllActive 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: CommandsGetAllActive408Example: summary: Default commands_getAllActive 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: CommandsGetAllActive204Example: summary: Default commands_getAllActive 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: CommandsGetAllActive429Example: summary: Default commands_getAllActive 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: CommandsGetAllActive500Example: summary: Default commands_getAllActive 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/commands/addPrinter: post: tags: - Commands summary: Mews Add Printer Command description: Adds a new printer command representing printing of the specified document on a printer. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: commands_addPrinter requestBody: content: application/json: schema: $ref: '#/components/schemas/PrinterCommandParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 PrinterId: d117866d-78de-4459-9077-42d7ea0120e3 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 CopyCount: 1 Data: JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwogIC9QYWdlcyAyIDAgUgo+PgplbmRvYmoKCjIgMCBvYmoKPDwKICAvVHlwZSAvUGFnZXMKICAvTWVkaWFCb3ggWyAwIDAgMjAwIDIwMCBdCiAgL0NvdW50IDEKICAvS2lkcyBbIDMgMCBSIF0KPj4KZW5kb2JqCgozIDAgb2JqCjw8CiAgL1R5cGUgL1BhZ2UKICAvUGFyZW50IDIgMCBSCiAgL1Jlc291cmNlcyA8PAogICAgL0ZvbnQgPDwKICAgICAgL0YxIDQgMCBSIAogICAgPj4KICA+PgogIC9Db250ZW50cyA1IDAgUgo+PgplbmRvYmoKCjQgMCBvYmoKPDwKICAvVHlwZSAvRm9udAogIC9TdWJ0eXBlIC9UeXBlMQogIC9CYXNlRm9udCAvVGltZXMtUm9tYW4KPj4KZW5kb2JqCgo1IDAgb2JqICAlIHBhZ2UgY29udGVudAo8PAogIC9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCjcwIDUwIFRECi9GMSAxMiBUZgooSGVsbG8sIHdvcmxkISkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNzkgMDAwMDAgbiAKMDAwMDAwMDE3MyAwMDAwMCBuIAowMDAwMDAwMzAxIDAwMDAwIG4gCjAwMDAwMDAzODAgMDAwMDAgbiAKdHJhaWxlcgo8PAogIC9TaXplIDYKICAvUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKNDkyCiUlRU9G responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeviceCommandAddResult' example: CommandId: 2391a3df-1c61-4131-b6f8-c85b4234adcb '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: CommandsAddPrinter400Example: summary: Default commands_addPrinter 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: CommandsAddPrinter401Example: summary: Default commands_addPrinter 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: CommandsAddPrinter403Example: summary: Default commands_addPrinter 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: CommandsAddPrinter408Example: summary: Default commands_addPrinter 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: CommandsAddPrinter204Example: summary: Default commands_addPrinter 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: CommandsAddPrinter429Example: summary: Default commands_addPrinter 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: CommandsAddPrinter500Example: summary: Default commands_addPrinter 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/commands/addKeyCutter: post: tags: - Commands summary: Mews Add Key Cutter Command description: Adds a new key cutter command representing cutting of a key for the specified reservation. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: commands_addKeyCutter requestBody: content: application/json: schema: $ref: '#/components/schemas/KeyCutterCommandParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 KeyCutterId: 7dafffff-a727-4917-a203-bd53995f21bf ReservationId: be35b39e-ad7e-460a-8de9-4c7581e016a2 KeyCount: 1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeviceCommandAddResult' example: CommandId: 2391a3df-1c61-4131-b6f8-c85b4234adcb '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: CommandsAddKeyCutter400Example: summary: Default commands_addKeyCutter 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: CommandsAddKeyCutter401Example: summary: Default commands_addKeyCutter 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: CommandsAddKeyCutter403Example: summary: Default commands_addKeyCutter 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: CommandsAddKeyCutter408Example: summary: Default commands_addKeyCutter 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: CommandsAddKeyCutter204Example: summary: Default commands_addKeyCutter 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: CommandsAddKeyCutter429Example: summary: Default commands_addKeyCutter 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: CommandsAddKeyCutter500Example: summary: Default commands_addKeyCutter 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/commands/addPaymentTerminal: post: tags: - Commands summary: Mews Add Payment Command description: "> ### Restricted!\r\n> This operation is part of a custom workflow for Mews partners such as POS systems to access Mews Payment Terminals.\r\n> See [Mews Payment Terminals](https://mews-systems.gitbook.io/connector-api/use-cases/mews-terminals).\r\n\r\nAdds a new Mews Payment Terminal command for taking a customer payment.\r\nThe operation instructs a specified terminal device to take a payment from a specified customer for a specified amount." operationId: commands_addPaymentTerminal requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentTerminalCommandParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: 7059D2C25BF64EA681ACAB3A00B859CC-D91BFF2B1E3047A3E0DEC1D57BE1382 Client: MyPOS 1.0 Type: Payment TerminalId: be35b39e-ad7e-460a-8de9-4c7581e016a2 CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 BillId: Amount: Currency: EUR Value: 230 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeviceCommandAddResult' example: CommandId: 2391a3df-1c61-4131-b6f8-c85b4234adcb '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: CommandsAddPaymentTerminal400Example: summary: Default commands_addPaymentTerminal 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: CommandsAddPaymentTerminal401Example: summary: Default commands_addPaymentTerminal 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: CommandsAddPaymentTerminal403Example: summary: Default commands_addPaymentTerminal 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: CommandsAddPaymentTerminal408Example: summary: Default commands_addPaymentTerminal 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: CommandsAddPaymentTerminal204Example: summary: Default commands_addPaymentTerminal 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: CommandsAddPaymentTerminal429Example: summary: Default commands_addPaymentTerminal 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: CommandsAddPaymentTerminal500Example: summary: Default commands_addPaymentTerminal 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/commands/update: post: tags: - Commands summary: Mews Update Command description: Updates state of a command. operationId: commands_update requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceCommandUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 CommandId: aa20961f-6d9e-4b35-ad25-071213530aec State: Processed responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: CommandsUpdate200Example: summary: Default commands_update 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: CommandsUpdate400Example: summary: Default commands_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: CommandsUpdate401Example: summary: Default commands_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: CommandsUpdate403Example: summary: Default commands_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: CommandsUpdate408Example: summary: Default commands_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: CommandsUpdate204Example: summary: Default commands_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: CommandsUpdate429Example: summary: Default commands_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: CommandsUpdate500Example: summary: Default commands_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/fiscalMachineCommands/getAll: post: tags: - Commands summary: Mews Get All Fiscal Machine Commands description: Returns fiscal machine commands. The commands can be filtered either by unique command identifiers or by `Device` unique identifiers and command states. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: fiscalMachineCommands_getAll requestBody: content: application/json: schema: title: Get all commands filter parameters oneOf: - $ref: '#/components/schemas/CommandsGetAllFilterByCommandIdParameters' - $ref: '#/components/schemas/CommandsGetAllFilterByStatesParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 DeviceIds: - d117866d-78de-4459-9077-42d7ea0120e3 - 7dafffff-a727-4917-a203-bd53995f21bf States: - Processed - Processing UpdatedUtc: StartUtc: '2025-01-10T00:00:00Z' EndUtc: '2025-01-17T00:00:00Z' EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FiscalMachineCommandDataV20250623Result' example: Commands: - Id: aa20961f-6d9e-4b35-ad25-071213530aec State: Processing CreatedUtc: '2025-01-15T14:30:00Z' Creator: Discriminator: Enterprise EnterpriseProfile: ProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf FiscalMachineId: FM-001 ApiUrl: https://fiscal-machine.example.com/api FiscalMachineData: '{"printerPort": "COM1", "baudRate": 9600}' TaxIdentifier: '12345678901' Device: Id: d117866d-78de-4459-9077-42d7ea0120e3 Type: FiscalMachine Name: Fiscal Printer FP-001 Identifier: Bill: Id: ea087d64-3901-4eee-b0b7-9fce4c58a005 Name: 'Hotel Invoice #1001' EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d AccountType: Customer AssociatedAccountIds: CounterId: State: Closed Type: Invoice Number: '1001' VariableSymbol: VS001 CreatedUtc: '2025-01-15T10:00:00Z' UpdatedUtc: '2025-01-15T14:25:00Z' IssuedUtc: '2025-01-15T14:25:00Z' TaxedUtc: '2025-01-15T14:25:00Z' PaidUtc: DueUtc: '2025-01-29T23:59:59Z' LastReminderDateUtc: PurchaseOrderNumber: PO-2025-001 Notes: Hotel accommodation services Options: Owner: AssociatedAccountsData: EnterpriseData: CorrectionState: Bill CorrectionType: CorrectedBillId: CommandData: Discriminator: ItalianFiscalMachineData ItalianFiscalMachineData: IsRefund: false RebatedReceiptNumber: RebatedReceiptSequence: RebatedReceiptDateTimeUtc: PrinterSerialNumber: FP001-123456 ItalianFiscalMachinePayload: - Id: f2e8c456-1234-4567-89ab-cdef01234567 State: Processed CreatedUtc: '2025-01-15T13:15:00Z' Creator: Discriminator: Enterprise EnterpriseProfile: ProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf FiscalMachineId: FM-002 ApiUrl: https://fiscal-machine-2.example.com/api FiscalMachineData: '{"printerPort": "USB001", "certificatePath": "/etc/fiscal/cert.p12"}' TaxIdentifier: '98765432109' Device: Id: 7dafffff-a727-4917-a203-bd53995f21bf Type: FiscalMachine Name: Fiscal Printer FP-002 Identifier: Bill: Id: 12345678-1234-1234-1234-123456789012 Name: 'Restaurant Bill #2001' EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d AccountType: Customer AssociatedAccountIds: CounterId: State: Closed Type: Receipt Number: '2001' VariableSymbol: VS002 CreatedUtc: '2025-01-15T12:30:00Z' UpdatedUtc: '2025-01-15T13:10:00Z' IssuedUtc: '2025-01-15T13:10:00Z' TaxedUtc: '2025-01-15T13:10:00Z' PaidUtc: '2025-01-15T13:10:00Z' DueUtc: LastReminderDateUtc: PurchaseOrderNumber: Notes: Restaurant services - Table 15 Options: Owner: AssociatedAccountsData: EnterpriseData: CorrectionState: Bill CorrectionType: CorrectedBillId: CommandData: Discriminator: ItalianFiscalMachinePayload ItalianFiscalMachineData: ItalianFiscalMachinePayload: Payload: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPGZ2cF9kb2M+CiAgPGhlYWRlcj4KICAgIDx0aW1lc3RhbXA+MjAyNS0wMS0xNVQxMzoxMDowMFo8L3RpbWVzdGFtcD4KICA8L2hlYWRlcj4KICA8Ym9keT4KICAgIDxyZWNlaXB0X2RhdGE+U2FtcGxlIGZpc2NhbCByZWNlaXB0IGRhdGE8L3JlY2VpcHRfZGF0YT4KICA8L2JvZHk+CjwvZnZwX2RvYz4= Cursor: f2e8c456-1234-4567-89ab-cdef01234567 '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: FiscalMachineCommandsGetAll400Example: summary: Default fiscalMachineCommands_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: FiscalMachineCommandsGetAll401Example: summary: Default fiscalMachineCommands_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: FiscalMachineCommandsGetAll403Example: summary: Default fiscalMachineCommands_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: FiscalMachineCommandsGetAll408Example: summary: Default fiscalMachineCommands_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: FiscalMachineCommandsGetAll204Example: summary: Default fiscalMachineCommands_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: FiscalMachineCommandsGetAll429Example: summary: Default fiscalMachineCommands_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: FiscalMachineCommandsGetAll500Example: summary: Default fiscalMachineCommands_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/devices/getAll: post: tags: - Devices summary: Mews Get All Devices description: Returns all devices in the enterprise. operationId: devices_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/Parameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeviceResult' example: Devices: - Id: d14efcfd-75b9-4bd3-9f10-5657a01f860a Name: Key cutter 1 Type: KeyCutter '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: DevicesGetAll400Example: summary: Default devices_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: DevicesGetAll401Example: summary: Default devices_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: DevicesGetAll403Example: summary: Default devices_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: DevicesGetAll408Example: summary: Default devices_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: DevicesGetAll204Example: summary: Default devices_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: DevicesGetAll429Example: summary: Default devices_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: DevicesGetAll500Example: summary: Default devices_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/images/getUrls: post: tags: - Images summary: Mews Get Image URLs description: Returns URLs of the specified images. operationId: images_getUrls requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageUrlParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Images: - ImageId: 57a971a5-a335-48f4-8cd1-595245d1a876 Width: 200 Height: 150 ResizeMode: Fit responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageUrlResult' example: ImageUrls: - ImageId: 57a971a5-a335-48f4-8cd1-595245d1a876 Url: https://cdn.demo.mews.li/Media/Image/57a971a5-a335-48f4-8cd1-595245d1a876?Mode=Fit&Width=200&Height=150 '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: ImagesGetUrls400Example: summary: Default images_getUrls 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: ImagesGetUrls401Example: summary: Default images_getUrls 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: ImagesGetUrls403Example: summary: Default images_getUrls 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: ImagesGetUrls408Example: summary: Default images_getUrls 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: ImagesGetUrls204Example: summary: Default images_getUrls 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: ImagesGetUrls429Example: summary: Default images_getUrls 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: ImagesGetUrls500Example: summary: Default images_getUrls 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/messageThreads/getAll: post: tags: - Message threads summary: Mews Get All Message Threads description: Get all message threads that you have created, filtered by time interval and/or specific message thread IDs. 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: messageThreads_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageThreadFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc CreatedUtc: StartUtc: '2022-03-03T00:00:00Z' EndUtc: '2022-03-14T00:00:00Z' Limitation: Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MessageThreadResult' example: MessageThreads: - Id: 7f9325f6-ef44-4911-89a8-ae51010a5aa4 OriginalSender: John Doe Subject: Example subject CreatedUtc: '2022-03-07T16:09:45Z' UpdatedUtc: '2022-03-07T16:09:45Z' Cursor: 7f9325f6-ef44-4911-89a8-ae51010a5aa4 '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: MessageThreadsGetAll400Example: summary: Default messageThreads_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: MessageThreadsGetAll401Example: summary: Default messageThreads_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: MessageThreadsGetAll403Example: summary: Default messageThreads_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: MessageThreadsGetAll408Example: summary: Default messageThreads_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: MessageThreadsGetAll204Example: summary: Default messageThreads_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: MessageThreadsGetAll429Example: summary: Default messageThreads_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: MessageThreadsGetAll500Example: summary: Default messageThreads_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/messageThreads/add: post: tags: - Message threads summary: Mews Add Message Thread description: Creates a new [Message thread](https://mews-systems.gitbook.io/connector-api/operations/#message-thread) on behalf of the specified customer, i.e. the sender of the original message in the message thread. operationId: messageThreads_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageThreadAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 OriginalSender: John Doe Subject: Example subject responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MessageThreadAddResult' example: MessageThreads: - Id: 7f9325f6-ef44-4911-89a8-ae51010a5aa4 OriginalSender: John Doe Subject: Example subject CreatedUtc: '2022-03-08T12:06:50Z' UpdatedUtc: '2022-03-08T12:06:50Z' IsResolved: false '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: MessageThreadsAdd400Example: summary: Default messageThreads_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: MessageThreadsAdd401Example: summary: Default messageThreads_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: MessageThreadsAdd403Example: summary: Default messageThreads_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: MessageThreadsAdd408Example: summary: Default messageThreads_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: MessageThreadsAdd204Example: summary: Default messageThreads_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: MessageThreadsAdd429Example: summary: Default messageThreads_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: MessageThreadsAdd500Example: summary: Default messageThreads_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/messages/getAll: post: tags: - Messages summary: Mews Get All Messages description: Get all messages belonging to the specified [Message threads](https://mews-systems.gitbook.io/connector-api/operations/messagethreads/#message-thread). Messages can only be returned for message threads you have created. 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: messages_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 MessageThreadIds: - 7f9325f6-ef44-4911-89a8-ae51010a5aa4 - 8d02142f-31cf-4115-90bf-ae5200c7a1ba CreatedUtc: StartUtc: '2022-03-03T00:00:00Z' EndUtc: '2022-03-14T00:00:00Z' EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MessageResult' example: Messages: - Id: 4bfe4675-98a9-4428-9ea9-ae5300dbaa93 MessageThreadId: 7f9325f6-ef44-4911-89a8-ae51010a5aa4 Text: Text of the message Sender: Discriminator: Application Value: CreatedUtc: '2022-03-09T13:19:46Z' Cursor: 7f9325f6-ef44-4911-89a8-ae51010a5aa4 '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: MessagesGetAll400Example: summary: Default messages_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: MessagesGetAll401Example: summary: Default messages_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: MessagesGetAll403Example: summary: Default messages_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: MessagesGetAll408Example: summary: Default messages_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: MessagesGetAll204Example: summary: Default messages_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: MessagesGetAll429Example: summary: Default messages_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: MessagesGetAll500Example: summary: Default messages_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/messages/add: post: tags: - Messages summary: Mews Add Messages description: Add the specified messages to the specified [Message threads](https://mews-systems.gitbook.io/connector-api/operations/messagethreads/#message-thread). You can only add messages to message threads that you have created. operationId: messages_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleMessageAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Messages: - MessageThreadId: 7f9325f6-ef44-4911-89a8-ae51010a5aa4 Text: Text of the message Identifier: Message 1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddedMessageResult' example: Messages: - Identifier: Message 1 Message: Id: 4bfe4675-98a9-4428-9ea9-ae5300dbaa93 MessageThreadId: 7f9325f6-ef44-4911-89a8-ae51010a5aa4 Text: Text of the message Sender: Discriminator: Application Value: CreatedUtc: '2022-03-09T13:19:46Z' '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: MessagesAdd400Example: summary: Default messages_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: MessagesAdd401Example: summary: Default messages_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: MessagesAdd403Example: summary: Default messages_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: MessagesAdd408Example: summary: Default messages_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: MessagesAdd204Example: summary: Default messages_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: MessagesAdd429Example: summary: Default messages_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: MessagesAdd500Example: summary: Default messages_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/rules/getAll: post: tags: - Rules summary: Mews Get All Rules description: 'Returns all rules applied with the reservations. 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: rules_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/RuleFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 UpdatedUtc: StartUtc: '2023-10-01T00:00:00Z' EndUtc: '2023-10-31T00:00:00Z' Extent: RuleActions: true Rates: true RateGroups: true ResourceCategories: true BusinessSegments: true Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RuleResult' example: Rules: - Id: 13638b12-53f1-4b35-baab-ac1e006ed8cb ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 Conditions: RateId: Value: 8a13f4e8-0274-4bcc-b2d4-ac1c00d1cd3f ConditionType: Equals RateGroupId: BusinessSegmentId: ResourceCategoryId: ResourceCategoryType: Origin: Value: Connector ConditionType: NotEquals TravelAgencyId: MinimumTimeUnitCount: MaximumTimeUnitCount: CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' RuleActions: - Id: 307e75a6-2cc8-4226-a600-ac1e006fbdb9 RuleId: 13638b12-53f1-4b35-baab-ac1e006ed8cb Data: Discriminator: Product Value: ProductId: 122fd92d-c561-4995-8ebc-ac1c00d1eaa8 ActionType: Add Rates: - Id: 8a13f4e8-0274-4bcc-b2d4-ac1c00d1cd3f GroupId: e4a9d8d1-5793-4d35-954e-ac1c00d1eaa8 ServiceId: ea80bbca-372f-4550-8e48-ac1c00d1cd20 BaseRateId: IsActive: true IsEnabled: true IsPublic: true Name: Fully Flexible ShortName: FF ExternalNames: {} RateGroups: [] ResourceCategories: [] BusinessSegments: [] Cursor: 13638b12-53f1-4b35-baab-ac1e006ed8cb '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: RulesGetAll400Example: summary: Default rules_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: RulesGetAll401Example: summary: Default rules_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: RulesGetAll403Example: summary: Default rules_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: RulesGetAll408Example: summary: Default rules_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: RulesGetAll204Example: summary: Default rules_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: RulesGetAll429Example: summary: Default rules_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: RulesGetAll500Example: summary: Default rules_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/tasks/getAll: post: tags: - Tasks summary: Mews Get All Tasks description: Returns all tasks of the enterprise, filtered by identifiers or other filters. operationId: tasks_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 TaskIds: - 65cf1aac-bef2-4653-9350-ab2600af65af DepartmentIds: - c28cfb42-a963-4195-ad26-ab1b009b6425 ServiceOrderIds: - 8d70f718-e19c-458d-8ddb-ab1b009b5487 CreatedUtc: StartUtc: '2019-12-08T00:00:00Z' EndUtc: '2019-12-10T00:00:00Z' ClosedUtc: StartUtc: '2019-12-08T00:00:00Z' EndUtc: '2019-12-10T00:00:00Z' DeadlineUtc: StartUtc: '2020-01-01T00:00:00Z' EndUtc: '2020-01-02T00:00:00Z' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TaskResult' example: Tasks: - Id: b166fc93-c75a-438f-93b8-ab1e00a031ae Name: Test all State: Open Description: Task description DepartmentId: c28cfb42-a963-4195-ad26-ab1b009b6425 ServiceOrderId: 8d70f718-e19c-458d-8ddb-ab1b009b5487 CreatedUtc: '2019-12-09T09:43:14Z' DeadlineUtc: '2020-01-01T14:00:00Z' ClosedUtc: '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: TasksGetAll400Example: summary: Default tasks_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: TasksGetAll401Example: summary: Default tasks_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: TasksGetAll403Example: summary: Default tasks_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: TasksGetAll408Example: summary: Default tasks_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: TasksGetAll204Example: summary: Default tasks_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: TasksGetAll429Example: summary: Default tasks_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: TasksGetAll500Example: summary: Default tasks_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/tasks/add: post: tags: - Tasks summary: Mews Add Task description: Adds a new task to the enterprise, optionally to a specified department. operationId: tasks_add requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Name: Test Description: Task description DeadlineUtc: '2016-01-01T14:00:00Z' ServiceOrderId: c73cf884-ae2b-4fba-858c-ab1400b4c8c3 DepartmentId: 8a0770a7-5178-4b87-8898-ab0400a346ec responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddTaskResult' example: TaskId: 11bcf947-d629-4781-89f9-ab1800d5aa47 '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: TasksAdd400Example: summary: Default tasks_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: TasksAdd401Example: summary: Default tasks_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: TasksAdd403Example: summary: Default tasks_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: TasksAdd408Example: summary: Default tasks_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: TasksAdd204Example: summary: Default tasks_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: TasksAdd429Example: summary: Default tasks_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: TasksAdd500Example: summary: Default tasks_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/tasks/close: post: tags: - Tasks summary: Mews Close Task description: Closes one or more tasks. Closed tasks are considered completed and not shown in active task lists. operationId: tasks_close requestBody: content: application/json: schema: $ref: '#/components/schemas/CloseTaskParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 TaskIds: - a7f6f8a1-6a2c-4c4d-8b9f-3c8a6d2f1b7e - b4c2d9fe-12a1-4c2b-9f6a-5b0c2f1d3e4a responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: TasksClose200Example: summary: Default tasks_close 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: TasksClose400Example: summary: Default tasks_close 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: TasksClose401Example: summary: Default tasks_close 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: TasksClose403Example: summary: Default tasks_close 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: TasksClose408Example: summary: Default tasks_close 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: TasksClose204Example: summary: Default tasks_close 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: TasksClose429Example: summary: Default tasks_close 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: TasksClose500Example: summary: Default tasks_close 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 components: schemas: BillAssigneeDataDiscriminator: title: Bill associated account data discriminator enum: - BillCustomerData - BillCompanyData type: string description: Determines type of value. CommandsGetAllFilterByCommandIdParameters: title: Get all commands by unique identifiers required: - CommandIds type: object allOf: - $ref: '#/components/schemas/CommandsGetAllFilterParameters' properties: CommandIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the commands to filter by. additionalProperties: false description: Filter commands by their unique identifiers. x-schema-id: CommandsGetAllFilterByCommandIdParameters CompanyAccountClassifications: title: Company classifications type: object properties: Corporate: type: boolean description: Corporate. example: true Internal: type: boolean description: Internal. example: true Private: type: boolean description: Private. example: true OnlineTravelAgency: type: boolean description: Online travel agency. example: true GlobalDistributionSystem: type: boolean description: Global distribution system. example: true Marketing: type: boolean description: Marketing. example: true Inactive: type: boolean description: Inactive. example: true GovernmentEntity: type: boolean description: Government Entity example: true additionalProperties: false x-schema-id: CompanyAccountClassifications RuleConditionType: title: Condition type enum: - Equals - NotEquals type: string description: Type of condition. PaymentItemOld: title: Payment item required: - AccountId - AccountingState - Amount - ConsumedUtc - Data - Id - OriginalAmount - State type: object properties: Id: type: string description: Unique identifier of the item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the account (for example `Customer`) the item belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillId: type: string description: Unique identifier of the `Bill` the item is assigned to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string description: Unique identifier of the `AccountingCategory` the item belongs to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Amount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Item's amount, negative amount represents either rebate or a payment. example: string OriginalAmount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain. example: string AmountDefault: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Item's amount in property's default currency, negative amount represents either rebate or a payment. nullable: true deprecated: true example: string Notes: type: string description: Additional notes. nullable: true example: string SettlementId: type: string description: Identifier of the settled payment from the external system (ApplePay/GooglePay). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ConsumedUtc: minLength: 1 type: string description: Date and time of the item consumption in UTC timezone in ISO 8601 format. example: string ClosedUtc: type: string description: Date and time of the item bill closure in UTC timezone in ISO 8601 format. nullable: true example: string AccountingState: minLength: 1 type: string description: Accounting state of the item. example: string State: minLength: 1 type: string description: Payment state of the item. example: string Identifier: type: string description: External payment identifier. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Data: title: Payment item data type: object properties: Discriminator: $ref: '#/components/schemas/PaymentType' Value: oneOf: - $ref: '#/components/schemas/PaymentCardPaymentData' - $ref: '#/components/schemas/InvoicePaymentData' description: Based on payment item data discriminator or `null` for types without any additional data. nullable: true description: Additional data specific to particular payment item. x-coproduct: true x-schema-id: PaymentItemOldDataCoproductOfPaymentType additionalProperties: false description: '' x-schema-id: PaymentItemOld MessageAddParameters: title: Message parameters required: - MessageThreadId - Text type: object properties: MessageThreadId: type: string description: Unique identifier of the `MessageThread` to which the message should be added. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Text: minLength: 1 type: string description: Text of the message. example: string Identifier: type: string description: Identifier of the message to be created. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: MessageAddParameters CommandsGetAllFilterByStatesParameters: title: Get all commands by device identifiers and states required: - DeviceIds - States type: object allOf: - $ref: '#/components/schemas/CommandsGetAllFilterParameters' properties: DeviceIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Device` to filter by. States: uniqueItems: true type: array items: $ref: '#/components/schemas/DeviceCommandStateEnum' description: States of the commands to filter by. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the commands were updated. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false description: Filter commands by the unique identifiers of `Device` and states, with optional filtering by update interval. x-schema-id: CommandsGetAllFilterByStatesParameters Account: title: Account required: - Discriminator - Id type: object properties: Id: type: string description: Unique identifier of the account. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Discriminator: title: Account type allOf: - $ref: '#/components/schemas/AccountTypeEnum' description: 'Type of the account. Company Customer' x-enumNames: - Company - Customer x-enumDescriptions: - '' - '' example: string Customer: title: Customer allOf: - $ref: '#/components/schemas/CustomerAccount' description: Updated customer data. nullable: true example: string Company: title: Company allOf: - $ref: '#/components/schemas/CompanyAccount' description: Updated company data. nullable: true example: string additionalProperties: false x-schema-id: Account AccountFileParameters: title: AccountFileParameters required: - AccessToken - AccountId - Client - ClientToken - Data - Name - Type 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 AccountId: type: string description: Unique identifier of the account to which the file will be uploaded to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: maxLength: 1000 minLength: 1 type: string description: Uploaded file name. example: Example Name Type: maxLength: 1000 minLength: 1 type: string description: Content type of the uploaded file following defined by its MIME type. example: string Data: minLength: 1 type: string description: Uploaded file data serialized in base64 format. example: string additionalProperties: false x-schema-id: AccountFileParameters ItalianFiscalMachinePayloadV20250623: title: Italian fiscal machine payload. required: - Payload type: object properties: Payload: minLength: 1 type: string description: Base64-encoded data of the file to be printed. example: string additionalProperties: false x-schema-id: ItalianFiscalMachinePayloadV20250623 BusinessSegment: title: Business segment required: - CreatedUtc - Id - IsActive - Name - ServiceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the business segment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the business segment is still active. example: true Name: minLength: 1 type: string description: Name of the business segment. example: Example Name CreatedUtc: minLength: 1 type: string description: Creation date and time of the business segment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the business segment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: BusinessSegment AccountCompanyUpdateParameters: title: Company update parameters type: object properties: Email: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Email address (or `null` if the email should not be updated). format: email nullable: true example: partner@example.com TaxIdentifier: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Tax identification number (or `null` if the tax identification number should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillingCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Billing code (or `null` if the billing code should not be updated). nullable: true example: string AccountingCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Accounting code (or `null` if the accounting code should not be updated). nullable: true example: string Notes: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Notes (or `null` if the notes should not be updated). nullable: true example: string Name: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Name (or `null` if the name should not be updated). nullable: true example: Example Name MotherCompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Mother company identifier (or `null` if the mother company identifier should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 WebsiteUrl: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Website url (or `null` if the website url should not be updated). format: uri nullable: true example: https://api.mews.com/api/connector/v1 InvoiceDueInterval: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Invoice due interval (or `null` if the invoice due interval should not be updated). nullable: true example: string Classifications: title: Company update classifications allOf: - $ref: '#/components/schemas/CompanyClassificationUpdateParameters' description: Classifications of the company. nullable: true example: string Options: title: Company update options allOf: - $ref: '#/components/schemas/CompanyOptionUpdateParameters' description: Options of the company. nullable: true example: string CreditRatingBasic: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' anyOf: - $ref: '#/components/schemas/CreditRatingBasic' description: Basic credit rating (or `null` if the basic credit rating should not be updated). nullable: true example: string Department: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Department (or `null` if the department should not be updated). nullable: true example: string DunsNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Duns number (or `null` if the duns number should not be updated). nullable: true example: '1001' ReferenceId: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reference identifier (or `null` if the reference identifier should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ExternalIdentifier: title: String update value maxLength: 255 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: External identifier (or `null` if the external identifier should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AdditionalTaxIdentifier: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Additional tax identifier (or `null` if the additional tax identifier should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Contact: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Contact (or `null` if the contact should not be updated). nullable: true example: string ContactPerson: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Contact person (or `null` if the contact person should not be updated). nullable: true example: string FiscalIdentifier: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Fiscal identifier (or `null` if the fiscal identifier should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Iata: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: IATA of the company (or `null` if the iata should not be updated). nullable: true example: string Telephone: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Telephone number (or `null` if the telephone number should not be updated). nullable: true example: string SourceId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Source identifier (or `null` if the source identifier should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: AccountCompanyUpdateParameters ProductOrderItemData: title: Product order item data required: - ProductId type: object properties: ProductId: type: string description: Unique identifier of the `Product`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AgeCategoryId: type: string description: Unique identifier of the `AgeCategory`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ProductOrderItemData AccountUpdateParameters: title: Account update parameters required: - Discriminator - Id type: object properties: Id: type: string description: Unique identifier of the account. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Discriminator: title: Account type discriminator allOf: - $ref: '#/components/schemas/AccountParameterDiscriminatorEnum' description: 'Type of the account. Customer Company' x-enumNames: - Customer - Company x-enumDescriptions: - '' - '' example: string Customer: title: Customer update parameters allOf: - $ref: '#/components/schemas/AccountCustomerUpdateParameters' description: Customer data to be updated. Required when `Discriminator` is `Customer`. nullable: true example: string Company: title: Company update parameters allOf: - $ref: '#/components/schemas/AccountCompanyUpdateParameters' description: Company data to be updated. Required when `Discriminator` is `Company`. nullable: true example: string additionalProperties: false x-schema-id: AccountUpdateParameters BillType: title: Bill type enum: - Receipt - Invoice type: string description: After a bill is closed, the Bill Type is set to `Receipt` or `Invoice`. `Receipt` indicates that the bill has been fully paid and the balance is zero. `Invoice` indicates that the bill has not yet been fully paid but an invoice has been issued. Prior to closing, Bill Type should not be used. x-enumDescriptions: - Default; the bill has been paid in full; only applicable after the bill is closed. - Bill has not been paid in full but an invoice has been issued to request payment. AddedMessage: title: Added message required: - Message type: object properties: Identifier: type: string description: Identifier of the created message. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Message: title: Message allOf: - $ref: '#/components/schemas/Message' description: Message that was added to the `MessageThread`. example: string additionalProperties: false x-schema-id: AddedMessage BillFiscalMachinePayloadData: title: Fiscal machine payload required: - Discriminator - Value type: object properties: Discriminator: title: Fiscal machine payload discriminator allOf: - $ref: '#/components/schemas/FiscalMachinePayloadDataDiscriminatorEnum' description: 'Discriminator of the object. ItalianFiscalMachine' x-enumNames: - ItalianFiscalMachine x-enumDescriptions: - '' example: string Value: minLength: 1 type: string description: Base64-encoded data of the file to be printed. example: string additionalProperties: false x-schema-id: BillFiscalMachinePayloadData 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 TaskAddParameters: title: TaskAddParameters required: - AccessToken - Client - ClientToken - DeadlineUtc - Name 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 DepartmentId: type: string description: Unique identifier of the [Department](https://mews-systems.gitbook.io/connector-api/operations/departments/#department) the task is addressed to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceOrderId: type: string description: Unique identifier of the service order (reservation or product service order) the task is linked with. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name (or title) of the task. example: Example Name Description: type: string description: Further decription of the task. nullable: true example: string DeadlineUtc: minLength: 1 type: string description: Deadline of the task in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: TaskAddParameters RuleActionDiscriminator: title: Rule action discriminator enum: - Product type: string x-enumDescriptions: - Data specific to a product. 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 BillCustomerData: title: Bill customer data required: - Id - LastName type: object properties: Id: minLength: 1 type: string description: ID of the `Customer` to whom the bill was assigned. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Address: allOf: - $ref: '#/components/schemas/Address' description: Address of the customer. nullable: true example: string LegalIdentifiers: type: object additionalProperties: type: string description: The set of `LegalIdentifiers` for the customer. nullable: true BillingCode: type: string description: A unique code for Mews to list on invoices it sends to the customer. nullable: true example: string LastName: minLength: 1 type: string description: Last name of the customer. example: Example Name FirstName: type: string description: First name of the customer. nullable: true example: Example Name SecondLastName: type: string description: Second last name of the customer. nullable: true example: Example Name TitlePrefix: allOf: - $ref: '#/components/schemas/Title' description: 'Title prefix of the customer. Mister (Mr.) Miss (Ms.) Misses (Mrs.)' nullable: true example: string TaxIdentifier: type: string description: Tax identifier of the customer. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: BillCustomerData Parameters: title: Parameters required: - AccessToken - 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 additionalProperties: false x-schema-id: Parameters MessageResult: title: MessageResult required: - Messages type: object properties: Messages: type: array items: $ref: '#/components/schemas/Message' description: The filtered messages. Cursor: type: string description: Unique identifier of the last and hence oldest message returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older messages. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: MessageResult 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 ImageResizeModeEnum: title: Image resize mode enum: - Cover - CoverExact - Fit - FitExact type: string description: ' Cover (Resize to fit within the specified size, so the result might be smaller than requested.) CoverExact (Resize and pad to exactly fit within the specified size.) Fit (Resize to fit within the specified size, so the result might be smaller than requested.) FitExact (Resize and pad to exactly fit within the specified size.)' x-enumNames: - Cover - CoverExact - Fit - FitExact x-enumDescriptions: - Resize to fit within the specified size, so the result might be smaller than requested. - Resize and pad to exactly fit within the specified size. - Resize to fit within the specified size, so the result might be smaller than requested. - Resize and pad to exactly fit within the specified size. CurrencyValueOld: title: Currency value (ver 2018-06-07) required: - Currency type: object properties: Currency: minLength: 1 type: string format: currency example: EUR Value: type: number format: double nullable: true example: 100.0 Net: type: number format: double nullable: true deprecated: true example: 100.0 Tax: type: number format: double nullable: true deprecated: true example: 100.0 TaxRate: type: number format: double nullable: true deprecated: true example: 100.0 additionalProperties: false description: Total price of the reservation. x-schema-id: CurrencyValueOld GuidNullableUpdateValue: title: Guid update value type: object properties: Value: type: string description: Value which is to be updated. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: GuidNullableUpdateValue 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 DeviceCommandUpdateParameters: title: DeviceCommandUpdateParameters required: - AccessToken - Client - ClientToken - CommandId - State 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 CommandId: type: string description: Identifier of the `Command` to be updated. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 State: allOf: - $ref: '#/components/schemas/DeviceCommandStateEnum' description: 'New state of the command. Pending (Created in Mews, but not yet received by the client application.) Received (Received by the client application.) Processing (Being processed by the client application.) Processed (Successfully processed command.) Cancelled (A command whose execution has been canceled before (or during) processing.) Error (A command whose execution or processing was terminated by an error.)' example: string Progress: type: number description: Progress of the command processing. Only used if the `State` is `Processing`, otherwise ignored. format: double nullable: true example: 100.0 Notes: type: string description: Notes about command execution. Only used if the `State` is `Processed`, `Cancelled` or `Error`, otherwise ignored. nullable: true example: string additionalProperties: false x-schema-id: DeviceCommandUpdateParameters KeyCutterCommandParameters: title: KeyCutterCommandParameters required: - AccessToken - Client - ClientToken - KeyCount - KeyCutterId - ReservationId 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 EnterpriseId: type: string description: Unique identifier of the enterprise. 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 KeyCutterId: type: string description: Unique identifier of the KeyCutter [Device](https://mews-systems.gitbook.io/connector-api/operations/devices/#device) where to encode the key. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ReservationId: type: string description: Unique identifier of the reservation to encode the key for. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 KeyCount: type: integer description: Count of keys to encode. format: int32 example: 1 additionalProperties: false x-schema-id: KeyCutterCommandParameters TaskResult: title: TaskResult required: - Tasks type: object properties: Tasks: type: array items: $ref: '#/components/schemas/Task' description: The filtered tasks. 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: TaskResult AccountMergeParameter: title: Account merge parameters required: - AccountType - SourceAccountIds - TargetAccountId type: object properties: SourceAccountIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the source accounts (`Customer` or `Company`). TargetAccountId: type: string description: Unique identifier of the target account (`Customer` or `Company`). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountType: title: Account merge type allOf: - $ref: '#/components/schemas/MergeAccountTypeEnum' description: 'Specifying types of the accounts provided (`Customer` or `Company`). Customer Company' x-enumNames: - Customer - Company x-enumDescriptions: - '' - '' example: string additionalProperties: false x-schema-id: AccountMergeParameter PrinterCommandParameters: title: PrinterCommandParameters required: - AccessToken - Client - ClientToken - CopyCount - Data - PrinterId 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 EnterpriseId: type: string description: Unique identifier of the enterprise. 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 PrinterId: type: string description: Unique identifier of the `Printer` `Device` where to print the document. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Data: minLength: 1 type: string description: Base64 encoded data of PDF document to print. example: string CopyCount: type: integer description: Count of copies to be printed. format: int32 example: 1 additionalProperties: false x-schema-id: PrinterCommandParameters RuleCondition: title: Rule condition required: - ConditionType - Value type: object properties: Value: minLength: 1 type: string description: Value of the condition depending on the property. E.g. `ReservationOrigin` in case of origin condition or unique identifier of a rate in case of rate condition. example: string ConditionType: $ref: '#/components/schemas/RuleConditionType' additionalProperties: false x-schema-id: RuleCondition BillOptions: title: Bill options type: object properties: DisplayCustomer: type: boolean description: Display customer information on a bill. example: true DisplayTaxation: type: boolean description: Display taxation detail on a bill. example: true TrackReceivable: type: boolean description: Tracking of payments is enabled for bill, only applicable for `BillType` of `Invoice`. example: true DisplayCid: type: boolean description: Display CID number on bill, only applicable for `BillType` of `Invoice`. example: true Rebated: type: boolean description: Whether the bill is rebated (both fully or partially). example: true additionalProperties: false description: Options of the bill. x-schema-id: BillOptions RebateOrderItemData: title: Rebate order item data required: - RebatedItemId type: object properties: RebatedItemId: type: string description: Unique identifier of `OrderItem` which has been rebated by current item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: RebateOrderItemData ResourceCategory: title: Resource category required: - Capacity - Classification - Descriptions - EnterpriseId - ExtraCapacity - Id - IsActive - Names - Ordering - ServiceId - ShortNames - Type type: object properties: Id: type: string description: Unique identifier of the category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service` of the resource category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the category is still active. example: true Type: $ref: '#/components/schemas/ResourceCategoryType' Classification: $ref: '#/components/schemas/ResourceClassification' Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings ShortNames: title: Localized text type: object additionalProperties: type: string description: All translations of the short name. x-schema-id: LocalizedStrings Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. x-schema-id: LocalizedStrings Ordering: type: integer description: Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed). format: int32 example: 1 Capacity: type: integer description: Capacity that can be served (e.g. bed count). format: int32 example: 1 ExtraCapacity: type: integer description: Extra capacity that can be served (e.g. extra bed count). format: int32 example: 1 ExternalIdentifier: maxLength: 255 type: string description: Identifier of the resource category from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string description: Unique identifier of the accounting category. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceCategory CommandsGetAllFilterParameters: title: Get all commands filter parameters 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 EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. nullable: true additionalProperties: false x-schema-id: CommandsGetAllFilterParameters RuleExtent: title: Rule extent type: object properties: RuleActions: type: boolean description: Whether the response should contain rule actions. nullable: true example: true Rates: type: boolean description: Whether the response should contain rates. nullable: true example: true RateGroups: type: boolean description: Whether the response should contain rate groups. nullable: true example: true ResourceCategories: type: boolean description: Whether the response should contain rate resource categories. nullable: true example: true BusinessSegments: type: boolean description: Whether the response should contain business segments. nullable: true example: true additionalProperties: false description: '' x-schema-id: RuleExtent CompanyAccount: title: Company required: - ChainId - Classifications - CreatedUtc - Name - Options - UpdatedUtc - UpdaterProfileId type: object properties: ChainId: type: string description: Unique identifier of the chain. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the `Company` in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the `Company` in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdaterProfileId: type: string description: Unique identifier of the user who updated the company. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Email: type: string description: Email address of the company. format: email nullable: true example: partner@example.com TaxIdentifier: type: string description: Tax identification number of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillingCode: type: string description: Billing code of the company. nullable: true example: string AccountingCode: type: string description: Accounting code of the company. nullable: true example: string Notes: type: string description: Additional notes. nullable: true example: string Name: minLength: 1 type: string description: Name of the company. example: Example Name MotherCompanyId: type: string description: Unique identifier of mother company. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 WebsiteUrl: type: string description: The website url of the company. format: uri nullable: true example: https://api.mews.com/api/connector/v1 InvoiceDueInterval: type: string description: The maximum time (in ISO 8601 duration format), when the invoice has to be be paid. nullable: true example: string CreditRatingBasic: allOf: - $ref: '#/components/schemas/CreditRatingBasicEnum' description: 'Credit rating to define credit worthiness of the company. CreditOk (Company can book services.) PaymentRequiredUpfront (Company must pay upfront.) LocalDecisionRequired (Requires local approval.)' nullable: true example: string Department: type: string description: The internal segmentation of a company, e.g. sales department. nullable: true example: string DunsNumber: type: string description: The Dun & Bradstreet unique 9-digit DUNS number. nullable: true example: '1001' ReferenceId: type: string description: External system identifier - custom identifier used by an external system such as an external database. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ExternalIdentifier: type: string description: Identifier of company from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AdditionalTaxIdentifier: type: string description: Additional tax identifier of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Contact: type: string description: Other contact details, such as telephone, email or similar. nullable: true example: string ContactPerson: type: string description: Contact person of the company. nullable: true example: string FiscalIdentifier: type: string description: Fiscal identifier of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Iata: type: string description: Iata of the company. nullable: true example: string Telephone: type: string description: Contact telephone number. nullable: true example: string SourceId: type: string description: Unique identifier of the `Source`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Classifications: title: Company classifications allOf: - $ref: '#/components/schemas/CompanyAccountClassifications' description: Classifications of the company. example: string Options: title: Company options allOf: - $ref: '#/components/schemas/CompanyAccountOptions' description: Options of the company. example: string additionalProperties: false description: '' x-schema-id: CompanyAccount MergeAccountTypeEnum: title: Account merge type enum: - Customer - Company type: string description: ' Customer Company' x-enumNames: - Customer - Company x-enumDescriptions: - '' - '' FiscalMachineCommandDataV20250623: title: Fiscal machine command data (ver. 2025-06-23) required: - ApiUrl - Bill - CreatedUtc - Device - FiscalMachineData - FiscalMachineId - Id - State type: object properties: Id: type: string description: Unique identifier of the command. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 State: title: Command state allOf: - $ref: '#/components/schemas/DeviceCommandStateEnum' description: 'State of the command. Pending (Created in Mews, but not yet received by the client application.) Received (Received by the client application.) Processing (Being processed by the client application.) Processed (Successfully processed command.) Cancelled (A command whose execution has been canceled before (or during) processing.) Error (A command whose execution or processing was terminated by an error.)' x-enumNames: - Pending - Received - Processing - Processed - Cancelled - Error x-enumDescriptions: - Created in Mews, but not yet received by the client application. - Received by the client application. - Being processed by the client application. - Successfully processed command. - A command whose execution has been canceled before (or during) processing. - A command whose execution or processing was terminated by an error. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the command. format: date-time example: '2026-06-02T14:30:00Z' Creator: title: Profile data allOf: - $ref: '#/components/schemas/ProfileData' description: Creator of the command. nullable: true example: string FiscalMachineId: minLength: 1 type: string description: Identifier of the fiscal machine. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ApiUrl: minLength: 1 type: string description: URL of the fiscal machine API. example: https://api.mews.com/api/connector/v1 FiscalMachineData: minLength: 1 type: string description: Custom JSON data. example: string TaxIdentifier: type: string description: Tax identifier to be used for fiscalization. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Device: allOf: - $ref: '#/components/schemas/Device' description: Device that the command should be executed on. example: string Bill: title: Bill (ver 2025-06-23) allOf: - $ref: '#/components/schemas/BillV20250623' description: The issued bill that should be fiscalized. example: string CommandData: allOf: - $ref: '#/components/schemas/FiscalMachineAdditionalData' description: Additional data of the fiscal machine. nullable: true example: string additionalProperties: false x-schema-id: FiscalMachineCommandDataV20250623 Amount: title: Amount required: - Breakdown - Currency - GrossValue - NetValue - TaxValues type: object properties: Currency: minLength: 1 type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). format: currency example: EUR NetValue: type: number description: Net value without taxes. format: double example: 100.0 GrossValue: type: number description: Gross value including all taxes. format: double example: 100.0 TaxValues: type: array items: $ref: '#/components/schemas/TaxValue' description: The tax values applied. Breakdown: title: Tax breakdown allOf: - $ref: '#/components/schemas/TaxBreakdown' description: Information about individual tax amounts. example: string additionalProperties: false description: '' x-schema-id: Amount Title: title: Title enum: - Mister - Miss - Misses type: string description: "Type of the title prefix of the customer.\r\n\r\nNote that the value should not be used as-is, but localized. For example, the value `Misses` should be displayed as `Mrs.` in English and `Fr.` in German.\n\nMister (Mr.)\n\nMiss (Ms.)\n\nMisses (Mrs.)" x-enumNames: - Mister - Miss - Misses x-enumDescriptions: - Mr. - Ms. - Mrs. x-schema-id: Title x-showDescription: true Address: title: Address type: object properties: Line1: type: string nullable: true example: string Line2: type: string nullable: true example: string City: type: string nullable: true example: string PostalCode: type: string nullable: true example: string SubdivisionCode: type: string nullable: true example: string CountryCode: type: string nullable: true example: string additionalProperties: false x-schema-id: Address 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 Message: title: Message required: - CreatedUtc - Id - MessageThreadId - Sender - Text type: object properties: Id: type: string description: Unique identifier of the message. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 MessageThreadId: type: string description: Unique identifier of the `MessageThread` to which the message belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Text: minLength: 1 type: string description: Text of the message. example: string Sender: title: Sender allOf: - $ref: '#/components/schemas/SenderCoproduct' description: The sender of the message. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the message in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: Message RuleConditions: title: Rule conditions type: object properties: RateId: title: Rule condition allOf: - $ref: '#/components/schemas/RuleCondition' description: Condition based on `Rate`. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateGroupId: title: Rule condition allOf: - $ref: '#/components/schemas/RuleCondition' description: Condition based on `RateGroup`. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BusinessSegmentId: title: Rule condition allOf: - $ref: '#/components/schemas/RuleCondition' description: Condition based on `BusinessSegment`. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryId: title: Rule condition allOf: - $ref: '#/components/schemas/RuleCondition' description: Condition based on `ResourceCategory`. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryType: title: Rule condition allOf: - $ref: '#/components/schemas/RuleCondition' description: Condition based on `ResourceCategoryType`. nullable: true example: string Origin: title: Rule condition allOf: - $ref: '#/components/schemas/RuleCondition' description: Condition based on `ReservationOrigin`. nullable: true example: string TravelAgencyId: title: Rule condition allOf: - $ref: '#/components/schemas/RuleCondition' description: Condition based on `Company`. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 MinimumTimeUnitCount: type: integer description: Condition based on minimum amount of time units. format: int32 nullable: true example: 1 MaximumTimeUnitCount: type: integer description: Condition based on maximum amount of time units. format: int32 nullable: true example: 1 additionalProperties: false description: '' x-schema-id: RuleConditions Task: title: Task required: - ClosedUtc - CreatedUtc - DeadlineUtc - Name - State type: object properties: Id: type: string description: Unique identifier of the task. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name (or title) of the task. example: Example Name State: minLength: 1 type: string description: State of the task. example: string Description: type: string description: Further description of the task. nullable: true example: string DepartmentId: type: string description: Unique identifier of the Department the task is addressed to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceOrderId: type: string description: Unique identifier of the service order (reservation or product service order) the task is linked with. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the task in UTC timezone in ISO 8601 format. example: string DeadlineUtc: minLength: 1 type: string description: Deadline date and time of the task in UTC timezone in ISO 8601 format. example: string ClosedUtc: minLength: 1 type: string description: Last update date and time of the task in UTC timezone in ISO 8601 format. example: string additionalProperties: false x-schema-id: Task PassportScannerCommandData: title: Passport scanner command data type: object allOf: - $ref: '#/components/schemas/DeviceCommandData' properties: PassportScannerId: type: string description: Identifier of the passport scanner. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Unique identifier of the `Customer` who should be processed. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ReservationId: type: string description: Unique identifier of the reservation whose companions should be processed. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: PassportScannerCommandData CompanyOptionUpdateParameters: title: Company update options type: object properties: Invoiceable: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether the company is invoiceable or not (or `null` if the `Invoiceable` field should not be updated). nullable: true example: string AddFeesToInvoices: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether the company has an additional fee applied for invoicing or not (or `null` if the `AddFeesToInvoices` field should not be updated). nullable: true example: string AddTaxDeductedPaymentToInvoices: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether tax-deducted payments should be automatically added to invoices (or `null` if the `AddTaxDeductedPaymentToInvoices` field should not be updated). nullable: true example: string additionalProperties: false description: Options of the company. x-schema-id: CompanyOptionUpdateParameters CompanyClassificationUpdateParameters: title: Company update classifications type: object properties: Corporate: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Corporate (or `null` if the value should not be updated). nullable: true example: string Internal: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Internal (or `null` if the value should not be updated). nullable: true example: string Private: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Private (or `null` if the value should not be updated). nullable: true example: string OnlineTravelAgency: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Online travel agency (or `null` if the value should not be updated). nullable: true example: string GlobalDistributionSystem: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Global distribution system (or `null` if the value should not be updated). nullable: true example: string Marketing: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Marketing (or `null` if the value should not be updated). nullable: true example: string Inactive: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Inactive (or `null` if the value should not be updated). nullable: true example: string GovernmentEntity: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Government Entity (or `null` if the value should not be updated). nullable: true example: string additionalProperties: false x-schema-id: CompanyClassificationUpdateParameters LegalEntityIdentifiers: title: Customer legal identifiers type: object properties: ItDestinationCode: type: string description: Italian destination code. nullable: true example: string ItFiscalCode: type: string description: Italian fiscal code. nullable: true example: string ItLotteryCode: maxLength: 15 minLength: 2 type: string description: Italian lottery code. nullable: true example: string additionalProperties: false x-schema-id: LegalEntityIdentifiers DeviceCommandCreator: title: User required: - LastName type: object properties: FirstName: type: string description: First name of the user. nullable: true example: Example Name LastName: minLength: 1 type: string description: Last name of the user. example: Example Name ImageUrl: type: string description: URL of the profile image. format: uri nullable: true example: https://api.mews.com/api/connector/v1 additionalProperties: false x-schema-id: DeviceCommandCreator AddedMessageResult: title: AddedMessageResult required: - Messages type: object properties: Messages: type: array items: $ref: '#/components/schemas/AddedMessage' description: Collection of created messages. additionalProperties: false x-schema-id: AddedMessageResult BillV20250623: title: Bill (ver 2025-06-23) required: - AccountId - AccountType - AssociatedAccountIds - CorrectionState - CreatedUtc - EnterpriseId - Id - State - Type - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the bill. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: type: string description: Name of the bill. nullable: true example: Example Name EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the account (`Customer` or `Company`) the bill is issued to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountType: title: Account type allOf: - $ref: '#/components/schemas/AccountTypeEnum' description: 'A discriminator specifying the account type, i.e. `Customer` or `Company`. Company Customer' x-enumNames: - Company - Customer x-enumDescriptions: - '' - '' example: string AssociatedAccountIds: type: array items: type: string format: uuid description: Unique identifiers of the `Customers` or `Companies` that are associated to the bill. nullable: true CounterId: type: string description: Unique identifier of the bill `Counter`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 State: $ref: '#/components/schemas/BillState' Type: $ref: '#/components/schemas/BillType' Number: type: string description: Number of the bill. nullable: true example: '1001' VariableSymbol: type: string description: Variable symbol of the bill. nullable: true example: string CreatedUtc: minLength: 1 type: string description: Date and time of the bill creation in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Date and time when the bill was last updated, in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' IssuedUtc: type: string description: Date and time of the bill issuance in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' TaxedUtc: type: string description: Taxation date of the bill in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' PaidUtc: type: string description: Date when the bill was paid in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' DueUtc: type: string description: Bill due date and time in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' LastReminderDateUtc: type: string description: Date and time when an email reminder to pay an invoice was last sent, in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' PurchaseOrderNumber: type: string description: Unique number of the purchase order from the buyer. nullable: true example: '1001' Notes: type: string description: Additional notes. nullable: true example: string Options: title: Bill options allOf: - $ref: '#/components/schemas/BillOptions' description: Options of the bill. nullable: true example: string Owner: title: Bill owner data allOf: - $ref: '#/components/schemas/BillAccountData' description: Additional information about owner of the bill. Can be a `Customer` or `Company`. Persisted at the time of closing of the bill. nullable: true example: string AssociatedAccountsData: type: array items: $ref: '#/components/schemas/BillAccountData' description: Additional information about the associated account of the bill. Can be a `Customer` or `Company`. Persisted at the time of closing of the bill. Currently only one account can be associated with a bill, but this may be extended in future. nullable: true EnterpriseData: title: Bill enterprise data allOf: - $ref: '#/components/schemas/BillEnterpriseData' description: Additional information about the enterprise issuing the bill, including bank account details. Persisted at the time of closing of the bill. nullable: true example: string CorrectionState: title: Bill correction state allOf: - $ref: '#/components/schemas/BillCorrectionStateEnum' description: 'Whether the bill is a regular bill or a corrective bill. Bill (Regular bill.) CorrectiveBill (Corrective bill, i.e. the `CorrectionType` is either `Edit`, `Cancellation`, or `ReceivablePaymentsBalance`.)' x-enumNames: - Bill - CorrectiveBill x-enumDescriptions: - Regular bill. - Corrective bill, i.e. the `CorrectionType` is either `Edit`, `Cancellation`, or `ReceivablePaymentsBalance`. example: string CorrectionType: allOf: - $ref: '#/components/schemas/BillCorrectionTypeEnum' description: 'Type of correction. Cancellation Edit CreditNote Reinstatement ReceivablePaymentsBalance' nullable: true example: string CorrectedBillId: type: string description: The ID of the bill that the corrective bill corrects. If the corrected bill was deleted, this field is `null`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: BillV20250623 DeviceCommandAddResult: title: DeviceCommandAddResult required: - CommandId type: object properties: CommandId: type: string description: Unique identifier of the created `Command`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: DeviceCommandAddResult RateTypeEnum: title: Rate type enum: - Public - Private - AvailabilityBlock type: string description: ' Public Private AvailabilityBlock' x-enumNames: - Public - Private - AvailabilityBlock x-enumDescriptions: - '' - '' - '' PaymentType: title: Payment item data discriminator enum: - CreditCard - Invoice - Cash - Unspecified - BadDebts - WireTransfer - ExchangeRateDifference - ExchangeRoundingDifference - BankCharges - Cheque - Other type: string x-enumDescriptions: - '[Credit card payment item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#credit-card-payment-item-data)' - '[Invoice payment item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#invoice-payment-item-data)' - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. CreditRatingBasic: title: Credit rating basic enum: - CreditOk - PaymentRequiredUpfront - LocalDecisionRequired type: string x-enumDescriptions: - Company can book services. - Company must pay upfront. - Requires local approval. SenderCoproduct: title: Sender required: - Discriminator type: object properties: Discriminator: title: Sender discriminator allOf: - $ref: '#/components/schemas/SenderDiscriminatorEnum' description: 'The sender of the message. Enterprise (The message was created by an employee of the enterprise.) Application (The message was created by the third party application.)' x-enumNames: - Enterprise - Application x-enumDescriptions: - The message was created by an employee of the enterprise. - The message was created by the third party application. example: string Value: description: Additional information about the sender. Currently not used and always `null`. nullable: true example: string additionalProperties: false x-schema-id: SenderCoproduct 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 BillCorrectionStateEnum: title: Bill correction state enum: - Bill - CorrectiveBill type: string description: ' Bill (Regular bill.) CorrectiveBill (Corrective bill, i.e. the `CorrectionType` is either `Edit`, `Cancellation`, or `ReceivablePaymentsBalance`.)' x-enumNames: - Bill - CorrectiveBill x-enumDescriptions: - Regular bill. - Corrective bill, i.e. the `CorrectionType` is either `Edit`, `Cancellation`, or `ReceivablePaymentsBalance`. 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 KeyCutterCommandData: title: Key cutter command data required: - EndUtc - KeyCount - LastName - LockIds - StartUtc type: object allOf: - $ref: '#/components/schemas/DeviceCommandData' properties: KeyCutterId: type: string description: Identifier of the key cutter. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ApiUrl: type: string description: URL of the key cutter server API. nullable: true example: https://api.mews.com/api/connector/v1 KeyCutterData: type: string description: Custom JSON data. nullable: true example: string KeyCount: type: integer description: Count of keys to cut. format: int32 example: 1 LockIds: type: array items: type: string description: Identifiers of locks/rooms the key should open. StartUtc: minLength: 1 type: string description: Reservation start. format: date-time example: '2026-06-02T14:30:00Z' EndUtc: minLength: 1 type: string description: Reservation end. format: date-time example: '2026-06-02T14:30:00Z' FirstName: type: string description: First name of the reservation owner. nullable: true example: Example Name LastName: minLength: 1 type: string description: Last name of the reservation owner. example: Example Name NormalizedFirstName: type: string description: Normalized first name of the customer without special characters. nullable: true example: Example Name NormalizedLastName: type: string description: Normalized last name of the customer without special characters. nullable: true example: Example Name Telephone: type: string description: Telephone of the reservation owner. nullable: true example: string Email: type: string description: Email of the reservation owner. nullable: true example: partner@example.com ReservationId: type: string description: Unique identifier of the reservation. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ReservationNumber: type: string description: Confirmation number of the reservation in Mews. nullable: true example: '1001' additionalProperties: false x-schema-id: KeyCutterCommandData BillCorrectionTypeEnum: title: Bill correction type enum: - Cancellation - Edit - CreditNote - Reinstatement - ReceivablePaymentsBalance type: string description: ' Cancellation Edit CreditNote Reinstatement ReceivablePaymentsBalance' x-enumNames: - Cancellation - Edit - CreditNote - Reinstatement - ReceivablePaymentsBalance x-enumDescriptions: - '' - '' - '' - '' - '' MessageThreadAddResult: title: MessageThreadAddResult required: - MessageThreads type: object properties: MessageThreads: type: array items: $ref: '#/components/schemas/MessageThread' description: The created message threads. additionalProperties: false x-schema-id: MessageThreadAddResult PaymentTerminalCommandAccountData: title: Account data for payment terminal command required: - Discriminator type: object properties: Discriminator: title: Account type allOf: - $ref: '#/components/schemas/AccountTypeEnum' description: 'Type of the account. Company Customer' x-enumNames: - Company - Customer x-enumDescriptions: - '' - '' example: string Customer: title: Customer data for payment terminal command. allOf: - $ref: '#/components/schemas/PaymentTerminalCommandCustomerData' description: Customer data if the `Discriminator` is `Customer`. nullable: true example: string Company: title: Company data for payment terminal command. allOf: - $ref: '#/components/schemas/PaymentTerminalCommandCompanyData' description: Company data if the `Discriminator` is `Company`. nullable: true example: string additionalProperties: false x-schema-id: PaymentTerminalCommandAccountData ImageSizeParameters: title: Image size parameters required: - ImageId type: object properties: ImageId: type: string description: Unique identifier of the image. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Width: type: integer description: Desired width of the image. format: int32 nullable: true example: 1 Height: type: integer description: Desired height of the image. format: int32 nullable: true example: 1 ResizeMode: allOf: - $ref: '#/components/schemas/ImageResizeModeEnum' description: 'Mode how the image should be resized to the desired width and height. Cover (Resize to fit within the specified size, so the result might be smaller than requested.) CoverExact (Resize and pad to exactly fit within the specified size.) Fit (Resize to fit within the specified size, so the result might be smaller than requested.) FitExact (Resize and pad to exactly fit within the specified size.)' nullable: true example: string additionalProperties: false x-schema-id: ImageSizeParameters BillFiscalMachineDataDiscriminatorEnum: title: Fiscal machine data discriminator enum: - ItalianFiscalMachineData type: string description: ' ItalianFiscalMachineData' x-enumNames: - ItalianFiscalMachineData x-enumDescriptions: - '' SenderDiscriminatorEnum: title: Sender discriminator enum: - Enterprise - Application type: string description: ' Enterprise (The message was created by an employee of the enterprise.) Application (The message was created by the third party application.)' x-enumNames: - Enterprise - Application x-enumDescriptions: - The message was created by an employee of the enterprise. - The message was created by the third party application. FiscalMachineCommandData: title: Fiscal machine command data required: - Bill type: object allOf: - $ref: '#/components/schemas/DeviceCommandData' properties: FiscalMachineId: type: string description: Identifier of the fiscal machine. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ApiUrl: type: string description: URL of the fiscal machine API. nullable: true example: https://api.mews.com/api/connector/v1 FiscalMachineData: type: string description: Custom JSON data. nullable: true example: string Bill: title: Bill allOf: - $ref: '#/components/schemas/Bill' description: The issued bill that should be fiscalized. example: string TaxIdentifier: type: string description: Tax identifier to be used for fiscalization. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillFiscalMachineData: title: Fiscal machine data allOf: - $ref: '#/components/schemas/BillFiscalMachineData' description: Fiscal machine data; currently only `ItalianFiscalMachineData` is supported. nullable: true example: string PayloadData: title: Fiscal machine payload allOf: - $ref: '#/components/schemas/BillFiscalMachinePayloadData' description: Fiscal machine payload data; currently only `ItalianFiscalMachinePayloadData` is supported. nullable: true example: string additionalProperties: false x-schema-id: FiscalMachineCommandData MultipleAccountUpdateParameters: title: MultipleAccountUpdateParameters required: - AccessToken - AccountUpdates - 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 AccountUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/AccountUpdateParameters' description: Accounts to be updated. additionalProperties: false x-schema-id: MultipleAccountUpdateParameters DeviceCommandData: type: object additionalProperties: false 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 BillFiscalMachineData: title: Fiscal machine data required: - Discriminator - Value type: object properties: Discriminator: title: Fiscal machine data discriminator allOf: - $ref: '#/components/schemas/BillFiscalMachineDataDiscriminatorEnum' description: 'Discriminator of the object. ItalianFiscalMachineData' x-enumNames: - ItalianFiscalMachineData x-enumDescriptions: - '' example: string Value: title: Fiscal machine data for Italian fiscal machine allOf: - $ref: '#/components/schemas/ItalianFiscalMachineData' description: Structure of the object depends on `Discriminator` (currently only `ItalianFiscalMachineData` is supported). example: string additionalProperties: false x-schema-id: BillFiscalMachineData RuleAction: title: Rule action required: - Id - RuleId type: object properties: Id: type: string description: Unique identifier of the rule action. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RuleId: type: string description: Unique identifier of the rule. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Data: title: Rule action data type: object properties: Discriminator: $ref: '#/components/schemas/RuleActionDiscriminator' Value: oneOf: - $ref: '#/components/schemas/RuleActionProductData' description: Additional information about action. nullable: true x-coproduct: true x-schema-id: RuleActionDataCoproductOfRuleActionDiscriminator additionalProperties: false x-schema-id: RuleAction AccountParameterDiscriminatorEnum: title: Account type discriminator enum: - Customer - Company type: string description: ' Customer Company' x-enumNames: - Customer - Company x-enumDescriptions: - '' - '' RateForExtent: title: Rate for extent required: - GroupId - Id - IsActive - IsBaseRate - IsEnabled - IsPublic - Names - ServiceId - Type - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the rate. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 GroupId: type: string description: Unique identifier of `Rate Group` where the rate belongs. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BaseRateId: type: string description: Unique identifier of the base `Rate`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsBaseRate: type: boolean description: Whether the rate is a base rate. example: true BusinessSegmentId: type: string description: Unique identifier of the `Business Segment`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the rate is still active. example: true IsEnabled: type: boolean description: Whether the rate is currently available to customers. example: true IsPublic: type: boolean description: Whether the rate is publicly available. example: true Type: title: Rate type allOf: - $ref: '#/components/schemas/RateTypeEnum' description: 'Type of the rate. Public Private AvailabilityBlock' x-enumNames: - Public - Private - AvailabilityBlock x-enumDescriptions: - '' - '' - '' example: string Name: type: string description: Name of the rate (in the default language). nullable: true deprecated: true x-deprecatedMessage: Use `Names` instead example: Example Name Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings ShortName: type: string description: Short name of the rate (in the default language). nullable: true example: Example Name UpdatedUtc: minLength: 1 type: string description: Interval in which the rates were updated. format: date-time example: '2026-06-02T14:30:00Z' ExternalNames: title: Localized text type: object additionalProperties: type: string description: All translations of the external name of the rate. nullable: true x-schema-id: LocalizedStrings Description: title: Localized text type: object additionalProperties: type: string description: All translations of the description of the rate. nullable: true x-schema-id: LocalizedStrings ExternalIdentifier: maxLength: 255 type: string description: Identifier of the rate from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false description: '`Rate` entity, without some of the details, e.g. pricing.' x-schema-id: RateForExtent ItalianFiscalMachineDataV20250623: title: Italian fiscal machine data type: object properties: IsRefund: type: boolean description: Indicates if the transaction is a refund. example: true RebatedReceiptNumber: type: string description: Number of the rebated receipt. nullable: true example: '1001' RebatedReceiptSequence: type: string description: Sequence of the rebated receipt. nullable: true example: string RebatedReceiptDateTimeUtc: type: string description: Date and time of the rebated receipt in UTC. format: date-time nullable: true example: '2026-06-02T14:30:00Z' PrinterSerialNumber: type: string description: Serial number of the printer. nullable: true example: '1001' additionalProperties: false x-schema-id: ItalianFiscalMachineDataV20250623 ResourceCategoryType: title: Resource category type enum: - Room - Bed - Dorm - Apartment - Suite - Villa - Site - Office - MeetingRoom - ParkingSpot - Desk - TeamArea - Membership - Tent - CaravanOrRV - UnequippedCampsite - Bike - ExtraBed - Cot - Crib - ConferenceRoom - Rooftop - Garden - Restaurant - Amphitheater - PrivateSpaces type: string description: Type of the category. LegalEntityIdentifierUpdateParameters: title: Customer update legal entity identifiers type: object properties: ItDestinationCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Italian destination code (or `null` if the Italian destination code should not be updated). nullable: true example: string ItFiscalCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Italian fiscal code (or `null` if the Italian fiscal code should not be updated). nullable: true example: string ItLotteryCode: title: String update value maxLength: 15 minLength: 2 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Italian lottery code (or `null` if the Italian lottery code should not be updated). nullable: true example: string additionalProperties: false x-schema-id: LegalEntityIdentifierUpdateParameters ResourceClassification: title: Resource classification enum: - StandardSingle - StandardDouble - SuperiorTwin - SuperiorDouble - JuniorSuite - SharedOrDorm - Other - SuperiorSingle - Triple - Family - StandardTwin - Studio - SuperiorTripleRoom - OneBedroomApartment - ThreeBedroomsApartment - TwoBedroomsApartment type: string description: Classification of the resource category. 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 Bill: title: Bill required: - AccountId - AccountType - AssociatedAccountIds - CorrectionState - CreatedUtc - EnterpriseId - Id - OrderItems - PaymentItems - Payments - Revenue - State - Type - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the bill. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: type: string description: Name of the bill. nullable: true example: Example Name EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the account (`Customer` or `Company`) the bill is issued to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountType: title: Account type allOf: - $ref: '#/components/schemas/AccountTypeEnum' description: 'A discriminator specifying the [type of account](https://mews-systems.gitbook.io/connector-api/operations/accounts/#account-type), i.e. `Customer` or `Company`. Company Customer' x-enumNames: - Company - Customer x-enumDescriptions: - '' - '' example: string CustomerId: type: string description: Unique identifier of the `Customer` the bill is issued to. format: uuid nullable: true deprecated: true x-deprecatedMessage: Use `AccountId` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: type: string description: Unique identifier of the `Company` specified in `CompanyDetails` or the `Company` the bill is issued to. format: uuid nullable: true deprecated: true x-deprecatedMessage: Use `AssociatedAccountIds` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssociatedAccountIds: type: array items: type: string format: uuid description: Unique identifiers of the `Customers` or `Companies` that are associated to the bill. nullable: true CounterId: type: string description: Unique identifier of the bill `Counter`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 State: $ref: '#/components/schemas/BillState' Type: $ref: '#/components/schemas/BillType' Number: type: string description: Number of the bill. nullable: true example: '1001' VariableSymbol: type: string description: Variable symbol of the bill. nullable: true example: string CreatedUtc: minLength: 1 type: string description: Date and time of the bill creation in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' IssuedUtc: type: string description: Date and time of the bill issuance in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' TaxedUtc: type: string description: Taxation date of the bill in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' PaidUtc: type: string description: Date when the bill was paid in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' DueUtc: type: string description: Bill due date and time in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' LastReminderDateUtc: type: string description: Date and time when an email reminder to pay an invoice was last sent, in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Date and time when the bill was last updated, in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' PurchaseOrderNumber: type: string description: Unique number of the purchase order from the buyer. nullable: true example: '1001' Notes: type: string description: Additional notes. nullable: true example: string Options: title: Bill options allOf: - $ref: '#/components/schemas/BillOptions' description: Options of the bill. nullable: true example: string Revenue: type: array items: $ref: '#/components/schemas/AccountingItem' nullable: true deprecated: true x-deprecatedMessage: Use `orderItems/getAll` with `BillId` instead. Payments: type: array items: $ref: '#/components/schemas/AccountingItem' nullable: true deprecated: true x-deprecatedMessage: Use `payments/getAll` with `BillId` instead. OrderItems: type: array items: $ref: '#/components/schemas/OrderItemOld' description: The order items (consumed items such as nights or products) on the bill. nullable: true deprecated: true x-deprecatedMessage: Use `orderItems/getAll` with `BillId` instead. PaymentItems: type: array items: $ref: '#/components/schemas/PaymentItemOld' description: The payment items (such as cash, credit card payments or invoices) on the bill. nullable: true deprecated: true AssigneeData: title: Bill assignee data type: object properties: Discriminator: $ref: '#/components/schemas/BillAssigneeDataDiscriminator' Value: oneOf: - $ref: '#/components/schemas/BillCompanyData' - $ref: '#/components/schemas/BillCustomerData' nullable: true deprecated: true x-coproduct: true x-schema-id: BillAssigneeDataCoproductOfBillAssigneeDataDiscriminator x-deprecatedMessage: Use `OwnerData` instead. OwnerData: title: Bill owner data type: object properties: Discriminator: $ref: '#/components/schemas/BillAssigneeDataDiscriminator' Value: oneOf: - $ref: '#/components/schemas/BillCompanyData' - $ref: '#/components/schemas/BillCustomerData' description: Additional information about owner of the bill. Can be a `Customer` or `Company`. Persisted at the time of closing of the bill. nullable: true x-coproduct: true x-schema-id: BillOwnerDataCoproductOfBillAssigneeDataDiscriminator CompanyDetails: title: Bill company data allOf: - $ref: '#/components/schemas/BillCompanyData' description: Additional information about the company assigned to the bill. Not the same as the owner. Persisted at the time of closing of the bill. nullable: true deprecated: true x-deprecatedMessage: Use `AssociatedAccountData` instead. example: string AssociatedAccountData: type: array items: $ref: '#/components/schemas/BillAccountData' description: Additional information about the associated account of the bill. Can be a `Customer` or `Company`. Persisted at the time of closing of the bill. Currently only one account can be associated with a bill, but this may be extended in future. nullable: true EnterpriseData: title: Bill enterprise data allOf: - $ref: '#/components/schemas/BillEnterpriseData' description: Additional information about the enterprise issuing the bill, including bank account details. Persisted at the time of closing of the bill. nullable: true example: string CorrectionState: title: Bill correction state allOf: - $ref: '#/components/schemas/BillCorrectionStateEnum' description: 'Whether the bill is a regular bill or a corrective bill. Bill (Regular bill.) CorrectiveBill (Corrective bill, i.e. the `CorrectionType` is either `Edit`, `Cancellation`, or `ReceivablePaymentsBalance`.)' x-enumNames: - Bill - CorrectiveBill x-enumDescriptions: - Regular bill. - Corrective bill, i.e. the `CorrectionType` is either `Edit`, `Cancellation`, or `ReceivablePaymentsBalance`. example: string CorrectionType: allOf: - $ref: '#/components/schemas/BillCorrectionTypeEnum' description: 'Type of correction. Cancellation Edit CreditNote Reinstatement ReceivablePaymentsBalance' nullable: true example: string CorrectedBillId: type: string description: The ID of the bill that the corrective bill corrects. If the corrected bill was deleted, this field is `null`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: Bill 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 TaxBreakdownItem: title: Tax breakdown item required: - NetValue - TaxValue type: object properties: TaxRateCode: type: string description: Tax rate code for the item. `null` for untaxed amounts. nullable: true example: string NetValue: type: number description: The net value that the tax is calculated from. format: double example: 100.0 TaxValue: type: number description: The value of the tax. format: double example: 100.0 additionalProperties: false x-schema-id: TaxBreakdownItem 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 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 CustomerAccount: title: Customer required: - ChainId - Classifications - CreatedUtc - LastName - LegalEntityIdentifiers - Options - UpdatedUtc - UpdaterProfileId type: object properties: ChainId: type: string description: Unique identifier of the chain. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the customer in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the customer in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdaterProfileId: type: string description: Unique identifier of the user who updated the customer. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Email: type: string description: Email address of the customer. format: email nullable: true example: partner@example.com TaxIdentifier: type: string description: Tax identification number of the customer. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillingCode: type: string description: Billing code of the customer. nullable: true example: string AccountingCode: type: string description: Accounting code of the customer. nullable: true example: string Notes: type: string description: Internal notes about the customer. nullable: true example: string LastName: minLength: 1 type: string description: Last name of the customer. example: Example Name FirstName: type: string description: First name of the customer. nullable: true example: Example Name SecondLastName: type: string description: Second last name of the customer. nullable: true example: Example Name BirthPlace: type: string description: Place of birth. nullable: true example: string Telephone: type: string description: Telephone number of the customer (possibly mobile). nullable: true example: string Occupation: type: string description: Occupation of the customer. nullable: true example: string CarRegistrationNumber: maxLength: 255 type: string description: Registration number of the customer's car. nullable: true example: '1001' DietaryRequirements: maxLength: 255 type: string description: Dietary requirements of the customer. nullable: true example: string LoyaltyCode: type: string description: Loyalty code of the customer. nullable: true example: string NationalityCode: type: string description: ISO 3166-1 code of the `Country`. nullable: true example: string CompanyId: type: string description: Unique identifier of `Company` the customer is associated with. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BirthDate: type: string description: Date of birth in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' Sex: type: string description: Sex of the customer. nullable: true example: string Title: allOf: - $ref: '#/components/schemas/Title' description: 'Title prefix of the customer. Mister (Mr.) Miss (Ms.) Misses (Mrs.)' nullable: true example: string PreferredLanguageCode: type: string description: Language and culture code of the customer's preferred language. E.g. `en-US` or `fr-FR`. nullable: true example: string Options: title: Customer options allOf: - $ref: '#/components/schemas/CustomerAccountOptions' description: Options of the customer. example: string Classifications: title: Customer classifications allOf: - $ref: '#/components/schemas/CustomerAccountClassifications' description: Classifications of the customer. example: string LegalEntityIdentifiers: title: Customer legal identifiers allOf: - $ref: '#/components/schemas/LegalEntityIdentifiers' description: Legal entity identifiers of the customer. example: string additionalProperties: false description: Updated customer data. x-schema-id: CustomerAccount PaymentTerminalCommandCompanyData: title: Company data for payment terminal command. required: - Name type: object properties: Name: minLength: 1 type: string description: Name of the company. example: Example Name additionalProperties: false x-schema-id: PaymentTerminalCommandCompanyData 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 DeviceTypeEnum: title: Device type enum: - Printer - PaymentTerminal - KeyCutter - FiscalMachine - PassportScanner type: string description: 'Type of the device. Printer ([Printer command data](https://mews-systems.gitbook.io/connector-api/operations/commands#printer-command-data)) PaymentTerminal ([Payment terminal command data](https://mews-systems.gitbook.io/connector-api/operations/commands#payment-terminal-command-data)) KeyCutter ([Key cutter command data](https://mews-systems.gitbook.io/connector-api/operations/commands#key-cutter-command-data)) FiscalMachine ([Fiscal machine command data](https://mews-systems.gitbook.io/connector-api/operations/commands#fiscal-machine-command-data)) PassportScanner ([Passport scanner command data](https://mews-systems.gitbook.io/connector-api/operations/commands#passport-scanner-command-data))' x-enumNames: - Printer - PaymentTerminal - KeyCutter - FiscalMachine - PassportScanner x-enumDescriptions: - '[Printer command data](https://mews-systems.gitbook.io/connector-api/operations/commands#printer-command-data)' - '[Payment terminal command data](https://mews-systems.gitbook.io/connector-api/operations/commands#payment-terminal-command-data)' - '[Key cutter command data](https://mews-systems.gitbook.io/connector-api/operations/commands#key-cutter-command-data)' - '[Fiscal machine command data](https://mews-systems.gitbook.io/connector-api/operations/commands#fiscal-machine-command-data)' - '[Passport scanner command data](https://mews-systems.gitbook.io/connector-api/operations/commands#passport-scanner-command-data)' CreditRatingBasicEnum: title: Credit rating basic enum: - CreditOk - PaymentRequiredUpfront - LocalDecisionRequired type: string description: ' CreditOk (Company can book services.) PaymentRequiredUpfront (Company must pay upfront.) LocalDecisionRequired (Requires local approval.)' x-enumNames: - CreditOk - PaymentRequiredUpfront - LocalDecisionRequired x-enumDescriptions: - Company can book services. - Company must pay upfront. - Requires local approval. ItalianFiscalMachineData: title: Fiscal machine data for Italian fiscal machine type: object properties: IsRefund: type: boolean description: Indicates if the transaction is a refund. example: true RebatedReceiptNumber: type: string description: Number of the rebated receipt. nullable: true example: '1001' RebatedReceiptSequence: type: string description: Sequence of the rebated receipt. nullable: true example: string RebatedReceiptDateTimeUtc: type: string description: Date and time of the rebated receipt in UTC. format: date-time nullable: true example: '2026-06-02T14:30:00Z' PrinterSerialNumber: type: string description: Serial number of the printer. nullable: true example: '1001' additionalProperties: false x-schema-id: ItalianFiscalMachineData 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 RuleFilterParameters: title: RuleFilterParameters required: - AccessToken - Client - ClientToken - Extent - Limitation - ServiceIds 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 EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. nullable: true Ids: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Rule`. nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Service`. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which `Rule` was updated. nullable: true x-max-interval-in-months: 3 example: string Extent: title: Rule extent allOf: - $ref: '#/components/schemas/RuleExtent' description: Extent of data to be returned. example: string additionalProperties: false x-schema-id: RuleFilterParameters AddAccountFileResult: title: AddAccountFileResult required: - FileId type: object properties: FileId: type: string description: Unique identifier of the uploaded file. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: AddAccountFileResult MessageFilterParameters: title: MessageFilterParameters required: - AccessToken - Client - ClientToken - Limitation - MessageThreadIds 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 EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. nullable: true MessageThreadIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `MessageThread`s from where to return messages. CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Message` was created. nullable: true x-max-interval-in-months: 1 example: string additionalProperties: false x-schema-id: MessageFilterParameters CustomerAccountClassifications: title: Customer classifications type: object properties: PaymasterAccount: type: boolean description: Paymaster account. example: true Blacklist: type: boolean description: Synonym of Blocklist, left for backward compatibility. deprecated: true x-deprecatedMessage: Use Blocklist instead. example: true Blocklist: type: boolean description: Blocklist. example: true Media: type: boolean description: Media. example: true LoyaltyProgram: type: boolean description: Loyalty program. example: true PreviousComplaint: type: boolean description: Previous complaint. example: true Returning: type: boolean description: Returning. example: true Staff: type: boolean description: Staff. example: true FriendOrFamily: type: boolean description: Friend or family. example: true TopManagement: type: boolean description: Top management. example: true Important: type: boolean description: Important. example: true VeryImportant: type: boolean description: Very important. example: true Problematic: type: boolean description: Problematic. example: true Cashlist: type: boolean description: Cash list. example: true DisabledPerson: type: boolean description: Disabled person. example: true Military: type: boolean description: Military. example: true Airline: type: boolean description: Airline. example: true HealthCompliant: type: boolean description: Health compliant. example: true InRoom: type: boolean description: In room. example: true WaitingForRoom: type: boolean description: Waiting for room. example: true Student: type: boolean description: Student. example: true additionalProperties: false x-schema-id: CustomerAccountClassifications GetAllActiveCommandsParameters: title: GetAllActiveCommandsParameters required: - AccessToken - 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 additionalProperties: false x-schema-id: GetAllActiveCommandsParameters 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: - '' - '' 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 PaymentTerminalCommandData: title: Payment terminal command data required: - AccountData - AccountId - Amount - CustomerId - PaymentTerminalId type: object allOf: - $ref: '#/components/schemas/DeviceCommandData' properties: PaymentTerminalId: minLength: 1 type: string description: Identifier of the payment terminal. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string format: uuid deprecated: true x-deprecatedMessage: Use `AccountId` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the account. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 FullName: type: string nullable: true deprecated: true x-deprecatedMessage: Use `AccountData.Customer.FullName`, if `AccountData.Discriminator` is `Customer`. example: Example Name BillId: type: string description: Identifier of the bill. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PaymentId: type: string description: Identifier of the `Payment`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PreauthorizationId: type: string description: Identifier of the `Preauthorization`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Amount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Amount to be processed. example: string Fee: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Payment fee to be processed. nullable: true example: string PaymentTerminalData: type: string description: Custom JSON data. nullable: true example: string AccountData: title: Account data for payment terminal command allOf: - $ref: '#/components/schemas/PaymentTerminalCommandAccountData' description: Account data for the payment terminal command. example: string additionalProperties: false x-schema-id: PaymentTerminalCommandData MessageThread: title: Message thread required: - CreatedUtc - Id - OriginalSender - Subject - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the message thread. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 OriginalSender: minLength: 1 type: string description: The sender of the original message in the thread. example: string Subject: minLength: 1 type: string description: Subject of the message thread. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the message thread in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the message thread in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' IsResolved: type: boolean description: Whether the message thread is resolved. example: true additionalProperties: false x-schema-id: MessageThread FiscalMachinePayloadDataDiscriminatorEnum: title: Fiscal machine payload discriminator enum: - ItalianFiscalMachine type: string description: ' ItalianFiscalMachine' x-enumNames: - ItalianFiscalMachine x-enumDescriptions: - '' DeviceCommandResult: title: DeviceCommandResult required: - Commands type: object properties: Commands: type: array items: $ref: '#/components/schemas/DeviceCommand' description: The active commands. Cursor: type: string description: Unique identifier of the last returned command. This can be used in Limitation in a subsequent request to fetch the next batch of commands. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: DeviceCommandResult DeviceCommand: title: Command required: - CreatedUtc - Data - Device - Id - State type: object properties: Id: type: string description: Unique identifier of the command. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 State: title: Command state allOf: - $ref: '#/components/schemas/DeviceCommandStateEnum' description: 'State of the command. Pending (Created in Mews, but not yet received by the client application.) Received (Received by the client application.) Processing (Being processed by the client application.) Processed (Successfully processed command.) Cancelled (A command whose execution has been canceled before (or during) processing.) Error (A command whose execution or processing was terminated by an error.)' x-enumNames: - Pending - Received - Processing - Processed - Cancelled - Error x-enumDescriptions: - Created in Mews, but not yet received by the client application. - Received by the client application. - Being processed by the client application. - Successfully processed command. - A command whose execution has been canceled before (or during) processing. - A command whose execution or processing was terminated by an error. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the command. format: date-time example: '2026-06-02T14:30:00Z' Creator: title: User allOf: - $ref: '#/components/schemas/DeviceCommandCreator' description: Creator of the command. nullable: true example: string Device: allOf: - $ref: '#/components/schemas/Device' description: Device that the command should be executed on. example: string Data: oneOf: - $ref: '#/components/schemas/PaymentTerminalCommandData' - $ref: '#/components/schemas/PrinterCommandData' - $ref: '#/components/schemas/KeyCutterCommandData' - $ref: '#/components/schemas/FiscalMachineCommandData' - $ref: '#/components/schemas/PassportScannerCommandData' description: Structure of the object depends on [Device type](https://mews-systems.gitbook.io/connector-api/operations/devices#device-type). example: string additionalProperties: false x-schema-id: DeviceCommand MultipleMessageAddParameters: title: MultipleMessageAddParameters required: - AccessToken - Client - ClientToken - Messages 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 Messages: maxItems: 1000 type: array items: $ref: '#/components/schemas/MessageAddParameters' description: Messages to be added. additionalProperties: false x-schema-id: MultipleMessageAddParameters 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 ProfileDataDiscriminator: title: Profile data discriminator enum: - Personal - Enterprise - Platform - Static - Integration type: string ImageUrl: title: Image URL required: - ImageId - Url type: object properties: ImageId: type: string description: Unique identifier of the image. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Url: minLength: 1 type: string description: URL of the image. example: https://api.mews.com/api/connector/v1 additionalProperties: false x-schema-id: ImageUrl AccountingItem: title: Accounting item type: object properties: Id: type: string format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string format: uuid nullable: true deprecated: true x-deprecatedMessage: Use `AccountId` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 OrderId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProductId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 InvoiceId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreditCardId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: type: string nullable: true example: string SubType: type: string nullable: true example: string Name: type: string nullable: true example: Example Name Notes: type: string nullable: true example: string ConsumptionUtc: type: string nullable: true example: string ClosedUtc: type: string nullable: true example: string State: type: string nullable: true example: string SubState: type: string nullable: true example: string Amount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: '' nullable: true example: string TaxExemptionReasonCode: type: string description: Code of tax exemption reason. **Restricted!** This property is currently intended for Mews' internal usage and may be subject to change. nullable: true example: string additionalProperties: false x-schema-id: AccountingItem RuleResult: title: RuleResult required: - Rules type: object properties: Rules: type: array items: $ref: '#/components/schemas/Rule' description: Rules used with reservation creations and modifications. RuleActions: type: array items: $ref: '#/components/schemas/RuleAction' description: Rule actions applied in rules. nullable: true Rates: type: array items: $ref: '#/components/schemas/RateForExtent' description: Rates used in conditions. nullable: true RateGroups: type: array items: $ref: '#/components/schemas/RateGroupOld' description: Rate groups used in conditions. nullable: true ResourceCategories: type: array items: $ref: '#/components/schemas/ResourceCategory' description: Resource categories used in conditions. nullable: true BusinessSegments: type: array items: $ref: '#/components/schemas/BusinessSegment' description: Business segments used in conditions. nullable: true 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: RuleResult CustomerClassificationUpdateParameters: title: Customer update classifications type: object properties: PaymasterAccount: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Paymaster account (or `null` if the value should not be updated). nullable: true example: string Blacklist: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Synonym of Blocklist, left for backward compatibility (`null` if the value should not be updated). nullable: true deprecated: true x-deprecatedMessage: Use Blocklist instead. example: string Blocklist: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Blocklist (or `null` if the value should not be updated). nullable: true example: string Media: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Media (or `null` if the value should not be updated). nullable: true example: string LoyaltyProgram: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Loyalty program (or `null` if the value should not be updated). nullable: true example: string PreviousComplaint: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Previous complaint (or `null` if the value should not be updated). nullable: true example: string Returning: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Returning (or `null` if the value should not be updated). nullable: true example: string Staff: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Staff (or `null` if the value should not be updated). nullable: true example: string FriendOrFamily: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Friend or family (or `null` if the value should not be updated). nullable: true example: string TopManagement: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Top management (or `null` if the value should not be updated). nullable: true example: string Important: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Important (or `null` if the value should not be updated). nullable: true example: string VeryImportant: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Very important (or `null` if the value should not be updated). nullable: true example: string Problematic: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Problematic (or `null` if the value should not be updated). nullable: true example: string Cashlist: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Cashlist (or `null` if the value should not be updated). nullable: true example: string DisabledPerson: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Disabled person (or `null` if the value should not be updated). nullable: true example: string Military: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Military (or `null` if the value should not be updated). nullable: true example: string Airline: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Airline (or `null` if the value should not be updated). nullable: true example: string HealthCompliant: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Health compliant (or `null` if the value should not be updated). nullable: true example: string InRoom: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: In room (or `null` if the value should not be updated). nullable: true example: string WaitingForRoom: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Waiting for room (or `null` if the value should not be updated). nullable: true example: string Student: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Student (or `null` if the value should not be updated). nullable: true example: string additionalProperties: false x-schema-id: CustomerClassificationUpdateParameters CompanyAccountOptions: title: Company options type: object properties: Invoiceable: type: boolean description: Whether the company is invoiceable or not. example: true AddFeesToInvoices: type: boolean description: Whether the company has an additional fee applied for invoicing or not. example: true AddTaxDeductedPaymentToInvoices: type: boolean description: Whether tax-deducted payments should be automatically added to invoices. example: true additionalProperties: false x-schema-id: CompanyAccountOptions RateGroupOld: title: Rate group (ver 2017-04-12) type: object properties: Id: type: string description: Unique identifier of the rate group. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the Service that the rate group belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the rate group is still active. example: true Name: type: string description: Name of the rate group. nullable: true example: Example Name ExternalIdentifier: maxLength: 255 type: string description: External identifier of the rate group. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: RateGroupOld PaymentTerminalCommandParameters: title: PaymentTerminalCommandParameters required: - AccessToken - Amount - Client - ClientToken - CustomerId - TerminalId - Type 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 TerminalId: type: string description: Unique identifier of the payment terminal. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Unique identifier of the `Customer`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: allOf: - $ref: '#/components/schemas/PaymentTerminalCommandTypeEnum' description: 'The type of payment, e.g. `Preauthorization`. Payment Preauthorization' example: string Amount: title: Currency value (ver 2018-06-07) allOf: - $ref: '#/components/schemas/CurrencyValueOld' description: Amount of the payment. example: string BillId: type: string description: Unique identifier of the `Bill`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PaymentRequestId: type: string description: Unique identifier of the `PaymentRequest`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ReservationId: type: string description: Unique identifier of the `Reservation`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: PaymentTerminalCommandParameters BillEnterpriseData: title: Bill enterprise data type: object properties: AdditionalTaxIdentifier: type: string description: Enterprise additional tax identifier. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyName: type: string description: Enterprise company name. nullable: true example: Example Name BankAccount: type: string description: Enterprise bank account. nullable: true example: string BankName: type: string description: Enterprise bank name. nullable: true example: Example Name Iban: type: string description: Enterprise IBAN (International Bank Account Number). nullable: true example: string Bic: type: string description: Enterprise BIC (Bank Identifier Code). nullable: true example: string additionalProperties: false description: Additional information about the enterprise issuing the bill, including bank account details. Persisted at the time of closing of the bill. x-schema-id: BillEnterpriseData DeviceCommandFilterParameters: title: DeviceCommandFilterParameters required: - AccessToken - Client - ClientToken - CommandIds 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 CommandIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Commands](https://mews-systems.gitbook.io/connector-api/operations/#command) to be returned. Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned. nullable: true example: string additionalProperties: false x-schema-id: DeviceCommandFilterParameters TaskFilterParameters: title: TaskFilterParameters 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 EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. nullable: true CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the Task was created. nullable: true x-max-interval-in-months: 3 example: string ClosedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the Task was closed. nullable: true x-max-interval-in-months: 3 example: string DeadlineUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the Task has a deadline. nullable: true x-max-interval-in-months: 3 example: string TaskIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Tasks](https://mews-systems.gitbook.io/connector-api/operations/#task). nullable: true DepartmentIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Departments](https://mews-systems.gitbook.io/connector-api/operations/departments/#department). Not possible to be used standalone, needs to be used in combination with other filters. nullable: true ServiceOrderIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of service orders (reservations or product service orders). nullable: true additionalProperties: false x-schema-id: TaskFilterParameters InvoicePaymentData: title: Invoice payment item data required: - InvoiceId type: object properties: InvoiceId: type: string description: Unique identifier of the invoice `Bill`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: InvoicePaymentData PrinterCommandData: title: Printer command data required: - CopyCount - FileData - FileType - PrinterDriverName - PrinterName - PrinterPortName type: object allOf: - $ref: '#/components/schemas/DeviceCommandData' properties: CopyCount: type: integer description: Number of copies to be printed. format: int32 example: 1 FileType: minLength: 1 type: string description: MIME type of the file to be printed (e.g. `application/pdf`). example: string FileData: minLength: 1 type: string description: Base64-encoded data of the file to be printed. example: string PrinterName: minLength: 1 type: string description: Name of the printer. example: Example Name PrinterDriverName: minLength: 1 type: string description: Name of the printer driver. example: Example Name PrinterPortName: minLength: 1 type: string description: Name of the printer port. example: Example Name additionalProperties: false x-schema-id: PrinterCommandData OrderItemOld: title: Order item required: - AccountId - AccountingState - Amount - CreatedUtc - CreatorProfileId - Data - Id - OrderId - OriginalAmount - RevenueType - UnitAmount - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the account (for example `Customer`) the item belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 OrderId: type: string description: Unique identifier of the order (or `Reservation` which is a special type of order) the item belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillId: type: string description: Unique identifier of the `Bill` the item is assigned to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string description: Unique identifier of the `AccountingCategory` the item belongs to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UnitCount: type: integer description: Unit count of item, i.e. the number of sub-items or units, if applicable. format: int32 example: 1 UnitAmount: title: Amount allOf: - $ref: '#/components/schemas/Amount' description: Unit amount of item, i.e. the amount of each individual sub-item or unit, if applicable. example: string Amount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Amount of item; note a negative amount represents a rebate or payment. example: string OriginalAmount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain. example: string RevenueType: minLength: 1 type: string description: Revenue type of the item. example: string CreatorProfileId: type: string description: Unique identifier of the user who created the item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UpdaterProfileId: type: string description: Unique identifier of the user who updated the item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the item in UTC timezone in ISO 8601 format. format: date example: '2026-06-02' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the item in UTC timezone in ISO 8601 format. format: date example: '2026-06-02' ConsumedUtc: type: string description: Date and time of the item consumption in UTC timezone in ISO 8601 format. format: date nullable: true example: '2026-06-02' CanceledUtc: type: string description: Cancellation date and time of the item in UTC timezone in ISO 8601 format. format: date nullable: true example: '2026-06-02' ClosedUtc: type: string description: Date and time of the item bill closure in UTC timezone in ISO 8601 format. format: date nullable: true example: '2026-06-02' StartUtc: type: string description: Start date and time of the item in UTC timezone in ISO 8601 format. format: date nullable: true example: '2026-06-02' AccountingState: minLength: 1 type: string description: Accounting state of the item. example: string Data: title: Order item data type: object properties: Discriminator: $ref: '#/components/schemas/OrderItemTypeOld' Value: oneOf: - $ref: '#/components/schemas/RebateOrderItemData' - $ref: '#/components/schemas/ProductOrderItemData' description: Based on order item discriminator or `null` for types without any additional data. nullable: true description: Additional data specific to particular order item. x-coproduct: true x-schema-id: OrderItemOldDataCoproductOfOrderItemTypeOld additionalProperties: false x-schema-id: OrderItemOld DeviceCommandStateEnum: title: Command state enum: - Pending - Received - Processing - Processed - Cancelled - Error type: string description: ' Pending (Created in Mews, but not yet received by the client application.) Received (Received by the client application.) Processing (Being processed by the client application.) Processed (Successfully processed command.) Cancelled (A command whose execution has been canceled before (or during) processing.) Error (A command whose execution or processing was terminated by an error.)' x-enumNames: - Pending - Received - Processing - Processed - Cancelled - Error x-enumDescriptions: - Created in Mews, but not yet received by the client application. - Received by the client application. - Being processed by the client application. - Successfully processed command. - A command whose execution has been canceled before (or during) processing. - A command whose execution or processing was terminated by an error. MessageThreadAddParameters: title: MessageThreadAddParameters required: - AccessToken - Client - ClientToken - OriginalSender - Subject 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 OriginalSender: minLength: 1 type: string description: The sender of the original message in the thread. example: string Subject: minLength: 1 type: string description: Subject of the message thread. example: string additionalProperties: false x-schema-id: MessageThreadAddParameters Unit: type: object additionalProperties: false ImageUrlParameters: title: ImageUrlParameters required: - AccessToken - Client - ClientToken - Images 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 Images: type: array items: $ref: '#/components/schemas/ImageSizeParameters' description: Parameters of images whose URLs should be returned. additionalProperties: false x-schema-id: ImageUrlParameters 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 PaymentTerminalCommandTypeEnum: title: Payment type enum: - Payment - Preauthorization type: string description: ' Payment Preauthorization' x-enumNames: - Payment - Preauthorization x-enumDescriptions: - '' - '' FiscalMachineAdditionalData: title: FiscalMachineAdditionalData type: object properties: Discriminator: allOf: - $ref: '#/components/schemas/FiscalMachineDataDiscriminatorEnum' description: 'Type of additional data for Italian fiscal machine. ItalianFiscalMachineData ItalianFiscalMachinePayload' nullable: true example: string ItalianFiscalMachineData: title: Italian fiscal machine data allOf: - $ref: '#/components/schemas/ItalianFiscalMachineDataV20250623' description: Fiscal machine data for Italian fiscal machine. nullable: true example: string ItalianFiscalMachinePayload: title: Italian fiscal machine payload. allOf: - $ref: '#/components/schemas/ItalianFiscalMachinePayloadV20250623' description: Fiscal machine payload for Italian fiscal machine. nullable: true example: string additionalProperties: false x-schema-id: FiscalMachineAdditionalData OrderItemTypeOld: title: Order item data discriminator enum: - CancellationFee - Rebate - Deposit - ExchangeRateDifference - CustomItem - Surcharge - SurchargeDiscount - SpaceOrder - ProductOrder - Other - TaxCorrection - ResourceUpgradeFee - InvoiceFee type: string x-enumDescriptions: - No additional data. - '[Rebate order item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#rebate-order-item-data)' - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - '[Product order item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#product-order-item-data)' - No additional data. - No additional data. - No additional data. - No additional data. ImageUrlResult: title: ImageUrlResult required: - ImageUrls type: object properties: ImageUrls: type: array items: $ref: '#/components/schemas/ImageUrl' description: URLs of the images. additionalProperties: false x-schema-id: ImageUrlResult AddTaskResult: title: AddTaskResult type: object properties: TaskId: type: string description: Unique identifier of added task. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: AddTaskResult TaxValue: title: Tax value required: - Value type: object properties: Code: type: string description: Code corresponding to tax type. nullable: true example: string Value: type: number description: Amount of tax applied. format: double example: 100.0 additionalProperties: false x-schema-id: TaxValue FiscalMachineCommandDataV20250623Result: title: FiscalMachineCommandDataV20250623Result required: - Commands type: object properties: Commands: type: array items: $ref: '#/components/schemas/FiscalMachineCommandDataV20250623' description: The filtered fiscal machine commands. Cursor: type: string description: Unique identifier of the last returned command. This can be used in Limitation in a subsequent request to fetch the next batch of commands. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: FiscalMachineCommandDataV20250623Result RuleActionProductData: title: Rule action product data required: - ActionType - ProductId type: object properties: ActionType: $ref: '#/components/schemas/RuleActionType' ProductId: type: string description: Unique identifier of product. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: RuleActionProductData 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 CustomerAccountOptions: title: Customer options type: object properties: SendMarketingEmails: type: boolean description: Send marketing emails. example: true Invoiceable: type: boolean description: Invoiceable. example: true BillAddressObjection: type: boolean description: Bill address objection. example: true additionalProperties: false x-schema-id: CustomerAccountOptions RuleActionType: title: Product action type enum: - Add - Delete type: string description: Action of rule. x-enumDescriptions: - Adds specified item. - Deletes specified item. BillState: title: Bill state enum: - Open - Closed type: string description: Whether the bill is `Open` or `Closed`. Rule: title: Rule required: - Conditions - CreatedUtc - Id - ServiceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the rule. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service` the rule is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Conditions: title: Rule conditions allOf: - $ref: '#/components/schemas/RuleConditions' description: Conditions of the rule. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the rule in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the rule in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: Rule ExtendedAmount: title: Extended amount required: - Breakdown - Currency - GrossValue - NetValue - TaxValues type: object properties: Currency: minLength: 1 type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). format: currency example: EUR NetValue: type: number description: Net value without taxes. format: double example: 100.0 GrossValue: type: number description: Gross value including all taxes. format: double example: 100.0 TaxValues: type: array items: $ref: '#/components/schemas/TaxValue' description: The tax values applied. Breakdown: title: Tax breakdown allOf: - $ref: '#/components/schemas/TaxBreakdown' description: Information about individual tax amounts. example: string Value: type: number format: double nullable: true example: 100.0 Net: type: number format: double nullable: true example: 100.0 Tax: type: number format: double nullable: true example: 100.0 TaxRate: type: number format: double nullable: true example: 100.0 additionalProperties: false description: '' x-schema-id: ExtendedAmount CloseTaskParameters: title: CloseTaskParameters required: - AccessToken - Client - ClientToken - TaskIds 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 TaskIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Tasks to be closed. additionalProperties: false x-schema-id: CloseTaskParameters TaxBreakdown: title: Tax breakdown required: - Items type: object properties: Items: type: array items: $ref: '#/components/schemas/TaxBreakdownItem' description: Tax breakdown items per each tax rate applied. additionalProperties: false x-schema-id: TaxBreakdown 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 DeviceResult: title: DeviceResult required: - Devices type: object properties: Devices: type: array items: $ref: '#/components/schemas/Device' description: The devices. additionalProperties: false x-schema-id: DeviceResult BillCompanyData: title: Bill company data required: - Id - Name type: object properties: Id: type: string description: ID of the `Company`. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Address: allOf: - $ref: '#/components/schemas/Address' description: Address of the company. nullable: true example: string LegalIdentifiers: type: object additionalProperties: type: string description: The set of `LegalIdentifiers` for the company. nullable: true BillingCode: type: string description: A unique code for Mews to list on invoices it sends to the company. nullable: true example: string Name: minLength: 1 type: string description: Name of the company. example: Example Name FiscalIdentifier: type: string description: Fiscal identifier of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AdditionalTaxIdentifier: type: string description: Additional tax identifier of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 DUNS: type: string description: DUNS (Data Universal Numbering System) number of the company. nullable: true example: string Telephone: type: string description: Company telephone number. nullable: true example: string TaxIdentifier: type: string description: Tax identifier of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 InvoicingEmail: type: string description: Invoicing email of the company. nullable: true example: partner@example.com Department: type: string description: Department of the company. nullable: true example: string additionalProperties: false description: '' x-schema-id: BillCompanyData PaymentCardPaymentData: title: Credit card payment item data type: object properties: PaymentCardId: type: string description: Unique identifier of the `CreditCard`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: PaymentCardPaymentData AccountCustomerUpdateParameters: title: Customer update parameters type: object properties: Email: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Email address (or `null` if the email should not be updated). nullable: true example: partner@example.com TaxIdentifier: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Tax identification number (or `null` if the tax identification number should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillingCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Billing code (or `null` if the billing code should not be updated). nullable: true example: string AccountingCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Accounting code (or `null` if the accounting code should not be updated). nullable: true example: string Notes: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Notes (or `null` if the notes should not be updated). nullable: true example: string LastName: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Last name (or `null` if the last name should not be updated). nullable: true example: Example Name FirstName: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: First name (or `null` if the first name should not be updated). nullable: true example: Example Name SecondLastName: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Second last name (or `null` if the second last name should not be updated). nullable: true example: Example Name BirthPlace: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Birth place (or `null` if the birth place should not be updated). nullable: true example: string Telephone: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Telephone number (or `null` if the telephone should not be updated). nullable: true example: string Occupation: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Occupation (or `null` if the occupation should not be updated). nullable: true example: string CarRegistrationNumber: title: String update value maxLength: 255 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Car registration number (or `null` if the car registration number should not be updated). nullable: true example: '1001' DietaryRequirements: title: String update value maxLength: 255 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Dietary requirements (or `null` if the dietary requirements should not be updated). nullable: true example: string LoyaltyCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Loyalty code (or `null` if the loyalty code should not be updated). nullable: true example: string NationalityCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Nationality code (or `null` if the nationality code should not be updated). nullable: true example: string CompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the company (or `null` if the company should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BirthDate: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Birth date (or `null` if the birth date should not be updated). nullable: true example: string Sex: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Sex (or `null` if the sex should not be updated). nullable: true example: string Title: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Title (or `null` if the title should not be updated). nullable: true example: string PreferredLanguageCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Preferred language code (or `null` if the preferred language code should not be updated). nullable: true example: string Options: title: Customer update options allOf: - $ref: '#/components/schemas/CustomerOptionUpdateParameters' description: Options of the customer. nullable: true example: string Classifications: title: Customer update classifications allOf: - $ref: '#/components/schemas/CustomerClassificationUpdateParameters' description: Classifications of the customer. nullable: true example: string LegalEntityIdentifiers: title: Customer update legal entity identifiers allOf: - $ref: '#/components/schemas/LegalEntityIdentifierUpdateParameters' description: Legal entity identifiers of the customer. nullable: true example: string additionalProperties: false x-schema-id: AccountCustomerUpdateParameters FiscalMachineDataDiscriminatorEnum: title: Fiscal machine data discriminator enum: - ItalianFiscalMachineData - ItalianFiscalMachinePayload type: string description: ' ItalianFiscalMachineData ItalianFiscalMachinePayload' x-enumNames: - ItalianFiscalMachineData - ItalianFiscalMachinePayload x-enumDescriptions: - '' - '' CustomerOptionUpdateParameters: title: Customer update options type: object properties: SendMarketingEmails: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Send marketing email (or `null` if the value should not be updated). nullable: true example: partner@example.com Invoiceable: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Invoiceable (or `null` if the value should not be updated). nullable: true example: string BillAddressObjection: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Bill address objection (or `null` if the value should not be updated). nullable: true example: string additionalProperties: false x-schema-id: CustomerOptionUpdateParameters PaymentTerminalCommandCustomerData: title: Customer data for payment terminal command. required: - FullName type: object properties: FullName: minLength: 1 type: string description: Full name of the customer. example: Example Name additionalProperties: false x-schema-id: PaymentTerminalCommandCustomerData MessageThreadFilterParameters: title: MessageThreadFilterParameters 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 EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. nullable: true MessageThreadIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `MessageThread`. Required if no other filter is provided. nullable: true CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `MessageThread` was created. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `MessageThread` was updated. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: MessageThreadFilterParameters Device: title: Device required: - Id - Name - Type type: object properties: Id: type: string description: Unique identifier of the device. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: title: Device type allOf: - $ref: '#/components/schemas/DeviceTypeEnum' description: 'Type of the device. Printer ([Printer command data](https://mews-systems.gitbook.io/connector-api/operations/commands#printer-command-data)) PaymentTerminal ([Payment terminal command data](https://mews-systems.gitbook.io/connector-api/operations/commands#payment-terminal-command-data)) KeyCutter ([Key cutter command data](https://mews-systems.gitbook.io/connector-api/operations/commands#key-cutter-command-data)) FiscalMachine ([Fiscal machine command data](https://mews-systems.gitbook.io/connector-api/operations/commands#fiscal-machine-command-data)) PassportScanner ([Passport scanner command data](https://mews-systems.gitbook.io/connector-api/operations/commands#passport-scanner-command-data))' x-enumNames: - Printer - PaymentTerminal - KeyCutter - FiscalMachine - PassportScanner x-enumDescriptions: - '[Printer command data](https://mews-systems.gitbook.io/connector-api/operations/commands#printer-command-data)' - '[Payment terminal command data](https://mews-systems.gitbook.io/connector-api/operations/commands#payment-terminal-command-data)' - '[Key cutter command data](https://mews-systems.gitbook.io/connector-api/operations/commands#key-cutter-command-data)' - '[Fiscal machine command data](https://mews-systems.gitbook.io/connector-api/operations/commands#fiscal-machine-command-data)' - '[Passport scanner command data](https://mews-systems.gitbook.io/connector-api/operations/commands#passport-scanner-command-data)' example: string Name: minLength: 1 type: string description: Name of the device. example: Example Name Identifier: type: string description: Device identifier (for internal purposes). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: Device ActivityStates: title: Activity state enum: - Deleted - Active type: string description: Activity states used for filtering. MessageThreadResult: title: MessageThreadResult required: - MessageThreads type: object properties: MessageThreads: type: array items: $ref: '#/components/schemas/MessageThread' description: The filtered message threads. Cursor: type: string description: Unique identifier of the last and hence oldest message thread returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older message threads. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: MessageThreadResult MultipleAccountMergeParameters: title: MultipleAccountMergeParameters required: - AccessToken - AccountMergeParameters - 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 AccountMergeParameters: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/AccountMergeParameter' description: Accounts to be merged. additionalProperties: false x-schema-id: MultipleAccountMergeParameters BillAccountData: title: Associated account bill data required: - Discriminator type: object properties: Discriminator: $ref: '#/components/schemas/BillAssigneeDataDiscriminator' BillCustomerData: title: Bill customer data allOf: - $ref: '#/components/schemas/BillCustomerData' description: Associated account bill data for customer. nullable: true example: string BillCompanyData: title: Bill company data allOf: - $ref: '#/components/schemas/BillCompanyData' description: Associated account bill data for company. nullable: true readOnly: true example: string additionalProperties: false x-schema-id: BillAccountData AccountResult: title: AccountResult required: - Accounts type: object properties: Accounts: maxItems: 1000 type: array items: $ref: '#/components/schemas/Account' description: Updated accounts. additionalProperties: false x-schema-id: AccountResult 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. servers: - url: https://api.mews.com description: Production - url: https://api.mews-demo.com description: Demo / sandbox security: - MewsClientToken: [] MewsAccessToken: [] tags: - name: Account notes - name: Accounts - name: Commands - name: Devices - name: Images - name: Message threads - name: Messages - name: Rules - name: Tasks