Skip to main content

StakeHolderView

Represents a stakeholder (person or company)

uidstring<uuid>required

Unique identifier of the stakeholder

Example: 123e4567-e89b-12d3-a456-426614174000
typestringrequired

Type of stakeholder (person or company)

Example: person
firstNamestring | nullnullable

First name of the stakeholder (null for companies)

Example: John
lastNamestring | nullnullable

Last name of the stakeholder (null for companies)

Example: Doe
namestringrequired

Full name of the stakeholder (null for person, company name required)

Example: Stonal
sirenstring | nullnullable

SIREN number of the companies (null for persons)

Example: 123456789
addressstring | nullnullable

Address of the company

postalCodestring | nullnullable

Postal code of the company

citystring | nullnullable

City of the company

externalCodestring | nullnullable

External code of the company

contactsDetails object[]

List of contact details of the stakeholder

  • Array [
    • phoneNumberstring | nullnullable

    Phone number of the contact

    Example: 0123456789
    additionalInfosstring | nullnullable

    Additional infos of the contact

    Example: Some additional infos
    emailstring | nullnullable

    Email address required for person and company

    Example: john.doe@example.com
    creationDatestring | nullnullable

    Date of creation of the contact

    Example: 2020-01-01
  • ]
    • phoneNumbers object[]

    Qualified phone numbers of the stakeholder

  • Array [
    • valuestringrequired

    Value of the coordinate (phone number or email)

    Example: 0611223344
    typestringrequired

    Qualifier of the coordinate

    Example: Mobile
    isPrimarybooleanrequired

    Whether this is the primary coordinate of its type

    Example: true
  • ]
    • emails object[]

    Qualified emails of the stakeholder

  • Array [
    • valuestringrequired

    Value of the coordinate (phone number or email)

    Example: 0611223344
    typestringrequired

    Qualifier of the coordinate

    Example: Mobile
    isPrimarybooleanrequired

    Whether this is the primary coordinate of its type

    Example: true
  • ]
    • contracts object[]

    Stakeholder contracts list

  • Array [
    • idstringrequired

    Id of the contract

    typestringrequired

    Type of the contract

    Example: LEASE
    codestringrequired

    Code of the contract

    labelstring | nullnullable

    Label of the contract

    assetUidsstring[]nullable

    Asset stonal ids linked of the contract

    assetChildrenUidsstring[]nullable

    Children assets stonal ids linked of the contract

  • ]
    • contractTypesstring[]required

    Derived contact sub-type (read-only): the distinct holder-type codes of the stakeholder's active (non-terminated) contracts. Empty when the stakeholder has no active contract.

    Example: ["LEASE","MAINTENANCE"]
    isActivebooleanrequired

    Active status of the stakeholder

    faxstring | nullnullable

    Fax of the company

    functionstring | nullnullable

    Function of the person

    parentUidstring | nullnullable

    Refers to the stakeholder hierarchy only (not the asset perimeter or a contract): uid of this stakeholder's parent company — the mother company for a company, the attachment company for a person

    Example: 030f134a-fb24-4a16-8acb-d29d9ba50077
    parent object

    Display-ready summary of the parent (same link as parentUid): lets a client render the selected parent (e.g. "SIREN - name" in the parent picker) without having paged through the company list to resolve the uid. Absent when the stakeholder has no parent.

    oneOf
    uidstringrequired

    Uid of the parent

    Example: 030f134a-fb24-4a16-8acb-d29d9ba50077
    namestringrequired

    Name of the parent

    Example: Acme Corp
    sirenstring | nullnullable

    SIREN of the parent

    Example: 552100554
    hasChildrenbooleanrequired

    Refers to the stakeholder hierarchy only (not the asset perimeter or a contract): whether this stakeholder has at least one child — a company's subsidiaries or the persons attached to it. Fetch the children with ?parentUid= on the search endpoint.

    Example: true
    childrenCountinteger<int32>required

    Number of direct children — the count behind hasChildren

    Example: 3
    contractCountinteger<int32>required

    Number of active (non-terminated) contracts

    Example: 2
    creationDatestring | nullnullable

    Date of creation of the stakeholder

    Example: 2024-01-15
    updatedAtstring | nullnullable

    Date of last update of the stakeholder

    Example: 2024-11-10T14:30:00
    StakeHolderView
    {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "type": "person",
      "firstName": "John",
      "lastName": "Doe",
      "name": "Stonal",
      "siren": "123456789",
      "address": "string",
      "postalCode": "string",
      "city": "string",
      "externalCode": "string",
      "contactsDetails": "Unknown Type: array,null",
      "phoneNumbers": "Unknown Type: array,null",
      "emails": "Unknown Type: array,null",
      "contracts": "Unknown Type: array,null",
      "contractTypes": [
        "LEASE",
        "MAINTENANCE"
      ],
      "isActive": true,
      "fax": "string",
      "function": "string",
      "parentUid": "030f134a-fb24-4a16-8acb-d29d9ba50077",
      "parent": {
        "uid": "030f134a-fb24-4a16-8acb-d29d9ba50077",
        "name": "Acme Corp",
        "siren": "552100554"
      },
      "hasChildren": true,
      "childrenCount": 3,
      "contractCount": 2,
      "creationDate": "2024-01-15",
      "updatedAt": "2024-11-10T14:30:00"
    }