Supplier

supplier_iduuid

supplier_numberstringrequired

supplier_namestringrequired

alternative_supplier_namestring

supplier_typestring

organization_codestring

Part of the (supplier_number, organization_code) upsert key. Defaults applied if omitted.

is_activeboolean

is_deletedboolean

Soft-delete flag. GET endpoints filter is_deleted=false; settable via DELETE endpoint only.

deleted_atdate-timenullable

custom_field_1stringnullable

custom_field_2stringnullable

custom_field_3stringnullable

custom_field_4stringnullable

custom_field_5stringnullable

created_atdate-time

updated_atdate-time

supplier_location object[]

Array [

supplier_location_iduuid

supplier_iduuid

location_codestring

location_namestring

organization_codestring

site_purposeinteger

default_currency_codestring

default_payment_term_codestring

default_payment_methodstring

taxpayer_idstring

duns_numberstring

is_activeboolean

custom_field_1stringnullable

custom_field_2stringnullable

custom_field_3stringnullable

custom_field_4stringnullable

custom_field_5stringnullable

created_atdate-time

updated_atdate-time

supplier_address object[]

Array [

supplier_location_iduuid

streetstring

citystring

statestring

postal_codestring

country_codestring

custom_field_1stringnullable

custom_field_2stringnullable

custom_field_3stringnullable

]

supplier_bank_account object[]

Array [

supplier_location_iduuid

bank_namestring

bank_branchstring

bank_account_numberstring

bank_routing_numberstring

swift_codestring

account_currencystring

is_primaryboolean

custom_field_1stringnullable

custom_field_2stringnullable

custom_field_3stringnullable

]

]

Supplier

{
  "supplier_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,
  "is_deleted": true,
  "deleted_at": "2024-07-29T15:51:28.071Z",
  "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",
  "supplier_location": [
    {
      "supplier_location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "supplier_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_active": true,
      "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",
      "supplier_address": [
        {
          "supplier_location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "street": "string",
          "city": "string",
          "state": "string",
          "postal_code": "string",
          "country_code": "string",
          "custom_field_1": "string",
          "custom_field_2": "string",
          "custom_field_3": "string"
        }
      ],
      "supplier_bank_account": [
        {
          "supplier_location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "bank_name": "string",
          "bank_branch": "string",
          "bank_account_number": "string",
          "bank_routing_number": "string",
          "swift_code": "string",
          "account_currency": "string",
          "is_primary": true,
          "custom_field_1": "string",
          "custom_field_2": "string",
          "custom_field_3": "string"
        }
      ]
    }
  ]
}