Add company contracts
POST /api/connector/v1/companyContracts/add
Adds one or more company contracts.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Information about travel agency contracts to be created.
object
Options of the travel agency contract.
object
Example
{ "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 } ]}Responses
Section titled “ Responses ”OK
object
The updated travel agency contracts.
object
Unique identifier of the contract.
Unique identifier of the Service the contract is related to.
Unique identifier of the contracted Company.
Whether the contract is still active.
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 of the travel agency.
Flat fee added to (or subtracted from) the reservation price when coming from Channel Managers.
Percentage of the reservation price added to (or subtracted from) price when coming from Channel Managers.
Options of the travel agency contract.
object
Accounting code of the travel agency contract.
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
Contact person of the travel agency.
Contact email of the travel agency.
Additional contact info of the travel agency.
Additional notes of the travel agency contract.
Creation date and time of the travel agency contract in UTC timezone in ISO 8601 format.
Last update date and time of the travel agency contract in UTC timezone in ISO 8601 format.
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.
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.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.