ContractsGetResultResponse

data object[]required

Array [

organizationCodestringrequired

Organization code

Example: ORG123

codestringrequired

Contract code

Example: CONT456

contractType objectrequired

Type of contract

organizationCodestringrequired

Organization code

Example: ORG123

codestringrequired

Code of the holder type

Example: BUILDING

typestringrequired

Type category

Example: ASSET

naturestring | nullnullable

Nature of the holder type (PHYSICAL, LOGICAL, PROPERTY_DYNAMIC)

Example: PHYSICAL

equipmentDestinationstring | nullnullable

Equipment destination classification

Example: WALL

names object[]required

Localized names for this holder type

Array [

singularstringrequired

Singular form of the name

Example: Building

pluralstringrequired

Plural form of the name

Example: Buildings

languagestringrequired

Language code

Example: en

]

numberOfAssets(integer | null)<int32>nullable

Number of assets of this holder type. Asynchronous: refreshed by a background job, may lag behind asset changes by ~10 minutes

Example: 42

hasAssetsboolean | nullnullable

Whether at least one non-deleted asset of this type or of any of its subtypes exists. Live check, only returned when withHasAssets=true and the holder super type is ASSET. Unlike numberOfAssets (asynchronous and direct assets only), this includes subtype assets: a parent type reports true when only its subtypes hold assets

Example: true

importErrors object

Information about import errors

oneOf

• ImportErrors
• null

Information about import errors

duplicatesinteger<int32>required

Number of duplicate entries

Example: 0

othersinteger<int32>required

Number of other errors

Example: 0

recommendedPropertyCodesstring[]required

Codes of properties recommended for this holder type

Example: ["PROP_AREA","PROP_HEIGHT"]

mandatoryPropertyCodesstring[]required

Codes of properties mandatory for this holder type

Example: ["PROP_REFERENCE"]

stakeholders object[]required

List of stakeholders involved in the contract

Array [

namestringrequired

Name of the stakeholder

Example: Acme Corporation

codestringrequired

Code identifying the stakeholder

Example: STK789

uidstring | nullnullable

Unique identifier of the stakeholder

Example: 33333333-3333-3333-3333-333333333333

externalCodestring | nullnullable

External code of the stakeholder

Example: EXT123

]

effectiveDate(string | null)<date>nullable

Date when the contract becomes effective

endDate(string | null)<date>nullable

End date of the contract

terminationDate(string | null)<date>nullable

Termination date if contract was terminated early

deadlines object[]required

Important deadlines in the contract lifecycle

Array [

valuestring<date>required

The deadline date

]

assets object[]required

Assets associated with this contract

Array [

assetErpCodestringrequired

ERP code of the asset

Example: ERP123

assetCodestringrequireddeprecated

Asset code (deprecated, use assetErpCode instead)

Example: ERP123

area(number | null)<double>nullable

Area of the asset in square meters

Example: 150.5

effectiveDatestringrequired

Date when the asset was added to the contract

Example: 2023-01-01

expirationDatestringrequired

Date when the asset will be removed from the contract

Example: 2025-12-31

initialRent(number | null)<double>nullable

Initial rent amount

Example: 1200

actualRent(number | null)<double>nullable

Current rent amount

Example: 1250

stonalIdentifierstring | nullnullable

Stonal identifier of the asset

]

integrationDate(string | null)<date-time>nullable

Date when contract was integrated into the system

labelstring | nullnullable

Label of the contract

equipments object[]requireddeprecated

List of equipments linked to the contract (deprecated, use the V2 installations field instead)

Array [

codestringrequired

Equipment code

Example: EQUIPMENT

names object[]required

List of names for the equipment

Array [

singularstringrequired

Singular form of the name

Example: Building

pluralstringrequired

Plural form of the name

Example: Buildings

languagestringrequired

Language code

Example: en

]

]

notice(integer | null)<int32>nullable

Notice period in months

data object | null

Property data values for the contract, keyed by property code. Populated only when ?include=data is set on the request.

property name* object[]

Array [

organizationCodestringrequired

Organization code

Example: ORG123

propertyCodestringrequired

Property code

Example: SURFACE

value

Data value (type depends on the property)

Example: 150.5

rawValuestringrequired

Raw string representation of the value

Example: 150.5

holderCodestringrequired

Holder code

Example: ASSET456

holderTypestringrequired

Type of holder

Possible values: [ASSET, LEASE, CONTRACT, PARTIAL, UNKNOWN]

Example: BUILDING

source objectrequired

Source information

detailsstringrequired

Source details

Example: Manually entered

typestringrequired

Source type

Example: USER

valuestringrequired

Source value

Example: Manually entered

sourceDocumentUidstring | nullnullable

Source document id when applicable (DOCUMENT)

Example: 185b19bd-cd1c-45ed-8f92-6b1641c72d0c

interval objectrequired

Validity interval of the data

effectiveDatestring<date>required

Date when the data becomes valid

expirationDatestring<date>required

Date when the data ceases to be valid

idinteger<int64>required

Unique identifier of the data

Example: 42

]

]

paginate objectrequired

sizeinteger<int32>

Number of results

Possible values: <= 2000

Default value: 50

cursorstring | nullnullable

A marker indicating the position in a dataset, used to determine where to continue fetching results in paginated data

Default value: 0

ContractsGetResultResponse

{
  "data": [
    {
      "organizationCode": "ORG123",
      "code": "CONT456",
      "contractType": {
        "organizationCode": "ORG123",
        "code": "BUILDING",
        "type": "ASSET",
        "nature": "PHYSICAL",
        "equipmentDestination": "WALL",
        "names": [
          {
            "singular": "Building",
            "plural": "Buildings",
            "language": "en"
          }
        ],
        "numberOfAssets": 42,
        "hasAssets": true,
        "importErrors": {
          "duplicates": 0,
          "others": 0
        },
        "recommendedPropertyCodes": [
          "PROP_AREA",
          "PROP_HEIGHT"
        ],
        "mandatoryPropertyCodes": [
          "PROP_REFERENCE"
        ]
      },
      "stakeholders": [
        {
          "name": "Acme Corporation",
          "code": "STK789",
          "uid": "33333333-3333-3333-3333-333333333333",
          "externalCode": "EXT123"
        }
      ],
      "effectiveDate": "2024-07-29",
      "endDate": "2024-07-29",
      "terminationDate": "2024-07-29",
      "deadlines": [
        {
          "value": "2024-07-29"
        }
      ],
      "assets": [
        {
          "assetErpCode": "ERP123",
          "area": 150.5,
          "effectiveDate": "2023-01-01",
          "expirationDate": "2025-12-31",
          "initialRent": 1200,
          "actualRent": 1250,
          "stonalIdentifier": "string"
        }
      ],
      "integrationDate": "2024-07-29T15:51:28.071Z",
      "label": "string",
      "notice": 0,
      "data": "Unknown Type: object,null"
    }
  ],
  "paginate": {
    "size": 50,
    "cursor": "0"
  }
}