Mews · Example Payload

Mews Billingautomations Add Example

HospitalityHotelsPMSProperty Management

Mews Billingautomations Add Example is an example object payload from Mews, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "billingAutomations_add",
  "method": "POST",
  "path": "/api/connector/v1/billingAutomations/add",
  "summary": "Add billing automations",
  "requestExamples": [
    {
      "contentType": "application/json",
      "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"
                ]
              }
            ]
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "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": null,
            "OrderItemConsumptionPeriod": null,
            "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
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}