Developer docs

← All schemas

CoreApiExternalSupplier

snowbee.coreapi.CoreApiItem_snowbee.coreapi.CoreApiExternalSupplier

object · non-null

Exactly one of these shapes is allowed.

deleted objectnon-null
typestringnon-nullrequired
Allowed values"deleted"
idstringnon-nullrequired
changed_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
deleted_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
entity objectnon-null
typestringnon-nullrequired
Allowed values"entity"
dataobjectnon-nullrequired
Show child fields
idstringnon-nullrequired
addressesarray of objectnon-nullrequired
Show item fields
citystringnon-nullrequired
idstringnon-nullrequired
mainbooleannon-nullrequired
streetstringnon-nullrequired
address_typestringnon-nullrequired
country_iso_codestringnon-nullrequired
post_codestringnon-nullrequired
namestringnon-nullrequired
numberstringnon-nullrequired
statusstringnon-nullrequired
versionintegernon-nullrequired
  • Format: int64
business_registration_numberstringnullableoptional
company_emailstringnullableoptional
company_phonestringnullableoptional
contact_peoplearray of objectnon-nullrequired
Show item fields
idstringnon-nullrequired
mainbooleannon-nullrequired
contact_emailstringnon-nullrequired
contact_namestringnullableoptional
contact_phonestringnullableoptional
use_in_purchase_orderbooleannon-nullrequired
country_iso_codestringnon-nullrequired
created_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
currency_for_tenant_idstringnon-nullrequired
is_service_centrebooleannon-nullrequired
language_iso_codestringnon-nullrequired
modified_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
standard_lead_timeintegernon-nullrequired
  • Format: int32
supplier_statusstringnon-nullrequired
web_addressstringnullableoptional
changed_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
View raw schema
{
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "deleted": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiExternalSupplier",
      "entity": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiExternalSupplier"
    }
  },
  "oneOf": [
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiExternalSupplier"
    },
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiExternalSupplier"
    }
  ],
  "title": "CoreApiItem<CoreApiExternalSupplier>"
}