Contracts Screen
A Contract is an agreement between a client and its supplier or service provider, and is mandatory for allowing the system to communicate with an external system.
Once a contract is established between a client and a supplier, an account is created at the supplier and access credentials (or equivalent) are assigned to the client.
A Contract in HSP consists of the account information, credentials, attributes, supplier end-point configuration and other settings of the client’s account at a supplier.
In addition, the HSP Contracts management screen allows configuring advanced settings such as Dynamic Markups, commissions and available user actions.
Contracts
Contracts (or accounts) are fundamental for working with the system as they represent and define the relationship between a client and a supplier of hotels, cars, etc., or a service provider (i.e. a payment gateway).
A contract includes the client’s account with a supplier. An account is represented by unique credentials (such as a username & password). These credentials are passed with each request the system sends to a supplier and identifies the client and the specific account type at the supplier’s system.
A contract entity also includes any mandatory configuration that is required for proper communication with the supplier. For example, fields for username and password, Client ID, designated URLs, etc.
A contract can be either "Net" / "Gross" type
- Net - When a contract is set as "Net" contract - the supplier will return the "Net price" , Hence , the amount which the supplier will charge .
It is recommended to add markups in order to generate profits .(More information - under "Static markups" / "Dynamic markups" ) .
Note - you must have an obligo/CC account , may also have a payment gateway of yours (CreditCardInternal). - "Gross" - When a contract is set as "Gross" contract - the supplier will return the "Gross price" , Hence , the amount which the supplier will charge the end-client , with the respective "Commission" which the client will get by selling this rate .
Note - Either client / End customer has to pass CC to supplier when booking (CreditCardExternal).
Once a contract is created in the system it is stored in the client database.
Contracts Management
Use the Contracts management screen to search, view and manage existing contracts, and to create new contracts/accounts.
Required Permissions :
(under "Manage Company") Admin 🡪 User Permissions 🡪 Contracts section
In the Back-Office - navigate to "Contract Screen" .
The Contracts tab opens with the below default view :
View & Modify Existing Contracts
The Contracts tab allows viewing and modifying existing contracts.
To display an existing contract :
- Click on Select service and select the relevant service from the list:
- A list opens displaying the suppliers with which you already have existing contracts:
Note for Super Admins : make sure the correct client is selected in the first field.
- Click on a supplier name to display all the existing contracts with this supplier for the selected service. The existing contracts are displayed on the right hand side of the screen.
Note: if there are multiple contracts with a supplier for the selected service, use the scroll bar to browse through the contracts. - Use the available filters to display only relevant contracts .
| Field | Description |
|---|---|
| Unassigned Suppliers | It is possible to create contracts for all suppliers the system supports. By default, the system displays only suppliers with which contracts already exists. Select this box to display only suppliers with which you do not yet have contracts. |
| Production only | It is possible to create both Production and Test contracts with your suppliers. By default, the system displays all contracts types. Select this box to display only contracts that are flagged as Production i.e. contracts used for live communication with your suppliers. |
| Cacheable only | A contract can be flagged as Cacheable i.e. the data received in the supplier’s response is saved in the system’s cache for improving performance. Select this box to display only contracts that are flagged as Cacheable. |
Creating a New Contract
To create a new account (contract):
- Super Admin Users: make sure the correct client is selected in the first field
- Select a service: Cars, Hotels, Flights, Payment, Transfers, Activities
- Click the relevant supplier on the list
- Click on Create new account
- The Account screen opens on the right.
NOTE :
Only suppliers with existing contracts are displayed on the list. To create a new account with a supplier with which you do not yet have any contracts, select the filter Unassigned Suppliers to display such suppliers on the list.
Contract Screen – Fields & Configuration
Use this screen to setup and manage the contracts/accounts with your suppliers.
NOTE :
The fields may vary between different suppliers as their respective supported fields and configuration.
| Field | Description |
|---|---|
| Contract Name | A descriptive name for the contract/account. By default the system dynamically adds descriptive texts based on the contract’s configuration i.e. Supplier Name, Gross/Net, Production/Test For example: Supplier Test Gross [Cache] |
| Alias | Optional field. Alias name for the contract. |
| Description | A description for the contract. |
| Assigned to Groups | Optional field. Contracts can be added to contracts groups . |
| Subset source | Read more about subsets - properties groups specific to each Contract . |
| Production | Determines if the account is Production or Test. Selected – Production account Empty – Test account |
| Cacheable | Determines if the contract allows caching. Selected – the data received in the supplier’s response will be saved in the system’s cache Empty – the data received in the supplier’s response will not be saved in the system’s cache |
| Allow Book | Determines if the contract allows booking. Selected – the contract allows booking Empty – the contract does not allow booking Note: if the contract does not allow booking, the user will not be able to perform booking with this account and a respective error will be returned in case of such attempt. |
| Gross | Determines if the account is Gross or Net. Selected – Gross Empty – Net |
| Contract active type | Title for: No search, No cancel, No check status |
| Contract search type | Title for: POI, HotelIDs |
| Dynamic markup type | Select a respective value of dynamic markups. Relevant only if the clients that using the Dynamic Markup feature |
| User | username/APIkey as provided by the Supplier. |
| Password | password/APIKey as provided by the Supplier. |
| UseLocalizedCurrency | Determines the system logic for sending the currency in a Hotels search request. Selected – if the system can identify the currency AND the supplier supports the requested currency, the search request to the supplier will be made in the destination currency based on the existing mapping of hotels/currencies. Empty – the system will determine the currency based on the values listed in the Supported Currencies field (if exist) and/or the Default Currency field (if exists). |
| Delta | Determines the allowed delta between the initially received price and the validated price. Enter a value in decimals that represents a percentage. For example, to configure a 10% delta, type 0.10. The system will terminate the booking if the validated price is greater than the allowed Delta. Example: the price received in the search response was 100. During the booking flow, in the price validation step, the supplier updated the price to 105. Since the price difference in % is 5 and within the allowed delta, the system completes the booking. If the validated price would have been 120 (above the allowed delta), the system would have terminated the booking. |
| UseOriginalCancellationPolicy | Determines if the contract uses HSP’s CXL Policy logic or the supplier’s. Selected – the supplier’s CXL Policy will be used as is, ignoring TV’s CXL Policy setup (if any). Empty – the CXL Policy will be calculated by the system, including any system rules, markups, etc. |
| CancellationPolicyRetries | Number of cxl-policy retries is case the information is not received. |
| Service URL | Suppliers service endpoint. |
| Custom fields | Custom fields |
Updated 9 months ago