Company contracts
Get all company contracts
Returns all contracts between the enterprise and other companies. Note this operation uses Pagination and supports Portfolio Access Tokens.
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
}
}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
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
CompanyContractIds
array of string
optional, max 1000 items
Unique identifier of the Travel agency contracts to fetch.
CompanyIds
array of string
optional, max 1000 items
Unique identifiers of Company assigned with Travel agency contracts.
ServiceIds
array of string
optional, max 1000 items
Unique identifiers of Service where the Travel agency contracts belong to.
UpdatedUtc
optional, max length 3 months
Interval in which the Travel agency contracts were updated.
ActivityStates
array of Activity state
optional
Whether to return only active, only deleted or both records.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
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
}
]
}Cursor
string
optional
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.
Travel agency contract
Id
string
required
Unique identifier of the contract.
ServiceId
string
required
Unique identifier of the Service the contract is related to.
CompanyId
string
required
Unique identifier of the contracted Company.
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.
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
Unique identifier of the BusinessSegment used for incoming reservations originating from Channel Managers, for this particular contract.
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.
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.
Travel agency contract options
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
}
]
}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
array of Travel agency contract parameters
required, max 1000 items
Information about travel agency contracts to be created.
Travel agency contract parameters
ServiceId
string
required
Unique identifier of the Service the travel agency contract is created to.
CompanyId
string
required
Unique identifier of the Company the travel agency contract is issued to.
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.
ChannelManagerBusinessSegmentId
string
optional
Unique identifier of the BusinessSegment used for incoming reservations originating from Channel Managers, for this particular contract.
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.
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.
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": "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
}
]
}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
}
]
}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, max 1000 items
Information about travel agency contracts to be updated.
Travel agency contract update parameters
TravelAgencyContractId
string
required
Unique identifier of the Travel agency contract.
CommissionIncluded
optional
Whether commission of the travel agency is included in the rate.
ChannelManagerBusinessSegmentId
optional
Unique identifier of the BusinessSegment used for incoming reservations originating from Channel Managers, for this particular contract.
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.
InvoiceDueInterval
optional
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
Travel agency contract update options
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
}
]
}Delete company contracts
Deletes one or more company contracts. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/companyContracts/delete
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"TravelAgencyContractIds": [
"0078f370-3787-43dc-a615-af150066bb88",
"652d4a22-ac33-42b7-abe7-af1f00820023"
],
"ServiceIds": [
"a1d6dee8-355b-44c3-b6be-faef1a7eb6c0",
"d5a2aac3-5194-479b-ba05-6c073398e0fd"
]
}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
optional
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
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 Service the travel agency contract belongs to.
Response
{}Last updated
Was this helpful?