SupplierWrite

idstring<uuid>

Key: the Nuntiq id

supplier_numberstringrequired

required

Possible values: <= 100 characters

supplier_namestringrequired

required

Possible values: <= 255 characters

alternative_supplier_namestring

Possible values: <= 255 characters

supplier_typestring

default "1"

Possible values: <= 50 characters

organization_codestring

Possible values: <= 100 characters

is_activeboolean

default true

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).

locations object[]

locations: POST replaces the integration's own locations (left out = kept; [] removes the integration's own); PATCH merges by key and removes an item sent with "_delete": true. Keys: id, source_system + source_record_id, location_code.

Array [

idstring<uuid>

Key: the Nuntiq id

location_codestringrequired

required

Possible values: <= 100 characters

location_namestring

Possible values: <= 255 characters

organization_codestring

Possible values: <= 100 characters

site_purposeinteger

default 1

Possible values: >= 1 and <= 32767

default_currency_codestring

stored upper case

Possible values: <= 3 characters

default_payment_term_codestring

Possible values: <= 100 characters

default_payment_methodstring

Possible values: <= 100 characters

taxpayer_idstring

Possible values: <= 100 characters

duns_numberstring

Possible values: <= 50 characters

is_defaultboolean

default false

is_activeboolean

default true

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).

addresses object[]

addresses: POST replaces the integration's own addresses (left out = kept; [] removes the integration's own); PATCH merges by key and removes an item sent with "_delete": true. Keys: id, source_system + source_record_id, street + city + postal_code + country_code.

Array [

idstring<uuid>

Key: the Nuntiq id

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

remit_to_addressboolean

default false

statusstring

Possible values: <= 50 characters

custom_field_1string

Possible values: <= 255 characters

custom_field_2string

Possible values: <= 255 characters

custom_field_3string

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).

_deleteboolean

PATCH: remove this item

]

bank_accounts object[]

bank_accounts: POST replaces the integration's own bank_accounts (left out = kept; [] removes the integration's own); PATCH merges by key and removes an item sent with "_delete": true. Keys: id, source_system + source_record_id, bank_account_number.

Array [

idstring<uuid>

Key: the Nuntiq id

bank_account_numberstringrequired

required

Possible values: <= 64 characters

bank_namestring

Possible values: <= 255 characters

bank_branchstring

Possible values: <= 255 characters

bank_routing_numberstring

Possible values: <= 64 characters

swift_codestring

stored upper case

Possible values: <= 11 characters

account_currencystring

stored upper case

Possible values: <= 3 characters

is_primaryboolean

default false

statusstring

default "Active"

Possible values: <= 50 characters

custom_field_1string

Possible values: <= 255 characters

custom_field_2string

Possible values: <= 255 characters

custom_field_3string

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).

_deleteboolean

PATCH: remove this item

]

_deleteboolean

PATCH: remove this item

]

SupplierWrite

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "supplier_number": "string",
  "supplier_name": "string",
  "alternative_supplier_name": "string",
  "supplier_type": "string",
  "organization_code": "string",
  "is_active": true,
  "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",
  "locations": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "location_code": "string",
      "location_name": "string",
      "organization_code": "string",
      "site_purpose": 0,
      "default_currency_code": "string",
      "default_payment_term_code": "string",
      "default_payment_method": "string",
      "taxpayer_id": "string",
      "duns_number": "string",
      "is_default": true,
      "is_active": true,
      "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",
      "addresses": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "street": "string",
          "city": "string",
          "state": "string",
          "postal_code": "string",
          "country_code": "string",
          "remit_to_address": true,
          "status": "string",
          "custom_field_1": "string",
          "custom_field_2": "string",
          "custom_field_3": "string",
          "source_system": "string",
          "source_record_id": "string",
          "source_updated_at": "2024-07-29T15:51:28.071Z",
          "_delete": true
        }
      ],
      "bank_accounts": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "bank_account_number": "string",
          "bank_name": "string",
          "bank_branch": "string",
          "bank_routing_number": "string",
          "swift_code": "string",
          "account_currency": "string",
          "is_primary": true,
          "status": "string",
          "custom_field_1": "string",
          "custom_field_2": "string",
          "custom_field_3": "string",
          "source_system": "string",
          "source_record_id": "string",
          "source_updated_at": "2024-07-29T15:51:28.071Z",
          "_delete": true
        }
      ],
      "_delete": true
    }
  ]
}