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

]

numberOfAssetsint32nullable

Number of assets of this holder type

Example: 42

importErrors object

oneOf

• ImportErrors
• null

duplicatesint32required

Number of duplicate entries

Example: 0

othersint32required

Number of other errors

Example: 0

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

]

effectiveDatedatenullable

Date when the contract becomes effective

endDatedatenullable

End date of the contract

terminationDatedatenullable

Termination date if contract was terminated early

deadlines object[]required

Important deadlines in the contract lifecycle

Array [

valuedaterequired

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

areadoublenullable

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

initialRentdoublenullable

Initial rent amount

Example: 1200

actualRentdoublenullable

Current rent amount

Example: 1250

stonalIdentifierstring | nullnullable

Stonal identifier of the asset

]

integrationDatedate-timenullable

Date when contract was integrated into the system

labelstring | nullnullable

Label of the contract

equipments object[]required

List of equipments linked to the contract

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

]

]

]

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
        }
      },
      "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",
      "equipments": [
        {
          "code": "EQUIPMENT",
          "names": [
            {
              "singular": "Building",
              "plural": "Buildings",
              "language": "en"
            }
          ]
        }
      ]
    }
  ]
}