Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Billing automations
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Get all company contracts
  • Request
  • Response
  • Add company contracts
  • Request
  • Response
  • Update company contracts
  • Request
  • Response
  • Delete company contracts
  • Request
  • Response

Was this helpful?

  1. API Operations

Company contracts

PreviousCompanionshipsNextConfiguration

Last updated 1 month ago

Was this helpful?

Get all company contracts

Returns all contracts between the enterprise and other companies. Note this operation uses and supports .

Request

[PlatformAddress]/api/connector/v1/companyContracts/getAll

{
    "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 }
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

EnterpriseIds

array of string

optional, max 1000 items

CompanyContractIds

array of string

optional, max 1000 items

Unique identifier of the Travel agency contract to fetch.

CompanyIds

array of string

optional, max 1000 items

ServiceIds

array of string

optional, max 1000 items

UpdatedUtc

optional, max length 3 months

ActivityStates

optional

Whether to return only active, only deleted or both records.

Limitation

required

Limitation on the quantity of data returned.

Response

{
    "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": null,
            "Commission": null,
            "ChannelManagerAbsoluteAdjustment": null,
            "ChannelManagerRelativeAdjustment": null,
            "Options": {
                "IncludeCancellationFeeInCommissionEstimate": false,
                "SkipAutomaticSettlement": false
            },
            "AccountingCode": null,
            "InvoiceDueInterval": null,
            "ChannelManagerBusinessSegmentId": null,
            "ContactPerson": null,
            "ContactEmail": null,
            "AdditionalContactInfo": null,
            "Notes": null
        }
    ],
    "Cursor": "0078f370-3787-43dc-a615-af150066bb88"
}
Property
Type
Contract
Description

TravelAgencyContracts

required

The travel agency contracts.

Cursor

string

optional

Travel agency contract

Property
Type
Contract
Description

Id

string

required

Unique identifier of the contract.

ServiceId

string

required

CompanyId

string

required

CreatedUtc

string

required

Creation date and time of the travel agency contract in UTC timezone in ISO 8601 format.

UpdatedUtc

string

required

Last update date and time of the travel agency contract in UTC timezone in ISO 8601 format.

IsActive

boolean

required

Whether the contract is still active.

CommissionIncluded

boolean

optional

Whether commission of the travel agency is included in the rate. When CommissionIncluded is not provided in the response, that means commission is unspecified, when set to true it means the the commission is included in the rate and false means the commission in not included in the rate.

Commission

number

optional

Commission of the travel agency.

ChannelManagerAbsoluteAdjustment

number

optional

Flat fee added to (or subtracted from) the reservation price when coming from Channel Managers.

ChannelManagerRelativeAdjustment

number

optional

Percentage of the reservation price added to (or subtracted from) price when coming from Channel Managers.

Options

required

Options of the travel agency contract.

AccountingCode

string

optional

Accounting code of the travel agency contract.

InvoiceDueInterval

string

optional

The maximum time, when the invoice has to be be paid in ISO 8601 duration format.

ChannelManagerBusinessSegmentId

string

optional

ContactPerson

string

optional

Contact person of the travel agency.

ContactEmail

string

optional

Contact email of the travel agency.

AdditionalContactInfo

string

optional

Additional contact info of the travel agency.

Notes

string

optional

Additional notes of the travel agency contract.

Travel agency contract options

Property
Type
Contract
Description

IncludeCancellationFeeInCommissionEstimate

boolean

required

Cancellation fee will be considered when calculating the travel agency commission estimate.

SkipAutomaticSettlement

boolean

required

Reservations from travel agencies will not be automatically charged.

Add company contracts

Adds one or more company contracts.

Request

[PlatformAddress]/api/connector/v1/companyContracts/add

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "TravelAgencyContracts": [
        {
            "ServiceId": "c8f88563-dc60-47f3-aca3-af150065d951",
            "CompanyId": "896e9313-477d-4306-9d37-af150065f4d6",
            "CommissionIncluded": true,
            "Commission": 0.1,
            "ChannelManagerAbsoluteAdjustment": 10,
            "ChannelManagerRelativeAdjustment": 0.15,
            "Options": {
                "IncludeCancellationFeeInCommissionEstimate": false,
                "SkipAutomaticSettlement": false
            },
            "AccountingCode": "P2DT23H",
            "InvoiceDueInterval": "P0M15DT0H0M0S",
            "ChannelManagerBusinessSegmentId": "1289d3c8-3c83-4169-b756-af150066bb87",
            "ContactPerson": "Sample person",
            "ContactEmail": "sample-person@email.com",
            "AdditionalContactInfo": null,
            "Notes": null
        }
    ]
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

TravelAgencyContracts

required

Information about travel agency contracts to be created.

Travel agency contract parameters

Property
Type
Contract
Description

ServiceId

string

required

CompanyId

string

required

CommissionIncluded

boolean

optional

Whether commission of the travel agency is included in the rate.

Commission

number

optional

Commission of the travel agency. Value must be between 0 and 1.

ChannelManagerAbsoluteAdjustment

number

optional

Flat fee added to (or subtracted from) the reservation price when coming from Channel Managers.

ChannelManagerRelativeAdjustment

number

optional

Percentage of the reservation price added to (or subtracted from) price when coming from Channel Managers. Value must be between -1 and 1.

Options

required

Options of the travel agency contract.

AccountingCode

string

optional

Accounting code of the travel agency contract.

InvoiceDueInterval

string

optional

The maximum time, when the invoice has to be be paid in ISO 8601 duration format.

ChannelManagerBusinessSegmentId

string

optional

ContactPerson

string

optional

Contact person of the travel agency.

ContactEmail

string

optional

Contact email of the travel agency.

AdditionalContactInfo

string

optional

Additional contact info of the travel agency.

Notes

string

optional

Additional notes of the travel agency contract.

Response

{
    "TravelAgencyContracts": [
        {
            "Id": "0078f370-3787-43dc-a615-af150066bb88",
            "ServiceId": "c8f88563-dc60-47f3-aca3-af150065d951",
            "CompanyId": "896e9313-477d-4306-9d37-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": false,
                "SkipAutomaticSettlement": false
            },
            "AccountingCode": "P2DT23H",
            "InvoiceDueInterval": "P0M15DT0H0M0S",
            "ChannelManagerBusinessSegmentId": "1289d3c8-3c83-4169-b756-af150066bb87",
            "ContactPerson": "Sample person",
            "ContactEmail": "sample-person@email.com",
            "AdditionalContactInfo": null,
            "Notes": null
        }
    ]
}
Property
Type
Contract
Description

TravelAgencyContracts

required

The added travel agency contracts.

Update company contracts

Updates one or more company contracts.

Request

[PlatformAddress]/api/connector/v1/companyContracts/update

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "TravelAgencyContractUpdates": [
    {
        "TravelAgencyContractId": "652d4a22-ac33-42b7-abe7-af1f00820023",
        "CommissionIncluded": { "Value": true },
        "Commission": { "Value" : 0.1 },
        "ChannelManagerAbsoluteAdjustment": { "Value": 10 },
        "ChannelManagerRelativeAdjustment": { "Value": 0.15 },
        "Options": {
            "IncludeCancellationFeeInCommissionEstimate": { "Value": true },
            "SkipAutomaticSettlement": { "Value": true }
        },
        "AccountingCode": { "Value": "P2DT23H" },
        "InvoiceDueInterval": { "Value": "P0M15DT0H0M0S" },
        "ChannelManagerBusinessSegmentId": { "Value": "1289D3C8-3C83-4169-B756-AF150066BB87" },
        "ContactPerson": { "Value": "Sample person" },
        "ContactEmail": { "Value": "sample-person@email.com" },
        "AdditionalContactInfo": null,
        "Notes": null
    }
  ]
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

TravelAgencyContractUpdates

required

Information about travel agency contracts to be updated.

Travel agency contract update parameters

Property
Type
Contract
Description

TravelAgencyContractId

string

required

Unique identifier of the Travel agency contract.

CommissionIncluded

optional

Whether commission of the travel agency is included in the rate.

Commission

optional

Commission of the travel agency.

ChannelManagerAbsoluteAdjustment

optional

Flat fee added to (or subtracted from) the reservation price when coming from Channel Managers.

ChannelManagerRelativeAdjustment

optional

Percentage of the reservation price added to (or subtracted from) price when coming from Channel Managers.

Options

optional

Options of the travel agency contract.

AccountingCode

optional

Accounting code of the travel agency contract.

InvoiceDueInterval

optional

The maximum time, when the invoice has to be be paid in ISO 8601 duration format.

ChannelManagerBusinessSegmentId

optional

ContactPerson

optional

Contact person of the travel agency.

ContactEmail

optional

Contact email of the travel agency.

AdditionalContactInfo

optional

Additional contact info of the travel agency.

Notes

optional

Additional notes of the travel agency contract.

Travel agency contract update options

Property
Type
Contract
Description

IncludeCancellationFeeInCommissionEstimate

required

Cancellation fee will be considered when calculating the travel agency commission estimate.

SkipAutomaticSettlement

required

Reservations from travel agencies will not be automatically charged.

Response

{
    "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
        }
    ]
}
Property
Type
Contract
Description

TravelAgencyContracts

required

The updated travel agency contracts.

Delete company contracts

Request

[PlatformAddress]/api/connector/v1/companyContracts/delete

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "TravelAgencyContractIds": [
        "0078f370-3787-43dc-a615-af150066bb88",
        "652d4a22-ac33-42b7-abe7-af1f00820023"
    ],
    "ServiceIds":
    [
        "a1d6dee8-355b-44c3-b6be-faef1a7eb6c0",
        "d5a2aac3-5194-479b-ba05-6c073398e0fd"
    ]
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

EnterpriseId

string

required

TravelAgencyContractIds

array of string

required, max 1000 items

Unique identifiers of the Travel agency contract to delete.

ServiceIds

array of string

required, max 1000 items

Response

{}

Unique identifiers of the . If not specified, the operation returns data for all enterprises within scope of the Access Token.

Unique identifiers of assigned with Travel agency contracts.

Unique identifiers of where the Travel agency contract belong to.

Interval in which was updated.

array of

array of

Unique identifier of the last and hence oldest contract returned. This can be used in in a subsequent request to fetch the next batch of older messages.

Unique identifier of the the contract is related to.

Unique identifier of the contracted .

Unique identifier of the used for incoming reservations originating from Channel Managers, for this particular contract.

array of

Unique identifier of the the travel agency contract is created to.

Unique identifier of the the travel agency contract is issued to.

Unique identifier of the used for incoming reservations originating from Channel Managers, for this particular contract.

array of

array of

Unique identifier of the used for incoming reservations originating from Channel Managers, for this particular contract.

array of

Deletes one or more company contracts. Note this operation supports .

Unique identifier of the .

Unique identifiers of the the travel agency contract belongs to.

Pagination
Portfolio Access Tokens
Portfolio Access Tokens
Travel agency contract
Travel agency contract
Travel agency contract options
Travel agency contract parameters
Travel agency contract options
Travel agency contract
Travel agency contract update parameters
Travel agency contract update options
Travel agency contract
Limitation
Limitation
Enterprises
Enterprise
Time interval
Activity state
Bool update value
Number update value
Number update value
Number update value
String update value
String update value
String update value
String update value
String update value
String update value
String update value
Bool update value
Bool update value
Services
Service
Service
Service
Business segment
Business segment
Business segment
Companies
Company
Company