Skip to content

Update company contracts

POST
/api/connector/v1/companyContracts/update

Updates one or more company contracts.

MultipleCompanyContractUpdateParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
TravelAgencyContractUpdates
required

Information about travel agency contracts to be updated.

Array<object>
>= 1 items <= 1000 items
TravelAgencyContractUpdateParameters
object
TravelAgencyContractId
required
string format: uuid
CommissionIncluded
Boolean update value
object
Value

Value which is to be updated.

boolean
nullable
Commission
Decimal update value
object
Value

Value which is to be updated.

number format: double
nullable
ChannelManagerBusinessSegmentId
Guid update value
object
Value

Value which is to be updated.

string format: uuid
nullable
ChannelManagerAbsoluteAdjustment
Decimal update value
object
Value

Value which is to be updated.

number format: double
nullable
ChannelManagerRelativeAdjustment
Decimal update value
object
Value

Value which is to be updated.

number format: double
nullable
Options
TravelAgencyContractOptionsParameters
object
IncludeCancellationFeeInCommissionEstimate
Boolean update value
object
Value

Value which is to be updated.

boolean
SkipAutomaticSettlement
Boolean update value
object
Value

Value which is to be updated.

boolean
AccountingCode
String update value
object
Value

Value which is to be updated.

string
nullable
InvoiceDueInterval
String update value
object
Value

Value which is to be updated.

string
nullable
ContactPerson
String update value
object
Value

Value which is to be updated.

string
nullable
ContactEmail
String update value
object
Value

Value which is to be updated.

string
nullable
AdditionalContactInfo
String update value
object
Value

Value which is to be updated.

string
nullable
Notes
String update value
object
Value

Value which is to be updated.

string
nullable
Example
{
"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
}
]
}

OK

ContractResult
object
TravelAgencyContracts
required

The updated travel agency contracts.

Array<object>
Travel agency contract
object
Id
required

Unique identifier of the contract.

string format: uuid
ServiceId
required

Unique identifier of the Service the contract is related to.

string format: uuid
CompanyId
required

Unique identifier of the contracted Company.

string format: uuid
IsActive
required

Whether the contract is still active.

boolean
CommissionIncluded

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.

boolean
nullable
Commission

Commission of the travel agency.

number format: double
nullable
ChannelManagerAbsoluteAdjustment

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

number format: double
nullable
ChannelManagerRelativeAdjustment

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

number format: double
nullable
Options
TravelAgencyContractOptions

Options of the travel agency contract.

object
IncludeCancellationFeeInCommissionEstimate
boolean
SkipAutomaticSettlement
boolean
AccountingCode

Accounting code of the travel agency contract.

string
nullable
InvoiceDueInterval

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

string
nullable
ChannelManagerBusinessSegmentId
string format: uuid
nullable
ContactPerson

Contact person of the travel agency.

string
nullable
ContactEmail

Contact email of the travel agency.

string format: email
nullable
AdditionalContactInfo

Additional contact info of the travel agency.

string
nullable
Notes

Additional notes of the travel agency contract.

string
nullable
CreatedUtc
required

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

string format: date-time
>= 1 characters
UpdatedUtc
required

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

string format: date-time
>= 1 characters
Cursor

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

string format: uuid
nullable
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
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable