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"
	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

Payload
curl
JavaScript
Node.js
Python

application/json

{"name": "Spotnana",
"emailDomains": ["spotnana.com"
],
"billingCurrency": "INR",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emergencyContactInfos": [{"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"designation": "MANAGER",
"email": "emergency-contact@email.com",
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumber": {"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"userOrgId": {"organizationAgencyId": {"id": "string"
},
"organizationId": {"id": "string"
},
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tmcInfo": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"primaryServiceProviderTmc": {"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"secondaryServiceProviderTmcs": [{"tmcId": {"id": null
},
"supplier": "SABRE",
"travelType": "AIR"
}
],
"partnerTmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"tmcBasicInfo": {"contractingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
},
"bookingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
}
}
}
}
],
"isSelfSignUpEnabled": true,
"announcements": [{"title": "Spotnana on Mission to Unbundle Travel",
"description": "Amex Ventures Joins Spotnana on Mission to Unbundle Travel.",
"linkUrl": "https://medium.com/inside-spotnana/amex-ventures-joins-spotnana-on-mission-to-unbundle-travel-3cdb2ecceff4",
"linkDisplayText": "New announcement"
}
],
"companyLogo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
},
"contractedBy": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"companyRoles": ["ORG"
],
"supportConfig": {"contactNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emailAddresses": ["support@spotnana.com"
],
"freshdeskConfig": {"enabled": true,
"hasCredentials": false,
"credentials": {"webCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
},
"mobileCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
}
}
},
"tier": "SEAT1A",
"genesysConfig": {"enabled": true,
"dataUrl": "string"
},
"portalUrls": ["www.support.spotnana.com"
],
"zendeskConfig": {"enabled": true,
"integrationId": "1234567890",
"androidIntegrationId": "1234567890",
"iosIntegrationId": "1234567890"
},
"genesysCloudConfig": {"enabled": true,
"deploymentId": "52dc2a6f-772a-4edf-96d3-b3f0c49400a7",
"environment": "usa-1",
"genesysScriptUrl": "https://test.test.com"
},
"twilioChatConfig": {"enabled": true
}
},
"supportConfigs": [{"contactNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emailAddresses": ["support@spotnana.com"
],
"freshdeskConfig": {"enabled": true,
"hasCredentials": false,
"credentials": {"webCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
},
"mobileCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
}
}
},
"tier": "SEAT1A",
"genesysConfig": {"enabled": true,
"dataUrl": "string"
},
"portalUrls": ["www.support.spotnana.com"
],
"zendeskConfig": {"enabled": true,
"integrationId": "1234567890",
"androidIntegrationId": "1234567890",
"iosIntegrationId": "1234567890"
},
"genesysCloudConfig": {"enabled": true,
"deploymentId": "52dc2a6f-772a-4edf-96d3-b3f0c49400a7",
"environment": "usa-1",
"genesysScriptUrl": "https://test.test.com"
},
"twilioChatConfig": {"enabled": true
}
}
],
"ccEmailAddresses": ["example@gmail.com"
],
"bccEmailAddresses": ["example@gmail.com"
],
"postalAddress": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"redirectUrl": "string",
"rewardsProgram": {"allowedUserRoles": ["TRAVEL_ARRANGER"
],
"conversionRate": {"currencyCode": "USD",
"rate": 0
},
"redeemablePaymentMethods": ["BREX_POINTS"
],
"backingCurrency": ["USD"
]
},
"tmcDefaultConfiguration": {"defaultBookingTmcId": "734f4ea2-e9ed-4c90-853c-9eed62f1254b",
"countryWiseBookingTmcs": [{"countryCode": "US",
"bookingTmcId": "734f4ea2-e9ed-4c90-853c-9eed62f1254b"
}
]
},
"expensePartnerConfig": {"partner": "EXPENSIFY",
"emailConfig": {"personalCardConfig": {"sendToTraveler": false,
"personalCardExpenseEmail": "user@company.com"
},
"centralCardExpenseEmail": "finance+le@company.com",
"expensePartnerEmail": "receipts@expensify.com",
"bccEmail": "docs@company.com"
},
"travelType": ["AIR"
],
"isExpensePartnerEnabled": true,
"reportCustomFields": true,
"personalCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"centralCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"partnerReferralId": "1234hgd",
"itineraryConfig": {"skipModificationUpdate": true,
"skipCancellationUpdate": true
}
},
"mobileRedirectUrl": "string",
"applicableCustomFieldTypes": ["QUESTION"
],
"oauthPartnerConfig": {"name": "string",
"userDetailEndpoint": {"url": "string",
"authHeaderName": "string"
},
"tokenVerifier": {"doVerifyToken": true,
"type": "OKTA_JWT",
"verifierDetails": {"oktaJwtVerifier": {"oauthUrl": "string",
"audience": "string"
}
}
},
"doPersistToken": true
},
"privacySettings": {"allowCompanyAdminAccessToRelativesInfo": true
},
"emailClientConfig": {"client": "SENDGRID",
"credentials": {"emailClientSecretKey": {"secretKey": "SECRET_KEY",
"versionId": "1"
}
},
"defaultSenderAddress": "test@somedomain.com",
"defaultSenderName": "Test Sender"
},
"externalId": "company-external-id",
"isFake": false,
"tmcPartnerRoleMappings": [{"partnerRole": "string",
"spotnanaRole": "TRAVEL_ARRANGER"
}
],
"loyaltyBlockedCountries": ["US",
"IN"
],
"allowDomainBasedAuthConfig": false,
"carbonCostConfig": {"price": {"amount": 510,
"currencyCode": "GBP",
"convertedAmount": 715.42,
"convertedCurrency": "USD",
"otherCoinage": [{"coinageCode": "BREX_POINTS",
"amount": 1000,
"conversionRate": 0.01,
"preferredCurrencyConversionRate": 0.01
}
]
},
"weight": {"weight": 150,
"unit": "KG"
}
}
}

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
companyRole	string (CompanyRole) Filter by a particular role Enum: "ORG" "TMC" "PARTNER_TMC" "HR_FEED_CONNECTOR" "TRIPS_DATA_CONNECTOR" Example: companyRole=ORG
companyIds	Array of strings Filter by a list of companies

Responses

200

401

Unauthorized

403

Forbidden

get/v2/companies

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

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

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

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "Spotnana",
"emailDomains": ["spotnana.com"
],
"billingCurrency": "INR",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emergencyContactInfos": [{"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"designation": "MANAGER",
"email": "emergency-contact@email.com",
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumber": {"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"userOrgId": {"organizationAgencyId": {"id": "string"
},
"organizationId": {"id": "string"
},
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tmcInfo": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"primaryServiceProviderTmc": {"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"secondaryServiceProviderTmcs": [{"tmcId": {"id": null
},
"supplier": "SABRE",
"travelType": "AIR"
}
],
"partnerTmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"tmcBasicInfo": {"contractingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
},
"bookingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
}
}
}
}
],
"isSelfSignUpEnabled": true,
"announcements": [{"title": "Spotnana on Mission to Unbundle Travel",
"description": "Amex Ventures Joins Spotnana on Mission to Unbundle Travel.",
"linkUrl": "https://medium.com/inside-spotnana/amex-ventures-joins-spotnana-on-mission-to-unbundle-travel-3cdb2ecceff4",
"linkDisplayText": "New announcement"
}
],
"companyLogo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
},
"contractedBy": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"isActive": true,
"companyRoles": ["ORG"
],
"supportConfig": {"contactNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emailAddresses": ["support@spotnana.com"
],
"freshdeskConfig": {"enabled": true,
"hasCredentials": false,
"credentials": {"webCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
},
"mobileCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
}
}
},
"tier": "SEAT1A",
"genesysConfig": {"enabled": true,
"dataUrl": "string"
},
"portalUrls": ["www.support.spotnana.com"
],
"zendeskConfig": {"enabled": true,
"integrationId": "1234567890",
"androidIntegrationId": "1234567890",
"iosIntegrationId": "1234567890"
},
"genesysCloudConfig": {"enabled": true,
"deploymentId": "52dc2a6f-772a-4edf-96d3-b3f0c49400a7",
"environment": "usa-1",
"genesysScriptUrl": "https://test.test.com"
},
"twilioChatConfig": {"enabled": true
}
},
"ccEmailAddresses": ["example@gmail.com"
],
"bccEmailAddresses": ["example@gmail.com"
],
"connectors": [{"connectorType": "HR_FEED_CONNECTOR",
"connectorId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
}
],
"postalAddress": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"redirectUrl": "string",
"rewardsProgram": {"allowedUserRoles": ["TRAVEL_ARRANGER"
],
"conversionRate": {"currencyCode": "USD",
"rate": 0
},
"redeemablePaymentMethods": ["BREX_POINTS"
],
"backingCurrency": ["USD"
]
},
"tmcDefaultConfiguration": {"defaultBookingTmcId": "734f4ea2-e9ed-4c90-853c-9eed62f1254b",
"countryWiseBookingTmcs": [{"countryCode": "US",
"bookingTmcId": "734f4ea2-e9ed-4c90-853c-9eed62f1254b"
}
]
},
"expensePartnerConfig": {"partner": "EXPENSIFY",
"emailConfig": {"personalCardConfig": {"sendToTraveler": false,
"personalCardExpenseEmail": "user@company.com"
},
"centralCardExpenseEmail": "finance+le@company.com",
"expensePartnerEmail": "receipts@expensify.com",
"bccEmail": "docs@company.com"
},
"travelType": ["AIR"
],
"isExpensePartnerEnabled": true,
"reportCustomFields": true,
"personalCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"centralCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"partnerReferralId": "1234hgd",
"itineraryConfig": {"skipModificationUpdate": true,
"skipCancellationUpdate": true
}
},
"mobileRedirectUrl": "string",
"applicableCustomFieldTypes": ["QUESTION"
],
"oauthPartnerConfig": {"name": "string",
"userDetailEndpoint": {"url": "string",
"authHeaderName": "string"
},
"tokenVerifier": {"doVerifyToken": true,
"type": "OKTA_JWT",
"verifierDetails": {"oktaJwtVerifier": {"oauthUrl": "string",
"audience": "string"
}
}
},
"doPersistToken": true
},
"privacySettings": {"allowCompanyAdminAccessToRelativesInfo": true
},
"designationTree": {"name": "string",
"children": [{ }
]
},
"externalId": "MyCompanyId",
"emailClientConfig": {"client": "SENDGRID",
"credentials": {"emailClientSecretKey": {"secretKey": "SECRET_KEY",
"versionId": "1"
}
},
"defaultSenderAddress": "test@somedomain.com",
"defaultSenderName": "Test Sender"
},
"isFake": false,
"tmcPartnerRoleMappings": [{"partnerRole": "string",
"spotnanaRole": "TRAVEL_ARRANGER"
}
],
"supportConfigs": {"length": 0,
"elements": [{"contactNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emailAddresses": ["support@spotnana.com"
],
"freshdeskConfig": {"enabled": true,
"hasCredentials": false,
"credentials": {"webCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
},
"mobileCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
}
}
},
"tier": "SEAT1A",
"genesysConfig": {"enabled": true,
"dataUrl": "string"
},
"portalUrls": ["www.support.spotnana.com"
],
"zendeskConfig": {"enabled": true,
"integrationId": "1234567890",
"androidIntegrationId": "1234567890",
"iosIntegrationId": "1234567890"
},
"genesysCloudConfig": {"enabled": true,
"deploymentId": "52dc2a6f-772a-4edf-96d3-b3f0c49400a7",
"environment": "usa-1",
"genesysScriptUrl": "https://test.test.com"
},
"twilioChatConfig": {"enabled": true
}
}
]
},
"loyaltyBlockedCountries": ["US",
"IN"
],
"allowDomainBasedAuthConfig": false,
"carbonCostConfig": {"price": {"amount": 510,
"currencyCode": "GBP",
"convertedAmount": 715.42,
"convertedCurrency": "USD",
"otherCoinage": [{"coinageCode": "BREX_POINTS",
"amount": 1000,
"conversionRate": 0.01,
"preferredCurrencyConversionRate": 0.01
}
]
},
"weight": {"weight": 150,
"unit": "KG"
}
}
}

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"
	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

Payload
curl
JavaScript
Node.js
Python

application/json

{"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "Spotnana",
"emailDomains": ["spotnana.com"
],
"billingCurrency": "INR",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emergencyContactInfos": [{"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"designation": "MANAGER",
"email": "emergency-contact@email.com",
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumber": {"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"userOrgId": {"organizationAgencyId": {"id": "string"
},
"organizationId": {"id": "string"
},
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tmcInfo": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"primaryServiceProviderTmc": {"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"secondaryServiceProviderTmcs": [{"tmcId": {"id": null
},
"supplier": "SABRE",
"travelType": "AIR"
}
],
"partnerTmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"tmcBasicInfo": {"contractingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
},
"bookingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
}
}
}
}
],
"isSelfSignUpEnabled": true,
"announcements": [{"title": "Spotnana on Mission to Unbundle Travel",
"description": "Amex Ventures Joins Spotnana on Mission to Unbundle Travel.",
"linkUrl": "https://medium.com/inside-spotnana/amex-ventures-joins-spotnana-on-mission-to-unbundle-travel-3cdb2ecceff4",
"linkDisplayText": "New announcement"
}
],
"companyLogo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
},
"contractedBy": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"isActive": true,
"companyRoles": ["ORG"
],
"supportConfig": {"contactNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emailAddresses": ["support@spotnana.com"
],
"freshdeskConfig": {"enabled": true,
"hasCredentials": false,
"credentials": {"webCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
},
"mobileCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
}
}
},
"tier": "SEAT1A",
"genesysConfig": {"enabled": true,
"dataUrl": "string"
},
"portalUrls": ["www.support.spotnana.com"
],
"zendeskConfig": {"enabled": true,
"integrationId": "1234567890",
"androidIntegrationId": "1234567890",
"iosIntegrationId": "1234567890"
},
"genesysCloudConfig": {"enabled": true,
"deploymentId": "52dc2a6f-772a-4edf-96d3-b3f0c49400a7",
"environment": "usa-1",
"genesysScriptUrl": "https://test.test.com"
},
"twilioChatConfig": {"enabled": true
}
},
"ccEmailAddresses": ["example@gmail.com"
],
"bccEmailAddresses": ["example@gmail.com"
],
"connectors": [{"connectorType": "HR_FEED_CONNECTOR",
"connectorId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
}
],
"postalAddress": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"redirectUrl": "string",
"rewardsProgram": {"allowedUserRoles": ["TRAVEL_ARRANGER"
],
"conversionRate": {"currencyCode": "USD",
"rate": 0
},
"redeemablePaymentMethods": ["BREX_POINTS"
],
"backingCurrency": ["USD"
]
},
"tmcDefaultConfiguration": {"defaultBookingTmcId": "734f4ea2-e9ed-4c90-853c-9eed62f1254b",
"countryWiseBookingTmcs": [{"countryCode": "US",
"bookingTmcId": "734f4ea2-e9ed-4c90-853c-9eed62f1254b"
}
]
},
"expensePartnerConfig": {"partner": "EXPENSIFY",
"emailConfig": {"personalCardConfig": {"sendToTraveler": false,
"personalCardExpenseEmail": "user@company.com"
},
"centralCardExpenseEmail": "finance+le@company.com",
"expensePartnerEmail": "receipts@expensify.com",
"bccEmail": "docs@company.com"
},
"travelType": ["AIR"
],
"isExpensePartnerEnabled": true,
"reportCustomFields": true,
"personalCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"centralCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"partnerReferralId": "1234hgd",
"itineraryConfig": {"skipModificationUpdate": true,
"skipCancellationUpdate": true
}
},
"mobileRedirectUrl": "string",
"applicableCustomFieldTypes": ["QUESTION"
],
"oauthPartnerConfig": {"name": "string",
"userDetailEndpoint": {"url": "string",
"authHeaderName": "string"
},
"tokenVerifier": {"doVerifyToken": true,
"type": "OKTA_JWT",
"verifierDetails": {"oktaJwtVerifier": {"oauthUrl": "string",
"audience": "string"
}
}
},
"doPersistToken": true
},
"privacySettings": {"allowCompanyAdminAccessToRelativesInfo": true
},
"designationTree": {"name": "string",
"children": [{ }
]
},
"externalId": "MyCompanyId",
"emailClientConfig": {"client": "SENDGRID",
"credentials": {"emailClientSecretKey": {"secretKey": "SECRET_KEY",
"versionId": "1"
}
},
"defaultSenderAddress": "test@somedomain.com",
"defaultSenderName": "Test Sender"
},
"isFake": false,
"tmcPartnerRoleMappings": [{"partnerRole": "string",
"spotnanaRole": "TRAVEL_ARRANGER"
}
],
"supportConfigs": {"length": 0,
"elements": [{"contactNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"emailAddresses": ["support@spotnana.com"
],
"freshdeskConfig": {"enabled": true,
"hasCredentials": false,
"credentials": {"webCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
},
"mobileCredentials": {"domain": "string",
"appId": "string",
"appKey": "string"
}
}
},
"tier": "SEAT1A",
"genesysConfig": {"enabled": true,
"dataUrl": "string"
},
"portalUrls": ["www.support.spotnana.com"
],
"zendeskConfig": {"enabled": true,
"integrationId": "1234567890",
"androidIntegrationId": "1234567890",
"iosIntegrationId": "1234567890"
},
"genesysCloudConfig": {"enabled": true,
"deploymentId": "52dc2a6f-772a-4edf-96d3-b3f0c49400a7",
"environment": "usa-1",
"genesysScriptUrl": "https://test.test.com"
},
"twilioChatConfig": {"enabled": true
}
}
]
},
"loyaltyBlockedCountries": ["US",
"IN"
],
"allowDomainBasedAuthConfig": false,
"carbonCostConfig": {"price": {"amount": 510,
"currencyCode": "GBP",
"convertedAmount": 715.42,
"convertedCurrency": "USD",
"otherCoinage": [{"coinageCode": "BREX_POINTS",
"amount": 1000,
"conversionRate": 0.01,
"preferredCurrencyConversionRate": 0.01
}
]
},
"weight": {"weight": 150,
"unit": "KG"
}
}
}

Response samples

application/json

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

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

curl
JavaScript
Node.js
Python

Response samples

application/json

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

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

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/features

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"length": 1,
"features": [{"name": "ADMIN_VIRTUAL_CARD",
"enabled": true,
"valueType": "BOOL",
"value": "string"
}
]
}

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" "LE_CUSTOM_COLUMNS_CONFIG" "PROFILE_ELEMENTS_VISIBILITY" "SHOW_TRIP_FEE_CONFIG" "SHOW_AGENT_FEE_CONFIG" "DEFAULT_HOTEL_SEARCH_RADIUS_CONFIG" "ENROLLMENT_DASHBOARD" "PRIVACY_CONFIG_HIERARCHY" "POLICY_CONFIGURED_IN_HR_FEED" "COMPANION_VIEW_CONFIG"

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

patch/v2/companies/{companyId}/features

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"featuresToUpdate": [{"name": "ADMIN_VIRTUAL_CARD",
"value": "string"
}
],
"featuresToDelete": ["ADMIN_VIRTUAL_CARD"
]
}

Response samples

application/json

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

Get company travel content config

SecurityBearer

Request

path Parameters

companyId

required

string <uuid>

Identifier for company.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/travel-content-config

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"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
}
]
}
]
}
}

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

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/travel-content-config

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"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
}
]
}
]
}
}

Response samples

application/json

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

Delete company travel content config

SecurityBearer

Request

path Parameters

companyId

required

string <uuid>

Identifier for company.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/v2/companies/{companyId}/travel-content-config

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"
}
]
}

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

400

Bad request

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/white-label-config

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"companyName": "Spotnana",
"colors": {"primary": "#D33B47",
"primaryDark": "#D33B47",
"primaryLight": "#D33B47",
"primaryPale": "#D33B47",
"onPrimary": "#D33B47",
"secondary": "#D33B47",
"secondaryDark": "#D33B47",
"secondaryLight": "#D33B47",
"secondaryPale": "#D33B47",
"onSecondary": "#D33B47",
"error": "#D33B47",
"errorDark": "#D33B47",
"errorLight": "#D33B47",
"errorPale": "#D33B47",
"onError": "#D33B47"
},
"webLinks": {"logoHeader": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/confirmation/spotnana3.png",
"logoFooter": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
"companyWebsiteAddress": "https://www.spotnana.com",
"homePage": "https://stage-app.spotnana.com/flights",
"itineraryPage": "https://stage-app.spotnana.com/trips/3375488451",
"disclaimerPage": "https://www.spotnana.com/terms",
"privacyPage": "https://www.spotnana.com/privacy-policy",
"hardApprovalUrl": "https://stage-app.spotnana.com/hardapproval?approvalId=CgozMzQ5OTI4MzI2EiMKIQoMCgpQaWh1IEd1cHRhEhFwaWh1QHNwb3RuYW5hLmNvbQ%3D%3D&approverName=Pihu%20Gupta&travelerName=Pihu%20Gupta&tripName=TESting%201&tripId=2418132231&voidDate=Tuesday,%2021%20Jun%20at%2002:00%20UTC",
"itineraryFlightStatsUrl": "https://stage-app.spotnana.com/trips/4694735622",
"appEmbedScriptUrl": "https://customjs.partner.com",
"logoNavigationLink": "http://www.spotnana.com",
"illustration": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
"poweredBySpotnana": false,
"logoutRedirectUrl": "https://www.spotnana.com/signout",
"faviconUrl": "http://www.spotnana.com",
"appDownloadLinks": {"androidPlayStoreUrl": "https://play.google.com/store/apps/details?id=com.spotnana",
"iosAppStoreUrl": "https://apps.apple.com/in/app/spotnana-travel-booking/id1580021446",
"qrCodeUrl": "https://www.spotnana.com"
},
"socialMediaLinks": {"facebookUrl": "https://www.facebook.com/spotnanaofficial",
"twitterUrl": "https://twitter.com/spotnana",
"instagramUrl": "https://www.instagram.com/spotnana_official"
},
"termsOfUse": "https://www.spotnana.com/terms/",
"illustrationActionUrl": "https://www.spotnana.com/login"
},
"fromEmailAddress": "no-reply@spotnana.com",
"fontFamily": "Arial",
"emailFontFamily": "Roboto",
"fontFamilyCss": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css",
"emailClientConfig": {"client": "SENDGRID",
"credentials": {"emailClientSecretKey": {"secretKey": "SECRET_KEY",
"versionId": "1"
}
},
"defaultSenderAddress": "test@somedomain.com",
"defaultSenderName": "Test Sender"
},
"clientRoutingBasePath": "string",
"routingConfig": {"appHomeRoute": "/my-account"
},
"privacyDisclaimer": {"show": true,
"html": "</html>"
}
}

Response samples

application/json

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

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

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/white-label-config

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"companyName": "Spotnana",
"colors": {"primary": "#D33B47",
"primaryDark": "#D33B47",
"primaryLight": "#D33B47",
"primaryPale": "#D33B47",
"onPrimary": "#D33B47",
"secondary": "#D33B47",
"secondaryDark": "#D33B47",
"secondaryLight": "#D33B47",
"secondaryPale": "#D33B47",
"onSecondary": "#D33B47",
"error": "#D33B47",
"errorDark": "#D33B47",
"errorLight": "#D33B47",
"errorPale": "#D33B47",
"onError": "#D33B47"
},
"webLinks": {"logoHeader": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/confirmation/spotnana3.png",
"logoFooter": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
"companyWebsiteAddress": "https://www.spotnana.com",
"homePage": "https://stage-app.spotnana.com/flights",
"itineraryPage": "https://stage-app.spotnana.com/trips/3375488451",
"disclaimerPage": "https://www.spotnana.com/terms",
"privacyPage": "https://www.spotnana.com/privacy-policy",
"hardApprovalUrl": "https://stage-app.spotnana.com/hardapproval?approvalId=CgozMzQ5OTI4MzI2EiMKIQoMCgpQaWh1IEd1cHRhEhFwaWh1QHNwb3RuYW5hLmNvbQ%3D%3D&approverName=Pihu%20Gupta&travelerName=Pihu%20Gupta&tripName=TESting%201&tripId=2418132231&voidDate=Tuesday,%2021%20Jun%20at%2002:00%20UTC",
"itineraryFlightStatsUrl": "https://stage-app.spotnana.com/trips/4694735622",
"appEmbedScriptUrl": "https://customjs.partner.com",
"logoNavigationLink": "http://www.spotnana.com",
"illustration": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
"poweredBySpotnana": false,
"logoutRedirectUrl": "https://www.spotnana.com/signout",
"faviconUrl": "http://www.spotnana.com",
"appDownloadLinks": {"androidPlayStoreUrl": "https://play.google.com/store/apps/details?id=com.spotnana",
"iosAppStoreUrl": "https://apps.apple.com/in/app/spotnana-travel-booking/id1580021446",
"qrCodeUrl": "https://www.spotnana.com"
},
"socialMediaLinks": {"facebookUrl": "https://www.facebook.com/spotnanaofficial",
"twitterUrl": "https://twitter.com/spotnana",
"instagramUrl": "https://www.instagram.com/spotnana_official"
},
"termsOfUse": "https://www.spotnana.com/terms/",
"illustrationActionUrl": "https://www.spotnana.com/login"
},
"fromEmailAddress": "no-reply@spotnana.com",
"fontFamily": "Arial",
"emailFontFamily": "Roboto",
"fontFamilyCss": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css",
"emailClientConfig": {"client": "SENDGRID",
"credentials": {"emailClientSecretKey": {"secretKey": "SECRET_KEY",
"versionId": "1"
}
},
"defaultSenderAddress": "test@somedomain.com",
"defaultSenderName": "Test Sender"
},
"clientRoutingBasePath": "string",
"routingConfig": {"appHomeRoute": "/my-account"
},
"privacyDisclaimer": {"show": true,
"html": "</html>"
}
}

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

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/color-config

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"profileColors": [{"title": "PROFILE_TIER_MEMBER_COLOR",
"color": "#FF0000"
}
]
}

Response samples

application/json

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

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

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/color-config

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"profileColors": [{"title": "PROFILE_TIER_MEMBER_COLOR",
"color": "#FF0000"
}
]
}

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

Payload
curl
JavaScript
Node.js
Python

application/json

{"name": "string",
"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"billingCurrency": "string",
"dba": "string",
"ein": "string",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"isDelayedInvoicingEnabled": true,
"ccEmailAddresses": ["example@gmail.com"
],
"bccEmailAddresses": ["example@gmail.com"
],
"externalId": "legal-entity-external-id",
"companySpecifiedAttributes": [{"fieldName": "businessId",
"value": "ABCD"
}
]
}

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

401

Unauthorized

403

Forbidden

get/v2/companies/{companyId}/legal-entities

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

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

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

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/legal-entities/{legalEntityId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"billingCurrency": "string",
"dba": "string",
"ein": "string",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"isDelayedInvoicingEnabled": true,
"bookingTmcRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"expensePartnerConfig": {"partner": "EXPENSIFY",
"emailConfig": {"personalCardConfig": {"sendToTraveler": false,
"personalCardExpenseEmail": "user@company.com"
},
"centralCardExpenseEmail": "finance+le@company.com",
"expensePartnerEmail": "receipts@expensify.com",
"bccEmail": "docs@company.com"
},
"travelType": ["AIR"
],
"isExpensePartnerEnabled": true,
"reportCustomFields": true,
"personalCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"centralCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"partnerReferralId": "1234hgd",
"itineraryConfig": {"skipModificationUpdate": true,
"skipCancellationUpdate": true
}
},
"ccEmailAddresses": ["example@gmail.com"
],
"bccEmailAddresses": ["example@gmail.com"
],
"externalId": "my-external-id",
"companySpecifiedAttributes": [{"fieldName": "businessId",
"value": "ABCD"
}
]
}

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

Payload
curl
JavaScript
Node.js
Python

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"billingCurrency": "string",
"dba": "string",
"ein": "string",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"isDelayedInvoicingEnabled": true,
"bookingTmcRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"expensePartnerConfig": {"partner": "EXPENSIFY",
"emailConfig": {"personalCardConfig": {"sendToTraveler": false,
"personalCardExpenseEmail": "user@company.com"
},
"centralCardExpenseEmail": "finance+le@company.com",
"expensePartnerEmail": "receipts@expensify.com",
"bccEmail": "docs@company.com"
},
"travelType": ["AIR"
],
"isExpensePartnerEnabled": true,
"reportCustomFields": true,
"personalCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"centralCardExpenseOwner": {"traveler": true,
"centralEmail": "docs@company.com"
},
"partnerReferralId": "1234hgd",
"itineraryConfig": {"skipModificationUpdate": true,
"skipCancellationUpdate": true
}
},
"ccEmailAddresses": ["example@gmail.com"
],
"bccEmailAddresses": ["example@gmail.com"
],
"externalId": "my-external-id",
"companySpecifiedAttributes": [{"fieldName": "businessId",
"value": "ABCD"
}
]
}

Response samples

application/json

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

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

curl
JavaScript
Node.js
Python

Response samples

application/json

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

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

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/companies/{companyId}/cost-centers

Request samples

Payload
curl
JavaScript
Node.js
Python

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

401

Unauthorized

403

Forbidden

get/v2/companies/{companyId}/cost-centers

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

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

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

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/companies/{companyId}/cost-centers/{costCenterId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"employeeCount": 120,
"id": {"id": "731ccbca-0415-6fe1-d235-c324dfbe7423"
},
"name": "CostCenter",
"externalId": "external-id"
}

Update cost center

This endpoint updates 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

Request Body schema: application/json

employeeCount	integer <int32> Count of employees in the cost center
required	object (CostCenterId)
name required	string
externalId	string

Responses

204

Updated Successfully

400

Bad request

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/companies/{companyId}/cost-centers/{costCenterId}

Request samples

Payload