ContractsGetResultResponse

data object[]required

Array [

organizationCodestringrequired

Organization code

Default value:

Example: ORG123

codestringrequired

Contract code

Default value:

Example: CONT456

contractType objectrequired

Type of contract

organizationCodestringrequired

Organization code

Default value:

Example: ORG123

codestringrequired

Code of the holder type

Default value:

Example: BUILDING

typestringrequired

Type category

Default value:

Example: ASSET

naturestring | nullnullable

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

Default value:

Example: PHYSICAL

equipmentDestinationstring | nullnullable

Equipment destination classification

Default value:

Example: WALL

names object[]required

Localized names for this holder type

Array [

singularstringrequired

Singular form of the name

Default value:

Example: Building

pluralstringrequired

Plural form of the name

Default value:

Example: Buildings

languagestringrequired

Language code

Default value:

Example: en

]

numberOfAssetsint32nullable

Number of assets of this holder type

Default value:

Example: 42

importErrors object

oneOf

• ImportErrors
• null

duplicatesint32required

Number of duplicate entries

Default value:

Example: 0

othersint32required

Number of other errors

Default value:

Example: 0

recommendedPropertyCodesstring[]required

Codes of properties recommended for this holder type

Default value:

Example: ["PROP_AREA","PROP_HEIGHT"]

mandatoryPropertyCodesstring[]required

Codes of properties mandatory for this holder type

Default value:

Example: ["PROP_REFERENCE"]

stakeholders object[]required

List of stakeholders involved in the contract

Array [

namestringrequired

Name of the stakeholder

Default value:

Example: Acme Corporation

codestringrequired

Code identifying the stakeholder

Default value:

Example: STK789

uidstring | nullnullable

Unique identifier of the stakeholder

Default value:

Example: 33333333-3333-3333-3333-333333333333

externalCodestring | nullnullable

External code of the stakeholder

Default value:

Example: EXT123

]

effectiveDatedatenullable

Date when the contract becomes effective

Default value:

endDatedatenullable

End date of the contract

Default value:

terminationDatedatenullable

Termination date if contract was terminated early

Default value:

deadlines object[]required

Important deadlines in the contract lifecycle

Array [

valuedaterequired

The deadline date

Default value:

]

assets object[]required

Assets associated with this contract

Array [

assetErpCodestringrequired

ERP code of the asset

Default value:

Example: ERP123

assetCodestringrequireddeprecated

Asset code (deprecated, use assetErpCode instead)

Default value:

Example: ERP123

areadoublenullable

Area of the asset in square meters

Default value:

Example: 150.5

effectiveDatestringrequired

Date when the asset was added to the contract

Default value:

Example: 2023-01-01

expirationDatestringrequired

Date when the asset will be removed from the contract

Default value:

Example: 2025-12-31

initialRentdoublenullable

Initial rent amount

Default value:

Example: 1200

actualRentdoublenullable

Current rent amount

Default value:

Example: 1250

stonalIdentifierstring | nullnullable

Stonal identifier of the asset

Default value:

]

integrationDatedate-timenullable

Date when contract was integrated into the system

Default value:

labelstring | nullnullable

Label of the contract

Default value:

equipments object[]required

List of equipments linked to the contract

Array [

codestringrequired

Equipment code

Default value:

Example: EQUIPMENT

names object[]required

List of names for the equipment

Array [

singularstringrequired

Singular form of the name

Default value:

Example: Building

pluralstringrequired

Plural form of the name

Default value:

Example: Buildings

languagestringrequired

Language code

Default value:

Example: en

]

]

noticeint32nullable

Notice period in months

Default value:

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

Default value:

Example: ORG123

propertyCodestringrequired

Property code

Default value:

Example: SURFACE

valuenull

Data value (type depends on the property)

Default value:

Example: 150.5

rawValuestringrequired

Raw string representation of the value

Default value:

Example: 150.5

holderCodestringrequired

Holder code

Default value:

Example: ASSET456

holderTypestringrequired

Type of holder

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

Default value:

Example: BUILDING

source objectrequired

Source information

detailsstringrequired

Source details

Default value:

Example: Manually entered

typestringrequired

Source type

Default value:

Example: USER

valuestringrequired

Source value

Default value:

Example: Manually entered

sourceDocumentUidstring | nullnullable

Source document id when applicable (DOCUMENT)

Default value:

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

interval objectrequired

Validity interval of the data

effectiveDatedaterequired

Date when the data becomes valid

Default value:

expirationDatedaterequired

Date when the data ceases to be valid

Default value:

idint64required

Unique identifier of the data

Default value:

Example: 42

]

]

paginate objectrequired

sizeint32

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,
        "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": "",
      "endDate": "",
      "terminationDate": "",
      "deadlines": [
        {
          "value": ""
        }
      ],
      "assets": [
        {
          "assetErpCode": "ERP123",
          "area": 150.5,
          "effectiveDate": "2023-01-01",
          "expirationDate": "2025-12-31",
          "initialRent": 1200,
          "actualRent": 1250,
          "stonalIdentifier": ""
        }
      ],
      "integrationDate": "",
      "label": "",
      "equipments": [
        {
          "code": "EQUIPMENT",
          "names": [
            {
              "singular": "Building",
              "plural": "Buildings",
              "language": "en"
            }
          ]
        }
      ],
      "notice": "",
      "data": ""
    }
  ],
  "paginate": {
    "size": 50,
    "cursor": "0"
  }
}