Company contracts
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all contracts between the enterprise and other companies. Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/companyContracts/getAll
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.
TravelAgencyContracts
required
The travel agency contracts.
Cursor
string
optional
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.
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.
Adds one or more company contracts.
[PlatformAddress]/api/connector/v1/companyContracts/add
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.
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.
TravelAgencyContracts
required
The added travel agency contracts.
Updates one or more company contracts.
[PlatformAddress]/api/connector/v1/companyContracts/update
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.
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.
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.
TravelAgencyContracts
required
The updated travel agency contracts.
[PlatformAddress]/api/connector/v1/companyContracts/delete
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
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.