Skip to main content

OrganizationUnit

idstring<uuid>

The Nuntiq id

codestring

Possible values: <= 100 characters

namestring

required

Possible values: <= 255 characters

organization_typeinteger

required

Possible values: [1, 2, 3]

parent_idstring<uuid>
activeboolean

default true

active_fromstring<date>
active_tostring<date>
default_currencystring

stored upper case

Possible values: <= 3 characters

timezonestring

kept when a POST leaves it out

Possible values: <= 64 characters

custom_field_1string

Possible values: <= 255 characters

custom_field_2string

Possible values: <= 255 characters

custom_field_3string

Possible values: <= 255 characters

custom_field_4string

Possible values: <= 255 characters

custom_field_5string

Possible values: <= 255 characters

custom_field_6string

Possible values: <= 255 characters

custom_field_7string

Possible values: <= 255 characters

custom_field_8string

Possible values: <= 255 characters

custom_field_9string

Possible values: <= 255 characters

custom_field_10string

Possible values: <= 255 characters

custom_field_11string

Possible values: <= 255 characters

custom_field_12string

Possible values: <= 255 characters

custom_field_13string

Possible values: <= 255 characters

custom_field_14string

Possible values: <= 255 characters

custom_field_15string

Possible values: <= 255 characters

source_systemstring

The integration that owns the record. Defaults to the API key's source system. Another one is accepted only when the API user owns All records or All integrated records; otherwise the record is refused (source_system_mismatch).

Possible values: <= 100 characters

source_record_idstring

Key: the record's id in the source system (with source_system)

Possible values: <= 255 characters

source_updated_atstring<date-time>

When the source last changed the record. An older value than the stored one is not applied (stale_source_update warning).

parent_codestring

write-only

Possible values: <= 100 characters

created_atstring<date-time>
updated_atstring<date-time>
identifiers object[]
  • Array [
  • idstring<uuid>

    The Nuntiq id

    identifier_typestring

    required; stored upper case

    Possible values: <= 50 characters

    identifier_valuestring

    required

    Possible values: <= 255 characters

    identifier_labelstring

    required

    Possible values: <= 255 characters

    source_systemstring

    The integration that owns the record. Defaults to the API key's source system. Another one is accepted only when the API user owns All records or All integrated records; otherwise the record is refused (source_system_mismatch).

    Possible values: <= 100 characters

    source_record_idstring

    Key: the record's id in the source system (with source_system)

    Possible values: <= 255 characters

    source_updated_atstring<date-time>

    When the source last changed the record. An older value than the stored one is not applied (stale_source_update warning).

    created_atstring<date-time>
    updated_atstring<date-time>
    organization_unit_idstring
  • ]
  • addresses object[]
  • Array [
  • idstring<uuid>

    The Nuntiq id

    namestring

    Possible values: <= 255 characters

    streetstring

    Possible values: <= 255 characters

    citystring

    Possible values: <= 100 characters

    statestring

    Possible values: <= 100 characters

    postal_codestring

    Possible values: <= 20 characters

    country_codestring

    stored upper case

    Possible values: <= 3 characters

    custom_field_1string

    Possible values: <= 255 characters

    custom_field_2string

    Possible values: <= 255 characters

    custom_field_3string

    Possible values: <= 255 characters

    custom_field_4string

    Possible values: <= 255 characters

    custom_field_5string

    Possible values: <= 255 characters

    source_systemstring

    The integration that owns the record. Defaults to the API key's source system. Another one is accepted only when the API user owns All records or All integrated records; otherwise the record is refused (source_system_mismatch).

    Possible values: <= 100 characters

    source_record_idstring

    Key: the record's id in the source system (with source_system)

    Possible values: <= 255 characters

    source_updated_atstring<date-time>

    When the source last changed the record. An older value than the stored one is not applied (stale_source_update warning).

    created_atstring<date-time>
    updated_atstring<date-time>
    organization_unit_idstring
  • ]
  • OrganizationUnit
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "name": "string",
    "organization_type": 1,
    "parent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "active": true,
    "active_from": "2024-07-29",
    "active_to": "2024-07-29",
    "default_currency": "string",
    "timezone": "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",
    "source_system": "string",
    "source_record_id": "string",
    "source_updated_at": "2024-07-29T15:51:28.071Z",
    "parent_code": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "identifiers": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "identifier_type": "string",
    "identifier_value": "string",
    "identifier_label": "string",
    "source_system": "string",
    "source_record_id": "string",
    "source_updated_at": "2024-07-29T15:51:28.071Z",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "organization_unit_id": "string"
    }
    ],
    "addresses": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "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",
    "source_system": "string",
    "source_record_id": "string",
    "source_updated_at": "2024-07-29T15:51:28.071Z",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "organization_unit_id": "string"
    }
    ]
    }