Policy API (v2)

Download OpenAPI specification:Download

Company Policies

APIs to configure company travel policies.

Create policy

This endpoint creates a policy.

SecurityBearer

Request

path Parameters

companyId

required

string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947

Request Body schema: application/json

name required	string Name of the policy.
type required	string (PolicyType) Policy type. Enum: "DEFAULT" "GROUP" "INTERNAL"
parentPolicyId	string <uuid> Policy to inherit the values of linked rules. If empty, consider the company default policy.
required	CurrencyCodeWrapper (object) or IsLinkedWrapper (object) (PolicyCurrency)
	object (PolicyApprovalInfo) Deprecated
	object (PolicyApprovalInfo) Deprecated
	Array of objects (PolicyApprovalInfo)
	Array of objects (PolicyApprovalInfo)
required	Array of objects (UserGroup)
	object (CommonPolicyRules) Details of policy that is common to all travel type.
	object (CarPolicyRules) Details of rules related to car.
	object (HotelPolicyRules) Details of rules related to hotel.
	object (AirPolicyRules) Details of rules related to air.
isRestrictive	boolean Deprecated True if policy is a restrictive policy.
	Array of objects (UniversalRule) A list of general policy rules for all travel types air, hotel, car and rail.
	OopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object) (OopReasonCodes)
	OopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object) (OopReasonCodes)
	OopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object) (OopReasonCodes)
	OopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object) (OopReasonCodes)
category	string (PolicyCategory) Default: "EMPLOYEE" Category of the policy. Enum: "EMPLOYEE" "GUEST"

Responses

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/companies/{companyId}/policies

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"name": "string",
"type": "GROUP",
"parentPolicyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
"currency": {"currencyCode": "USD"
},
"inPolicyApprovalInfo": {"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": "DOMESTIC"
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"outOfPolicyApprovalInfo": {"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": "DOMESTIC"
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"inPolicyApprovalInfos": [{"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": null
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"outOfPolicyApprovalInfos": [{"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": null
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"userGroups": [{"userIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"legalEntityIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"officeIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": ["string"
],
"costCenters": ["string"
],
"grades": ["string"
],
"positionTitles": ["string"
],
"personas": ["EMPLOYEE"
],
"customFieldIds": [{"type": "QUESTION",
"externalId": "string"
}
],
"countryCodes": ["GB"
],
"workerTypes": ["EMPLOYEE"
],
"accountingCodes": ["string"
]
}
],
"commonPolicyRules": {"restrictedContinents": {"isLinked": true
},
"restrictedCountries": {"isLinked": true
}
},
"carPolicyRules": {"maxCarPricePerNumberOfDays": {"isLinked": true
},
"allowedCarTypes": {"isLinked": true
}
},
"hotelPolicyRules": {"restrictedHotels": {"isLinked": true
},
"maxHotelPriceByLocation": {"isLinked": true
},
"hotelAdvanceBookingWindow": {"isLinked": true
},
"hotelCancellation": {"isLinked": true
},
"hotelChainCodes": {"isLinked": true
},
"hotelStarRating": {"isLinked": true
},
"hotelMedianRateNightly": {"isLinked": true
}
},
"airPolicyRules": {"restrictedAirlines": {"isLinked": true
},
"restrictedAirCrafts": {"isLinked": true
},
"maxFlightBookingPriceByDuration": {"isLinked": true
},
"flightCabinUpgrade": {"isLinked": true
},
"flightAdvanceBookingWindow": {"isLinked": true
},
"flightTicketsRefundable": {"isLinked": true
},
"flightTicketsChangeable": {"isLinked": true
},
"highestFlightCabinByDurationDomestic": {"isLinked": true
},
"highestFlightCabinByDurationInternational": {"isLinked": true
},
"highestFlightCabinOvernight": {"isLinked": true
},
"differenceBetweenFlightFareAndMedianFare": {"isLinked": true
},
"co2EmissionPerPassengerPerKm": {"isLinked": true
},
"maxFlightBookingPriceInternational": {"isLinked": true
},
"maxFlightBookingPriceDomestic": {"isLinked": true
},
"lowestLogicalFare": {"isLinked": true
}
},
"isRestrictive": true,
"rules": [{"ruleType": "CAR_TYPES_NOT_ALLOWED",
"action": {"preventBooking": {"prevent": false,
"reason": "string"
}
},
"policyValue": {"isLinked": true
}
}
],
"airOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"hotelOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"carOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"railOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"category": "EMPLOYEE"
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

List company policies

This endpoint list company policies.

SecurityBearer

Request

path Parameters

companyId

required

string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947

query Parameters

Get policy

This endpoint gets a policy by ID.

SecurityBearer

Request

path Parameters

companyId required	string <uuid> Identifier for company. Example: 4974a66b-7493-4f41-908c-58ba81093947
policyId required	string <uuid> Identifier for policy. Example: 4974a66b-7493-4f41-908c-58ba81093947

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/policies/{policyId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": "4974a66b-7493-4f41-908c-58ba81093947",
"version": 0,
"updatedAt": {"iso8601": "2017-07-21T17:32Z"
},
"isMembershipViaHrFeed": true,
"hrFeedPolicyDetails": {"totalMemberCount": 0
},
"name": "string",
"type": "GROUP",
"parentPolicyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
"currency": {"currencyCode": "USD"
},
"inPolicyApprovalInfo": {"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": "DOMESTIC"
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"outOfPolicyApprovalInfo": {"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": "DOMESTIC"
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"inPolicyApprovalInfos": [{"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": null
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"outOfPolicyApprovalInfos": [{"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": null
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"userGroups": [{"userIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"legalEntityIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"officeIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": ["string"
],
"costCenters": ["string"
],
"grades": ["string"
],
"positionTitles": ["string"
],
"personas": ["EMPLOYEE"
],
"customFieldIds": [{"type": "QUESTION",
"externalId": "string"
}
],
"countryCodes": ["GB"
],
"workerTypes": ["EMPLOYEE"
],
"accountingCodes": ["string"
]
}
],
"commonPolicyRules": {"restrictedContinents": {"isLinked": true
},
"restrictedCountries": {"isLinked": true
}
},
"carPolicyRules": {"maxCarPricePerNumberOfDays": {"isLinked": true
},
"allowedCarTypes": {"isLinked": true
}
},
"hotelPolicyRules": {"restrictedHotels": {"isLinked": true
},
"maxHotelPriceByLocation": {"isLinked": true
},
"hotelAdvanceBookingWindow": {"isLinked": true
},
"hotelCancellation": {"isLinked": true
},
"hotelChainCodes": {"isLinked": true
},
"hotelStarRating": {"isLinked": true
},
"hotelMedianRateNightly": {"isLinked": true
}
},
"airPolicyRules": {"restrictedAirlines": {"isLinked": true
},
"restrictedAirCrafts": {"isLinked": true
},
"maxFlightBookingPriceByDuration": {"isLinked": true
},
"flightCabinUpgrade": {"isLinked": true
},
"flightAdvanceBookingWindow": {"isLinked": true
},
"flightTicketsRefundable": {"isLinked": true
},
"flightTicketsChangeable": {"isLinked": true
},
"highestFlightCabinByDurationDomestic": {"isLinked": true
},
"highestFlightCabinByDurationInternational": {"isLinked": true
},
"highestFlightCabinOvernight": {"isLinked": true
},
"differenceBetweenFlightFareAndMedianFare": {"isLinked": true
},
"co2EmissionPerPassengerPerKm": {"isLinked": true
},
"maxFlightBookingPriceInternational": {"isLinked": true
},
"maxFlightBookingPriceDomestic": {"isLinked": true
},
"lowestLogicalFare": {"isLinked": true
}
},
"isRestrictive": true,
"rules": [{"ruleType": "CAR_TYPES_NOT_ALLOWED",
"action": {"preventBooking": {"prevent": false,
"reason": "string"
}
},
"policyValue": {"isLinked": true
}
}
],
"airOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"hotelOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"carOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"railOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"category": "EMPLOYEE"
}

Update policy

This endpoint updates a policy by ID.

SecurityBearer

Request

path Parameters

companyId required	string <uuid> Identifier for company. Example: 4974a66b-7493-4f41-908c-58ba81093947
policyId required	string <uuid> Identifier for policy. Example: 4974a66b-7493-4f41-908c-58ba81093947

Request Body schema: application/json

id required	string <uuid>
version	integer <int32>
	object (DateTimeOffset) ISO8601 UTC Date Time
isMembershipViaHrFeed	boolean True if membership is via HR feed. Read-only.
	object (HrFeedPolicyDetails) User group details if membership is via HR feed. Read-only.
name required	string Name of the policy.
type required	string (PolicyType) Policy type. Enum: "DEFAULT" "GROUP" "INTERNAL"
parentPolicyId	string <uuid> Policy to inherit the values of linked rules. If empty, consider the company default policy.
required	CurrencyCodeWrapper (object) or IsLinkedWrapper (object) (PolicyCurrency)
	object (PolicyApprovalInfo) Deprecated
	object (PolicyApprovalInfo) Deprecated
	Array of objects (PolicyApprovalInfo)
	Array of objects (PolicyApprovalInfo)
required	Array of objects (UserGroup)
	object (CommonPolicyRules) Details of policy that is common to all travel type.
	object (CarPolicyRules) Details of rules related to car.
	object (HotelPolicyRules) Details of rules related to hotel.
	object (AirPolicyRules) Details of rules related to air.
isRestrictive	boolean Deprecated True if policy is a restrictive policy.
	Array of objects (UniversalRule) A list of general policy rules for all travel types air, hotel, car and rail.
	OopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object) (OopReasonCodes)
	OopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object) (OopReasonCodes)
	OopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object) (OopReasonCodes)
	OopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object) (OopReasonCodes)
category	string (PolicyCategory) Default: "EMPLOYEE" Category of the policy. Enum: "EMPLOYEE" "GUEST"

Responses

204

Updated Successfully

400

Bad request

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/policies/{policyId}

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"id": "4974a66b-7493-4f41-908c-58ba81093947",
"version": 0,
"updatedAt": {"iso8601": "2017-07-21T17:32Z"
},
"isMembershipViaHrFeed": true,
"hrFeedPolicyDetails": {"totalMemberCount": 0
},
"name": "string",
"type": "GROUP",
"parentPolicyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
"currency": {"currencyCode": "USD"
},
"inPolicyApprovalInfo": {"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": "DOMESTIC"
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"outOfPolicyApprovalInfo": {"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": "DOMESTIC"
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"inPolicyApprovalInfos": [{"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": null
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"outOfPolicyApprovalInfos": [{"approvalProcessType": "NONE",
"designatedApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"isManagerApprover": false,
"isEmployeeLevelDesignatedApprover": false,
"shouldNotifyManager": false,
"travelTypes": ["AIR"
],
"approvalConditions": [{"rules": [{"travelRegionRule": {"travelRegionType": null
}
}
]
}
],
"defaultApprovers": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"userGroups": [{"userIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"legalEntityIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"officeIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": ["string"
],
"costCenters": ["string"
],
"grades": ["string"
],
"positionTitles": ["string"
],
"personas": ["EMPLOYEE"
],
"customFieldIds": [{"type": "QUESTION",
"externalId": "string"
}
],
"countryCodes": ["GB"
],
"workerTypes": ["EMPLOYEE"
],
"accountingCodes": ["string"
]
}
],
"commonPolicyRules": {"restrictedContinents": {"isLinked": true
},
"restrictedCountries": {"isLinked": true
}
},
"carPolicyRules": {"maxCarPricePerNumberOfDays": {"isLinked": true
},
"allowedCarTypes": {"isLinked": true
}
},
"hotelPolicyRules": {"restrictedHotels": {"isLinked": true
},
"maxHotelPriceByLocation": {"isLinked": true
},
"hotelAdvanceBookingWindow": {"isLinked": true
},
"hotelCancellation": {"isLinked": true
},
"hotelChainCodes": {"isLinked": true
},
"hotelStarRating": {"isLinked": true
},
"hotelMedianRateNightly": {"isLinked": true
}
},
"airPolicyRules": {"restrictedAirlines": {"isLinked": true
},
"restrictedAirCrafts": {"isLinked": true
},
"maxFlightBookingPriceByDuration": {"isLinked": true
},
"flightCabinUpgrade": {"isLinked": true
},
"flightAdvanceBookingWindow": {"isLinked": true
},
"flightTicketsRefundable": {"isLinked": true
},
"flightTicketsChangeable": {"isLinked": true
},
"highestFlightCabinByDurationDomestic": {"isLinked": true
},
"highestFlightCabinByDurationInternational": {"isLinked": true
},
"highestFlightCabinOvernight": {"isLinked": true
},
"differenceBetweenFlightFareAndMedianFare": {"isLinked": true
},
"co2EmissionPerPassengerPerKm": {"isLinked": true
},
"maxFlightBookingPriceInternational": {"isLinked": true
},
"maxFlightBookingPriceDomestic": {"isLinked": true
},
"lowestLogicalFare": {"isLinked": true
}
},
"isRestrictive": true,
"rules": [{"ruleType": "CAR_TYPES_NOT_ALLOWED",
"action": {"preventBooking": {"prevent": false,
"reason": "string"
}
},
"policyValue": {"isLinked": true
}
}
],
"airOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"hotelOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"carOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"railOopReasonCodes": {"props": {"reasonCodes": [{"entityId": "string",
"displayInfo": "string",
"questionFormat": "CHECKBOX",
"options": [{"displayCode": "string",
"displayValue": "string"
}
],
"isRequired": true,
"isDisabled": true
}
]
}
},
"category": "EMPLOYEE"
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Delete policy

This endpoint deletes a policy by ID.

SecurityBearer

Request

path Parameters

companyId required	string <uuid> Identifier for company. Example: 4974a66b-7493-4f41-908c-58ba81093947
policyId required	string <uuid> Identifier for policy. Example: 4974a66b-7493-4f41-908c-58ba81093947

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/v2/companies/{companyId}/policies/{policyId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Custom Fields

APIs to manage company custom fields.

Get company questions

SecurityBearer

Request

path Parameters

companyId

required

string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947

Responses

200

401

Unauthorized

403

Forbidden

get/v2/companies/{companyId}/questions

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"length": 0,
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
}

Create company question

SecurityBearer

Request

path Parameters

companyId

required

string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947

Request Body schema: application/json

name required	string Question display name that the user will see. For eg, 'Choose the purpose of your trip'.
questionFormat required	string (QuestionFormat) Question types. INPUT_BOX will make user enter a free flowing text. RADIO_BUTTON will have multiple options, user can select only one. CHECKBOX questions contain the possible set of options, from which the user can choose multiple options. CHECKBOX_WITH_PERCENTAGE is similar to checkbox, with the difference being that each option having an additional input field whose values must add up to 100. Enum: "INPUT_BOX" "RADIO_BUTTON" "CHECKBOX" "CHECKBOX_WITH_PERCENTAGE"
	object (OptionInfo) Options related information for the question.
isRequired required	boolean Default: false Whether its compulsory to answer the question or not.
isDisabled required	boolean Default: true Whether the question is disabled or not. If true, this should not be asked.
includeInItinerary	boolean Deprecated Default: false Whether to include this question in the itinerary related emails.
customFieldLocations	Array of strings (CustomFieldLocation) Items Enum: "POLICY_APPROVAL_EMAIL" "PNR_EMAIL" "TRIP_EMAIL"
	object (CustomFieldMatchConditions) Conditions to select the custom field for given context.

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

post/v2/companies/{companyId}/questions

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"name": "string",
"questionFormat": "CHECKBOX",
"optionInfo": {"source": "MANUAL",
"sourceMetadata": {"companyConfig": {"optionsParam": "COST_CENTER"
}
},
"totalNumOptions": 0,
"options": [{"displayCode": "string",
"displayValue": "string"
}
]
},
"isRequired": true,
"isDisabled": false,
"includeInItinerary": true,
"customFieldLocations": ["POLICY_APPROVAL_EMAIL"
],
"matchConditions": {"travelerConditions": {"workerTypes": ["EMPLOYEE"
],
"countries": ["string"
],
"legalEntities": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"departments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"costCenters": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"offices": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
},
"travelTypes": ["AIR"
],
"travelRegionTypes": ["DOMESTIC"
],
"tripUsageTypes": ["STANDARD"
]
}
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get company question

SecurityBearer

Request

path Parameters

companyId required	string <uuid> Identifier for company. Example: 4974a66b-7493-4f41-908c-58ba81093947
questionId required	string <uuid> Identifier for question. Example: 1234a66b-7493-4f41-908c-58ba81093947

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/questions/{questionId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"questionFormat": "CHECKBOX",
"optionInfo": {"source": "MANUAL",
"sourceMetadata": {"companyConfig": {"optionsParam": "COST_CENTER"
}
},
"totalNumOptions": 0,
"options": [{"displayCode": "string",
"displayValue": "string"
}
]
},
"isRequired": true,
"isDisabled": true,
"includeInItinerary": true,
"customFieldLocations": ["POLICY_APPROVAL_EMAIL"
],
"matchConditions": {"travelerConditions": {"workerTypes": ["EMPLOYEE"
],
"countries": ["string"
],
"legalEntities": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"departments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"costCenters": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"offices": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
},
"travelTypes": ["AIR"
],
"travelRegionTypes": ["DOMESTIC"
],
"tripUsageTypes": ["STANDARD"
]
},
"questionType": {"preSearchQuestionType": "PURPOSE_OF_TRIP",
"preCheckoutQuestionType": "OOP_REASON_CODE"
}
}

Update company question

SecurityBearer

Request

path Parameters

companyId required	string <uuid> Identifier for company. Example: 4974a66b-7493-4f41-908c-58ba81093947
questionId required	string <uuid> Identifier for question. Example: 1234a66b-7493-4f41-908c-58ba81093947

Request Body schema: application/json

id required	string <uuid>
name required	string Question display name that the user will see. For eg, 'Choose the purpose of your trip'.
questionFormat	string (QuestionFormat) Question types. INPUT_BOX will make user enter a free flowing text. RADIO_BUTTON will have multiple options, user can select only one. CHECKBOX questions contain the possible set of options, from which the user can choose multiple options. CHECKBOX_WITH_PERCENTAGE is similar to checkbox, with the difference being that each option having an additional input field whose values must add up to 100. Enum: "INPUT_BOX" "RADIO_BUTTON" "CHECKBOX" "CHECKBOX_WITH_PERCENTAGE"
	object (OptionInfo) Options related information for the question.
isRequired required	boolean Default: false Whether its compulsory to answer the question or not.
isDisabled required	boolean Default: true Whether the question is disabled or not. If true, this should not be asked.
includeInItinerary	boolean Deprecated Default: false Whether to include this question in the itinerary related emails.
customFieldLocations	Array of strings (CustomFieldLocation) Items Enum: "POLICY_APPROVAL_EMAIL" "PNR_EMAIL" "TRIP_EMAIL"
	object (CustomFieldMatchConditions) Conditions to select the custom field for given context.
	object (QuestionType) Question type.

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/questions/{questionId}

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"questionFormat": "CHECKBOX",
"optionInfo": {"source": "MANUAL",
"sourceMetadata": {"companyConfig": {"optionsParam": "COST_CENTER"
}
},
"totalNumOptions": 0,
"options": [{"displayCode": "string",
"displayValue": "string"
}
]
},
"isRequired": true,
"isDisabled": true,
"includeInItinerary": true,
"customFieldLocations": ["POLICY_APPROVAL_EMAIL"
],
"matchConditions": {"travelerConditions": {"workerTypes": ["EMPLOYEE"
],
"countries": ["string"
],
"legalEntities": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"departments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"costCenters": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"offices": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
},
"travelTypes": ["AIR"
],
"travelRegionTypes": ["DOMESTIC"
],
"tripUsageTypes": ["STANDARD"
]
},
"questionType": {"preSearchQuestionType": "PURPOSE_OF_TRIP",
"preCheckoutQuestionType": "OOP_REASON_CODE"
}
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Delete company question

SecurityBearer

Request

path Parameters

companyId required	string <uuid> Identifier for company. Example: 4974a66b-7493-4f41-908c-58ba81093947
questionId required	string <uuid> Identifier for question. Example: 1234a66b-7493-4f41-908c-58ba81093947

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/v2/companies/{companyId}/questions/{questionId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}