openapi: 3.0.4 info: title: Mews Booking Engine API (Distributor) Account notes Commands API version: v1 description: The Mews Booking Engine API (historically the Distributor API, served from /api/distributor/v1) lets developers build guest-facing booking engines that create reservations directly in Mews. It exposes enterprise configuration, availability, pricing, products, vouchers, payment cards, and reservation group creation for front-end client consumption. x-generated-from: documentation x-source-url: https://api.mews.com/Swagger/distributor/swagger.json x-last-validated: '2026-06-02' servers: - url: https://api.mews.com description: Production - url: https://api.mews-demo.com description: Demo / sandbox security: - MewsClientToken: [] MewsAccessToken: [] tags: - name: Commands paths: /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: delay: 0 dispatcher: FALLBACK /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: delay: 0 dispatcher: FALLBACK /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: delay: 0 dispatcher: FALLBACK /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: delay: 0 dispatcher: FALLBACK /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: null 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: delay: 0 dispatcher: FALLBACK /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: delay: 0 dispatcher: FALLBACK /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: null 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: null CounterId: null 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: null DueUtc: '2025-01-29T23:59:59Z' LastReminderDateUtc: null PurchaseOrderNumber: PO-2025-001 Notes: Hotel accommodation services Options: null Owner: null AssociatedAccountsData: null EnterpriseData: null CorrectionState: Bill CorrectionType: null CorrectedBillId: null CommandData: Discriminator: ItalianFiscalMachineData ItalianFiscalMachineData: IsRefund: false RebatedReceiptNumber: null RebatedReceiptSequence: null RebatedReceiptDateTimeUtc: null PrinterSerialNumber: FP001-123456 ItalianFiscalMachinePayload: null - 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: null 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: null CounterId: null 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: null LastReminderDateUtc: null PurchaseOrderNumber: null Notes: Restaurant services - Table 15 Options: null Owner: null AssociatedAccountsData: null EnterpriseData: null CorrectionState: Bill CorrectionType: null CorrectedBillId: null CommandData: Discriminator: ItalianFiscalMachinePayload ItalianFiscalMachineData: null 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: delay: 0 dispatcher: FALLBACK components: schemas: 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 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. Unit: type: object additionalProperties: false 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: - '' - '' - '' - '' - '' 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 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 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 BillState: title: Bill state enum: - Open - Closed type: string description: Whether the bill is `Open` or `Closed`. 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 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 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 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 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 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)' 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 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 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. 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 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 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 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. 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 BillFiscalMachineDataDiscriminatorEnum: title: Fiscal machine data discriminator enum: - ItalianFiscalMachineData type: string description: ' ItalianFiscalMachineData' x-enumNames: - ItalianFiscalMachineData x-enumDescriptions: - '' PaymentTerminalCommandTypeEnum: title: Payment type enum: - Payment - Preauthorization type: string description: ' Payment Preauthorization' x-enumNames: - Payment - Preauthorization x-enumDescriptions: - '' - '' 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 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 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 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 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 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 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 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 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 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 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 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 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. 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 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 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 FiscalMachineDataDiscriminatorEnum: title: Fiscal machine data discriminator enum: - ItalianFiscalMachineData - ItalianFiscalMachinePayload type: string description: ' ItalianFiscalMachineData ItalianFiscalMachinePayload' x-enumNames: - ItalianFiscalMachineData - ItalianFiscalMachinePayload x-enumDescriptions: - '' - '' 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 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 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 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 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 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 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 ProfileData: title: Profile data required: - Discriminator type: object properties: Discriminator: $ref: '#/components/schemas/ProfileDataDiscriminator' EnterpriseProfile: title: Enterprise profile data allOf: - $ref: '#/components/schemas/EnterpriseProfileData' description: Enterprise profile data. nullable: true example: string additionalProperties: false description: The profile data of the user who created or last updated the record. x-schema-id: ProfileData ProfileDataDiscriminator: title: Profile data discriminator enum: - Personal - Enterprise - Platform - Static - Integration type: string FiscalMachinePayloadDataDiscriminatorEnum: title: Fiscal machine payload discriminator enum: - ItalianFiscalMachine type: string description: ' ItalianFiscalMachine' x-enumNames: - ItalianFiscalMachine x-enumDescriptions: - '' 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 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 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 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 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 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 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 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 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 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 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 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 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`. 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 DeviceCommandData: type: object additionalProperties: false 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 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 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 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 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: - '' - '' 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 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 BillAssigneeDataDiscriminator: title: Bill associated account data discriminator enum: - BillCustomerData - BillCompanyData type: string description: Determines type of value. 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.