Company API (v2)

Download OpenAPI description
Languages
Servers
Staging URL
https://apis.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi/

Companies

APIs to onboard and manage company.

Operations

Update Company Features

Request

Path
companyIdstring(uuid)required

Identifier for company.

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

Role of the company.

Enum"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"
Example: companyRole=TMC
Headers
X-Application-Idstring(uuid)
Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
featuresToUpdateArray of objects(FeatureConfig)

Features that has to be updated.

featuresToDeleteArray 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"
Example: ["ADMIN_VIRTUAL_CARD"]
curl -i -X PATCH \
  'https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/features?companyRole=TMC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Application-Id: 4974a66b-7493-4f41-908c-58ba81093947' \
  -d '{
    "featuresToUpdate": [
      {
        "name": "ADMIN_VIRTUAL_CARD",
        "value": "string"
      }
    ],
    "featuresToDelete": [
      "ADMIN_VIRTUAL_CARD"
    ]
  }'

Responses

OK

Response
No content

Get company travel content config

Request

Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
curl -i -X GET \
  https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/travel-content-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
airConfigobject(AirConfig)

Air content config

Response
application/json
{ "airConfig": { "fareCategoryFilter": [] } }

Update company travel content config

Request

Path
companyIdstring(uuid)required

Identifier for company.

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

Travel content config of a given company

airConfigobject(AirConfig)

Air content config

curl -i -X PUT \
  https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/travel-content-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "airConfig": {
      "fareCategoryFilter": [
        {
          "priority": 1,
          "origin": {
            "value": "string",
            "metadata": {
              "type": "CITY",
              "code": "string"
            },
            "infos": [
              {}
            ]
          },
          "destination": {
            "value": "string",
            "metadata": {
              "type": "CITY",
              "code": "string"
            },
            "infos": [
              {}
            ]
          },
          "fareCategoryOption": [
            {
              "fareCategory": {
                "ngsCategory": "UNKNOWN_NGS_CATEGORY",
                "cabinViewCategory": "UNKNOWN_CABIN_CATEGORY"
              },
              "disabled": true
            }
          ]
        }
      ]
    }
  }'

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

Service Charge Plan

APIs to manage service charge plans.

Operations

Service Charge

Operations

Company Enrollment

Operations

Company Tier

Operations