OrganizationUnit

namestringrequired

Required. Name of the organization unit.

codestringrequired

Required. Unique code that identifies the organization unit. Used as a reference in parent-child relationships.

organization_typeintegerrequired

Required. Type of the organization unit:
1 = Group
2 = Unit
3 = Business Unit

parent_idstringnullable

Code of the parent organization unit. Must reference a valid unit of the correct type.

activeboolean

Whether the organization unit is active. Defaults to true.

active_fromdate-timenullable

Optional start date when the organization unit becomes active.

active_todate-timenullable

Optional end date after which the organization unit is no longer active.

default_currencystringnullable

ISO currency code (e.g., USD, EUR) to be used as the default for this unit.

custom_field_1stringnullable

Free to use text field

custom_field_2stringnullable

Free to use text field

custom_field_3stringnullable

Free to use text field

custom_field_4stringnullable

Free to use text field

custom_field_5stringnullable

Free to use text field

custom_field_6stringnullable

Free to use text field

custom_field_7stringnullable

Free to use text field

custom_field_8stringnullable

Free to use text field

custom_field_9stringnullable

Free to use text field

custom_field_10stringnullable

Free to use text field

custom_field_11stringnullable

Free to use text field

custom_field_12stringnullable

Free to use text field

custom_field_13stringnullable

Free to use text field

custom_field_14stringnullable

Free to use text field

custom_field_15stringnullable

Free to use text field

created_atdate-time

Timestamp when the record was created.

updated_atdate-time

Timestamp of the last update to the record.

identifiers object[]

List of identifiers for the organization unit (e.g., DUNS, Tax ID).

Array [

identifier_labelstring

Required. Display name of the identifier (e.g., "VAT Number").

identifier_valuestring

Required. The actual value of the identifier.

identifier_typestring

Required. Type code of the identifier (e.g., VAT, DUNS, EIN).

created_atdate-time

Timestamp when the identifier was created.

updated_atdate-time

Timestamp when the identifier was last updated.

]

addresses object[]

List of address records associated with the organization unit.

Array [

namestring

Label for the address (e.g., "Headquarters", "Warehouse").

streetstring

Required. Street address.

citystring

Required. City name.

statestring

State, region, or province.

postal_codestring

Postal or ZIP code.

country_codestring

Required. ISO 2-letter country code (e.g., US, CA, GB).

custom_field_1stringnullable

Free to use text field

custom_field_2stringnullable

Free to use text field

custom_field_3stringnullable

Free to use text field

custom_field_4stringnullable

Free to use text field

custom_field_5stringnullable

Free to use text field

created_atdate-time

Timestamp when the address was created.

updated_atdate-time

Timestamp when the address was last updated.

]

OrganizationUnit

{
  "name": "string",
  "code": "string",
  "organization_type": 0,
  "parent_id": "string",
  "active": true,
  "active_from": "2024-07-29T15:51:28.071Z",
  "active_to": "2024-07-29T15:51:28.071Z",
  "default_currency": "string",
  "custom_field_1": "string",
  "custom_field_2": "string",
  "custom_field_3": "string",
  "custom_field_4": "string",
  "custom_field_5": "string",
  "custom_field_6": "string",
  "custom_field_7": "string",
  "custom_field_8": "string",
  "custom_field_9": "string",
  "custom_field_10": "string",
  "custom_field_11": "string",
  "custom_field_12": "string",
  "custom_field_13": "string",
  "custom_field_14": "string",
  "custom_field_15": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "identifiers": [
    {
      "identifier_label": "string",
      "identifier_value": "string",
      "identifier_type": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "addresses": [
    {
      "name": "string",
      "street": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country_code": "string",
      "custom_field_1": "string",
      "custom_field_2": "string",
      "custom_field_3": "string",
      "custom_field_4": "string",
      "custom_field_5": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}