Skip to content

Company API (v2)

Download OpenAPI description
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi

Companies

APIs to onboard and manage company.

Operations

Get color config

Request

This endpoint fetches the color config for the given entity.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
companyRolestring(CompanyRole)required

Role of the company.

Enum"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"
Example: companyRole=TMC
curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/color-config?companyRole=TMC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
profileColorsArray of objects(ProfileColors)

The list of colors relating to profile.

Response
application/json
{ "profileColors": [ {} ] }

Upload company vendor preferences csv file

Request

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodymultipart/form-data
vendorTypestring(VendorType)required

Types of vendors supported for company preferences.

Enum"CAR""HOTEL""HOTEL_CHAIN""AIRLINE""HOTEL_BRAND"
filestring(binary)
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/vendor-preferences \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F vendorType=CAR \
  -F file=string

Responses

OK

Response
No content

Store tier levels with labels

Request

This endpoint store the tiers with respective label for a company.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
preferenceTiersPerBookingTypeArray of objects(PreferenceTiersPerBookingType)required

List of preference tiers with respective labels for different booking types.

preferenceTiersPerBookingType[].​allowedEntityTypesArray of strings(PreferenceEntityType)non-emptyrequired

Different entity types that are allowed for defining preference.

Items Enum"COMPANY""LEGAL_ENTITY""COUNTRY"
preferenceTiersPerBookingType[].​bookingTypestring(BookingType)required

What type of travel booking it is.

Enum"AIR""HOTEL""CAR""RAIL""LIMO"
preferenceTiersPerBookingType[].​preferenceTiersArray of objects(PreferenceTier)required

List of preference tiers with respective labels.

preferenceTiersPerBookingType[].​preferenceTiers[].​levelstring(PreferenceTierLevel)required

Different levels of tier.

Enum"TIER_1""TIER_2""TIER_3""TIER_4""TIER_5""TIER_6"
preferenceTiersPerBookingType[].​preferenceTiers[].​labelstringrequired

Text to be used to display given tier.

preferenceTiersPerBookingType[].​preferenceTiers[].​descriptionstring

Short description about the tier level.

preferenceTiersPerBookingType[].​preferenceTiers[].​showLabelbooleanrequired

Whether to show label in search result for the given tier.

Default false
curl -i -X PUT \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/preference-tiers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "preferenceTiersPerBookingType": [
      {
        "allowedEntityTypes": [
          "COMPANY"
        ],
        "bookingType": "AIR",
        "preferenceTiers": [
          {
            "level": "TIER_1",
            "label": "string",
            "description": "string",
            "showLabel": false
          }
        ]
      }
    ]
  }'

Responses

OK

Response
No content

Cost Centers

APIs to create and manage company cost centers.

Operations

Offices

APIs to create and manage company offices.

Operations

Departments

APIs to create and manage departments.

Operations

Grades

APIs to create and manage grades.

Operations

Service Charge Plan

APIs to manage service charge plans.

Operations

Partner Public Keys

APIs to manage partner public keys for token exchange authentication.

Operations

Service Charge

Operations

Company Enrollment

Operations

Company Tier

Operations

Stealth Config

Operations