v1

latestOpenAPI 3.1.02026-08-0662251219.8 KB
Offices

Create office

This endpoint creates an office.

post/v2/companies/{companyId}/legal-entities/{legalEntityId}/offices

Request body

namestring
externalIdstring
taxIdstring

Example request

{
  "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",
    "regionCode": "US",
    "regionName": "America",
    "revision": 1,
    "sortingCode": "Jamaica",
    "timezone": "America/Los_Angeles",
    "coordinates": {
      "latitude": 77.1025,
      "longitude": 28.7041
    }
  },
  "name": "Office name",
  "latlng": {
    "latitude": 77.1025,
    "longitude": 28.7041
  },
  "externalId": "external-id",
  "taxId": "123232"
}

Response

Created

idstring uuid required

Example response

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