API reference

Company

Company API (v2)

Download OpenAPI description

CompanyApi.json

CompanyApi.yaml

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

Legal Entities

APIs to create and manage company legal entities.

Operations

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

Updates Enrollment config

Request

This endpoint stores Enrollment config for the company at TMC level.

Path

companyIdstring(uuid)required

Identifier for company.

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

Bodyapplication/jsonrequired

termsAndConditionsstringrequired

Link to terms and conditions.

Example: "https://www.spotnana.com/terms/"

curl -i -X PUT \
  https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/enrollment-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "termsAndConditions": "https://www.spotnana.com/terms/"
  }'

Responses

Response

No content

Get enrollment config

Request

This endpoint fetches the enrollment config for the company.

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/enrollment-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

termsAndConditionsstringrequired

Link to terms and conditions.

Example: "https://www.spotnana.com/terms/"

Response

application/json

{
  "termsAndConditions": "https://www.spotnana.com/terms/"
}

Company Tier

Operations