CoreApiCompany

snowbee.coreapi.CoreApiItem_snowbee.coreapi.CoreApiCompany

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

emailstringnullableoptional

namestringnon-nullrequired

numberstringnon-nullrequired

phonestringnullableoptional

statusstringnon-nullrequired

versionintegernon-nullrequired

Format: int64

business_registration_numberstringnullableoptional

company_typestringnon-nullrequired

country_iso_codestringnon-nullrequired

created_atstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

currency_iso_codestringnon-nullrequired

invoice_emailstringnullableoptional

is_customerbooleannon-nullrequired

is_supplierbooleannon-nullrequired

language_iso_codestringnon-nullrequired

modified_atstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

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.CoreApiCompany",
      "entity": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiCompany"
    }
  },
  "oneOf": [
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiCompany"
    },
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiCompany"
    }
  ],
  "title": "CoreApiItem<CoreApiCompany>"
}