--- title: "Get all company contracts" method: POST path: "/api/connector/v1/companyContracts/getAll" tags: ["Company contracts"] --- # Get all company contracts `POST /api/connector/v1/companyContracts/getAll` Returns all contracts between the enterprise and other companies. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). ## Request body - CompanyContractFilterParameters - `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. - `Limitation` Limitation, required — Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable - `EnterpriseIds` string[], nullable — Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. - `CompanyContractIds` string[], nullable — Unique identifier of the Travel agency contracts to fetch. - `CompanyIds` string[], nullable — Unique identifiers of `Company` assigned with Travel agency contracts. - `ServiceIds` string[], nullable — Unique identifiers of `Service` where the Travel agency contracts belong to. - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `ActivityStates` ActivityStates[], nullable — Whether to return only active, only deleted or both records. ## Response `200` OK - ContractResult - `TravelAgencyContracts` TravelAgencyContract[], required — The travel agency contracts. - `Id` string, uuid, required — Unique identifier of the contract. - `ServiceId` string, uuid, required — Unique identifier of the `Service` the contract is related to. - `CompanyId` string, uuid, required — Unique identifier of the contracted `Company`. - `IsActive` boolean, required — Whether the contract is still active. - `CommissionIncluded` boolean, nullable — 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, double, nullable — Commission of the travel agency. - `ChannelManagerAbsoluteAdjustment` number, double, nullable — Flat fee added to (or subtracted from) the reservation price when coming from Channel Managers. - `ChannelManagerRelativeAdjustment` number, double, nullable — Percentage of the reservation price added to (or subtracted from) price when coming from Channel Managers. - `Options` TravelAgencyContractOptions, required - `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. - `AccountingCode` string, nullable — Accounting code of the travel agency contract. - `InvoiceDueInterval` string, nullable — The maximum time, when the invoice has to be be paid in ISO 8601 duration format. - `ChannelManagerBusinessSegmentId` string, uuid, nullable — Unique identifier of the `BusinessSegment` used for incoming reservations originating from Channel Managers, for this particular contract. - `ContactPerson` string, nullable — Contact person of the travel agency. - `ContactEmail` string, email, nullable — Contact email of the travel agency. - `AdditionalContactInfo` string, nullable — Additional contact info of the travel agency. - `Notes` string, nullable — Additional notes of the travel agency contract. - `CreatedUtc` string, date-time, required — Creation date and time of the travel agency contract in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the travel agency contract in UTC timezone in ISO 8601 format. - `Cursor` string, uuid, nullable — 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. ## Other responses - `204` — Server has successfully fulfilled the request and there is no additional information to send back. - `400` — 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). - `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. - `403` — 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. - `408` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) - `429` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). - `500` — 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](https://github.com/MewsSystems/gitbook-connector-api). --- [API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/f37f136ed35a/schema)