Model: OrganizationModel

1 min

Model Parameters

OrganizationModel
- primaryKeyIdstring<uuid>
  Description
  Organization ID (GUID).
  Format
  uuid
- addressesAddressModel[]
  Description
  List of addresses.
  - addressIdstring<uuid>
    Description
    Address ID (GUID).
    Format
    uuid
  - modifiedstring<date-time>
    Description
    Last modified date.
    Format
    date-time
  - namestring
    Description
    Address name.
  - firstNamestring
    Description
    First name.
  - lastNamestring
    Description
    Last name.
  - countryNamestring
    Description
    Country name.
  - countryCodestring
    Description
    Country code.
  - citystring
    Description
    City.
  - postalCodestring
    Description
    Postal code (Zip code).
  - line1string
    Description
    Address line 1.
  - line2string
    Description
    Address line 2.
  - regionNamestring
    Description
    Region name.
  - regionCodestring
    Description
    Region code.
  - emailstring
    Description
    Email.
  - isShippingAddressboolean
    Description
    Flag to indicate if this is a shipping address or not.
  - isBillingAddressboolean
    Description
    Flag to indicate if this is a billing address or not.
  - daytimePhoneNumberstring
    Description
    Daytime phone number.
  - eveningPhoneNumberstring
    Description
    Evening phone number.
  - organizationstring
    Description
    Organization name.
  - addressTypeinteger[]
    Description
    Address type.
- childOrganizationsOrganizationModel[]
  Description
  List of child organizations.
  - Circular-Reference
- contactsContactModel[]
  Description
  List of contacts.
  - primaryKeyIdstring<uuid>
    Description
    Contact ID (GUID).
    Format
    uuid
  - addressesAddressModel[]
    Description
    Contacts addresses.
    - addressIdstring<uuid>
      Description
      Address ID (GUID).
      Format
      uuid
    - modifiedstring<date-time>
      Description
      Last modified date.
      Format
      date-time
    - namestring
      Description
      Address name.
    - firstNamestring
      Description
      First name.
    - lastNamestring
      Description
      Last name.
    - countryNamestring
      Description
      Country name.
    - countryCodestring
      Description
      Country code.
    - citystring
      Description
      City.
    - postalCodestring
      Description
      Postal code (Zip code).
    - line1string
      Description
      Address line 1.
    - line2string
      Description
      Address line 2.
    - regionNamestring
      Description
      Region name.
    - regionCodestring
      Description
      Region code.
    - emailstring
      Description
      Email.
    - isShippingAddressboolean
      Description
      Flag to indicate if this is a shipping address or not.
    - isBillingAddressboolean
      Description
      Flag to indicate if this is a billing address or not.
    - daytimePhoneNumberstring
      Description
      Daytime phone number.
    - eveningPhoneNumberstring
      Description
      Evening phone number.
    - organizationstring
      Description
      Organization name.
    - addressTypeinteger[]
      Description
      Address type.
  - firstNamestring
    Description
    First name.
  - lastNamestring
    Description
    Last name.
  - emailstring
    Description
    Email.
  - registrationSourcestring
    Description
    Registration source.
- organizationTypestring
  Description
  Organization type.
- orgCustomerGroupstring
  Description
  Organization customer group.
- businessCategorystring
  Description
  Business category.
- namestringrequired
  Description
  Organization name.
- descriptionstring
  Description
  Organization description.
- propertiesPropertyItemModel[]
  Description
  Gets the list of key value pairs for dealing with custom properties.
  - keystring
    Description
    Key of the property.
  - valuestring
    Description
    Value of the property.

Organization model.