Create legal entity

API reference

Company

Create legal entity

Request

This endpoint creates a legal entity.

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

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

Bodyapplication/jsonrequired

namestringrequired

Name of the legal entity

registeredNamestring

The official name of this legal entity as registered with local tax authorities.

registeredEmailstring

The primary email (or alias) used for the "Registered name" of this legal entity. Used for official communications, including regulatory, compliance, and invoicing purposes.

addressobject(PostalAddress)required

Address of the legal entity.

billingAddressobject(PostalAddress)

Optional dedicated billing address. A present valid value stores the dedicated address. Omitting this property or setting it to null stores no dedicated address, so billing uses the current physical address.

billingCurrencystringrequired

Billing currency for the legal entity.

dbastring

Business name, sort form of Doing Business As

einstring

Tax number

phoneNumbersArray of objects(PhoneNumber)

isDelayedInvoicingEnabledboolean

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.

ccEmailAddressesArray 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'

Example:

[
  "example@gmail.com"
]

bccEmailAddressesArray 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'

Example:

[
  "example@gmail.com"
]

externalIdstring

External id for legal entity.

Example:"legal-entity-external-id"

companySpecifiedAttributesArray of objects(CompanySpecifiedAttributeLegalEntity)

Company specified attributes or fields for the legal entity.

billingLegalEntityRefobject(Reference object containing uuid and name of the entity.)

Optional reference to another legal entity in the same company whose name, address, and tax ID are used on invoices/receipts. When absent, this entity bills as itself.

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",
    "registeredName": "string",
    "registeredEmail": "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
      }
    },
    "billingAddress": {
      "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"
      }
    ],
    "billingLegalEntityRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    }
  }'

Responses

Created

Bodyapplication/json

idstring, (uuid)required

Example:"b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"

Response

{
  "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
}