openapi: 3.0.4 info: title: Mews Connector API — Bills and Accounting description: General-purpose API that enables partners of Mews to access data and services in Mews Operations This modular spec covers the Bills and Accounting domain (24 operations). termsOfService: https://www.mews.com/en/terms-conditions/partners contact: name: Partner success email: partnersuccess@mews.com version: v1 x-generated-from: documentation x-source-url: https://api.mews.com/Swagger/connector/swagger.json x-last-validated: '2026-06-02' paths: /api/connector/v1/accountingCategories/getAll: post: tags: - Accounting categories summary: Mews Get All Accounting Categories description: "Returns all accounting categories of the enterprise associated with the connector integration. \nNote this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property)." operationId: accountingCategories_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingCategoryFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc AccountingCategoryIds: - 0cf7aa90-736f-43e9-a7dc-787704548d86 - 0b9560fb-055d-47d3-a6d4-e579c44ca558 UpdatedUtc: StartUtc: '2023-10-01T00:00:00Z' EndUtc: '2023-10-31T00:00:00Z' ActivityStates: - Active Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountingCategoryResult' example: AccountingCategories: - Classification: Accommodation EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Code: '345' CostCenterCode: '2589' ExternalCode: '3010' Id: 0cf7aa90-736f-43e9-a7dc-787704548d86 IsActive: true LedgerAccountCode: '311100' Name: Accommodation PostingAccountCode: '602020' CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' - Classification: EnterpriseId: 4d0201db-36f5-428b-8d11-4f0a65e960cc Code: '100' CostCenterCode: '2589' ExternalCode: ABVG Id: 0b9560fb-055d-47d3-a6d4-e579c44ca558 IsActive: true LedgerAccountCode: '311100' Name: Alcoholic Beverage PostingAccountCode: '602020' CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' Cursor: 0b9560fb-055d-47d3-a6d4-e579c44ca558 '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: AccountingCategoriesGetAll400Example: summary: Default accountingCategories_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: AccountingCategoriesGetAll401Example: summary: Default accountingCategories_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: AccountingCategoriesGetAll403Example: summary: Default accountingCategories_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: AccountingCategoriesGetAll408Example: summary: Default accountingCategories_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: AccountingCategoriesGetAll204Example: summary: Default accountingCategories_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: AccountingCategoriesGetAll429Example: summary: Default accountingCategories_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: AccountingCategoriesGetAll500Example: summary: Default accountingCategories_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: &id001 delay: 0 dispatcher: FALLBACK /api/connector/v1/accountingItems/update: post: tags: - Accounting items summary: Mews Update Accounting Items description: "Updates specified accounting items. You can use this operation to assign an accounting item to a different account or bill. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).\r\n\r\n> **State Restrictions**: Only accounting items in specific states can be moved:\r\n> - **Order items**: Must be in `Open` state\r\n> - **Payments**: Must be in `Pending` state\r\n> \r\n> Attempting to move items in other states (e.g., `Closed`, `Inactive`, `Charged`, `Failed`, `Canceled`) will result in an `Invalid AccountingItemId` error." operationId: accountingItems_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleAccountingItemsUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AccountingItemUpdates: - AccountingItemId: 6c2897de-620a-4f48-af1e-ada8004202bd AccountId: Value: 182a56ee-037d-4da5-b6f8-ada8006e7d5c BillId: Value: 9e3791dc-95c7-439a-aa8a-ada8007de0ca responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountingItemUpdateResult' example: OrderItems: - Id: 6c2897de-620a-4f48-af1e-ada8004202bd AccountId: 182a56ee-037d-4da5-b6f8-ada8006e7d5c OrderId: f9090129-fb49-46d2-9dc5-ad9d015d43b9 BillId: 9e3791dc-95c7-439a-aa8a-ada8007de0ca AccountingCategoryId: d250149e-a29d-4c70-b607-a1759faf7320 Amount: Currency: GBP NetValue: 95.24 GrossValue: 100 TaxValues: - Code: UK-2020-R Value: 4.76 Breakdown: Items: - TaxRateCode: UK-2020-R NetValue: 95.24 TaxValue: 4.76 RevenueType: Additional ConsumedUtc: '2021-09-19T04:00:20Z' ClosedUtc: AccountingState: Open Data: Discriminator: CancellationFee Value: PaymentItems: [] '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: AccountingItemsUpdate400Example: summary: Default accountingItems_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: AccountingItemsUpdate401Example: summary: Default accountingItems_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: AccountingItemsUpdate403Example: summary: Default accountingItems_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: AccountingItemsUpdate408Example: summary: Default accountingItems_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: AccountingItemsUpdate204Example: summary: Default accountingItems_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: AccountingItemsUpdate429Example: summary: Default accountingItems_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: AccountingItemsUpdate500Example: summary: Default accountingItems_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/accountingItems/getAll: post: tags: - Accounting items summary: Mews Get All Accounting Items description: Use [Get all payments](https://mews-systems.gitbook.io/connector-api/operations/payments#get-all-payments) and [Get all order items](https://mews-systems.gitbook.io/connector-api/operations/orderitems#get-all-order-items) instead. operationId: accountingItems_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingItemParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ConsumedUtc: StartUtc: '2020-01-05T00:00:00Z' EndUtc: '2020-01-10T00:00:00Z' ClosedUtc: StartUtc: '2020-01-05T00:00:00Z' EndUtc: '2020-01-10T00:00:00Z' UpdatedUtc: StartUtc: '2020-01-05T00:00:00Z' EndUtc: '2020-01-10T00:00:00Z' ItemIds: - cb643cb7-8b6e-48a6-b67e-ad4c0041f550 - 44ca12b8-f009-455e-be91-ad4c013fcbc5 Extent: OrderItems: true PaymentItems: true CreditCardTransactions: false States: - Open responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountingItemResult' example: OrderItems: - Id: cb643cb7-8b6e-48a6-b67e-ad4c0041f550 AccountId: 77673c9d-0e31-4e90-9228-ad4b00a9fcdc OrderId: 1103b431-998a-4b78-84de-ad4b00a9fd99 BillId: AccountingCategoryId: d250149e-a29d-4c70-b607-a1759faf7320 UnitCount: 15 UnitAmount: Currency: EUR NetValue: 8.4 GrossValue: 10.0 TaxValues: - Code: DE-2020-1-I Value: 1.6 Breakdown: Items: - TaxRateCode: DE-2020-1-I NetValue: 8.4 TaxValue: 1.6 Amount: Value: 150.0 Net: 126.05 Tax: 23.95 TaxRate: 19.0 Currency: EUR NetValue: 126.05 GrossValue: 150.0 TaxValues: - Code: DE-2020-1-I Value: 23.95 Breakdown: Items: - TaxRateCode: DE-2020-1-I NetValue: 126.05 TaxValue: 23.95 OriginalAmount: Value: 150.0 Net: 126.05 Tax: 23.95 TaxRate: 19.0 Currency: EUR NetValue: 126.05 GrossValue: 150.0 TaxValues: - Code: DE-2020-1-I Value: 23.95 Breakdown: Items: - TaxRateCode: DE-2020-1-I NetValue: 126.05 TaxValue: 23.95 RevenueType: Additional CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae CreatedUtc: '2021-06-19T00:00:00Z' UpdatedUtc: '2021-06-19T00:00:00Z' ConsumedUtc: '2021-06-19T04:00:08Z' CanceledUtc: ClosedUtc: StartUtc: AccountingState: Open Data: Discriminator: CancellationFee Value: PaymentItems: - Id: 44ca12b8-f009-455e-be91-ad4c013fcbc5 AccountId: 5da55e5c-18e5-48d8-9a0e-ac0600704c5c BillId: AccountingCategoryId: b89345c1-2814-4750-808d-aa7900ee464a Amount: Value: 850.0 Net: 850.0 Tax: 0.0 TaxRate: 0.0 Currency: GBP NetValue: 850.0 GrossValue: 850.0 TaxValues: [] Breakdown: Items: - TaxRateCode: NetValue: 850.0 TaxValue: 0.0 OriginalAmount: Value: 850.0 Net: 850.0 Tax: 0.0 TaxRate: 0.0 Currency: GBP NetValue: 850.0 GrossValue: 850.0 TaxValues: [] Breakdown: Items: - TaxRateCode: NetValue: 850.0 TaxValue: 0.0 AmountDefault: Notes: NORMAL0140 SettlementId: po_1Lun9w4JpyDC38oQJQz7hAcx ConsumedUtc: '2021-06-19T19:24:20Z' ClosedUtc: AccountingState: Open State: Charged Identifier: Data: Discriminator: Invoice Value: InvoiceId: 3c818013-d9de-47e9-bb2c-ad4c013f9ad3 CreditCardTransactions: '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: AccountingItemsGetAll400Example: summary: Default accountingItems_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: AccountingItemsGetAll401Example: summary: Default accountingItems_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: AccountingItemsGetAll403Example: summary: Default accountingItems_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: AccountingItemsGetAll408Example: summary: Default accountingItems_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: AccountingItemsGetAll204Example: summary: Default accountingItems_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: AccountingItemsGetAll429Example: summary: Default accountingItems_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: AccountingItemsGetAll500Example: summary: Default accountingItems_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string deprecated: true x-deprecatedMessage: Use [Get all payments](https://mews-systems.gitbook.io/connector-api/operations/payments#get-all-payments) and [Get all order items](https://mews-systems.gitbook.io/connector-api/operations/orderitems#get-all-order-items) instead. x-microcks-operation: *id001 /api/connector/v1/billingAutomations/getAll: post: tags: - Billing automations summary: Mews Get All Billing Automations description: Returns all billing automations. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: billingAutomations_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAutomationFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 CompanyIds: - c6f5c82d-621a-4c8a-903b-1b0a9a23b71f - 956aa0f0-a090-42c8-bee2-991972d32f80 BillingAutomationIds: - ecd64eec-4423-4c65-b844-814b9199856d - 13e6b16e-39bc-4cb1-8610-70ecdb4f91cc EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingAutomationResult' example: BillingAutomations: - Id: ecd64eec-4423-4c65-b844-814b9199856d EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Continuous billing automation for company XYZ Description: Billing Automation for company XYZ with prepayment all, company as owner. CompaniesWithRelations: - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f CompanyRelations: PartnerCompany: true TravelAgency: false Prepayment: All AssignmentTargetType: CompanyAsOwner TriggerType: Continuous BillAggregationType: AggregateAll CreatedUtc: '2017-01-31T10:58:06Z' UpdatedUtc: '2023-10-28T14:23:00Z' CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae ProcessingStartOffset: OrderItemConsumptionPeriod: Assignments: - Id: d6b550e9-9c4b-42dd-9daa-555312b030e6 BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RoutedItemTypes: SpaceOrder: true CityTax: true AllProducts: true Deposits: true AdditionalExpenses: false AllCustomItems: false RateIds: - ab3682ba-4493-4eb0-bcdc-8d000f5bad65 ProductCategoryIds: - 599c477e-b826-4444-8ded-4fa7276ef0c1 ProductIds: - f0184ec2-9f02-4026-9b70-0b2bed2adde7 AccountingCategoryAssignments: - AccountingCategoryId: 2e0f5930-605e-4a23-9994-a7701a56b576 ItemTypes: Products: true CustomItems: false Cursor: 54ec08b6-e6fc-48e9-b8ae-02943e0ac693 '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: BillingAutomationsGetAll400Example: summary: Default billingAutomations_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: BillingAutomationsGetAll401Example: summary: Default billingAutomations_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: BillingAutomationsGetAll403Example: summary: Default billingAutomations_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: BillingAutomationsGetAll408Example: summary: Default billingAutomations_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: BillingAutomationsGetAll204Example: summary: Default billingAutomations_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: BillingAutomationsGetAll429Example: summary: Default billingAutomations_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: BillingAutomationsGetAll500Example: summary: Default billingAutomations_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/billingAutomations/add: post: tags: - Billing automations summary: Mews Add Billing Automations description: Adds billing automations. operationId: billingAutomations_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleBillingAutomationAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillingAutomations: - Name: Company A billing automation Description: Billing automation routing reservations made for Company A to bills where company is an owner, aggregating all reservations onto one bill. CompaniesWithRelations: - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f CompanyRelations: PartnerCompany: true TravelAgency: false Prepayment: All AssignmentTargetType: CompanyAsOwner TriggerType: Continuous BillAggregationType: AggregateAll Assignments: - ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RoutedItemTypes: SpaceOrder: true CityTax: true AllProducts: false Deposits: true AdditionalExpenses: true AllCustomItems: false ProductIds: - 507d93e6-9fb5-4734-a6d1-977afc4dfdff responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingAutomationModificationResult' example: BillingAutomations: - Id: ecd64eec-4423-4c65-b844-814b9199856d EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Continuous billing automation for company XYZ Description: Billing Automation for company XYZ with prepayment all, company as owner. CompaniesWithRelations: - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f CompanyRelations: PartnerCompany: true TravelAgency: false Prepayment: All AssignmentTargetType: CompanyAsOwner TriggerType: Continuous BillAggregationType: AggregateAll CreatedUtc: '2017-01-31T10:58:06Z' UpdatedUtc: '2023-10-28T14:23:00Z' CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae ProcessingStartOffset: OrderItemConsumptionPeriod: Assignments: - Id: d6b550e9-9c4b-42dd-9daa-555312b030e6 BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RoutedItemTypes: SpaceOrder: true CityTax: true AllProducts: true Deposits: true AdditionalExpenses: false AllCustomItems: false RateIds: - ab3682ba-4493-4eb0-bcdc-8d000f5bad65 ProductCategoryIds: - 599c477e-b826-4444-8ded-4fa7276ef0c1 ProductIds: - f0184ec2-9f02-4026-9b70-0b2bed2adde7 AccountingCategoryAssignments: - AccountingCategoryId: 2e0f5930-605e-4a23-9994-a7701a56b576 ItemTypes: Products: true CustomItems: false '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsAdd400Example: summary: Default billingAutomations_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsAdd401Example: summary: Default billingAutomations_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsAdd403Example: summary: Default billingAutomations_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsAdd408Example: summary: Default billingAutomations_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsAdd204Example: summary: Default billingAutomations_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsAdd429Example: summary: Default billingAutomations_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsAdd500Example: summary: Default billingAutomations_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/billingAutomations/update: post: tags: - Billing automations summary: Mews Update Billing Automations description: Updates one or more existing billing automations. operationId: billingAutomations_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleBillingAutomationUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillingAutomationUpdates: - BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d Name: Value: New name. Description: Value: Billing Automation that has prepayment changed to All, Assignment target to Company as owner and Bill aggregation to aggregate all items into one bill. Prepayment: Value: All AssignmentTargetType: Value: CompanyAsOwner BillAggregationType: Value: AggregateAll responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingAutomationModificationResult' example: BillingAutomations: - Id: ecd64eec-4423-4c65-b844-814b9199856d EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Continuous billing automation for company XYZ Description: Billing Automation for company XYZ with prepayment all, company as owner. CompaniesWithRelations: - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f CompanyRelations: PartnerCompany: true TravelAgency: false Prepayment: All AssignmentTargetType: CompanyAsOwner TriggerType: Continuous BillAggregationType: AggregateAll CreatedUtc: '2017-01-31T10:58:06Z' UpdatedUtc: '2023-10-28T14:23:00Z' CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae ProcessingStartOffset: OrderItemConsumptionPeriod: Assignments: - Id: d6b550e9-9c4b-42dd-9daa-555312b030e6 BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RoutedItemTypes: SpaceOrder: true CityTax: true AllProducts: true Deposits: true AdditionalExpenses: false AllCustomItems: false RateIds: - ab3682ba-4493-4eb0-bcdc-8d000f5bad65 ProductCategoryIds: - 599c477e-b826-4444-8ded-4fa7276ef0c1 ProductIds: - f0184ec2-9f02-4026-9b70-0b2bed2adde7 AccountingCategoryAssignments: - AccountingCategoryId: 2e0f5930-605e-4a23-9994-a7701a56b576 ItemTypes: Products: true CustomItems: false '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsUpdate400Example: summary: Default billingAutomations_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: BillingAutomationsUpdate401Example: summary: Default billingAutomations_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: BillingAutomationsUpdate403Example: summary: Default billingAutomations_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: BillingAutomationsUpdate408Example: summary: Default billingAutomations_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: BillingAutomationsUpdate204Example: summary: Default billingAutomations_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: BillingAutomationsUpdate429Example: summary: Default billingAutomations_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: BillingAutomationsUpdate500Example: summary: Default billingAutomations_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/billingAutomations/updateAssignments: post: tags: - Billing automations summary: Mews Update Billing Automations Assignments description: Add, update or remove billing automation assignments of a specific billing automation. operationId: billingAutomations_updateAssignments requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAutomationAssignmentsUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d AssignmentsToUpdate: - BillingAutomationAssignmentId: 00000000-0000-0000-0000-000000000000 RoutedItemTypes: SpaceOrder: Value: true CityTax: Value: true AllProducts: Value: false Deposits: Value: true AdditionalExpenses: Value: true AllCustomItems: Value: false ProductIds: Value: - 507d93e6-9fb5-4734-a6d1-977afc4dfdff responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingAutomationAssignmentsUpdateParameters' example: BillingAutomations: - Id: ecd64eec-4423-4c65-b844-814b9199856d EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Continuous billing automation for company XYZ Description: Billing Automation for company XYZ with prepayment all, company as owner. CompaniesWithRelations: - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f CompanyRelations: PartnerCompany: true TravelAgency: false Prepayment: All AssignmentTargetType: CompanyAsOwner TriggerType: Continuous BillAggregationType: AggregateAll CreatedUtc: '2017-01-31T10:58:06Z' UpdatedUtc: '2023-10-28T14:23:00Z' CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae ProcessingStartOffset: OrderItemConsumptionPeriod: Assignments: - Id: d6b550e9-9c4b-42dd-9daa-555312b030e6 BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RoutedItemTypes: SpaceOrder: true CityTax: true AllProducts: true Deposits: true AdditionalExpenses: false AllCustomItems: false RateIds: - ab3682ba-4493-4eb0-bcdc-8d000f5bad65 ProductCategoryIds: - 599c477e-b826-4444-8ded-4fa7276ef0c1 ProductIds: - f0184ec2-9f02-4026-9b70-0b2bed2adde7 AccountingCategoryAssignments: - AccountingCategoryId: 2e0f5930-605e-4a23-9994-a7701a56b576 ItemTypes: Products: true CustomItems: false '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsUpdateAssignments400Example: summary: Default billingAutomations_updateAssignments 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: BillingAutomationsUpdateAssignments401Example: summary: Default billingAutomations_updateAssignments 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: BillingAutomationsUpdateAssignments403Example: summary: Default billingAutomations_updateAssignments 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: BillingAutomationsUpdateAssignments408Example: summary: Default billingAutomations_updateAssignments 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: BillingAutomationsUpdateAssignments204Example: summary: Default billingAutomations_updateAssignments 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: BillingAutomationsUpdateAssignments429Example: summary: Default billingAutomations_updateAssignments 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: BillingAutomationsUpdateAssignments500Example: summary: Default billingAutomations_updateAssignments 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/billingAutomations/delete: post: tags: - Billing automations summary: Mews Delete Billing Automations description: Deletes specified billing automations. operationId: billingAutomations_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAutomationDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillingAutomationIds: - ecd64eec-4423-4c65-b844-814b9199856d - 13e6b16e-39bc-4cb1-8610-70ecdb4f91cc responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' example: {} '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: BillingAutomationsDelete400Example: summary: Default billingAutomations_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsDelete401Example: summary: Default billingAutomations_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsDelete403Example: summary: Default billingAutomations_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsDelete408Example: summary: Default billingAutomations_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsDelete204Example: summary: Default billingAutomations_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsDelete429Example: summary: Default billingAutomations_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationsDelete500Example: summary: Default billingAutomations_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/bills/update: post: tags: - Bills summary: Mews Update Bills description: Updates one or more existing bills in the system. Closed bills cannot be updated. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: bills_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleBillsUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillsUpdates: - BillId: ea087d64-3901-4eee-b0b7-9fce4c58a005 AccountId: Value: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f AssociatedAccountIds: Value: - fadd5bb6-b428-45d5-94f8-fd0d89fece6d EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillsUpdateResult' example: Bills: - Id: ea087d64-3901-4eee-b0b7-9fce4c58a005 Name: Accommodation Charges EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AccountId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f AccountType: Company CustomerId: CompanyId: AssociatedAccountIds: - fadd5bb6-b428-45d5-94f8-fd0d89fece6d CounterId: State: Closed Type: Invoice Number: '29' VariableSymbol: CreatedUtc: '2017-01-31T10:48:06Z' IssuedUtc: '2017-01-31T10:58:06Z' TaxedUtc: PaidUtc: DueUtc: LastReminderDateUtc: UpdatedUtc: '2017-01-31T10:58:06Z' PurchaseOrderNumber: XX-123 Notes: '' Options: DisplayCustomer: true DisplayTaxation: true TrackReceivable: true DisplayCid: false Rebated: false Revenue: [] Payments: [] OrderItems: [] PaymentItems: [] AssigneeData: OwnerData: Discriminator: BillCompanyData Value: Id: 26afba60-06c3-455b-92db-0e3983be0b1d Address: Line1: I.P. Pavlova 5 Line2: City: Prague PostalCode: '12000' SubdivisionCode: CZ-PR CountryCode: CZ LegalIdentifiers: TaxIdentifier: CZ24227781 CityOfRegistration: Prague BillingCode: Billing code value Name: Acme, Inc. FiscalIdentifier: Fiscal identifier AdditionalTaxIdentifier: Additional tax identifier DUNS: '150483782' Telephone: '+420123456789' TaxIdentifier: CZ24227781 InvoicingEmail: billing@acme.example Department: Billing CompanyDetails: AssociatedAccountData: - Discriminator: BillCompanyData BillCustomerData: BillCompanyData: Id: 26afba60-06c3-455b-92db-0e3983be0b1d Address: Line1: I.P. Pavlova 5 Line2: City: Prague PostalCode: '12000' SubdivisionCode: CZ-PR CountryCode: CZ LegalIdentifiers: TaxIdentifier: CZ24227781 CityOfRegistration: Prague BillingCode: Billing code value Name: Acme, Inc. FiscalIdentifier: Fiscal identifier AdditionalTaxIdentifier: Additional tax identifier DUNS: '150483782' Telephone: '+420123456789' TaxIdentifier: CZ24227781 InvoicingEmail: billing@acme.example Department: Billing EnterpriseData: AdditionalTaxIdentifier: XY00112233445 CompanyName: The Sample Hotel Group AS BankAccount: CZ3808000000000012345678 BankName: CESKA SPORITELNA A.S. Iban: CZ6508000000192000145399 Bic: GIBACZPX CorrectionState: Bill CorrectionType: CorrectedBillId: '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: BillsUpdate400Example: summary: Default bills_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: BillsUpdate401Example: summary: Default bills_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: BillsUpdate403Example: summary: Default bills_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: BillsUpdate408Example: summary: Default bills_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: BillsUpdate204Example: summary: Default bills_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: BillsUpdate429Example: summary: Default bills_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: BillsUpdate500Example: summary: Default bills_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/bills/getAll: post: tags: - Bills summary: Mews Get All Bills description: Returns all bills, optionally filtered by customers, identifiers and other filters. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/). operationId: bills_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/BillFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Extent: Items: false ClosedUtc: StartUtc: '2020-02-05T00:00:00Z' EndUtc: '2020-02-10T00:00:00Z' CreatedUtc: StartUtc: '2020-02-05T00:00:00Z' EndUtc: '2020-02-10T00:00:00Z' UpdatedUtc: StartUtc: '2020-02-05T00:00:00Z' EndUtc: '2020-02-10T00:00:00Z' BillIds: - e654f217-d1b5-46be-a820-e93ba568dfac CustomerIds: - fe795f96-0b64-445b-89ed-c032563f2bac State: Closed EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillsResult' example: Bills: - Id: ea087d64-3901-4eee-b0b7-9fce4c58a005 Name: Accommodation Charges EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AccountId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f AccountType: Company CustomerId: CompanyId: AssociatedAccountIds: - fadd5bb6-b428-45d5-94f8-fd0d89fece6d CounterId: State: Closed Type: Invoice Number: '29' VariableSymbol: CreatedUtc: '2017-01-31T10:48:06Z' IssuedUtc: '2017-01-31T10:58:06Z' TaxedUtc: PaidUtc: DueUtc: LastReminderDateUtc: UpdatedUtc: '2017-01-31T10:58:06Z' PurchaseOrderNumber: XX-123 Notes: '' Options: DisplayCustomer: true DisplayTaxation: true TrackReceivable: true DisplayCid: false Rebated: false Revenue: [] Payments: [] OrderItems: [] PaymentItems: [] AssigneeData: OwnerData: Discriminator: BillCompanyData Value: Id: 26afba60-06c3-455b-92db-0e3983be0b1d Address: Line1: I.P. Pavlova 5 Line2: City: Prague PostalCode: '12000' SubdivisionCode: CZ-PR CountryCode: CZ LegalIdentifiers: TaxIdentifier: CZ24227781 CityOfRegistration: Prague BillingCode: Billing code value Name: Acme, Inc. FiscalIdentifier: Fiscal identifier AdditionalTaxIdentifier: Additional tax identifier DUNS: '150483782' Telephone: '+420123456789' TaxIdentifier: CZ24227781 InvoicingEmail: billing@acme.example Department: Billing CompanyDetails: AssociatedAccountData: - Discriminator: BillCompanyData BillCustomerData: BillCompanyData: Id: 26afba60-06c3-455b-92db-0e3983be0b1d Address: Line1: I.P. Pavlova 5 Line2: City: Prague PostalCode: '12000' SubdivisionCode: CZ-PR CountryCode: CZ LegalIdentifiers: TaxIdentifier: CZ24227781 CityOfRegistration: Prague BillingCode: Billing code value Name: Acme, Inc. FiscalIdentifier: Fiscal identifier AdditionalTaxIdentifier: Additional tax identifier DUNS: '150483782' Telephone: '+420123456789' TaxIdentifier: CZ24227781 InvoicingEmail: billing@acme.example Department: Billing EnterpriseData: AdditionalTaxIdentifier: XY00112233445 CompanyName: The Sample Hotel Group AS BankAccount: CZ3808000000000012345678 BankName: CESKA SPORITELNA A.S. Iban: CZ6508000000192000145399 Bic: GIBACZPX CorrectionState: Bill CorrectionType: CorrectedBillId: Cursor: ea087d64-3901-4eee-b0b7-9fce4c58a005 '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: BillsGetAll400Example: summary: Default bills_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: BillsGetAll401Example: summary: Default bills_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: BillsGetAll403Example: summary: Default bills_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: BillsGetAll408Example: summary: Default bills_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: BillsGetAll204Example: summary: Default bills_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: BillsGetAll429Example: summary: Default bills_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: BillsGetAll500Example: summary: Default bills_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/bills/getPdf: post: tags: - Bills summary: Mews Get Bill PDF description: "Generates a PDF document of the specified bill. If the PDF cannot be returned immediately, retry the call later with the unique event identifier returned by the first invocation as `BillPrintEventId`.\r\n\r\nThis operation is subject to the [Mews Operations quota](https://help.mews.com/s/article/Quotas-in-Mews-Operations) \"Property Financial Document Print Event Weekly Count\". Each bill can be printed or previewed up to 30 times within 7 days. Requests that include an existing `BillPrintEventId` do not count against this quota." operationId: bills_getPdf requestBody: content: application/json: schema: $ref: '#/components/schemas/BillPdfParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillId: 44eba542-193e-47c7-8077-abd7008eb206 PdfTemplate: Detailed responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillPdfResult' example: BillId: 44eba542-193e-47c7-8077-abd7008eb206 Result: Discriminator: BillPdfFile Value: Base64Data: JVBERi0xLj... '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: BillsGetPdf400Example: summary: Default bills_getPdf 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: BillsGetPdf401Example: summary: Default bills_getPdf 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: BillsGetPdf403Example: summary: Default bills_getPdf 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: BillsGetPdf408Example: summary: Default bills_getPdf 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: BillsGetPdf204Example: summary: Default bills_getPdf 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: BillsGetPdf429Example: summary: Default bills_getPdf 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: BillsGetPdf500Example: summary: Default bills_getPdf 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/bills/add: post: tags: - Bills summary: Mews Add Bill description: Creates new empty bill assigned to specified account. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: bills_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleBillAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Bills: - AccountId: a5786a7b-a388-43cc-a838-abd7007b5ff7 Name: Bill of Joe Doe responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillsAddResult' example: BillId: 44eba542-193e-47c7-8077-abd7008eb206 Result: Discriminator: BillPdfFile Value: Base64Data: JVBER..... '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: BillsAdd400Example: summary: Default bills_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsAdd401Example: summary: Default bills_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsAdd403Example: summary: Default bills_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsAdd408Example: summary: Default bills_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsAdd204Example: summary: Default bills_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsAdd429Example: summary: Default bills_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsAdd500Example: summary: Default bills_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/bills/delete: post: tags: - Bills summary: Mews Delete Bill description: Removes selected bills. Bill must be empty, otherwise it's not possible to delete it. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: bills_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/BillDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillIds: - 177966b7-f3d9-42b7-ba49-abd80057329b EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: BillsDelete200Example: summary: Default bills_delete 200 response x-microcks-default: true value: {} '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsDelete400Example: summary: Default bills_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsDelete401Example: summary: Default bills_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsDelete403Example: summary: Default bills_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsDelete408Example: summary: Default bills_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsDelete204Example: summary: Default bills_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsDelete429Example: summary: Default bills_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsDelete500Example: summary: Default bills_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/bills/close: post: tags: - Bills summary: Mews Close Bill description: Closes a bill so no further modification to it is possible. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: bills_close requestBody: content: application/json: schema: $ref: '#/components/schemas/BillCloseParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillId: 44eba542-193e-47c7-8077-abd7008eb206 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Type: Receipt BillCounterId: 84b25778-c1dd-48dc-8c00-ab3a00b6df14 FiscalMachineId: Options: DisplayCustomer: Value: false DisplayTaxation: TaxedDate: Value: '2020-07-07' DueDate: Value: '2020-07-14' VariableSymbol: Value: '5343' AccountTaxIdentifier: Value: '446768' AccountAddress: Line1: Astronautů 2 Line2: '' City: Havířov PostalCode: 736 01 CountryCode: CZ CountrySubdivisionCode: PurchaseOrderNumber: Value: XX-123 Notes: Value: Bill closing note AssociatedAccountData: - Id: 84b25778-c1dd-48dc-8c00-ab3a00b6df14 TaxIdentifier: Value: '123459' Address: Line1: Astronautů 2 Line2: '' City: Havířov PostalCode: 736 01 CountryCode: CZ CountrySubdivisionCode: responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillsCloseResult' example: BillId: 44eba542-193e-47c7-8077-abd7008eb206 Result: Discriminator: BillPdfFile Value: Base64Data: JVBER..... '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: BillsClose400Example: summary: Default bills_close 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsClose401Example: summary: Default bills_close 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsClose403Example: summary: Default bills_close 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsClose408Example: summary: Default bills_close 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsClose204Example: summary: Default bills_close 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsClose429Example: summary: Default bills_close 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillsClose500Example: summary: Default bills_close 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/counters/getAll: post: tags: - Counters summary: Mews Get All Counters description: 'Returns all counters of an enterprise associated with the connector integration. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).' operationId: counters_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/CounterFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc UpdatedUtc: StartUtc: '2023-10-01T00:00:00Z' EndUtc: '2023-10-31T00:00:00Z' Type: Counter Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CounterResult' example: Counters: - Id: b7e4b68a-026e-41f3-ad2f-35325aa5dcbf EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Normal CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsDefault: false Value: 67 Format: NORMAL{0:0000} Type: BillCounter - Id: 403842df-635f-4b6e-8de5-42129201235e EnterpriseId: 4d0201db-36f5-428b-8d11-4f0a65e960cc Name: Events IsDefault: true CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' Value: 1575 Format: E2018{0:0000} Type: BillCounter - Id: 3362d7d5-a52f-4077-b2b4-4ec2476e6e19 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Default CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsDefault: true Value: 171 Format: '' Type: ProformaCounter - Id: 1162d7d5-a52f-4077-b2b4-4ec2476e6e19 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Default CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsDefault: true Value: 911 Format: '' Type: BillPreviewCounter - Id: a9fd7868-1ed0-4e96-8dd9-580708c200ea EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Default CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsDefault: true Value: 25797 Format: Type: ServiceOrderCounter '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: CountersGetAll400Example: summary: Default counters_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: CountersGetAll401Example: summary: Default counters_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: CountersGetAll403Example: summary: Default counters_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: CountersGetAll408Example: summary: Default counters_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: CountersGetAll204Example: summary: Default counters_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: CountersGetAll429Example: summary: Default counters_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: CountersGetAll500Example: summary: Default counters_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/exports/add: post: tags: - Exports summary: Mews Add Export description: Creates a new pending export for all entities of the specified `EntityType`. If an export with status Pending or Processing already exists for the same entity type, the request will be rejected. Successfully created exports remain available for download until the expiration date specified in ExpiresUtc. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: exports_add requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EntityType: Reservation Scope: EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 Filters: UpdatedUtc: StartUtc: '2020-11-04T00:00:00Z' EndUtc: '2020-11-05T00:00:00Z' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportAddResult' example: Export: Id: 09708665-0e31-4b23-b337-b0a000be0df0 Status: Pending EntityType: Reservation Scope: EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 ChainIds: Files: [] ExpiresUtc: Filters: UpdatedUtc: StartUtc: '2020-11-04T00:00:00Z' EndUtc: '2020-11-05T00:00:00Z' LedgerEntryFilters: '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: ExportsAdd400Example: summary: Default exports_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ExportsAdd401Example: summary: Default exports_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ExportsAdd403Example: summary: Default exports_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ExportsAdd408Example: summary: Default exports_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ExportsAdd204Example: summary: Default exports_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ExportsAdd429Example: summary: Default exports_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ExportsAdd500Example: summary: Default exports_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/exports/getAll: post: tags: - Exports summary: Mews Get All Exports description: Returns exports for the given `ExportIds`. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: exports_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ExportIds: - 3fa85f64-5717-4562-b3fd-2c963f66afa6 - 5f51c9ef-fc1d-4438-90ad-6b925ab7d7a9 - 706dc6d5-9511-4751-825e-538ce99da2ce - f776f20a-6f1a-4ddf-93f4-9dae95261415 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportResult' example: Exports: - Id: 3fa85f64-5717-4562-b3fd-2c963f66afa6 Status: Success EntityType: OrderItem Scope: EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ChainIds: Files: - Url: https://example.com/exports/3fa85f64-5717-4562-b3fd-2c963f66afa6-1.jsonl?example=signature SizeInBytes: 1215279 - Url: https://example.com/exports/3fa85f64-5717-4562-b3fd-2c963f66afa6-2.jsonl?example=signature SizeInBytes: 1398362 ExpiresUtc: '2023-10-26T11:42:28Z' Filters: UpdatedUtc: StartUtc: '2020-11-04T00:00:00Z' EndUtc: '2020-11-05T00:00:00Z' LedgerEntryFilters: - Id: 5f51c9ef-fc1d-4438-90ad-6b925ab7d7a9 Status: Pending EntityType: LedgerEntry Scope: EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 ChainIds: Files: [] ExpiresUtc: Filters: UpdatedUtc: LedgerEntryFilters: Posting: Start: '2024-01-01' End: '2024-01-31' - Id: 706dc6d5-9511-4751-825e-538ce99da2ce Status: Processing EntityType: Company Scope: EnterpriseIds: ChainIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 Files: [] ExpiresUtc: Filters: - Id: f776f20a-6f1a-4ddf-93f4-9dae95261415 Status: Expired EntityType: OrderItem Scope: EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 ChainIds: Files: [] ExpiresUtc: '2023-10-24T14:12:30Z' Filters: '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: ExportsGetAll400Example: summary: Default exports_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: ExportsGetAll401Example: summary: Default exports_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: ExportsGetAll403Example: summary: Default exports_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: ExportsGetAll408Example: summary: Default exports_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: ExportsGetAll204Example: summary: Default exports_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: ExportsGetAll429Example: summary: Default exports_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: ExportsGetAll500Example: summary: Default exports_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/ledgerBalances/getAll: post: tags: - Ledger balances summary: Mews Get All Ledger Balances description: Returns opening and closing balances of specified ledgers for each day in the specified date interval. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: ledgerBalances_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/LedgerBalanceParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Date: Start: '2024-01-01' End: '2024-01-02' LedgerTypes: - Revenue - Payment - Guest 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/LedgerBalanceResult' example: LedgerBalances: - EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Date: '2024-01-15' LedgerType: Revenue OpeningBalance: Currency: EUR NetValue: 15000.0 GrossValue: 18000.0 TaxValues: - Code: VAT Value: 3000.0 Breakdown: Items: - TaxRateCode: VAT NetValue: 15000.0 TaxValue: 3000.0 ClosingBalance: Currency: EUR NetValue: 25000.0 GrossValue: 30000.0 TaxValues: - Code: VAT Value: 5000.0 Breakdown: Items: - TaxRateCode: VAT NetValue: 25000.0 TaxValue: 5000.0 - EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Date: '2024-01-15' LedgerType: Payment OpeningBalance: Currency: EUR NetValue: 5000.0 GrossValue: 5000.0 TaxValues: - Code: VAT Value: 0.0 Breakdown: Items: - TaxRateCode: VAT NetValue: 5000.0 TaxValue: 0.0 ClosingBalance: Currency: EUR NetValue: 12000.0 GrossValue: 12000.0 TaxValues: - Code: VAT Value: 0.0 Breakdown: Items: - TaxRateCode: VAT NetValue: 12000.0 TaxValue: 0.0 - EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Date: '2024-01-15' LedgerType: Guest OpeningBalance: Currency: EUR NetValue: -2000.0 GrossValue: -2400.0 TaxValues: - Code: VAT Value: -400.0 Breakdown: Items: - TaxRateCode: VAT NetValue: -2000.0 TaxValue: -400.0 ClosingBalance: Currency: EUR NetValue: -5000.0 GrossValue: -6000.0 TaxValues: - Code: VAT Value: -1000.0 Breakdown: Items: - TaxRateCode: VAT NetValue: -5000.0 TaxValue: -1000.0 Cursor: 145a6ece-e15e-4b22-922d-eeac973478c8 '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: LedgerBalancesGetAll400Example: summary: Default ledgerBalances_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: LedgerBalancesGetAll401Example: summary: Default ledgerBalances_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: LedgerBalancesGetAll403Example: summary: Default ledgerBalances_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: LedgerBalancesGetAll408Example: summary: Default ledgerBalances_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: LedgerBalancesGetAll204Example: summary: Default ledgerBalances_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: LedgerBalancesGetAll429Example: summary: Default ledgerBalances_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: LedgerBalancesGetAll500Example: summary: Default ledgerBalances_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/orderItems/cancel: post: tags: - Order items summary: Mews Cancel Order Items description: Cancels all order items with specified identifiers. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: orderItems_cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelOrderItemParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 OrderItemIds: - f5c6b7a8-9d4f-4e2a-8a3b-2f3b8b9e6a1f - a6b7c8d9-0e1f-4d2a-9b3c-5d6e7f8a9b0c EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: OrderItemsCancel200Example: summary: Default orderItems_cancel 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: OrderItemsCancel400Example: summary: Default orderItems_cancel 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: OrderItemsCancel401Example: summary: Default orderItems_cancel 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: OrderItemsCancel403Example: summary: Default orderItems_cancel 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: OrderItemsCancel408Example: summary: Default orderItems_cancel 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: OrderItemsCancel204Example: summary: Default orderItems_cancel 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: OrderItemsCancel429Example: summary: Default orderItems_cancel 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: OrderItemsCancel500Example: summary: Default orderItems_cancel 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/orderItems/getAll: post: tags: - Order items summary: Mews Get All Order Items description: Returns all order items. At least one of the `OrderItemIds`, `ServiceOrderIds`, `ServiceIds`, `BillIds`, `CreatedUtc`, `UpdatedUtc`, `ClosedUtc` filters must be specified in the request. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: orderItems_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderItemFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AccountIds: - fadd5bb6-b428-45d5-94f8-fd0d89fece6d - bccdafd1-3e44-439d-861f-341526b597a9 CreatedUtc: StartUtc: '2023-01-01T00:00:00Z' EndUtc: '2023-01-31T23:59:59Z' 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/OrderItemResult' example: OrderItems: - Id: 53896156-f25b-4949-b55b-afd3007b1146 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AccountId: c173bb22-6ff8-4ffd-875f-afb900c92865 AccountType: Customer Notes: Additional note ServiceId: 294c7859-63ba-46ad-a8bf-34fad2019383 ServiceOrderId: ac5ef5eb-c5b2-4083-879f-83f04a5ebda5 BillId: d27ffe99-ff92-4afb-ac03-9268f24f0556 AccountingCategoryId: c0610937-0165-4091-a79c-44eb34173daf UnitCount: 1 UnitAmount: Currency: EUR NetValue: 5 GrossValue: 5 TaxValues: - Code: DE-2020-1-Z Value: 0 Breakdown: Items: - TaxRateCode: DE-2020-1-Z NetValue: 5 TaxValue: 0 Amount: Currency: EUR NetValue: 5 GrossValue: 5 TaxValues: - Code: DE-2020-1-Z Value: 0 Breakdown: Items: - TaxRateCode: DE-2020-1-Z NetValue: 5 TaxValue: 0 OriginalAmount: Currency: EUR NetValue: 5 GrossValue: 5 TaxValues: - Code: DE-2020-1-Z Value: 0 Breakdown: Items: - TaxRateCode: DE-2020-1-Z NetValue: 5 TaxValue: 0 RevenueType: Additional CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf CreatedUtc: '2023-03-28T07:28:04Z' UpdatedUtc: '2023-03-28T07:28:04Z' ConsumedUtc: '2023-03-31T00:00:00Z' CanceledUtc: ClosedUtc: StartUtc: '2023-03-30T22:00:00Z' AccountingState: Open Type: CityTax Options: CanceledWithReservation: false Data: - Id: bd11dc4a-8f9e-442b-bb1e-f5361b31dfa2 EnterpriseId: 4d0201db-36f5-428b-8d11-4f0a65e960cc AccountId: c173bb22-6ff8-4ffd-875f-afb900c92865 AccountType: Company Notes: Additional note ServiceId: 05089c0c-5d55-4756-827b-c4bcee1edf00 ServiceOrderId: dd01a673-ee6e-4f10-9c93-afcd00759ddd BillId: 297de6f8-bd67-4ebd-98b6-ecc1cd8f920c AccountingCategoryId: c5819fe7-d67c-4c24-b02e-6ce84a1d3b1d UnitCount: 1 UnitAmount: Currency: EUR NetValue: 93.46 GrossValue: 100 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 Amount: Currency: EUR NetValue: 93.46 GrossValue: 100 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 OriginalAmount: Currency: EUR NetValue: 93.46 GrossValue: 100 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 RevenueType: Service CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf CreatedUtc: '2023-03-28T07:28:01Z' UpdatedUtc: '2023-03-28T07:28:04Z' ConsumedUtc: '2023-03-31T00:00:00Z' CanceledUtc: ClosedUtc: StartUtc: '2023-03-30T22:00:00Z' AccountingState: Open Type: SpaceOrder Options: CanceledWithReservation: false Data: Discriminator: Product Rebate: Product: ProductId: 8c8dbd02-f2e2-4845-b964-afb900c8f919 AgeCategoryId: Cursor: d98c9611-0006-4691-a835-af2e00b170c4 '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: OrderItemsGetAll400Example: summary: Default orderItems_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: OrderItemsGetAll401Example: summary: Default orderItems_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: OrderItemsGetAll403Example: summary: Default orderItems_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: OrderItemsGetAll408Example: summary: Default orderItems_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: OrderItemsGetAll204Example: summary: Default orderItems_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: OrderItemsGetAll429Example: summary: Default orderItems_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: OrderItemsGetAll500Example: summary: Default orderItems_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/orders/add: post: tags: - Orders summary: Mews Add Order description: "Creates a new order, with the specified products and items. If the product being posted already exists in Mews, then use `ProductOrders`. If the product does *not* exist in Mews, then use `Items`. If the time of consumption is specified, this must be either in the future or within the Editable History Interval for the enterprise. Compared to a stay service order (i.e. a reservation), which is consumed over certain span of time, a product service order is consumed at a single point in time.\r\nNote this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).\r\n\r\n> ### Linking orders to reservations\r\n> Specify parameter `LinkedReservationId` in order to link the order to a guest reservation. This will greatly assist the property when using billing automation." operationId: orders_add requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderAdditionParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d Options: DisableItemGrouping: false ProductOrders: - ProductId: 2eb7ad8b-8dfb-4381-aba5-ab58009f2993 Count: 2 ExternalIdentifier: EXT-PROD-001 Items: - Name: Beer UnitCount: 3 UnitAmount: Currency: USD TaxCodes: - US-DC-G NetValue: 7.0 AccountingCategoryId: 90eff5aa-36b4-4689-80c0-ab3a00bb412e ExternalIdentifier: EXT-ITEM-001 ConsumptionUtc: '2020-02-04T00:00:00Z' Notes: Order for guest room service BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed BillId: ea087d64-3901-4eee-b0b7-9fce4c58a005 LinkedReservationId: 0f515589-99b4-423d-b83a-b237009f0509 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderAdditionResult' example: OrderId: cdfd5caa-2868-411b-ba95-322e70035f1a '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: OrdersAdd400Example: summary: Default orders_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: OrdersAdd401Example: summary: Default orders_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: OrdersAdd403Example: summary: Default orders_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: OrdersAdd408Example: summary: Default orders_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: OrdersAdd204Example: summary: Default orders_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: OrdersAdd429Example: summary: Default orders_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: OrdersAdd500Example: summary: Default orders_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/billingAutomationPaymentPlans/add: post: tags: - Payment plans summary: Mews Add Billing Automation Payment Plan description: "Adds a payment plan connected to a `Billing automation` and returns the payment request URL associated with the created payment plan. The fulfillment of the payment request will activate the payment plan.\r\nNote this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/)." operationId: billingAutomationPaymentPlans_add requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAutomationPaymentPlanAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 BillingAutomationId: ecd64eec-4423-4c65-b844-814b9199856d CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d Name: Payment Plan Name PaymentRequest: PaymentMethods: - PaymentCard - SepaDirectDebit Message: Your scheduled payments will be collected automatically based on your selected plan and timing. Note: Bill for previous month included ExpirationDateUtc: '2026-10-01T12:00:00Z' SendEmail: false PaymentOffsetDays: 5 StartMonth: 2026-10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentPlanAddResult' example: PaymentRequestUrl: https://example.com/payment-request-url '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: BillingAutomationPaymentPlansAdd400Example: summary: Default billingAutomationPaymentPlans_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationPaymentPlansAdd401Example: summary: Default billingAutomationPaymentPlans_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationPaymentPlansAdd403Example: summary: Default billingAutomationPaymentPlans_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationPaymentPlansAdd408Example: summary: Default billingAutomationPaymentPlans_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationPaymentPlansAdd204Example: summary: Default billingAutomationPaymentPlans_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationPaymentPlansAdd429Example: summary: Default billingAutomationPaymentPlans_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: BillingAutomationPaymentPlansAdd500Example: summary: Default billingAutomationPaymentPlans_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/taxEnvironments/getAll: post: tags: - Tax environments summary: Mews Get All Tax Environments description: Returns all tax environments supported by the API. operationId: taxEnvironments_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/Parameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TaxEnvironmentResult' example: TaxEnvironments: - Code: AT-2020 CountryCode: AUT ValidityStartUtc: '2020-06-30T22:00:00Z' ValidityEndUtc: TaxationCodes: - AT-2020 - Code: AW-2023 CountryCode: ABW ValidityStartUtc: '2023-01-01T04:00:00Z' ValidityEndUtc: TaxationCodes: - AW-2023 - AW-TOURIST-2023 - AW-RESIDENCE - Code: CA-QC-TR-2023 CountryCode: CAN ValidityStartUtc: '2023-10-19T19:00:00Z' ValidityEndUtc: TaxationCodes: - CA-TR-2023 - CA-QC-2023 - CA-QC-LODGING-2023 - CA-QC-LO-FLAT - Code: PH-MA-CUSTOM CountryCode: PHL ValidityStartUtc: ValidityEndUtc: TaxationCodes: - PH - PH-MA-CUSTOM - PH-MA-SERVICE '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: TaxEnvironmentsGetAll400Example: summary: Default taxEnvironments_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: TaxEnvironmentsGetAll401Example: summary: Default taxEnvironments_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: TaxEnvironmentsGetAll403Example: summary: Default taxEnvironments_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: TaxEnvironmentsGetAll408Example: summary: Default taxEnvironments_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: TaxEnvironmentsGetAll204Example: summary: Default taxEnvironments_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: TaxEnvironmentsGetAll429Example: summary: Default taxEnvironments_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: TaxEnvironmentsGetAll500Example: summary: Default taxEnvironments_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/taxations/getAll: post: tags: - Taxations summary: Mews Get All Taxations description: Returns all taxations supported in tax environments. operationId: taxations_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/Parameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TaxationResult' example: Taxations: - Code: AT-2020 Name: VAT LocalName: MWST - Code: AT-2020-Extra Name: Extra tax on top of VAT LocalName: Extra tax on top of MWST - Code: AT-2016 Name: VAT LocalName: MWST - Code: AT Name: VAT LocalName: MWST - Code: AW Name: TAX LocalName: TAX - Code: CA-QC-2023 Name: TVQ/QST LocalName: TVQ/QST - Code: PH-MA-CUSTOM Name: Makati local tax LocalName: Makati local tax TaxRates: - Code: AT-2020-21% TaxationCode: AT Value: 0.21 ValidityInvervalsUtc: Strategy: Discriminator: Relative Value: Value: 0.21 - Code: AT-2020-Extra-10% TaxationCode: AT-2020-Extra Value: 0.1 ValidityInvervalsUtc: Strategy: Discriminator: Dependent Value: Value: 0.1 BaseTaxationCodes: - AT-2020 - Code: AT-5-EUR TaxationCode: AT Value: 5.0 ValidityInvervalsUtc: Strategy: Discriminator: Flat Value: CurrencyCode: EUR Value: 5.0 - Code: AW-S TaxationCode: AW Value: 0.2062 ValidityInvervalsUtc: - StartUtc: EndUtc: '2021-01-14T00:00:00Z' Strategy: Discriminator: Relative Value: Value: 0.2062 - Code: CA-QC-2023-9.975% TaxationCode: CA-QC-2023 Value: 0.0 ValidityInvervalsUtc: - StartUtc: '2023-10-19T19:00:00Z' EndUtc: Strategy: Discriminator: Dependent Value: Value: 0.09975 BaseTaxationCodes: - CA-QC-MT-LO - CA-QC-LODGING-2023 - CA-QC-LO-FLAT - Code: PH-MA-CUSTOM-0.75% TaxationCode: PH-MA-CUSTOM Value: 0.0075 ValidityInvervalsUtc: Strategy: Discriminator: Relative Value: Value: 0.0075 '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: TaxationsGetAll400Example: summary: Default taxations_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: TaxationsGetAll401Example: summary: Default taxations_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: TaxationsGetAll403Example: summary: Default taxations_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: TaxationsGetAll408Example: summary: Default taxations_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: TaxationsGetAll204Example: summary: Default taxations_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: TaxationsGetAll429Example: summary: Default taxations_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: TaxationsGetAll500Example: summary: Default taxations_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 components: schemas: OrderItemFilterParameters: title: OrderItemFilterParameters 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 OrderItemIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Order items](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item). Required if no other filter is provided. nullable: true AccountIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of specific `Accounts` to which the order items belong to. Required if no other filter is provided. nullable: true ServiceOrderIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the service orders ([product service orders](https://mews-systems.gitbook.io/connector-api/operations/productserviceorders/#product-service-order) or [reservations](https://mews-systems.gitbook.io/connector-api/operations/reservations/#reservation-ver-2023-06-06)). Required if no other filter is provided. nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service). Required if no other filter is provided. nullable: true BillIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Bills](https://mews-systems.gitbook.io/connector-api/operations/bills/#bill) to which order item is assigned. Required if no other filter is provided. nullable: true CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) was created. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) was updated. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string ConsumedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) was consumed. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string CanceledUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) was canceled. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string ClosedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) was closed. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string Currency: type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to. format: currency nullable: true example: EUR AccountingStates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/AccountingStateEnum' description: Accounting state of the item. nullable: true Types: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/OrderItemTypeEnum' description: Order item type, e.g. whether product order or space order. nullable: true additionalProperties: false x-schema-id: OrderItemFilterParameters BillAssigneeDataDiscriminator: title: Bill associated account data discriminator enum: - BillCustomerData - BillCompanyData type: string description: Determines type of value. BillPdfParameters: title: BillPdfParameters required: - AccessToken - BillId - 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 BillId: type: string description: Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/#bill) to be printed. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillPrintEventId: type: string description: Identifier of an existing bill print event returned by a previous call. Provide this value to retry retrieval of a pending PDF without consuming its "Property Financial Document Print Event Weekly Count" quota. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PdfTemplate: allOf: - $ref: '#/components/schemas/FinancialDocumentPdfTemplateTypeEnum' description: 'Bill PDF template type. If not specified, the default template is used. Detailed (Detailed overview. Items are grouped by the reservation, item type and price, and consumption date.) Consumption (Overview by date (no reservation details). Items of the same type and price are grouped by consumption date.) Reservation (Overview by reservation (no date). Items of the same type and price are grouped by reservation.) OrderItem (Consumption overview (not fiscal document). Items are grouped by the item type and price without reservation details and consumption date.) Guest (Overview by guest. Items are grouped by guest, reservation, consumption date, and item type.)' nullable: true example: string PrintReason: maxLength: 255 type: string description: The reason for reprinting the bill with different template. Required for France LE. nullable: true example: string additionalProperties: false x-schema-id: BillPdfParameters BillingAutomationResult: title: Billing automation result type: object properties: BillingAutomations: maxItems: 1000 type: array items: $ref: '#/components/schemas/BillingAutomation' description: The list of filtered billing automations. nullable: true Cursor: type: string description: Unique identifier of the last returned billing automation. This can be used in Limitation in a subsequent request to fetch the next batch of billing automations. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: BillingAutomationResult BillCloseParameters: title: BillCloseParameters required: - AccessToken - BillId - Client - ClientToken - 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 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 BillId: type: string description: Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/#bill) to be closed. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: $ref: '#/components/schemas/BillType' BillCounterId: type: string description: Unique identifier of the [Counter](https://mews-systems.gitbook.io/connector-api/operations/counters/#counter) to be used for closing. Default one is used when no value is provided. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 FiscalMachineId: type: string description: Unique identifier of the [Fiscal Machine](https://mews-systems.gitbook.io/connector-api/operations/devices/#device) to be used for closing. Default one is used when no value is provided. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Options: title: Bill options parameters allOf: - $ref: '#/components/schemas/BillOptionsParameters' description: Options of the bill. If not provided, both DisplayCustomer and DisplayTaxation are set by default. nullable: true example: string TaxedDate: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Date of consumption for tax purposes. Can be used only with `Type` of `Invoice`. nullable: true example: string DueDate: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Deadline when bill is due to be paid. Can be used only with `Type` of `Invoice`. nullable: true example: string VariableSymbol: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Optional unique identifier of requested payment. Can be used only with `Type` of `Invoice`. nullable: true example: string TaxIdentifier: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Tax identifier of account to be put on a bill. nullable: true deprecated: true x-deprecatedMessage: Use `AccountTaxIdentifier` or `AssociatedAccountData` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountTaxIdentifier: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Tax identifier of account to be put on a bill. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyTaxIdentifier: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Tax identifier of company to be put on a bill. nullable: true deprecated: true x-deprecatedMessage: Use `AccountTaxIdentifier` or `AssociatedAccountData` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PurchaseOrderNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Unique number of the purchase order from the buyer. nullable: true example: '1001' Notes: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Notes to be attached to bill. nullable: true example: string Address: title: Address parameters allOf: - $ref: '#/components/schemas/AddressParameters' description: Address of the account to be displayed on bill. Overrides the default one taken from account profile. nullable: true deprecated: true x-deprecatedMessage: Use `AccountAddress` or `AssociatedAccountData` instead. example: string AccountAddress: title: Address parameters allOf: - $ref: '#/components/schemas/AddressParameters' description: Address of the account to be displayed on bill. Overrides the default one taken from account profile. nullable: true example: string AssociatedAccountData: maxItems: 1 type: array items: $ref: '#/components/schemas/BillCloseAccountParameters' description: Account data of the associated account on a bill. Currently one object is supported and only populated when the bill is closed. nullable: true additionalProperties: false x-schema-id: BillCloseParameters 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 OrderItemAllowanceProfitsData: title: Allowance profits data required: - AllowanceProductOrderItemId - AllowanceProfitType type: object properties: AllowanceProductOrderItemId: type: string description: Unique identifier of the allowance product [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) which credit has been consumed by current item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AllowanceProfitType: allOf: - $ref: '#/components/schemas/AllowanceProfitTypeEnum' description: 'Type of allowance profit. AllowanceBreakage (Profit of the allowance product.) AllowanceContraBreakage (Accounting balance for profit of the allowance product.) AllowanceLoss (Loss of the allowance product.) AllowanceContraLoss (Accounting balance for loss of the allowance product.)' example: string additionalProperties: false x-schema-id: OrderItemAllowanceProfitsData ExportScopeParameters: title: Export scope parameters type: object properties: EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the enterprises to export data for. If not specified, data for all enterprises within the access token's scope will be returned. nullable: true ChainIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the chains to export data for. If not specified, data for all chains within the access token's scope will be returned. nullable: true additionalProperties: false x-schema-id: ExportScopeParameters DateTimeIntervalUtc: title: DateTimeIntervalUtc type: object properties: StartUtc: type: string nullable: true example: string EndUtc: type: string nullable: true example: string additionalProperties: false x-schema-id: DateTimeIntervalUtc MultipleBillingAutomationAddParameters: title: Multiple billing automation add parameters required: - AccessToken - BillingAutomations - 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 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 BillingAutomations: maxItems: 100 minItems: 1 type: array items: $ref: '#/components/schemas/BillingAutomationAddParameters' description: Parameters of the new billing automations to be created. additionalProperties: false x-schema-id: MultipleBillingAutomationAddParameters MultipleBillAddParameters: title: MultipleBillAddParameters required: - AccessToken - Bills - 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 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 Bills: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/BillAddParameters' description: Information about bills to be created. additionalProperties: false x-schema-id: MultipleBillAddParameters BillingAutomationPaymentPlanAddParameters: title: BillingAutomationPaymentPlanAddParameters required: - AccessToken - BillingAutomationId - Client - ClientToken - CustomerId - Name - PaymentOffsetDays - PaymentRequest 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 BillingAutomationId: type: string description: Unique identifier of the `Billing automation` associated with the payment plan. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Unique identifier of the `Customer` associated with the payment plan. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: maxLength: 255 minLength: 1 type: string description: Name of the payment plan. example: Example Name PaymentRequest: title: Billing automation payment plan payment request allOf: - $ref: '#/components/schemas/BillingAutomationPaymentPlanPaymentRequest' description: Data related to the payment request associated with the payment plan created. example: string PaymentOffsetDays: type: integer description: Number of days since the bill creation when the payment will be charged. format: int32 example: 1 StartMonth: type: string description: Specifies the month when the payment plan begins collecting payments, in the 'YYYY-MM' format. The month must be in the future. If a value is not set, it'll start with the earliest available bill created from billing automation. nullable: true example: string additionalProperties: false x-schema-id: BillingAutomationPaymentPlanAddParameters BillingAutomationPrepaymentEnum: title: Billing automation prepayment type enum: - All - Prepaid type: string description: ' All (All) Prepaid (Prepaid)' x-enumNames: - All - Prepaid x-enumDescriptions: - All - Prepaid BillFilterParameters: title: BillFilterParameters 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 Extent: title: Bill extent allOf: - $ref: '#/components/schemas/BillExtent' description: Extent of data to be returned. E.g. it is possible to specify that together with the bills, payments and revenue items should be also returned. nullable: true deprecated: true x-deprecatedMessage: Use `orderItems/getAll` and `payments/getAll` with `BillIds` filter instead. example: string ClosedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Bill` was closed. nullable: true deprecated: true x-deprecatedMessage: Use `IssuedUtc` instead. x-max-interval-in-months: 3 example: string IssuedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Bill` was issued. nullable: true x-max-interval-in-months: 3 example: string PaidUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Bill` was paid. nullable: true x-max-interval-in-months: 3 example: string DueUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Bill` is due to be paid. nullable: true x-max-interval-in-months: 3 example: string CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Bill` was created. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Bill` was updated. nullable: true x-max-interval-in-months: 3 example: string BillIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Bills`. Required if no other filter is provided. nullable: true CustomerIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Customers`. nullable: true State: allOf: - $ref: '#/components/schemas/BillStateEnum' description: 'State the bills should be in. If not specified, `Open` and `Closed` bills are returned. Open Closed' nullable: true example: string Type: allOf: - $ref: '#/components/schemas/BillTypeEnum' description: 'Type of the bills. If not specified, all types are returned. Receipt (Default; the bill has been paid in full; only applicable after the bill is closed.) Invoice (Bill has not been paid in full but an invoice has been issued to request payment.)' nullable: true example: string CorrectionState: uniqueItems: true type: array items: $ref: '#/components/schemas/BillCorrectionStateEnum' description: Whether to return regular bills, corrective bills, or both. If `BillIds` are specified, defaults to both, otherwise defaults to `Bill`. nullable: true additionalProperties: false x-schema-id: BillFilterParameters 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 BillingAutomationAssignmentAddParameters: title: Billing automation assignment add parameters required: - RoutedItemTypes - ServiceId type: object properties: ServiceId: type: string description: Unique identifier of the related service. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RoutedItemTypes: title: Billing automation item types parameters allOf: - $ref: '#/components/schemas/BillingAutomationItemTypesParameters' description: Type of items that are going to be routed. example: string RateIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifiers of `Rates` that will be applied as billing automation condition. nullable: true ProductCategoryIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifiers of `Product Categories` that will be applied as billing automation condition. nullable: true ProductIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifiers of `Products` that will be applied as billing automation condition. nullable: true AccountingCategories: maxItems: 100 type: array items: $ref: '#/components/schemas/BillingAutomationAccountingCategoryAssignment' description: List of accounting categories that will be applied as billing automation condition. nullable: true additionalProperties: false x-schema-id: BillingAutomationAssignmentAddParameters 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. DependentTaxRateStrategy: title: Dependent tax rate strategy data required: - BaseTaxationCodes - Value type: object properties: Value: type: number description: Tax rate, e.g. `0.1` in case of 10% tax rate. format: double example: 100.0 BaseTaxationCodes: type: array items: type: string description: Codes of the taxations that are included in the base of calculation. additionalProperties: false x-schema-id: DependentTaxRateStrategy OrderAdditionOptions: title: Order addition options type: object properties: DisableItemGrouping: type: boolean description: Whether to disable item grouping. Defaults to `false` (item grouping is enabled by default). nullable: true example: true additionalProperties: false x-schema-id: OrderAdditionOptions AccountingItemUpdateParameters: title: Accounting item update required: - AccountingItemId - BillId type: object properties: AccountingItemId: type: string description: Unique identifier of the `AccountingItem`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Unique identifier of the account (for example `Customer`) the item is assigned to (or `null` if the assigned account should not be updated). If defined, valid account identifier must be provided. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Unique identifier of the `Bill` the items is assigned to. It's possible to assign item to bill belonging to another account, in that case both `AccountId` and `BillId` must be provided. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: AccountingItemUpdateParameters BillOptionsParameters: title: Bill options parameters required: - DisplayCustomer - DisplayTaxation type: object properties: DisplayCustomer: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Display customer information on a bill. example: string DisplayTaxation: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Display taxation detail on a bill. example: string additionalProperties: false description: '' x-schema-id: BillOptionsParameters CompanyRelationsParameters: title: Company with relations parameters type: object properties: PartnerCompany: type: boolean description: Indicates whether the billing automation will apply if the company added to a reservation is a partner company. example: true TravelAgency: type: boolean description: Indicates whether the billing automation will apply if the company added to a reservation is a travel agency. example: true additionalProperties: false x-schema-id: CompanyRelationsParameters BillCustomerData: title: Bill customer data required: - Id - LastName type: object properties: Id: minLength: 1 type: string description: ID of the `Customer` to whom the bill was assigned. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Address: allOf: - $ref: '#/components/schemas/Address' description: Address of the customer. nullable: true example: string LegalIdentifiers: type: object additionalProperties: type: string description: The set of `LegalIdentifiers` for the customer. nullable: true BillingCode: type: string description: A unique code for Mews to list on invoices it sends to the customer. nullable: true example: string LastName: minLength: 1 type: string description: Last name of the customer. example: Example Name FirstName: type: string description: First name of the customer. nullable: true example: Example Name SecondLastName: type: string description: Second last name of the customer. nullable: true example: Example Name TitlePrefix: allOf: - $ref: '#/components/schemas/Title' description: 'Title prefix of the customer. Mister (Mr.) Miss (Ms.) Misses (Mrs.)' nullable: true example: string TaxIdentifier: type: string description: Tax identifier of the customer. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: BillCustomerData Parameters: title: Parameters required: - AccessToken - Client - ClientToken type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string additionalProperties: false x-schema-id: Parameters BillingAutomationBillAggregationTypeUpdateValue: title: Billing automation bill aggregation type update value type: object properties: Value: title: Billing automation bill aggregation type allOf: - $ref: '#/components/schemas/BillingAutomationBillAggregationTypeEnum' description: Value which is to be updated. x-enumNames: - OnePerReservation - AggregateByCustomer - AggregateAll - AggregatePerReservationGroup x-enumDescriptions: - Create a separate bill for each reservation. - Create a separate bill for each reservation owner. - Group all moved items on one bill. - Create a separate bill for each reservation group. example: string additionalProperties: false x-schema-id: BillingAutomationBillAggregationTypeUpdateValue LedgerBalanceParameters: title: LedgerBalanceParameters required: - AccessToken - Client - ClientToken - Date - LedgerTypes - 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 Date: title: Date filter interval allOf: - $ref: '#/components/schemas/DateFilterInterval' description: Date interval over which the ledger balances are created. x-max-interval-in-months: 1 example: string LedgerTypes: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/AccountingLedgerTypeEnum' description: Accounting ledger types to which ledger balances belong. additionalProperties: false x-schema-id: LedgerBalanceParameters OrderAdditionParameters: title: OrderAdditionParameters required: - AccessToken - AccountId - Client - ClientToken - ServiceId 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, ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Identifier of the `Service` to be ordered. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Identifier of the `Customer` or `Company` to be charged. Company billing may not be enabled for your integration. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Identifier of the [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) to be charged. **Deprecated!** format: uuid nullable: true deprecated: true x-deprecatedMessage: Use `AccountId`. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Options: title: Order addition options allOf: - $ref: '#/components/schemas/OrderAdditionOptions' description: Options for the added order. nullable: true example: string ProductOrders: type: array items: $ref: '#/components/schemas/ProductOrderAdditionData' description: Parameters of the ordered products. nullable: true Items: type: array items: $ref: '#/components/schemas/OrderItemAdditionData' description: Parameters of the ordered custom items. nullable: true ConsumptionUtc: type: string description: Date and time of the order consumption in UTC timezone in ISO 8601 format. If not specified, current date and time is used. Please note, as order consumption is one-time event, the optional parameters `StartUtc` and `EndUtc` in `ProductOrders` should not be used. format: date-time nullable: true example: '2026-06-02T14:30:00Z' Notes: type: string description: Additional notes of the order. nullable: true example: string BusinessSegmentId: type: string description: Unique identifier of the business segment. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillId: type: string description: Identifier of the `Bill` to which the created order will be assigned. The bill needs to be issued to the same account as the order. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 LinkedReservationId: type: string description: Identifier of the `Reservation` to which the created order will be linked. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: OrderAdditionParameters BillsAddResult: title: BillsAddResult required: - Bills type: object properties: Bills: type: array items: $ref: '#/components/schemas/Bill' description: The created bills. additionalProperties: false x-schema-id: BillsAddResult StringUpdateValue: title: String update value type: object properties: Value: type: string description: Value which is to be updated. nullable: true example: string additionalProperties: false x-schema-id: StringUpdateValue AccountingItemUpdateResult: title: AccountingItemUpdateResult type: object properties: OrderItems: type: array items: $ref: '#/components/schemas/OrderItemOld' description: Updated order items. nullable: true PaymentItems: type: array items: $ref: '#/components/schemas/PaymentItemOld' description: Updated payment items. nullable: true additionalProperties: false x-schema-id: AccountingItemUpdateResult AccountingCategoryResult: title: AccountingCategoryResult required: - AccountingCategories type: object properties: AccountingCategories: type: array items: $ref: '#/components/schemas/AccountingCategory' description: Accounting categories of the enterprise. Cursor: type: string description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: AccountingCategoryResult BillingAutomationAssignment: title: Billing automation assignment required: - BillingAutomationId - Id - RoutedItemTypes - ServiceId type: object properties: Id: type: string description: Unique identifier of the billing automation assignment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillingAutomationId: type: string description: Unique identifier of the billing automation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the related service. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RoutedItemTypes: title: Billing automation item types parameters allOf: - $ref: '#/components/schemas/BillingAutomationItemTypesParameters' description: Type of items that are going to be routed. example: string RateIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifiers of `Rates` used in billing automation conditions. nullable: true ProductCategoryIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifiers of `Product Categories` used in billing automation conditions. nullable: true ProductIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifiers of `Products` used in billing automation conditions. nullable: true AccountingCategoryAssignments: maxItems: 100 type: array items: $ref: '#/components/schemas/BillingAutomationAccountingCategoryAssignment' description: List of accounting category assignments used in billing automation conditions. nullable: true additionalProperties: false x-schema-id: BillingAutomationAssignment 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 AssociatedAccountIdsUpdate: title: Associated account IDs update parameters type: object properties: Value: maxItems: 1 minItems: 0 type: array items: type: string format: uuid description: Unique identifiers of the `Customer` or `Company` that are associated to the bill. Set to `null` to remove all associated accounts. Note that only single associated account is currently supported. nullable: true additionalProperties: false description: Has same structure as [Array of strings update value](https://mews-systems.gitbook.io/connector-api/operations/_objects#array-of-strings-update-value). x-schema-id: AssociatedAccountIdsUpdate LedgerBalance: title: Ledger balance required: - ClosingBalance - Date - EnterpriseId - LedgerType - OpeningBalance type: object properties: EnterpriseId: type: string description: Unique identifier of the Enterprise. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Date: minLength: 1 type: string description: Day for which the ledger balance applies in ISO 8601 format. format: date example: '2026-06-02' LedgerType: title: Accounting ledger type allOf: - $ref: '#/components/schemas/AccountingLedgerTypeEnum' description: 'Type of accounting ledger. Revenue Tax Payment Deposit Guest City NonRevenue' x-enumNames: - Revenue - Tax - Payment - Deposit - Guest - City - NonRevenue x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' example: string OpeningBalance: title: Amount allOf: - $ref: '#/components/schemas/Amount' description: Ledger opening balance at the start of the day. example: string ClosingBalance: title: Amount allOf: - $ref: '#/components/schemas/Amount' description: Ledger closing balance at the end of the day. example: string additionalProperties: false description: Ledger balance x-schema-id: LedgerBalance GuidUpdateValue: title: Guid update value type: object properties: Value: type: string description: Value which is to be updated. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: GuidUpdateValue 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 BillPdfFile: title: Bill PDF file required: - Base64Data type: object properties: Base64Data: minLength: 1 type: string description: Base64 encoded PDF file. example: string additionalProperties: false x-schema-id: BillPdfFile BillAddParameters: title: Bill parameters required: - AccountId type: object properties: AccountId: type: string description: Unique identifier of the account (`Customer` or `Company`) the bill is issued to. Company billing may not be enabled for your integration. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssociatedAccountId: type: string description: Account that has a possible link with the owner of the bill. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: type: string description: Name of the newly created bill. nullable: true example: Example Name additionalProperties: false x-schema-id: BillAddParameters AccountingCategoryClassificationEnum: title: Accounting category classification enum: - Accommodation - FoodAndBeverage - Taxes - Payments - ExternalRevenue - SundryIncome - Wellness - Sport - Technology - Facilities - Events - Tourism type: string description: ' Accommodation FoodAndBeverage Taxes Payments ExternalRevenue SundryIncome Wellness Sport Technology Facilities Events Tourism' x-enumNames: - Accommodation - FoodAndBeverage - Taxes - Payments - ExternalRevenue - SundryIncome - Wellness - Sport - Technology - Facilities - Events - Tourism x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' BillingAutomationPrepaymentUpdateValue: title: Billing automation prepayment type update value type: object properties: Value: title: Billing automation prepayment type allOf: - $ref: '#/components/schemas/BillingAutomationPrepaymentEnum' description: Value which is to be updated. x-enumNames: - All - Prepaid x-enumDescriptions: - All - Prepaid example: string additionalProperties: false x-schema-id: BillingAutomationPrepaymentUpdateValue OrderItemResult: title: OrderItemResult required: - OrderItems type: object properties: OrderItems: maxItems: 1000 type: array items: $ref: '#/components/schemas/OrderItem' description: Set of requested order items. Cursor: type: string description: Unique identifier of the last and hence oldest order item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older order items. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: OrderItemResult AccountingCategoryFilterParameters: title: AccountingCategoryFilterParameters 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 AccountingCategoryIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested [Accounting categories](https://mews-systems.gitbook.io/connector-api/operations/#accounting-category). nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Last update date and time of the accounting category in UTC timezone in ISO 8601 format. nullable: true x-max-interval-in-months: 3 example: string ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted or both records. nullable: true additionalProperties: false x-schema-id: AccountingCategoryFilterParameters Counter: title: Counter required: - CreatedUtc - EnterpriseId - Format - Id - IsDefault - Name - Type - UpdatedUtc - Value type: object properties: Id: type: string description: Unique identifier of the counter. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the enterprise to which the counter belongs. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name of the counter. example: Example Name IsDefault: type: boolean description: Whether the counter is used by default. example: true Value: type: integer description: Current value of the counter. format: int64 example: 1 Format: minLength: 1 type: string description: Display format of the counter. example: string Type: $ref: '#/components/schemas/EnterpriseScopeCounterDiscriminator' CreatedUtc: minLength: 1 type: string description: Creation date and time of the counter in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the counter in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: Counter DateFilterInterval: title: Date filter interval required: - End - Start type: object properties: Start: minLength: 1 type: string description: Starting date of the interval in ISO 8601 format. format: date example: '2026-06-02' End: minLength: 1 type: string description: Ending date of the interval in ISO 8601 format. format: date example: '2026-06-02' additionalProperties: false x-schema-id: DateFilterInterval Amount: title: Amount required: - Breakdown - Currency - GrossValue - NetValue - TaxValues type: object properties: Currency: minLength: 1 type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). format: currency example: EUR NetValue: type: number description: Net value without taxes. format: double example: 100.0 GrossValue: type: number description: Gross value including all taxes. format: double example: 100.0 TaxValues: type: array items: $ref: '#/components/schemas/TaxValue' description: The tax values applied. Breakdown: title: Tax breakdown allOf: - $ref: '#/components/schemas/TaxBreakdown' description: Information about individual tax amounts. example: string additionalProperties: false description: '' x-schema-id: Amount Title: title: Title enum: - Mister - Miss - Misses type: string description: "Type of the title prefix of the customer.\r\n\r\nNote that the value should not be used as-is, but localized. For example, the value `Misses` should be displayed as `Mrs.` in English and `Fr.` in German.\n\nMister (Mr.)\n\nMiss (Ms.)\n\nMisses (Mrs.)" x-enumNames: - Mister - Miss - Misses x-enumDescriptions: - Mr. - Ms. - Mrs. x-schema-id: Title x-showDescription: true AccountingCategoryRoutedItemTypes: title: Accounting category routed item types required: - CustomItems - Products type: object properties: Products: type: boolean description: Specifies whether products under the given accounting category are routed. example: true CustomItems: type: boolean description: Specifies whether custom items under the given accounting category are routed. example: true additionalProperties: false x-schema-id: AccountingCategoryRoutedItemTypes 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 TaxationResult: title: TaxationResult required: - Taxations - TaxRates type: object properties: Taxations: type: array items: $ref: '#/components/schemas/Taxation' description: The supported taxations. TaxRates: type: array items: $ref: '#/components/schemas/TaxRate' description: The supported tax rates. additionalProperties: false x-schema-id: TaxationResult BillingAutomationOrderItemConsumptionPeriodTypeUpdateValue: title: Billing automation order item consumption period type update value type: object properties: Value: title: Billing automation order item consumption period type allOf: - $ref: '#/components/schemas/BillingAutomationOrderItemConsumptionPeriodTypeEnum' description: Value which is to be updated. x-enumNames: - MonthBefore - SameMonthAndMonthBefore - SameMonth - SameMonthAndMonthAfter - MonthAfter x-enumDescriptions: - Only items with a consumption date within the previous month will be routed. - Only items with a consumption date within this and the previous month will be routed. - Only items with a consumption date within this month will be routed. - Only items with a consumption date within this and the next month will be routed. - Only items with a consumption date within the next month will be routed. example: string additionalProperties: false x-schema-id: BillingAutomationOrderItemConsumptionPeriodTypeUpdateValue BillingAutomationModificationResult: title: Billing automation modification result type: object properties: BillingAutomations: type: array items: $ref: '#/components/schemas/BillingAutomation' description: Billing automations affected by the operation. nullable: true additionalProperties: false x-schema-id: BillingAutomationModificationResult RevenueTypeEnum: title: Revenue type enum: - Service - Product - Additional type: string description: 'Revenue type. Service Product Additional' x-enumNames: - Service - Product - Additional x-enumDescriptions: - '' - '' - '' BillingAutomationOrderItemConsumptionPeriodTypeEnum: title: Billing automation order item consumption period type enum: - MonthBefore - SameMonthAndMonthBefore - SameMonth - SameMonthAndMonthAfter - MonthAfter type: string description: ' MonthBefore (Only items with a consumption date within the previous month will be routed.) SameMonthAndMonthBefore (Only items with a consumption date within this and the previous month will be routed.) SameMonth (Only items with a consumption date within this month will be routed.) SameMonthAndMonthAfter (Only items with a consumption date within this and the next month will be routed.) MonthAfter (Only items with a consumption date within the next month will be routed.)' x-enumNames: - MonthBefore - SameMonthAndMonthBefore - SameMonth - SameMonthAndMonthAfter - MonthAfter x-enumDescriptions: - Only items with a consumption date within the previous month will be routed. - Only items with a consumption date within this and the previous month will be routed. - Only items with a consumption date within this month will be routed. - Only items with a consumption date within this and the next month will be routed. - Only items with a consumption date within the next month will be routed. CompanyWithBillingAutomationRelationIEnumerableUpdateValue: title: Company with billing automation relation array update value type: object properties: Value: type: array items: $ref: '#/components/schemas/CompanyWithBillingAutomationRelation' description: Value which is to be updated. nullable: true additionalProperties: false x-schema-id: CompanyWithBillingAutomationRelationIEnumerableUpdateValue 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. ExportScope: title: Export scope type: object properties: EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of enterprises for which the data is exported. nullable: true ChainIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of chains for which the data is exported. nullable: true additionalProperties: false x-schema-id: ExportScope ExportFilterParameters: title: Export filter parameters required: - AccessToken - Client - ClientToken - ExportIds 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 ExportIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Exports](https://mews-systems.gitbook.io/connector-api/operations/#export). additionalProperties: false x-schema-id: ExportFilterParameters ExportDataFilters: title: Export data filters type: object properties: UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Filters entities by the specified UTC update interval. The end of the interval must be no later than 5 minutes in the past. The maximum interval is 180 days. nullable: true example: string LedgerEntryFilters: title: Export ledger entry data filters allOf: - $ref: '#/components/schemas/ExportLedgerEntryDataFilters' description: Filters specific to the `LedgerEntry` entity type. Required when `EntityType` is `LedgerEntry`. nullable: true example: string additionalProperties: false x-schema-id: ExportDataFilters BillingAutomationDeleteParameters: title: Billing automation delete parameters required: - AccessToken - BillingAutomationIds - 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 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 BillingAutomationIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifier of the billing automations to be deleted. additionalProperties: false x-schema-id: BillingAutomationDeleteParameters BillingAutomationAssignmentTargetTypeUpdateValue: title: Billing automation assignment target type update value type: object properties: Value: title: Billing automation assignment target type allOf: - $ref: '#/components/schemas/BillingAutomationAssignmentTargetTypeEnum' description: Value which is to be updated. x-enumNames: - CompanyAsDetails - CompanyAsOwner - NoCompany x-enumDescriptions: - The company will be the associated account in the resulting routed bill, and the customer is the owner. - The company will be the owner in the resulting routed bill, and the customer might be the associated account. - The customer will be owner of the bill. example: string additionalProperties: false x-schema-id: BillingAutomationAssignmentTargetTypeUpdateValue OrderItemRebateData: title: Rebate data required: - ProductId - RebatedItemId type: object properties: ProductId: type: string description: Unique identifier of the [Product](https://mews-systems.gitbook.io/connector-api/operations/products/#product) of the original rebated [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item). format: uuid x-mews-legacy-nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RebatedItemId: type: string description: Unique identifier of [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) which has been rebated by current item. format: uuid x-mews-legacy-nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: OrderItemRebateData BillsCloseResult: title: BillsCloseResult required: - Bills type: object properties: Bills: type: array items: $ref: '#/components/schemas/Bill' description: The closed bills. additionalProperties: false x-schema-id: BillsCloseResult BillStateEnum: title: Bill state enum: - Open - Closed type: string description: 'Whether the bill is `Open` or `Closed`. Open Closed' x-enumNames: - Open - Closed x-enumDescriptions: - '' - '' AddressParameters: title: Address parameters type: object properties: Line1: type: string description: First line of the address. nullable: true example: string Line2: type: string description: Second line of the address. nullable: true example: string City: type: string description: The city. nullable: true example: string PostalCode: type: string description: Postal code. format: postal-code nullable: true example: string CountryCode: type: string description: ISO 3166-1 code of the Country. nullable: true example: string CountrySubdivisionCode: type: string description: ISO 3166-2 code of the administrative division, e.g. DE-BW nullable: true example: string additionalProperties: false description: New address details. x-schema-id: AddressParameters AmountParameters: title: Amount parameters required: - Currency - TaxCodes type: object properties: Currency: minLength: 1 type: string format: currency example: EUR TaxCodes: type: array items: type: string NetValue: type: number format: double nullable: true example: 100.0 GrossValue: type: number format: double nullable: true example: 100.0 additionalProperties: false description: Price of the product that overrides the price defined in Mews. x-schema-id: AmountParameters BillCorrectionStateEnum: title: Bill correction state enum: - Bill - CorrectiveBill type: string description: ' Bill (Regular bill.) CorrectiveBill (Corrective bill, i.e. the `CorrectionType` is either `Edit`, `Cancellation`, or `ReceivablePaymentsBalance`.)' x-enumNames: - Bill - CorrectiveBill x-enumDescriptions: - Regular bill. - Corrective bill, i.e. the `CorrectionType` is either `Edit`, `Cancellation`, or `ReceivablePaymentsBalance`. BooleanUpdateValue: title: Boolean update value type: object properties: Value: type: boolean description: Value which is to be updated. example: true additionalProperties: false x-schema-id: BooleanUpdateValue AccountingItemExtent: title: Accounting item extent type: object properties: OrderItems: type: boolean description: Whether the response should contain order items (consumed items such as nights or products). example: true PaymentItems: type: boolean description: Whether the response should contain payment items (such as cash, credit card payments or invoices). example: true CreditCardTransactions: type: boolean description: Whether the response should contain credit card transactions of the payment items. example: true additionalProperties: false description: '' x-schema-id: AccountingItemExtent BillPdfResult: title: BillPdfResult required: - Result type: object properties: BillId: type: string description: Unique identifier of the printed bill. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Result: title: Bill PDF result discriminator type: object properties: Discriminator: $ref: '#/components/schemas/BillPdfResultDiscriminator' Value: oneOf: - $ref: '#/components/schemas/BillPdfFile' - $ref: '#/components/schemas/BillPrintEvent' description: The result of operation. x-coproduct: true x-schema-id: BillPdfResultResultCoproductOfBillPdfResultDiscriminator additionalProperties: false x-schema-id: BillPdfResult 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: - '' - '' - '' - '' - '' ProductTypeEnum: title: Product type enum: - Product - Allowance type: string description: ' Product Allowance' x-enumNames: - Product - Allowance x-enumDescriptions: - '' - '' BillingAutomationAddParameters: title: Billing automation add parameters required: - Assignments - AssignmentTargetType - BillAggregationType - Name - Prepayment - TriggerType type: object properties: Name: maxLength: 255 minLength: 1 type: string description: Name of the billing automation. example: Example Name Description: maxLength: 1000 type: string description: Description of the billing automation. nullable: true example: string CompaniesWithRelations: maxItems: 1000 type: array items: $ref: '#/components/schemas/CompanyWithBillingAutomationRelation' description: List of companies with relations indicating whether the company is considered a travel agency or a company in the reservation. Can only be empty if `AssignmentTargetType` is `CompanyAsDetails` or `NoCompany`. nullable: true Prepayment: title: Billing automation prepayment type allOf: - $ref: '#/components/schemas/BillingAutomationPrepaymentEnum' description: 'Type of prepayment. All (All) Prepaid (Prepaid)' x-enumNames: - All - Prepaid x-enumDescriptions: - All - Prepaid example: string AssignmentTargetType: title: Billing automation assignment target type allOf: - $ref: '#/components/schemas/BillingAutomationAssignmentTargetTypeEnum' description: 'Specifies the type of company assignment to the bill. If set to `NoCompany`, the `BillAggregationType` must be `AggregateByCustomer`. CompanyAsDetails (The company will be the associated account in the resulting routed bill, and the customer is the owner.) CompanyAsOwner (The company will be the owner in the resulting routed bill, and the customer might be the associated account.) NoCompany (The customer will be owner of the bill.)' x-enumNames: - CompanyAsDetails - CompanyAsOwner - NoCompany x-enumDescriptions: - The company will be the associated account in the resulting routed bill, and the customer is the owner. - The company will be the owner in the resulting routed bill, and the customer might be the associated account. - The customer will be owner of the bill. example: string TriggerType: title: Billing automation trigger type allOf: - $ref: '#/components/schemas/BillingAutomationTriggerTypeEnum' description: 'Trigger type of billing automation. Continuous (Billing automation is continuously triggered by reservation actions, such as creation, updates, and rebates.) Recurring (Billing automation is executed monthly.) Legacy (Billing automation is executed on reservation creation only. Items added later are not transfered to any bill.)' x-enumNames: - Continuous - Recurring - Legacy x-enumDescriptions: - Billing automation is continuously triggered by reservation actions, such as creation, updates, and rebates. - Billing automation is executed monthly. - Billing automation is executed on reservation creation only. Items added later are not transfered to any bill. example: string BillAggregationType: title: Billing automation bill aggregation type allOf: - $ref: '#/components/schemas/BillingAutomationBillAggregationTypeEnum' description: 'Specifies the type of bill aggregation. If the value is not `AggregateByCustomer`, the `AssignmentTargetType` must be `CompanyAsOwner`. OnePerReservation (Create a separate bill for each reservation.) AggregateByCustomer (Create a separate bill for each reservation owner.) AggregateAll (Group all moved items on one bill.) AggregatePerReservationGroup (Create a separate bill for each reservation group.)' x-enumNames: - OnePerReservation - AggregateByCustomer - AggregateAll - AggregatePerReservationGroup x-enumDescriptions: - Create a separate bill for each reservation. - Create a separate bill for each reservation owner. - Group all moved items on one bill. - Create a separate bill for each reservation group. example: string OrderItemConsumptionPeriod: allOf: - $ref: '#/components/schemas/BillingAutomationOrderItemConsumptionPeriodTypeEnum' description: 'Specifies the order item consumption period type for the billing automation. This is required if the `TriggerType` is set to `Reccuring`. MonthBefore (Only items with a consumption date within the previous month will be routed.) SameMonthAndMonthBefore (Only items with a consumption date within this and the previous month will be routed.) SameMonth (Only items with a consumption date within this month will be routed.) SameMonthAndMonthAfter (Only items with a consumption date within this and the next month will be routed.) MonthAfter (Only items with a consumption date within the next month will be routed.)' nullable: true example: string ProcessingStartOffset: maxLength: 20 type: string description: Specifies the processing start offset. This is required if the billing automation `TriggerType` is set to `Reccuring`. nullable: true example: string Assignments: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/BillingAutomationAssignmentAddParameters' description: List of billing automation assignments. additionalProperties: false x-schema-id: BillingAutomationAddParameters OrderItem: title: Order item required: - AccountingState - Amount - ConsumedUtc - CreatedUtc - CreatorProfileId - EnterpriseId - Id - Options - OriginalAmount - RevenueType - ServiceId - ServiceOrderId - Type - UnitAmount - UnitCount - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the order item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the account (for example [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer)) the order item belongs to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountType: allOf: - $ref: '#/components/schemas/AccountTypeEnum' description: 'A discriminator specifying the [type of account](https://mews-systems.gitbook.io/connector-api/operations/accounts/#account-type), e.g. customer or company. Company Customer' nullable: true example: string ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service) the order item is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceOrderId: type: string description: Unique identifier of the [Service order](https://mews-systems.gitbook.io/connector-api/operations/serviceorders/#service-order) the order item is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Notes: type: string description: Additional notes. nullable: true example: string BillId: type: string description: Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/bills/#bill) the order item is assigned to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string description: Unique identifier of the [Accounting category](https://mews-systems.gitbook.io/connector-api/operations/accountingcategories/#accounting-category) the order item belongs to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillingName: type: string description: Name of the order item for billing purposes. nullable: true example: Example Name ExternalIdentifier: type: string description: Identifier of the entity from external system. 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: Amount allOf: - $ref: '#/components/schemas/Amount' description: Amount of item; note a negative amount represents a rebate or payment. example: string OriginalAmount: title: Amount allOf: - $ref: '#/components/schemas/Amount' description: Order item's original amount. Negative amount represents either rebate or a payment. Contains the earliest known value in conversion chain. example: string RevenueType: title: Revenue type allOf: - $ref: '#/components/schemas/RevenueTypeEnum' description: 'Revenue type of the item. Service Product Additional' x-enumNames: - Service - Product - Additional x-enumDescriptions: - '' - '' - '' example: string CreatorProfileId: type: string description: Unique identifier of the user who created the order item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UpdaterProfileId: type: string description: Unique identifier of the user who updated the order item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the order item created in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the order item in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' ConsumedUtc: minLength: 1 type: string description: Date and time of the item consumption in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' CanceledUtc: type: string description: Cancellation date and time of the order item in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ClosedUtc: type: string description: Date and time of the item bill closure in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' StartUtc: type: string description: Start of the order item in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ClaimedUtc: type: string description: Date and time when the order item was claimed in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' AccountingState: title: Order item accounting state allOf: - $ref: '#/components/schemas/AccountingStateEnum' description: 'Accounting state of the order item. Open (Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice.) Closed (Order items which carry a non-zero value and have been closed on a bill or invoice.) Inactive (Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive.) Canceled (Order items which have been canceled, regardless of whether the item is of zero value.)' x-enumNames: - Open - Closed - Inactive - Canceled x-enumDescriptions: - Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice. - Order items which carry a non-zero value and have been closed on a bill or invoice. - Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive. - Order items which have been canceled, regardless of whether the item is of zero value. example: string Type: title: Order item type allOf: - $ref: '#/components/schemas/OrderItemTypeEnum' description: 'Order item type, e.g. whether product order or space order. CancellationFee NightRebate ProductOrderRebate AdditionalExpenseRebate Deposit ExchangeRateDifference CustomItem ServiceCharge CityTax CityTaxDiscount SpaceOrder ProductOrder Surcharge TaxCorrection ResourceUpgradeFee InvoiceFee MulticurrencyFee AllowanceDiscount AllowanceBreakage AllowanceContraBreakage' x-enumNames: - CancellationFee - NightRebate - ProductOrderRebate - AdditionalExpenseRebate - Deposit - ExchangeRateDifference - CustomItem - ServiceCharge - CityTax - CityTaxDiscount - SpaceOrder - ProductOrder - Surcharge - TaxCorrection - ResourceUpgradeFee - InvoiceFee - MulticurrencyFee - AllowanceDiscount - AllowanceBreakage - AllowanceContraBreakage x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' example: string Options: title: Order item options allOf: - $ref: '#/components/schemas/OrderItemOptions' description: Options of the order item. example: string Data: title: Order item data allOf: - $ref: '#/components/schemas/OrderItemData' description: Additional order item data. nullable: true example: string TaxExemptionReason: allOf: - $ref: '#/components/schemas/TaxExemptionReasonTypeEnum' description: 'Specifies the reason an order item is exempt from tax. Unknown (Unknown tax exemption reason) IT_N1 (N1 - Escluse ex art.15) IT_N2_2 (N2.2 - Non soggette – altri casi) IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento) IT_N4 (N4 - Esenti) IT_N5 (N5 - Regime del margine / IVA non esposta in fattura) PL_ZW (ZW - Zwolniony) PL_NP (NP - Nie podlega) DE_NATO (NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen)' nullable: true example: string TaxExemptionLegalReference: type: string description: Legal reference that states why this order item is exempt from tax. nullable: true example: string additionalProperties: false x-schema-id: OrderItem GuidIEnumerableUpdateValue: title: Guid array update value type: object properties: Value: type: array items: type: string format: uuid description: Value which is to be updated. nullable: true additionalProperties: false x-schema-id: GuidIEnumerableUpdateValue BillPrintEvent: title: Bill print event type: object properties: BillPrintEventId: type: string description: Unique identifier of print event. Must be used in retry calls to retrieve the PDF. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: BillPrintEvent OrderItemAllowanceDiscountData: title: Allowance discount data required: - AllowanceProductOrderItemId - DiscountedOrderItemId type: object properties: DiscountedOrderItemId: type: string description: Unique identifier of [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) which has been discounted by current item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AllowanceProductOrderItemId: type: string description: Unique identifier of the allowance product [Order item](https://mews-systems.gitbook.io/connector-api/operations/orderitems/#order-item) which credit has been consumed by current item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: OrderItemAllowanceDiscountData ExportResult: title: ExportResult required: - Exports type: object properties: Exports: type: array items: $ref: '#/components/schemas/Export' description: Requested exports. additionalProperties: false x-schema-id: ExportResult OrderAdditionResult: title: OrderAdditionResult type: object properties: OrderId: type: string description: Unique identifier of the created order. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: OrderAdditionResult BillingAutomationAssignmentTargetTypeEnum: title: Billing automation assignment target type enum: - CompanyAsDetails - CompanyAsOwner - NoCompany type: string description: ' CompanyAsDetails (The company will be the associated account in the resulting routed bill, and the customer is the owner.) CompanyAsOwner (The company will be the owner in the resulting routed bill, and the customer might be the associated account.) NoCompany (The customer will be owner of the bill.)' x-enumNames: - CompanyAsDetails - CompanyAsOwner - NoCompany x-enumDescriptions: - The company will be the associated account in the resulting routed bill, and the customer is the owner. - The company will be the owner in the resulting routed bill, and the customer might be the associated account. - The customer will be owner of the bill. OrderItemData: title: Order item data type: object properties: Discriminator: title: Order item data discriminator allOf: - $ref: '#/components/schemas/OrderItemDataDiscriminatorEnum' description: 'Discriminator pointing to the fields within this object that contains additional data. Rebate (Rebate.) Product (Product.) AllowanceDiscount (Allowance discount.) AllowanceProfits (Allowance profits.)' x-enumNames: - Rebate - Product - AllowanceDiscount - AllowanceProfits x-enumDescriptions: - Rebate. - Product. - Allowance discount. - Allowance profits. example: string Rebate: title: Rebate data allOf: - $ref: '#/components/schemas/OrderItemRebateData' description: Contains additional data in the case of rebate item. nullable: true example: string Product: title: Product data allOf: - $ref: '#/components/schemas/OrderItemProductData' description: Contains additional data in the case of product item. nullable: true example: string AllowanceDiscount: title: Allowance discount data allOf: - $ref: '#/components/schemas/OrderItemAllowanceDiscountData' description: Contains additional data in the case of allowance discount item. nullable: true example: string AllowanceProfits: title: Allowance profits data allOf: - $ref: '#/components/schemas/OrderItemAllowanceProfitsData' description: Contains additional data in the case of allowance profits item. nullable: true example: string additionalProperties: false description: Additional order item data. x-schema-id: OrderItemData BillingAutomationAssignmentUpdateParameters: title: Billing automation assignment update parameters required: - BillingAutomationAssignmentId type: object properties: BillingAutomationAssignmentId: type: string description: Unique identifier of the billing automation assignment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RoutedItemTypes: title: Billing automation item types update parameters allOf: - $ref: '#/components/schemas/BillingAutomationItemTypesUpdateParameters' description: Type of items that are going to be routed (or `null` should it not be updated). nullable: true example: string RateIds: title: Guid array update value maxLength: 100 allOf: - $ref: '#/components/schemas/GuidIEnumerableUpdateValue' description: Unique identifiers of `Rates` that will be applied as billing automation condition (or `null` should it not be updated). nullable: true example: string ProductCategoryIds: title: Guid array update value maxLength: 100 allOf: - $ref: '#/components/schemas/GuidIEnumerableUpdateValue' description: Unique identifiers of `Product Categories` that will be applied as billing automation condition (or `null` should it not be updated). nullable: true example: string ProductIds: title: Guid array update value maxLength: 100 allOf: - $ref: '#/components/schemas/GuidIEnumerableUpdateValue' description: Unique identifiers of `Products` that will be applied as billing automation condition (or `null` should it not be updated). nullable: true example: string AccountingCategories: title: Billing automation accounting category assignment array update value maxLength: 100 allOf: - $ref: '#/components/schemas/BillingAutomationAccountingCategoryAssignmentIEnumerableUpdateValue' description: List of `Accounting Categories` with their `ItemTypes` that will be applied as billing automation condition (or `null` should it not be updated). nullable: true example: string additionalProperties: false x-schema-id: BillingAutomationAssignmentUpdateParameters BillingAutomationAssignmentsUpdateParameters: title: Billing automation assignments update parameters required: - AccessToken - BillingAutomationId - 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 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 BillingAutomationId: type: string description: Unique identifier of the billing automation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignmentsToAdd: maxItems: 20 type: array items: $ref: '#/components/schemas/BillingAutomationAssignmentAddParameters' description: Parameters for adding new assignments (or null if not being updated). nullable: true AssignmentsToUpdate: maxItems: 20 type: array items: $ref: '#/components/schemas/BillingAutomationAssignmentUpdateParameters' description: List of parameters for updating existing assignments (or null if not being updated). nullable: true AssignmentIdsToRemove: maxItems: 100 type: array items: type: string format: uuid description: List of unique identifiers for assignments to be removed (or null if not being updated). nullable: true additionalProperties: false x-schema-id: BillingAutomationAssignmentsUpdateParameters RelativeTaxRateStrategy: title: Relative tax rate strategy data required: - Value type: object properties: Value: type: number description: Tax rate, e.g. `0.21` in case of 21% tax rate. format: double example: 100.0 additionalProperties: false x-schema-id: RelativeTaxRateStrategy BillingAutomation: title: Billing automation required: - AssignmentTargetType - BillAggregationType - CompaniesWithRelations - CreatedUtc - CreatorProfileId - EnterpriseId - Id - Name - Prepayment - TriggerType - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the billing automation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the enterprise. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name of the billing automation. example: Example Name Description: type: string description: Description of the billing automation. nullable: true example: string CompaniesWithRelations: maxItems: 1000 type: array items: $ref: '#/components/schemas/CompanyWithBillingAutomationRelation' description: List of companies with relations to the billing automation. Prepayment: title: Billing automation prepayment type allOf: - $ref: '#/components/schemas/BillingAutomationPrepaymentEnum' description: 'Type of prepayment. All (All) Prepaid (Prepaid)' x-enumNames: - All - Prepaid x-enumDescriptions: - All - Prepaid example: string AssignmentTargetType: title: Billing automation assignment target type allOf: - $ref: '#/components/schemas/BillingAutomationAssignmentTargetTypeEnum' description: 'Type of target company and customer assignment behavior. CompanyAsDetails (The company will be the associated account in the resulting routed bill, and the customer is the owner.) CompanyAsOwner (The company will be the owner in the resulting routed bill, and the customer might be the associated account.) NoCompany (The customer will be owner of the bill.)' x-enumNames: - CompanyAsDetails - CompanyAsOwner - NoCompany x-enumDescriptions: - The company will be the associated account in the resulting routed bill, and the customer is the owner. - The company will be the owner in the resulting routed bill, and the customer might be the associated account. - The customer will be owner of the bill. example: string TriggerType: title: Billing automation trigger type allOf: - $ref: '#/components/schemas/BillingAutomationTriggerTypeEnum' description: 'Trigger type of billing automation. Continuous (Billing automation is continuously triggered by reservation actions, such as creation, updates, and rebates.) Recurring (Billing automation is executed monthly.) Legacy (Billing automation is executed on reservation creation only. Items added later are not transfered to any bill.)' x-enumNames: - Continuous - Recurring - Legacy x-enumDescriptions: - Billing automation is continuously triggered by reservation actions, such as creation, updates, and rebates. - Billing automation is executed monthly. - Billing automation is executed on reservation creation only. Items added later are not transfered to any bill. example: string BillAggregationType: title: Billing automation bill aggregation type allOf: - $ref: '#/components/schemas/BillingAutomationBillAggregationTypeEnum' description: 'Type of bill aggregation. OnePerReservation (Create a separate bill for each reservation.) AggregateByCustomer (Create a separate bill for each reservation owner.) AggregateAll (Group all moved items on one bill.) AggregatePerReservationGroup (Create a separate bill for each reservation group.)' x-enumNames: - OnePerReservation - AggregateByCustomer - AggregateAll - AggregatePerReservationGroup x-enumDescriptions: - Create a separate bill for each reservation. - Create a separate bill for each reservation owner. - Group all moved items on one bill. - Create a separate bill for each reservation group. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the billing automation in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the billing automation in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' CreatorProfileId: type: string description: Unique identifier of the user who created the billing automation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UpdaterProfileId: type: string description: Unique identifier of the user who last updated the billing automation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProcessingStartOffset: type: string description: Processing start offset. Applicable only if the billing automation `TriggerType` is set to `Reccuring`. nullable: true example: string OrderItemConsumptionPeriod: allOf: - $ref: '#/components/schemas/BillingAutomationOrderItemConsumptionPeriodTypeEnum' description: 'Specifies the type of order item consumption period for the billing automation. This value is applicable only when the `TriggerType` is set to `Reccuring`. MonthBefore (Only items with a consumption date within the previous month will be routed.) SameMonthAndMonthBefore (Only items with a consumption date within this and the previous month will be routed.) SameMonth (Only items with a consumption date within this month will be routed.) SameMonthAndMonthAfter (Only items with a consumption date within this and the next month will be routed.) MonthAfter (Only items with a consumption date within the next month will be routed.)' nullable: true example: string Assignments: maxItems: 20 type: array items: $ref: '#/components/schemas/BillingAutomationAssignment' description: List of billing automation assignments. nullable: true additionalProperties: false x-schema-id: BillingAutomation BillingAutomationUpdateParameters: title: Billing automation update parameters required: - BillingAutomationId type: object properties: BillingAutomationId: type: string description: Unique identifier of the billing automation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: title: String update value maxLength: 255 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Name of the billing automation (or null should it not be updated). nullable: true example: Example Name Description: title: String update value maxLength: 1000 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Description of the billing automation (or null should it not be updated). nullable: true example: string Companies: title: Company with billing automation relation array update value maxLength: 1000 allOf: - $ref: '#/components/schemas/CompanyWithBillingAutomationRelationIEnumerableUpdateValue' description: List of companies with relations indicating whether the company should be considered as a travel agency or a company in the reservation. This list can only be empty if the `AssignmentTargetType` is `CompanyAsDetails` or `NoCompany`. Set to null if the value is not updated. nullable: true example: string Prepayment: title: Billing automation prepayment type update value allOf: - $ref: '#/components/schemas/BillingAutomationPrepaymentUpdateValue' description: Type of prepayment (or null should it not be updated). nullable: true example: string AssignmentTargetType: title: Billing automation assignment target type update value allOf: - $ref: '#/components/schemas/BillingAutomationAssignmentTargetTypeUpdateValue' description: Specifies the type of company assignment to the bill. If set to `NoCompany`, the `BillAggregationType` must be `AggregateByCustomer`. Set to null if the value is not updated. nullable: true example: string BillAggregationType: title: Billing automation bill aggregation type update value allOf: - $ref: '#/components/schemas/BillingAutomationBillAggregationTypeUpdateValue' description: Defines the aggregation target type for billing automation. If not `AggregateByCustomer`, the `AssignmentTargetType` must be `CompanyAsOwner`. Set to null if the value is not updated. nullable: true example: string OrderItemConsumptionPeriod: title: Billing automation order item consumption period type update value allOf: - $ref: '#/components/schemas/BillingAutomationOrderItemConsumptionPeriodTypeUpdateValue' description: Specifies the order item consumption period type for the billing automation. Required if the `TriggerType` is recurring. Can be null if the value is not updated. nullable: true example: string ProcessingStartOffset: title: String update value maxLength: 20 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Processing start offset. Required if the billing automation `TriggerType` is recurring (or null should it not be updated). nullable: true example: string additionalProperties: false x-schema-id: BillingAutomationUpdateParameters 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 AccountingState: title: Order item accounting state enum: - Open - Closed - Inactive - Canceled type: string x-enumDescriptions: - Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice. - Order items which carry a non-zero value and have been closed on a bill or invoice. - Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive. - Order items which have been canceled, regardless of whether the item is of zero value. ProductOrderAdditionData: title: Product order parameters required: - ProductId type: object properties: ProductId: type: string description: Unique identifier of the `Product` to be ordered. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Count: type: integer description: Count of products to be ordered, e.g. 10 in case of 10 beers. format: int32 nullable: true example: 1 UnitAmount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Unit amount of the product that overrides the amount defined in Mews. nullable: true example: string StartUtc: type: string description: Product start in UTC timezone in ISO 8601 format. For products with charging `Once` and `PerPerson` must be set to same value as `EndUtc`. Use only with operation [Add reservations](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservations) or [Add reservation product](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservation-product), can be omitted for [Add order](https://mews-systems.gitbook.io/connector-api/operations/orders#add-order) operation. format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string description: Product end in UTC timezone in ISO 8601 format. For products with charging `Once` and `PerPerson` must be set to same value as `StartUtc`. Use only with operation [Add reservations](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservations) or [Add reservation product](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservation-product), can be omitted for [Add order](https://mews-systems.gitbook.io/connector-api/operations/orders#add-order) operation. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ExternalIdentifier: type: string description: External identifier of the product order. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ProductOrderAdditionData OrderItemProductData: title: Product data required: - ProductId type: object properties: ProductId: type: string description: Unique identifier of the [Product](https://mews-systems.gitbook.io/connector-api/operations/products/#product). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AgeCategoryId: type: string description: Unique identifier of the [Age Category](https://mews-systems.gitbook.io/connector-api/operations/agecategories/#age-category). format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProductType: allOf: - $ref: '#/components/schemas/ProductTypeEnum' description: 'Type of Product, e.g. whether allowance or product. Product Allowance' nullable: true example: string additionalProperties: false x-schema-id: OrderItemProductData 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 Export: title: Export required: - EntityType - Files - Id - Scope - Status type: object properties: Id: type: string description: Unique identifier of the export. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Status: title: Export status allOf: - $ref: '#/components/schemas/ExportStatusEnum' description: 'Export status. Pending Processing Success Failed Expired' x-enumNames: - Pending - Processing - Success - Failed - Expired x-enumDescriptions: - '' - '' - '' - '' - '' example: string EntityType: title: Exported entity type allOf: - $ref: '#/components/schemas/ExportEntityTypeEnum' description: 'Exported entity type. OrderItem Payment Reservation Customer Company Bill AvailabilityAdjustment AvailabilityBlock ResourceBlock LedgerEntry (**Beta testing - subject to change.** See [Ledger entry type](https://docs.mews.com/connector-api/operations/_export-types#ledger-entry).)' x-enumNames: - OrderItem - Payment - Reservation - Customer - Company - Bill - AvailabilityAdjustment - AvailabilityBlock - ResourceBlock - LedgerEntry x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '**Beta testing - subject to change.** See [Ledger entry type](https://docs.mews.com/connector-api/operations/_export-types#ledger-entry).' example: string Scope: title: Export scope allOf: - $ref: '#/components/schemas/ExportScope' description: The scope of the export, i.e. which enterprises or chains the data is exported for. example: string Files: type: array items: $ref: '#/components/schemas/ExportFileEntry' description: Files with exported data. Empty if no files are available or the export is expired. ExpiresUtc: type: string description: Expiration date and time of the export in UTC timezone in ISO 8601 format. After this time the Exported files may no longer be available for download. format: date-time nullable: true example: '2026-06-02T14:30:00Z' Filters: title: Export data filters allOf: - $ref: '#/components/schemas/ExportDataFilters' description: Filters applied to the exported data set. If omitted, all available data is included in the export. nullable: true example: string additionalProperties: false x-schema-id: Export TaxEnvironment: title: Tax environment required: - Code - CountryCode - TaxationCodes type: object properties: Code: minLength: 1 type: string description: Code of the tax environment. example: string CountryCode: minLength: 1 type: string description: ISO 3166-1 alpha-3 code of associated country, e.g. `USA` or `GBR`. example: string ValidityStartUtc: type: string description: If specified, marks the start of the validity interval in UTC timezone in ISO 8601 format. nullable: true example: string ValidityEndUtc: type: string description: If specified, marks the end of the validity interval in UTC timezone in ISO 8601 format. nullable: true example: string TaxationCodes: type: array items: type: string description: Codes of the `Taxation` that are used by this environment. additionalProperties: false description: Tax environment represents set of `Taxation` together with optional validity interval. x-schema-id: TaxEnvironment 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 BillPdfResultDiscriminator: title: Bill PDF result discriminator enum: - BillPdfFile - BillPrintEvent type: string description: '' x-enumDescriptions: - PDF version of a `Bill` was successfully created, `Value` is `BillPdfFile`. - PDF version of a `Bill` couldn't be created at this moment (for example bill haven't been reported to authorities yet), `Value` is `BillPrintEvent` 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 OrderItemTypeEnum: title: Order item type enum: - CancellationFee - NightRebate - ProductOrderRebate - AdditionalExpenseRebate - Deposit - ExchangeRateDifference - CustomItem - ServiceCharge - CityTax - CityTaxDiscount - SpaceOrder - ProductOrder - Surcharge - TaxCorrection - ResourceUpgradeFee - InvoiceFee - MulticurrencyFee - AllowanceDiscount - AllowanceBreakage - AllowanceContraBreakage type: string description: ' CancellationFee NightRebate ProductOrderRebate AdditionalExpenseRebate Deposit ExchangeRateDifference CustomItem ServiceCharge CityTax CityTaxDiscount SpaceOrder ProductOrder Surcharge TaxCorrection ResourceUpgradeFee InvoiceFee MulticurrencyFee AllowanceDiscount AllowanceBreakage AllowanceContraBreakage' x-enumNames: - CancellationFee - NightRebate - ProductOrderRebate - AdditionalExpenseRebate - Deposit - ExchangeRateDifference - CustomItem - ServiceCharge - CityTax - CityTaxDiscount - SpaceOrder - ProductOrder - Surcharge - TaxCorrection - ResourceUpgradeFee - InvoiceFee - MulticurrencyFee - AllowanceDiscount - AllowanceBreakage - AllowanceContraBreakage x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' BillsUpdateResult: title: BillsUpdateResult required: - Bills type: object properties: Bills: type: array items: $ref: '#/components/schemas/Bill' description: Updated bills. additionalProperties: false x-schema-id: BillsUpdateResult BillingAutomationPaymentPlanPaymentRequest: title: Billing automation payment plan payment request required: - ExpirationDateUtc - Message - PaymentMethods - SendEmail type: object properties: PaymentMethods: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/PaymentMethodsEnum' description: Allowed payment methods to use for the payment plan. Message: maxLength: 1000 minLength: 1 type: string description: Message for customer in the payment request email. example: string Note: maxLength: 2000 type: string description: Internal note for the payment request. nullable: true example: string ExpirationDateUtc: minLength: 1 type: string description: Expiration date (UTC time) of the payment request. Must be within 30 days of payment plan creation. ISO-8601 format. format: date-time example: '2026-06-02T14:30:00Z' SendEmail: type: boolean description: Specifies whether a payment request email is sent to the customer. example: true additionalProperties: false x-schema-id: BillingAutomationPaymentPlanPaymentRequest TaxRate: title: Tax rate required: - Code - Strategy - TaxationCode type: object properties: Code: minLength: 1 type: string description: Code of the tax rate. To be used when posting revenue items which should be accompanied by the tax rate(s) applicable to the nature of the item and the tax environment. example: string TaxationCode: minLength: 1 type: string description: Code of the `Taxation` the rate is part of. example: string Value: type: number description: Tax rate, e.g. `0.21` in case of 21% tax rate. format: double example: 100.0 ValidityInvervalsUtc: type: array items: $ref: '#/components/schemas/DateTimeIntervalUtc' description: Validity intervals in UTC. nullable: true Strategy: title: Tax rate strategy type: object properties: Discriminator: $ref: '#/components/schemas/TaxRateStrategyDiscriminator' Value: oneOf: - $ref: '#/components/schemas/RelativeTaxRateStrategy' - $ref: '#/components/schemas/FlatTaxRateStrategy' - $ref: '#/components/schemas/DependentTaxRateStrategy' description: Tax strategy type, e.g. relative, flat or dependent. x-coproduct: true x-schema-id: TaxRateStrategyCoproductOfTaxRateStrategyDiscriminator additionalProperties: false description: Definition of single tax rate. x-schema-id: TaxRate FlatTaxRateStrategy: title: Flat tax rate strategy data required: - CurrencyCode - Value type: object properties: CurrencyCode: minLength: 1 type: string description: Code of `Currency`. example: EUR Value: type: number description: Absolute value of tax. format: double example: 100.0 additionalProperties: false x-schema-id: FlatTaxRateStrategy TaxEnvironmentResult: title: TaxEnvironmentResult required: - TaxEnvironments type: object properties: TaxEnvironments: type: array items: $ref: '#/components/schemas/TaxEnvironment' description: The supported tax environments. additionalProperties: false x-schema-id: TaxEnvironmentResult PaymentPlanAddResult: title: PaymentPlanAddResult required: - PaymentRequestUrl type: object properties: PaymentRequestUrl: minLength: 1 type: string description: Payment request URL associated with the created payment plan. example: https://api.mews.com/api/connector/v1 additionalProperties: false x-schema-id: PaymentPlanAddResult FinancialDocumentPdfTemplateTypeEnum: title: Bill PDF template type enum: - Detailed - Consumption - Reservation - OrderItem - Guest type: string description: ' Detailed (Detailed overview. Items are grouped by the reservation, item type and price, and consumption date.) Consumption (Overview by date (no reservation details). Items of the same type and price are grouped by consumption date.) Reservation (Overview by reservation (no date). Items of the same type and price are grouped by reservation.) OrderItem (Consumption overview (not fiscal document). Items are grouped by the item type and price without reservation details and consumption date.) Guest (Overview by guest. Items are grouped by guest, reservation, consumption date, and item type.)' x-enumNames: - Detailed - Consumption - Reservation - OrderItem - Guest x-enumDescriptions: - Detailed overview. Items are grouped by the reservation, item type and price, and consumption date. - Overview by date (no reservation details). Items of the same type and price are grouped by consumption date. - Overview by reservation (no date). Items of the same type and price are grouped by reservation. - Consumption overview (not fiscal document). Items are grouped by the item type and price without reservation details and consumption date. - Overview by guest. Items are grouped by guest, reservation, consumption date, and item type. BillingAutomationItemTypesUpdateParameters: title: Billing automation item types update parameters type: object properties: SpaceOrder: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Space order (or `null` should it not be updated). nullable: true example: string CityTax: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: City tax (or `null` should it not be updated). nullable: true example: string AllProducts: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Products (or `null` should it not be updated). nullable: true example: string Deposits: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Deposits(or `null` should it not be updated). nullable: true example: string AdditionalExpenses: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Additional expenses (or `null` should it not be updated). nullable: true example: string AllCustomItems: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Custom items (or `null` should it not be updated). nullable: true example: string additionalProperties: false x-schema-id: BillingAutomationItemTypesUpdateParameters OrderItemAdditionData: title: Item parameters required: - Name - UnitAmount - UnitCount type: object properties: Name: minLength: 1 type: string description: Name of the item. example: Example Name UnitCount: type: integer description: Count of units to be ordered, e.g. 10 in case of 10 beers. format: int32 example: 1 UnitAmount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Unit amount, e.g. amount for one beer (note that total amount of the item is therefore `UnitAmount` times `UnitCount`). example: string AccountingCategoryId: type: string description: Unique identifier of an `AccountingCategory` to be assigned to the item. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ExternalIdentifier: type: string description: External identifier of the order item. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: OrderItemAdditionData AccountingStateEnum: title: Order item accounting state enum: - Open - Closed - Inactive - Canceled type: string description: ' Open (Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice.) Closed (Order items which carry a non-zero value and have been closed on a bill or invoice.) Inactive (Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive.) Canceled (Order items which have been canceled, regardless of whether the item is of zero value.)' x-enumNames: - Open - Closed - Inactive - Canceled x-enumDescriptions: - Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice. - Order items which carry a non-zero value and have been closed on a bill or invoice. - Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive. - Order items which have been canceled, regardless of whether the item is of zero value. 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: - '' - '' TaxExemptionReasonTypeEnum: title: Tax exemption reason type enum: - Unknown - IT_N1 - IT_N2_2 - IT_N3_5 - IT_N4 - IT_N5 - PL_ZW - PL_NP - DE_NATO type: string description: ' Unknown (Unknown tax exemption reason) IT_N1 (N1 - Escluse ex art.15) IT_N2_2 (N2.2 - Non soggette – altri casi) IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento) IT_N4 (N4 - Esenti) IT_N5 (N5 - Regime del margine / IVA non esposta in fattura) PL_ZW (ZW - Zwolniony) PL_NP (NP - Nie podlega) DE_NATO (NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen)' x-enumNames: - Unknown - IT_N1 - IT_N2_2 - IT_N3_5 - IT_N4 - IT_N5 - PL_ZW - PL_NP - DE_NATO x-enumDescriptions: - Unknown tax exemption reason - N1 - Escluse ex art.15 - N2.2 - Non soggette – altri casi - N3.5 - Non imponibili – a seguito di dichiarazioni d’intento - N4 - Esenti - N5 - Regime del margine / IVA non esposta in fattura - ZW - Zwolniony - NP - Nie podlega - NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen BillUpdateParameters: title: Bill update parameters required: - BillId type: object properties: BillId: type: string description: Unique identifier of the bill to update. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Unique identifier of the account (`Customer` or `Company`) the bill is issued to (or null if the account should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssociatedAccountIds: title: Associated account IDs update parameters allOf: - $ref: '#/components/schemas/AssociatedAccountIdsUpdate' description: Unique identifiers of the `Customer` or `Company` that are associated to the bill (or null if the account should not be updated). nullable: true example: string additionalProperties: false x-schema-id: BillUpdateParameters ExportFileEntry: title: Export file entry required: - SizeInBytes - Url type: object properties: Url: minLength: 1 type: string description: Download URL for the exported file in JSON Lines format. The link remains valid for 10 minutes after it is returned. format: uri example: https://api.mews.com/api/connector/v1 SizeInBytes: type: integer description: Total size of the exported file in bytes. format: int64 example: 1 additionalProperties: false x-schema-id: ExportFileEntry 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 BillingAutomationFilterParameters: title: Billing automation 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 CompanyIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifiers of `Company` associated with the billing automations. nullable: true BillingAutomationIds: maxItems: 100 type: array items: type: string format: uuid description: Unique identifiers of specific `Billing automation` items. nullable: true additionalProperties: false x-schema-id: BillingAutomationFilterParameters TaxRateStrategyDiscriminator: title: Tax rate strategy discriminator enum: - Relative - Flat - Dependent type: string description: '' x-enumDescriptions: - Used with Relative tax rate strategy (e.g. 21%). Relative tax is calculated only from net base value. - Used with Flat tax rate strategy (e.g. 5.00 EUR). - Used with Dependent tax rate strategy (e.g. 10%). Dependent tax is calculated from net base value and all taxes it depends on. AllowanceProfitTypeEnum: title: Allowance profit type enum: - AllowanceBreakage - AllowanceContraBreakage - AllowanceLoss - AllowanceContraLoss type: string description: ' AllowanceBreakage (Profit of the allowance product.) AllowanceContraBreakage (Accounting balance for profit of the allowance product.) AllowanceLoss (Loss of the allowance product.) AllowanceContraLoss (Accounting balance for loss of the allowance product.)' x-enumNames: - AllowanceBreakage - AllowanceContraBreakage - AllowanceLoss - AllowanceContraLoss x-enumDescriptions: - Profit of the allowance product. - Accounting balance for profit of the allowance product. - Loss of the allowance product. - Accounting balance for loss of the allowance product. BillingAutomationItemTypesParameters: title: Billing automation item types parameters required: - AdditionalExpenses - AllCustomItems - AllProducts - CityTax - Deposits - SpaceOrder type: object properties: SpaceOrder: type: boolean description: Space order example: true CityTax: type: boolean description: City tax example: true AllProducts: type: boolean description: All products example: true Deposits: type: boolean description: Deposits example: true AdditionalExpenses: type: boolean description: Additional expenses example: true AllCustomItems: type: boolean description: All custom items example: true additionalProperties: false x-schema-id: BillingAutomationItemTypesParameters 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 CreditCardTransaction: title: Credit card transaction required: - ChargedAmount - PaymentId type: object properties: PaymentId: type: string description: Unique identifier of the `PaymentItem`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 SettlementId: type: string description: Identifier of the settlement. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 SettledUtc: type: string description: Settlement date and time in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' Fee: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Transaction fee - this includes an estimate of bank charges. nullable: true example: string AdjustedFee: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Transaction fee (adjusted) - this is the final confirmed transaction fee, including confirmed bank charges. nullable: true example: string ChargedAmount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Charged amount of the transaction. example: string SettledAmount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Settled amount of the transaction. nullable: true example: string additionalProperties: false x-schema-id: CreditCardTransaction BillingAutomationBillAggregationTypeEnum: title: Billing automation bill aggregation type enum: - OnePerReservation - AggregateByCustomer - AggregateAll - AggregatePerReservationGroup type: string description: ' OnePerReservation (Create a separate bill for each reservation.) AggregateByCustomer (Create a separate bill for each reservation owner.) AggregateAll (Group all moved items on one bill.) AggregatePerReservationGroup (Create a separate bill for each reservation group.)' x-enumNames: - OnePerReservation - AggregateByCustomer - AggregateAll - AggregatePerReservationGroup x-enumDescriptions: - Create a separate bill for each reservation. - Create a separate bill for each reservation owner. - Group all moved items on one bill. - Create a separate bill for each reservation group. AccountingItemResult: title: AccountingItemResult type: object properties: OrderItems: type: array items: $ref: '#/components/schemas/OrderItemOld' description: The order items (consumed items such as nights or products). nullable: true PaymentItems: type: array items: $ref: '#/components/schemas/PaymentItemOld' description: The payment items (such as cash, credit card payments or invoices). nullable: true CreditCardTransactions: type: array items: $ref: '#/components/schemas/CreditCardTransaction' description: The credit card payment transactions. nullable: true additionalProperties: false x-schema-id: AccountingItemResult 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 PaymentMethodsEnum: title: Available payment plan payment methods enum: - Ideal - PaymentCard - ApplePay - GooglePay - SepaDirectDebit - All type: string description: ' Ideal (iDEAL) PaymentCard (Payment card) ApplePay (Apple Pay) GooglePay (Google Pay) SepaDirectDebit (SEPA Direct Debit) All' x-enumNames: - Ideal - PaymentCard - ApplePay - GooglePay - SepaDirectDebit - All x-enumDescriptions: - iDEAL - Payment card - Apple Pay - Google Pay - SEPA Direct Debit - '' BillExtent: title: Bill extent type: object properties: Items: type: boolean description: Whether the response should contain payments and revenue items. deprecated: true x-deprecatedMessage: Use `orderItems/getAll` and `payments/getAll` with `BillIds` filter instead. example: true additionalProperties: false description: Extent of data to be returned. E.g. it is possible to specify that together with the bills, payments and revenue items should be also returned. **Deprecated!** x-schema-id: BillExtent BillDeleteParameters: title: BillDeleteParameters required: - AccessToken - BillIds - 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 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 BillIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/#bill)s to be deleted. additionalProperties: false x-schema-id: BillDeleteParameters BillingAutomationAccountingCategoryAssignmentIEnumerableUpdateValue: title: Billing automation accounting category assignment array update value type: object properties: Value: type: array items: $ref: '#/components/schemas/BillingAutomationAccountingCategoryAssignment' description: Value which is to be updated. nullable: true additionalProperties: false x-schema-id: BillingAutomationAccountingCategoryAssignmentIEnumerableUpdateValue 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 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 BillTypeEnum: 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. Receipt (Default; the bill has been paid in full; only applicable after the bill is closed.) Invoice (Bill has not been paid in full but an invoice has been issued to request payment.)' x-enumNames: - Receipt - Invoice 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. Taxation: title: Taxation required: - Code - LocalName - Name type: object properties: Code: minLength: 1 type: string description: Code of the taxation. example: string Name: minLength: 1 type: string description: Name of the taxation. example: Example Name LocalName: minLength: 1 type: string description: Local name of the taxation. example: Example Name additionalProperties: false description: Taxation represents set of `TaxRate` within `TaxEnvironment`. x-schema-id: Taxation BillsResult: title: BillsResult required: - Bills type: object properties: Bills: type: array items: $ref: '#/components/schemas/Bill' description: The filtered bills. Cursor: type: string description: Unique identifier of the last and hence oldest bill returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older bills. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: BillsResult OrderItemOptions: title: Order item options required: - CanceledWithReservation type: object properties: CanceledWithReservation: type: boolean description: Order item was canceled with reservation cancellation. example: true additionalProperties: false description: Options of the order item. x-schema-id: OrderItemOptions ExportStatusEnum: title: Export status enum: - Pending - Processing - Success - Failed - Expired type: string description: 'Current status of the export. Pending Processing Success Failed Expired' x-enumNames: - Pending - Processing - Success - Failed - Expired x-enumDescriptions: - '' - '' - '' - '' - '' BillCloseAccountParameters: title: Bill close account parameters required: - Id type: object properties: Id: type: string description: Unique identifier of the associated account (`Customer` or `Company`) the bill is associated to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TaxIdentifier: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Tax identifier of the associated account to be put on a bill. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Address: title: Address parameters allOf: - $ref: '#/components/schemas/AddressParameters' description: Address of the associated account to be displayed on bill. Overrides the default one taken from account profile. nullable: true example: string additionalProperties: false x-schema-id: BillCloseAccountParameters CompanyWithBillingAutomationRelation: title: Company with billing automation relation required: - CompanyId - CompanyRelations type: object properties: CompanyId: type: string description: Unique identifier of the company. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyRelations: title: Company with relations parameters allOf: - $ref: '#/components/schemas/CompanyRelationsParameters' description: Company relations. example: string additionalProperties: false x-schema-id: CompanyWithBillingAutomationRelation CounterResult: title: CounterResult required: - BillCounters - BillPreviewCounters - Counters - ProformaCounters - RegistrationCardCounters - ServiceOrderCounters type: object properties: Counters: type: array items: $ref: '#/components/schemas/Counter' description: All types of counters. BillCounters: type: array items: $ref: '#/components/schemas/Counter' description: The counters used to count closed `Bills`. deprecated: true x-deprecatedMessage: Use `Counters` instead. ProformaCounters: type: array items: $ref: '#/components/schemas/Counter' description: The counters used to count Pro Forma invoices for `Bills`. deprecated: true x-deprecatedMessage: Use `Counters` instead. BillPreviewCounters: type: array items: $ref: '#/components/schemas/Counter' description: The counters used to count bill previews for `Bills`. deprecated: true x-deprecatedMessage: Use `Counters` instead. ServiceOrderCounters: type: array items: $ref: '#/components/schemas/Counter' description: The counters used to count service orders (for example reservations). deprecated: true x-deprecatedMessage: Use `Counters` instead. RegistrationCardCounters: type: array items: $ref: '#/components/schemas/Counter' description: The counters used to count registration cards. deprecated: true x-deprecatedMessage: Use `Counters` instead. Cursor: type: string description: Unique identifier of the last returned counter in `Counters`. This can be used in Limitation in a subsequent request to fetch the next batch of counters. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: CounterResult MultipleBillsUpdateParameters: title: MultipleBillsUpdateParameters required: - AccessToken - BillsUpdates - 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 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 BillsUpdates: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/BillUpdateParameters' description: Information about bills to be updated. additionalProperties: false x-schema-id: MultipleBillsUpdateParameters MultipleBillingAutomationUpdateParameters: title: Multiple billing automation update parameters required: - AccessToken - BillingAutomationUpdates - 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 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 BillingAutomationUpdates: maxItems: 100 minItems: 1 type: array items: $ref: '#/components/schemas/BillingAutomationUpdateParameters' description: Details of the billing automations to be updated. additionalProperties: false x-schema-id: MultipleBillingAutomationUpdateParameters LedgerBalanceResult: title: LedgerBalanceResult required: - LedgerBalances type: object properties: LedgerBalances: type: array items: $ref: '#/components/schemas/LedgerBalance' description: The list of filtered ledger balances. nullable: true Cursor: type: string description: Unique identifier of the last and hence oldest ledger balance returned. This can be used in Limitation in a subsequent request to fetch the next batch of ledger balances. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: LedgerBalanceResult Unit: type: object additionalProperties: false ExportAddResult: title: ExportAddResult required: - Export type: object properties: Export: allOf: - $ref: '#/components/schemas/Export' description: Added export. example: string additionalProperties: false x-schema-id: ExportAddResult CounterFilterParameters: title: CounterFilterParameters 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 CounterIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the counters. If not specified, the operation returns all counters. nullable: true Type: anyOf: - $ref: '#/components/schemas/EnterpriseScopeCounterDiscriminator' description: Type of the counter. If not specified, the operation returns all types. nullable: true example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which `Counter` was updated. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: CounterFilterParameters AccountingLedgerTypeEnum: title: Accounting ledger type enum: - Revenue - Tax - Payment - Deposit - Guest - City - NonRevenue type: string description: ' Revenue Tax Payment Deposit Guest City NonRevenue' x-enumNames: - Revenue - Tax - Payment - Deposit - Guest - City - NonRevenue x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' 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. ExportAddParameters: title: ExportAddParameters required: - AccessToken - Client - ClientToken - EntityType 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 EntityType: allOf: - $ref: '#/components/schemas/ExportEntityTypeEnum' description: 'Specifies the type of entity which should be exported. OrderItem Payment Reservation Customer Company Bill AvailabilityAdjustment AvailabilityBlock ResourceBlock LedgerEntry (**Beta testing - subject to change.** See [Ledger entry type](https://docs.mews.com/connector-api/operations/_export-types#ledger-entry).)' example: string Scope: title: Export scope parameters allOf: - $ref: '#/components/schemas/ExportScopeParameters' description: Selects enterprises or chains for which the data should be exported. Which one is used depends on `EntityType`. If not specified, the export will include all enterprises or chains the client has access to. nullable: true example: string Filters: title: Export data filters allOf: - $ref: '#/components/schemas/ExportDataFilters' description: Specifies filters to apply on the exported data set. If omitted, the export will include all available data. nullable: true example: string additionalProperties: false x-schema-id: ExportAddParameters EnterpriseScopeCounterDiscriminator: title: Counter type discriminator enum: - Counter - AccountingCounter - AvailabilityBlockCounter - BillCounter - BillPreviewCounter - FiscalCounter - ProformaCounter - RegistrationCardCounter - ServiceOrderCounter - CorrectionBillCounter - PaymentConfirmationBillCounter - CreditNoteBillCounter type: string description: Type of the counter. x-enumDescriptions: - Any type of counter. - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' ExportLedgerEntryDataFilters: title: Export ledger entry data filters required: - Posting type: object properties: Posting: title: Date filter interval allOf: - $ref: '#/components/schemas/DateFilterInterval' description: Filters ledger entries by their posting date within the specified date interval, inclusive of both the start and end dates. example: string additionalProperties: false x-schema-id: ExportLedgerEntryDataFilters 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 ExportEntityTypeEnum: title: Exported entity type enum: - OrderItem - Payment - Reservation - Customer - Company - Bill - AvailabilityAdjustment - AvailabilityBlock - ResourceBlock - LedgerEntry type: string description: 'Type of exported entities OrderItem Payment Reservation Customer Company Bill AvailabilityAdjustment AvailabilityBlock ResourceBlock LedgerEntry (**Beta testing - subject to change.** See [Ledger entry type](https://docs.mews.com/connector-api/operations/_export-types#ledger-entry).)' x-enumNames: - OrderItem - Payment - Reservation - Customer - Company - Bill - AvailabilityAdjustment - AvailabilityBlock - ResourceBlock - LedgerEntry x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '**Beta testing - subject to change.** See [Ledger entry type](https://docs.mews.com/connector-api/operations/_export-types#ledger-entry).' AccountingCategory: title: Accounting category required: - CreatedUtc - EnterpriseId - Id - IsActive - Name - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the accounting category is still active. example: true Name: minLength: 1 type: string description: Name of the category. example: Example Name Code: type: string description: Code of the category within Mews. nullable: true example: string ExternalCode: type: string description: Code of the category in external systems. nullable: true example: string LedgerAccountCode: type: string description: Code of the ledger account (double entry accounting). nullable: true example: string PostingAccountCode: type: string description: Code of the posting account (double entry accounting). nullable: true example: string CostCenterCode: type: string description: Code of cost center. nullable: true example: string Classification: allOf: - $ref: '#/components/schemas/AccountingCategoryClassificationEnum' description: 'Classification of the accounting category allowing cross-enterprise reporting. Accommodation FoodAndBeverage Taxes Payments ExternalRevenue SundryIncome Wellness Sport Technology Facilities Events Tourism' nullable: true example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the accounting category in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the accounting category in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: AccountingCategory BillState: title: Bill state enum: - Open - Closed type: string description: Whether the bill is `Open` or `Closed`. 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 BillingAutomationTriggerTypeEnum: title: Billing automation trigger type enum: - Continuous - Recurring - Legacy type: string description: ' Continuous (Billing automation is continuously triggered by reservation actions, such as creation, updates, and rebates.) Recurring (Billing automation is executed monthly.) Legacy (Billing automation is executed on reservation creation only. Items added later are not transfered to any bill.)' x-enumNames: - Continuous - Recurring - Legacy x-enumDescriptions: - Billing automation is continuously triggered by reservation actions, such as creation, updates, and rebates. - Billing automation is executed monthly. - Billing automation is executed on reservation creation only. Items added later are not transfered to any bill. BillingAutomationAccountingCategoryAssignment: title: Billing automation accounting category assignment required: - AccountingCategoryId - ItemTypes type: object properties: AccountingCategoryId: type: string description: Unique identifier of the accounting category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ItemTypes: title: Accounting category routed item types allOf: - $ref: '#/components/schemas/AccountingCategoryRoutedItemTypes' description: Type of the accounting category routed item. example: string additionalProperties: false x-schema-id: BillingAutomationAccountingCategoryAssignment 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 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 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 OrderItemDataDiscriminatorEnum: title: Order item data discriminator enum: - Rebate - Product - AllowanceDiscount - AllowanceProfits type: string description: ' Rebate (Rebate.) Product (Product.) AllowanceDiscount (Allowance discount.) AllowanceProfits (Allowance profits.)' x-enumNames: - Rebate - Product - AllowanceDiscount - AllowanceProfits x-enumDescriptions: - Rebate. - Product. - Allowance discount. - Allowance profits. CancelOrderItemParameters: title: CancelOrderItemParameters required: - AccessToken - Client - ClientToken - OrderItemIds 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 OrderItemIds: maxItems: 10 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `OrderItems` to cancel. additionalProperties: false x-schema-id: CancelOrderItemParameters ActivityStates: title: Activity state enum: - Deleted - Active type: string description: Activity states used for filtering. MultipleAccountingItemsUpdateParameters: title: MultipleAccountingItemsUpdateParameters required: - AccessToken - AccountingItemUpdates - 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 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 AccountingItemUpdates: type: array items: $ref: '#/components/schemas/AccountingItemUpdateParameters' description: List of requested updates. additionalProperties: false x-schema-id: MultipleAccountingItemsUpdateParameters 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 AccountingItemParameters: title: AccountingItemParameters required: - AccessToken - Client - ClientToken - Extent 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 Extent: title: Accounting item extent allOf: - $ref: '#/components/schemas/AccountingItemExtent' description: Extent of data to be returned. E.g. it is possible to specify that together with the accounting items, credit card transactions should be also returned. example: string ItemIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Accounting items. Required if no other filter is provided. nullable: true RebatedItemIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Accounting items we are finding rebates for. Required if no other filter is provided. nullable: true ClosedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the accounting item was closed. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the accounting item was updated. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string ConsumedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the accounting item was consumed. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string Currency: type: string description: ISO-4217 code of the `Currency` the item costs should be converted to. format: currency nullable: true example: EUR States: type: array items: $ref: '#/components/schemas/AccountingState' description: States the accounting items should be in. If not specified, accounting items in `Open` or `Closed` states are returned. nullable: true additionalProperties: false x-schema-id: AccountingItemParameters securitySchemes: MewsClientToken: type: apiKey in: header name: ClientToken description: Mews authentication is performed by supplying ClientToken, AccessToken and Client as fields in the JSON request body (not as HTTP headers). This securityScheme is a tooling-compatible representation of the ClientToken credential. ClientToken is unique to your application and identifies the API client. MewsAccessToken: type: apiKey in: header name: AccessToken description: Tooling-compatible representation of the AccessToken credential, which is supplied in the JSON request body. AccessToken is unique to the connection with a property (enterprise) and identifies the property or properties whose data and services you can access. Portfolio Access Tokens enable multi-property access with a single token. servers: - url: https://api.mews.com description: Production - url: https://api.mews-demo.com description: Demo / sandbox security: - MewsClientToken: [] MewsAccessToken: [] tags: - name: Accounting categories - name: Accounting items - name: Billing automations - name: Bills - name: Counters - name: Exports - name: Ledger balances - name: Order items - name: Orders - name: Payment plans - name: Tax environments - name: Taxations