CoreApiCompany

snowbee.coreapi.CoreApiCompany

object · non-null

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

View raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiAddress"
      },
      "title": "List<CoreApiAddress>"
    },
    "email": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "name": {
      "type": "string",
      "title": "String"
    },
    "number": {
      "type": "string",
      "title": "String"
    },
    "phone": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "version": {
      "type": "integer",
      "format": "int64",
      "title": "Long"
    },
    "business_registration_number": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "company_type": {
      "type": "string",
      "title": "String"
    },
    "country_iso_code": {
      "type": "string",
      "title": "String"
    },
    "created_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "currency_iso_code": {
      "type": "string",
      "title": "String"
    },
    "invoice_email": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "is_customer": {
      "type": "boolean",
      "title": "Boolean"
    },
    "is_supplier": {
      "type": "boolean",
      "title": "Boolean"
    },
    "language_iso_code": {
      "type": "string",
      "title": "String"
    },
    "modified_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "web_address": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "addresses",
    "id",
    "name",
    "number",
    "status",
    "version",
    "company_type",
    "country_iso_code",
    "created_at",
    "currency_iso_code",
    "is_customer",
    "is_supplier",
    "language_iso_code",
    "modified_at"
  ],
  "title": "CoreApiCompany"
}