Company API (v2)

Download OpenAPI specification:Download

Companies

APIs to onboard and manage company.

Create company

This endpoint creates a company. This is allowed only by TMC_ADMIN and above roles.

SecurityBearer
Request
Request Body schema: application/json
name
required
string

Company name

emailDomains
Array of strings unique

List of the company email domains

billingCurrency
required
string

Billing currency of the company

Array of objects (PhoneNumber)

List of company phone numbers

Array of objects (EmergencyContactInfo)

List of company emergency contacts

isSelfSignUpEnabled
boolean

Boolean to show if company has self sign up enabled.

Array of objects (Announcement)

Company announcements

object (Image)

Company logo

object (CompanyId)

Company ID which have contracted this company.

companyRoles
required
Array of strings (CompanyRole)

Company roles

Items Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
object (SupportConfig)
Deprecated

Support Configuration for company

Array of objects (SupportConfig)

Support Configs for company

ccEmailAddresses
Array of strings

List of email addresses on which all confirmation emails will be cced. This is applicable only for company roles 'ORG'

bccEmailAddresses
Array of strings

List of email addresses on which all confirmation emails will be bcced. This is applicable only for company roles 'ORG'

object (PostalAddress)

Postal address of the company.

redirectUrl
string

Redirect URL for the company. It is applicable only for company roles 'PARTNER_TMC'

object (RewardsProgram)
Deprecated

Rewards Program corresponding to partner. It is applicable only for company roles 'PARTNER_TMC'.

object (TmcDefaultConfiguration)

Default Booking configuration for the TMC. It is applicable only for company roles 'TMC'

object (ExpensePartnerConfig)

Expense Partner Configuration

mobileRedirectUrl
string

Redirect URL for the company for mobile. It is applicable only for company roles 'PARTNER_TMC'

applicableCustomFieldTypes
Array of strings (CustomFieldType)

List of custom fields supported by the company.

Items Enum: "QUESTION" "MEETING" "BUDGET" "BREX_TOKEN"
Array of objects (FeatureConfig)

Features related to company.

object (OAuthPartnerConfig)

Config for token exchange in case of partner's have their own IDP.

object (PrivacySettings)

Privacy settings for a company.

object (EmailClientConfig)

Email client configuration representing the email provider to be used.

externalId
string

External id for legal entity.

isFake
boolean
Default: false

Whether the company is a fake company for testing. This is for internal use.

Array of objects (TmcPartnerRoleMapping)

list of individual role mappings between spotnana and partner.

loyaltyBlockedCountries
Array of strings

List of 2 letter country codes where business travelers should not be allowed to add loyalty info.

allowDomainBasedAuthConfig
boolean
Default: false

Whether to allow user to get auth config based on email domain

object (CarbonCostConfig)

The config is used to calculate carbon cost of CO2 emission.

Responses
201

Created

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/companies
Request samples
application/json
{
  • "name": "Spotnana",
  • "emailDomains": [
    ],
  • "billingCurrency": "INR",
  • "phoneNumbers": [
    ],
  • "emergencyContactInfos": [
    ],
  • "isSelfSignUpEnabled": true,
  • "announcements": [],
  • "companyLogo": {},
  • "contractedBy": {
    },
  • "companyRoles": [
    ],
  • "supportConfig": {
    },
  • "supportConfigs": [
    ],
  • "ccEmailAddresses": [
    ],
  • "bccEmailAddresses": [
    ],
  • "postalAddress": {
    },
  • "redirectUrl": "string",
  • "rewardsProgram": {
    },
  • "tmcDefaultConfiguration": {
    },
  • "expensePartnerConfig": {
    },
  • "mobileRedirectUrl": "string",
  • "applicableCustomFieldTypes": [
    ],
  • "features": [
    ],
  • "oauthPartnerConfig": {
    },
  • "privacySettings": {
    },
  • "emailClientConfig": {
    },
  • "externalId": "company-external-id",
  • "isFake": false,
  • "tmcPartnerRoleMappings": [
    ],
  • "loyaltyBlockedCountries": [
    ],
  • "allowDomainBasedAuthConfig": false,
  • "carbonCostConfig": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

List companies

This endpoint lists companies. If externalId is provided in query param, only the company having the specified external ID is returned.

SecurityBearer
Request
query Parameters
externalId
string

External id of the entity.

Example: externalId=my-external-id
Responses
200

OK

401

Unauthorized

403

Forbidden

get/v2/companies
Request samples
Response samples
application/json
{
  • "length": 0,
  • "elements": [
    ]
}

Get company

This endpoint gets a company by ID.

SecurityBearer
Request
path Parameters
companyId
required
string

Identifier for company. External id can be supplied in X prefixed form. For instance, if external_id = abc, then Xabc, has to be passed.

Example: 4974a66b-7493-4f41-908c-58ba81093947
header Parameters
x-application-id
string <uuid>
Example: 4974a66b-7493-4f41-908c-58ba81093947
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}
Request samples
Response samples
application/json
{
  • "id": {
    },
  • "name": "Spotnana",
  • "emailDomains": [
    ],
  • "billingCurrency": "INR",
  • "phoneNumbers": [
    ],
  • "emergencyContactInfos": [
    ],
  • "isSelfSignUpEnabled": true,
  • "announcements": [],
  • "companyLogo": {},
  • "contractedBy": {
    },
  • "isActive": true,
  • "companyRoles": [
    ],
  • "supportConfig": {
    },
  • "ccEmailAddresses": [
    ],
  • "bccEmailAddresses": [
    ],
  • "connectors": [
    ],
  • "postalAddress": {
    },
  • "redirectUrl": "string",
  • "rewardsProgram": {
    },
  • "tmcDefaultConfiguration": {
    },
  • "expensePartnerConfig": {
    },
  • "mobileRedirectUrl": "string",
  • "applicableCustomFieldTypes": [
    ],
  • "features": [
    ],
  • "oauthPartnerConfig": {
    },
  • "privacySettings": {
    },
  • "designationTree": {
    },
  • "externalId": "MyCompanyId",
  • "emailClientConfig": {
    },
  • "isFake": false,
  • "tmcPartnerRoleMappings": [
    ],
  • "supportConfigs": {
    },
  • "loyaltyBlockedCountries": [
    ],
  • "allowDomainBasedAuthConfig": false,
  • "carbonCostConfig": {
    }
}

Update company

This endpoint updates a company by ID.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Request Body schema: application/json
required
object (CompanyId)

Company ID

name
required
string

Company name

emailDomains
Array of strings unique

List of the company email domains

billingCurrency
required
string

Billing currency of the company

Array of objects (PhoneNumber)

List of company phone numbers

Array of objects (EmergencyContactInfo)

List of company emergency contacts

isSelfSignUpEnabled
boolean

Boolean to show if company has self sign up enabled.

Array of objects (Announcement)

Company announcements

object (Image)

Company logo

object (CompanyId)

Company ID which have contracted this company.

isActive
boolean

Boolean to show if this is an active company.

companyRoles
required
Array of strings (CompanyRole)

Company roles

Items Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
object (SupportConfig)
Deprecated

Support Configuration for company

ccEmailAddresses
Array of strings

List of email addresses on which all confirmation emails will be cced. This is applicable only for company roles 'ORG'

bccEmailAddresses
Array of strings

List of email addresses on which all confirmation emails will be bcced. This is applicable only for company roles 'ORG'

Array of objects (Connector)

Connectors related to company.

object (PostalAddress)

Postal address of the company.

redirectUrl
string

Redirect URL for the company. It is applicable only for company roles 'PARTNER_TMC'

object (RewardsProgram)
Deprecated

Reward Program corresponding to partner. It is applicable only for company roles 'PARTNER_TMC'.

object (TmcDefaultConfiguration)

Default Booking configuration for the TMC. It is applicable only for company roles 'TMC'

object (ExpensePartnerConfig)

Expense Partner Configuration

mobileRedirectUrl
string

Redirect URL for the company for mobile. It is applicable only for company roles 'PARTNER_TMC'

applicableCustomFieldTypes
Array of strings (CustomFieldType)

List of custom fields supported by the company.

Items Enum: "QUESTION" "MEETING" "BUDGET" "BREX_TOKEN"
Array of objects (FeatureConfig)

Features related to company.

object (OAuthPartnerConfig)

Config for token exchange in case of partner's have their own IDP.

object (PrivacySettings)

Privacy settings for a company.

object (DesignationNode)

Designation tree for company showing who reports whom.

externalId
string

External id to be linked with this.

object (EmailClientConfig)

Email client configuration representing the email provider to be used.

isFake
boolean
Default: false

Whether the company is a fake company for testing. This is for internal use.

Array of objects (TmcPartnerRoleMapping)

list of individual role mappings between spotnana and partner.

object (SupportConfigs)
loyaltyBlockedCountries
Array of strings

List of 2 letter country codes where business travelers should not be allowed to add loyalty info.

allowDomainBasedAuthConfig
boolean
Default: false

Whether to allow user to get auth config based on email domain

object (CarbonCostConfig)

The config is used to calculate carbon cost of CO2 emission.

Responses
204

Updated Successfully

400

Bad request

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}
Request samples
application/json
{
  • "id": {
    },
  • "name": "Spotnana",
  • "emailDomains": [
    ],
  • "billingCurrency": "INR",
  • "phoneNumbers": [
    ],
  • "emergencyContactInfos": [
    ],
  • "isSelfSignUpEnabled": true,
  • "announcements": [],
  • "companyLogo": {},
  • "contractedBy": {
    },
  • "isActive": true,
  • "companyRoles": [
    ],
  • "supportConfig": {
    },
  • "ccEmailAddresses": [
    ],
  • "bccEmailAddresses": [
    ],
  • "connectors": [
    ],
  • "postalAddress": {
    },
  • "redirectUrl": "string",
  • "rewardsProgram": {
    },
  • "tmcDefaultConfiguration": {
    },
  • "expensePartnerConfig": {
    },
  • "mobileRedirectUrl": "string",
  • "applicableCustomFieldTypes": [
    ],
  • "features": [
    ],
  • "oauthPartnerConfig": {
    },
  • "privacySettings": {
    },
  • "designationTree": {
    },
  • "externalId": "MyCompanyId",
  • "emailClientConfig": {
    },
  • "isFake": false,
  • "tmcPartnerRoleMappings": [
    ],
  • "supportConfigs": {
    },
  • "loyaltyBlockedCountries": [
    ],
  • "allowDomainBasedAuthConfig": false,
  • "carbonCostConfig": {
    }
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Delete company

This endpoint deletes a company by ID.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

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

Deleted Successfully

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/v2/companies/{companyId}
Request samples
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Get company features

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
companyRole
string (CompanyRole)

Role of the company.

Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
Example: companyRole=TMC
header Parameters
X-Application-Id
string <uuid>
Example: 4974a66b-7493-4f41-908c-58ba81093947
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/features
Request samples
Response samples
application/json
{
  • "length": 1,
  • "features": [
    ]
}

Update Company FeaturesDeprecated

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
companyRole
string (CompanyRole)

Role of the company.

Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
Example: companyRole=TMC
header Parameters
X-Application-Id
string <uuid>
Example: 4974a66b-7493-4f41-908c-58ba81093947
Request Body schema: application/json
length
integer

Number of features.

Array of objects (FeatureConfig)

Features related to company.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/features
Request samples
application/json
{
  • "length": 1,
  • "features": [
    ]
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Update Company Features

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
companyRole
string (CompanyRole)

Role of the company.

Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
Example: companyRole=TMC
header Parameters
X-Application-Id
string <uuid>
Example: 4974a66b-7493-4f41-908c-58ba81093947
Request Body schema: application/json
Array of objects (FeatureConfig)

Features that has to be updated.

featuresToDelete
Array of strings (FeatureNameEnum)

Features that has to be deleted.

Items Enum: "FLIGHT_RESULTS_OOP" "HOTEL_RESULTS_OOP" "RAIL_RESULTS_OOP" "CARS_RESULTS_OOP" "PAYMENT_ADD_CARD" "MENU_ITEM_POLICIES" "INTEGRATION_EXPENSIFY" "TRAVELER_SELECTION" "FEATURE_PERSONAL_TRAVEL" "PRODUCT_OBT_RAIL" "MENU_ITEM_COMPANY_REMARKS" "HOMEPAGE_ADD_USER" "MENU_ITEM_CUSTOM_FIELDS" "PAYMENT_UNUSED_CREDITS" "EMAIL_UPDATE_BY_COMPANY_ADMIN" "ADHOC_BOOKING_SEARCH_PAGE" "ADHOC_BOOKING_SAVE_TRAVELER" "ADMIN_VIRTUAL_CARD" "CENTRAL_CARD_SERVICE_FEE" "EXPEDIA_SOURCE_ENABLED" "BOOKING_COM_SOURCE_ENABLED" "HOTEL_MEDIAN_ENABLE" "HIDE_SEARCH_CRITERIA" "ADHOC_PAYMENT_SOURCE" "SERVICE_CHARGE_CONFIG_DISABLED" "HIDE_SETTINGS_MENU_ITEM_COMPANY" "HIDE_SETTINGS_MENU_ITEM_USERS" "HIDE_POLICY_APPROVAL_SECTION" "HIDE_POLICY_CREATION" "HIDE_SETTINGS_TEXT_FROM_MENU" "HIDE_LEFT_NAV" "HIDE_POLICY_AIR_CARRIER" "HIDE_POLICY_AIR_CO2" "HIDE_POLICY_HOTEL_PRICE_LOCATION_CUSTOMISATION" "HIDE_PROFILE_PREFERENCES_AIRLINES" "HIDE_PROFILE_PREFERENCES_ALLIANCES" "MONEY_SET_CONVERTED_CURRENCY_AS_ORIGINAL_CURRENCY" "PRODUCT_OBT_AIR_DISABLED" "PRODUCT_OBT_HOTEL_DISABLED" "PRODUCT_OBT_CAR_DISABLED" "PRODUCT_OBT_LIMO_DISABLED" "PRODUCT_OBT_CONCIERGE_DISABLED" "EVENT_BOOKING_ENABLED" "EMPLOYEE_LEVEL_DESIGNATED_APPROVER_ENABLED" "ENRICH_SEARCH_RESPONSE_WITH_REWARD_POINTS" "HIDE_LEFT_NAV_EMBED" "HIDE_POLICY_AIR_NOT_ALLOWED_TO_BE_BOOKED" "HIDE_TRIP_FEE_CONFIG" "HIDE_AGENT_FEE_CONFIG" "SHOW_SERVICE_FEE_TAXES" "HIDE_GUEST_BOOKING_SETTING" "USER_CREATION_PERSONA_TYPE_OPTIONS" "AIR_SEARCH_RESULT_AIRLINE_SORT_ORDER" "HIDE_SHERPA_VISA_WIDGET" "AUTO_DEACTIVATE_GUEST" "POLICY_USER_GROUPS" "HIDE_SUPPLIER_MANAGEMENT" "HIDE_BOOKING_RESTRICTIONS_BY_COUNTRY" "LINKED_MARRIOTT_BONVOY_REQUIRED" "EDITING_DEFAULT_POLICIES_DISABLED" "DISALLOW_MULTI_CITY_ADD_FLIGHT" "REQUIRE_ONBOARDING_ON_ENROLLMENT" "GEO_CUSTOMIZATIONS" "HIDE_PREFERRED_PARENT_CHAINS" "HIDE_PREFERRED_HOTEL_BRANDS" "HIDE_ROOM_OPTIONS_AND_STAY_PREFERENCES" "HIDE_CONDITIONAL_RATES_PREFERENCES" "HIDE_HOTELS_IN_SUPPLIER_MANAGEMENT" "HIDE_HOTEL_BRANDS_IN_SUPPLIER_MANAGEMENT" "HIDE_POLICY_HOTEL_STAR_RATING" "PRODUCT_OBT_HOMEPAGE_ORDER" "HIDE_COMPANY_SUPPLIER_MENU" "EXTERNAL_EVENT_BOOKING_URL" "HIDE_IDLE_SESSION_TIMEOUT"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

patch/v2/companies/{companyId}/features
Request samples
application/json
{
  • "featuresToUpdate": [
    ],
  • "featuresToDelete": [
    ]
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Get company travel content config

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

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

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/travel-content-config
Request samples
Response samples
application/json
{
  • "airConfig": {
    }
}

Update company travel content config

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Request Body schema: application/json

Travel content config of a given company

object (AirConfig)

Air content config

Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/travel-content-config
Request samples
application/json
{
  • "airConfig": {
    }
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Delete company travel content config

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

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

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/v2/companies/{companyId}/travel-content-config
Request samples
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Updates white label config

This endpoint stores white label config for the company at different entity levels.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
companyRole
required
string (CompanyRole)

Role of the company.

Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
Example: companyRole=ORG
Request Body schema: application/json
companyName
string
required
object (ColorWhiteLabelConfig)

Whitelabel configuration related to colours.

object (WebLinksConfig)

Weblinks which are parts of WhiteLabelConfig.

fromEmailAddress
string
fontFamily
string
Default: "Arial"
emailFontFamily
string
Default: "Roboto"
fontFamilyCss
string
object (EmailClientConfig)

Email client configuration representing the email provider to be used.

clientRoutingBasePath
string

Base path used by Spotnana OBT application to invoke API calls. Default path value is /

object (RoutingConfig)

App routing configuration.

object (PrivacyDisclaimer)

Html to shown on the the login page. This will be text with hyper links.

Responses
200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/white-label-config
Request samples
application/json
{}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Get white label config

This endpoint fetches the white label config for the company.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
companyRole
required
string (CompanyRole)

Role of the company.

Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
Example: companyRole=ORG
applicationId
string <uuid>

Application context to get white label config.

Example: applicationId=1234a66b-7493-4f41-908c-58ba81055667
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/white-label-config
Request samples
Response samples
application/json
{}

Updates Color config

This endpoint stores Color config for the company at some entity level.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
companyRole
required
string (CompanyRole)

Role of the company.

Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
Example: companyRole=TMC
Request Body schema: application/json
Array of objects (ProfileColors)

The list of colors relating to profile.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/color-config
Request samples
application/json
{
  • "profileColors": [
    ]
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Get color config

This endpoint fetches the color config for the given entity.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
companyRole
required
string (CompanyRole)

Role of the company.

Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR"
Example: companyRole=TMC
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/color-config
Request samples
Response samples
application/json
{
  • "profileColors": [
    ]
}

Legal Entities

APIs to create and manage company legal entities.

Create legal entity

This endpoint creates a legal entity.

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 legal entity

required
object (PostalAddress)

Address of the legal entity.

billingCurrency
required
string

Billing currency for the legal entity.

dba
string

Business name, sort form of Doing Business As

ein
string

Tax number

Array of objects (PhoneNumber)
isDelayedInvoicingEnabled
boolean

Whether delayed invoicing is enabled for the legal entity. If enabled, travelers of the legal entity won't be charged for trip on checkout, rather the bills would be sent to the company later on based on the billing cycle.

ccEmailAddresses
Array of strings

List of email addresses on which all confirmation emails for this LE will be cc'ed. This is applicable only for company roles 'ORG'

bccEmailAddresses
Array of strings

List of email addresses on which all confirmation emails for this LE will be bcc'ed. This is applicable only for company roles 'ORG'

externalId
string

External id for legal entity.

Array of objects (CompanySpecifiedAttributeLegalEntity)

Company specified attributes or fields for the legal entity.

Responses
201

Created

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/companies/{companyId}/legal-entities
Request samples
application/json
{
  • "name": "string",
  • "address": {
    },
  • "billingCurrency": "string",
  • "dba": "string",
  • "ein": "string",
  • "phoneNumbers": [
    ],
  • "isDelayedInvoicingEnabled": true,
  • "ccEmailAddresses": [
    ],
  • "bccEmailAddresses": [
    ],
  • "externalId": "legal-entity-external-id",
  • "companySpecifiedAttributes": [
    ]
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

List legal entities

This endpoint lists legal entities of a company. If externalId is provided in the query param only the legal entity having the provided externalId is returned.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
pageNumber
integer <int32> >= 1
Default: 1

Page number to fetch for the query. Page number starts from 1.

Example: pageNumber=2
pageSize
integer <int32> [ 1 .. 1000 ]
Default: 1000

Page size to be to fetch for the query.

Example: pageSize=20
externalId
string

External id of the entity.

Example: externalId=my-external-id
Responses
200

OK

401

Unauthorized

403

Forbidden

get/v2/companies/{companyId}/legal-entities
Request samples
Response samples
application/json
{
  • "length": 0,
  • "elements": [
    ]
}

Get legal entity

This endpoint gets a legal entity by ID.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
legalEntityId
required
string <uuid>

Identifier for legal-entity.

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

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/legal-entities/{legalEntityId}
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "address": {
    },
  • "billingCurrency": "string",
  • "dba": "string",
  • "ein": "string",
  • "phoneNumbers": [
    ],
  • "isDelayedInvoicingEnabled": true,
  • "bookingTmcRef": {
    },
  • "expensePartnerConfig": {
    },
  • "ccEmailAddresses": [
    ],
  • "bccEmailAddresses": [
    ],
  • "externalId": "my-external-id",
  • "companySpecifiedAttributes": [
    ]
}

Update legal entity

This endpoint updates a legal entity by ID.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
legalEntityId
required
string <uuid>

Identifier for legal-entity.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Request Body schema: application/json
id
string <uuid>

Unique identifier of the legal entity.

name
string

Name of the legal entity

object (PostalAddress)

Address of the legal entity.

billingCurrency
string

Billing currency for the legal entity.

dba
string

Business name, sort form of Doing Business As

ein
string

Tax number

Array of objects (PhoneNumber)
isDelayedInvoicingEnabled
boolean

Whether delayed invoicing is enabled for the legal entity. If enabled, travelers of the legal entity won't be charged for trip on checkout, rather the bills would be sent to the company later on based on the billing cycle.

object (Reference)

Booking TMC of the legal entity.

object (ExpensePartnerConfig)

Configured details of expense partner.

ccEmailAddresses
Array of strings

List of email addresses on which all confirmation emails will be CCed. This is applicable only for company roles 'ORG'

bccEmailAddresses
Array of strings

List of email addresses on which all confirmation emails will be BCCed. This is applicable only for company roles 'ORG'

externalId
string

External id for the legal entity.

Array of objects (CompanySpecifiedAttributeLegalEntity)

Company specified attributes or fields for the legal entity.

Responses
204

Updated Successfully

400

Bad request

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/legal-entities/{legalEntityId}
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "address": {
    },
  • "billingCurrency": "string",
  • "dba": "string",
  • "ein": "string",
  • "phoneNumbers": [
    ],
  • "isDelayedInvoicingEnabled": true,
  • "bookingTmcRef": {
    },
  • "expensePartnerConfig": {
    },
  • "ccEmailAddresses": [
    ],
  • "bccEmailAddresses": [
    ],
  • "externalId": "my-external-id",
  • "companySpecifiedAttributes": [
    ]
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Delete legal entity

This endpoint deletes a legal entity by ID.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
legalEntityId
required
string <uuid>

Identifier for legal-entity.

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

Deleted

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/v2/companies/{companyId}/legal-entities/{legalEntityId}
Request samples
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Cost Centers

APIs to create and manage company cost centers.

Create cost center

This endpoint creates a cost center.

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
numberOfEmployees
integer <int32>
externalId
string
Responses
201

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/companies/{companyId}/cost-centers
Request samples
application/json
{
  • "name": "string",
  • "numberOfEmployees": 0,
  • "externalId": "external-id"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

List cost centers

This endpoint lists cost centers of a company. If an externalId is provided in the query parameter only the cost center with the provided externalId is returned.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
query Parameters
externalId
string

External id of the cost center.

Example: externalId=cost-center-external-id
Responses
200

OK

401

Unauthorized

403

Forbidden

get/v2/companies/{companyId}/cost-centers
Request samples
Response samples
application/json
{
  • "length": 0,
  • "elements": [
    ]
}

Get cost center

This endpoint gets a cost center by ID.

SecurityBearer
Request
path Parameters
companyId
required
string <uuid>

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
costCenterId
required
string <uuid>

Identifier for cost-center.

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

OK

401

Unauthorized