insertSubsidiary

WRITE

Insert subsidiary.

POST /api/v1/settings/insertSubsidiary

curl -X POST '<your-host>/api/v1/settings/insertSubsidiary' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "addressLine1": "string",
    "city": "string",
    "postalCode": "string",
    "countryCode": "string",
    "baseCurrencyCode": "string",
    "timezone": "string"
  }'

Response

{
  "id": "string"
}

Parameters

ParameterType

min length 1

pattern ^\+[1-9]\d{1,14}$

Input schema

schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "addressLine1": {
      "type": "string",
      "minLength": 1
    },
    "addressLine2": {
      "type": "string"
    },
    "city": {
      "type": "string",
      "minLength": 1
    },
    "stateProvince": {
      "type": "string"
    },
    "postalCode": {
      "type": "string",
      "minLength": 1
    },
    "countryCode": {
      "type": "string",
      "minLength": 1
    },
    "baseCurrencyCode": {
      "type": "string"
    },
    "timezone": {
      "type": "string",
      "minLength": 1
    },
    "website": {
      "type": "string"
    },
    "taxId": {
      "type": "string"
    },
    "phone": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{1,14}$"
    },
    "fax": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{1,14}$"
    },
    "email": {
      "type": "string"
    },
    "vatNumber": {
      "type": "string"
    },
    "eori": {
      "type": "string"
    },
    "registrationNumber": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "parentCompanyId": {
      "type": "string"
    },
    "isEliminationEntity": {
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "addressLine1",
    "city",
    "postalCode",
    "countryCode",
    "baseCurrencyCode",
    "timezone"
  ]
}