APIs to onboard and manage company.
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/
Bodyapplication/jsonrequired
Code of administrative area. For example: DL for Delhi, India. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
Example: "CA"
Name of administrative area. This is full name corresponding to administrativeArea. Like Delhi for DL area code. For some places, code and name maybe same as well like Tokyo.
Example: "California"
Whether this address is default address in case multiple addresses are specified.
Example: true
BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. Examples: "zh-Hant", "ja", "ja-Latn", "en".
Example: "en"
Generally refers to the city/town portion of the address.
Example: "San Francisco"
IATA 3-letter location code. See https://www.iata.org/en/services/codes.
Example: "LAX"
Postal code of the address. This is a required field when setting for a user/legal entity/company etc.
Example: "94130"
2 letter continent code of the continent this address falls in.
Example: "AF"
Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
Example: "Jamaica"
Sublocality of the address. This can be neighborhoods, boroughs, districts.
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.
List of email addresses on which all confirmation emails for this LE will be cc'ed. This is applicable only for company roles 'ORG'
Example: ["example@gmail.com"]
List of email addresses on which all confirmation emails for this LE will be bcc'ed. This is applicable only for company roles 'ORG'
Example: ["example@gmail.com"]
- Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/{companyId}/legal-entities
- Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi/v2/companies/{companyId}/legal-entities
- curl
- JavaScript
- Node.js
- Python
curl -i -X POST \
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/legal-entities \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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
application/json
{ "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3" }
- Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/{companyId}/legal-entities
- Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi/v2/companies/{companyId}/legal-entities
- curl
- JavaScript
- Node.js
- Python
curl -i -X GET \
'https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/legal-entities?pageNumber=2&pageSize=20&externalId=my-external-id' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "length": 0, "elements": [ { … } ], "totalNumResults": 0 }
- Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/{companyId}/legal-entities/{legalEntityId}
- Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi/v2/companies/{companyId}/legal-entities/{legalEntityId}
- curl
- JavaScript
- Node.js
- Python
curl -i -X GET \
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/legal-entities/4974a66b-7493-4f41-908c-58ba81093947 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
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.
List of email addresses on which all confirmation emails will be CCed. This is applicable only for company roles 'ORG'
Example: ["example@gmail.com"]
List of email addresses on which all confirmation emails will be BCCed. This is applicable only for company roles 'ORG'
Example: ["example@gmail.com"]
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "address": { "addressLines": [ … ], "administrativeArea": "CA", "administrativeAreaName": "California", "description": "San Francisco Home", "isDefault": true, "languageCode": "en", "locality": "San Francisco", "locationCode": "LAX", "organization": "Spotnana", "postalCode": "94130", "continentCode": "AF", "recipients": [ … ], "regionCode": "US", "regionName": "America", "revision": 1, "sortingCode": "Jamaica", "sublocality": "string", "timezone": "America/Los_Angeles", "coordinates": { … } }, "billingCurrency": "string", "dba": "string", "ein": "string", "phoneNumbers": [ { … } ], "isDelayedInvoicingEnabled": true, "bookingTmcRef": { "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3", "name": "Name" }, "expensePartnerConfig": { "partner": "EXPENSIFY", "emailConfig": { … }, "travelType": [ … ], "isExpensePartnerEnabled": true, "reportCustomFields": true, "personalCardExpenseOwner": { … }, "centralCardExpenseOwner": { … }, "partnerReferralId": "1234hgd", "itineraryConfig": { … } }, "ccEmailAddresses": [ "example@gmail.com" ], "bccEmailAddresses": [ "example@gmail.com" ], "externalId": "my-external-id", "companySpecifiedAttributes": [ { … } ] }
Bodyapplication/jsonrequired
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.
List of email addresses on which all confirmation emails will be CCed. This is applicable only for company roles 'ORG'
Example: ["example@gmail.com"]
List of email addresses on which all confirmation emails will be BCCed. This is applicable only for company roles 'ORG'
Example: ["example@gmail.com"]
- Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/{companyId}/legal-entities/{legalEntityId}
- Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi/v2/companies/{companyId}/legal-entities/{legalEntityId}
- curl
- JavaScript
- Node.js
- Python
curl -i -X PUT \
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/legal-entities/4974a66b-7493-4f41-908c-58ba81093947 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
"name": "Name"
},
"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"
}
]
}'- Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/{companyId}/legal-entities/{legalEntityId}
- Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi/v2/companies/{companyId}/legal-entities/{legalEntityId}
- curl
- JavaScript
- Node.js
- Python
curl -i -X DELETE \
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/legal-entities/4974a66b-7493-4f41-908c-58ba81093947 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'