Mews · Example Payload

Mews Companycontracts Getall Example

HospitalityHotelsPMSProperty Management

Mews Companycontracts Getall 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": "companyContracts_getAll",
  "method": "POST",
  "path": "/api/connector/v1/companyContracts/getAll",
  "summary": "Get all company contracts",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
        "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
        "Client": "Sample Client 1.0.0",
        "CompanyContractIds": [
          "3396f6f3-6733-443b-92e0-b2a0009a05a7"
        ],
        "CompanyIds": [
          "bfd5667b-533f-424f-860d-af150065f4d6"
        ],
        "ServiceIds": [
          "c8f88563-dc60-47f3-aca3-af150065d951"
        ],
        "UpdatedUtc": {
          "StartUtc": "2023-10-01T00:00:00Z",
          "EndUtc": "2023-10-31T00:00:00Z"
        },
        "ActivityStates": [
          "Active",
          "Deleted"
        ],
        "EnterpriseIds": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "4d0201db-36f5-428b-8d11-4f0a65e960cc"
        ],
        "Limitation": {
          "Count": 10
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "TravelAgencyContracts": [
          {
            "Id": "0078f370-3787-43dc-a615-af150066bb88",
            "ServiceId": "c8f88563-dc60-47f3-aca3-af150065d951",
            "CompanyId": "bfd5667b-533f-424f-860d-af150065f4d6",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "IsActive": true,
            "CommissionIncluded": true,
            "Commission": 0.1,
            "ChannelManagerAbsoluteAdjustment": 10,
            "ChannelManagerRelativeAdjustment": 0.15,
            "Options": {
              "IncludeCancellationFeeInCommissionEstimate": true,
              "SkipAutomaticSettlement": true
            },
            "AccountingCode": "P2DT23H",
            "InvoiceDueInterval": "P0M15DT0H0M0S",
            "ChannelManagerBusinessSegmentId": "1289d3c8-3c83-4169-b756-af150066bb87",
            "ContactPerson": "Sample person",
            "ContactEmail": "sample-person@email.com",
            "AdditionalContactInfo": null,
            "Notes": null
          }
        ]
      }
    }
  ]
}