ContractView

Contract information

organizationCodestring

Organization code

Default value: ##default

Example: ORG123

codestring

Contract code

Default value: ##default

Example: CONT456

contractType object

Type of contract

organizationCodestring

Organization code

Default value: ##default

Example: ORG123

codestring

Code of the holder type

Default value: ##default

Example: BUILDING

typestring

Type category

Default value: ##default

Example: ASSET

naturestring

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

Default value: ##default

Example: PHYSICAL

names object[]

Localized names for this holder type

Array [

singularstring

Singular form of the name

Default value: ##default

Example: Building

pluralstring

Plural form of the name

Default value: ##default

Example: Buildings

languagestring

Language code

Default value: ##default

Example: en

]

numberOfAssetsinteger<int32>

Number of assets of this holder type

Default value: ##default

Example: 42

importErrors object

Information about import errors

duplicatesinteger<int32>

Number of duplicate entries

Default value: ##default

Example: 0

othersinteger<int32>

Number of other errors

Default value: ##default

Example: 0

stakeholders object[]

List of stakeholders involved in the contract

Array [

namestring

Name of the stakeholder

Default value: ##default

Example: Acme Corporation

codestring

Code identifying the stakeholder

Default value: ##default

Example: STK789

]

effectiveDatestring<date>

Date when the contract becomes effective

Default value: ##default

endDatestring<date>

End date of the contract

Default value: ##default

terminationDatestring<date>

Termination date if contract was terminated early

Default value: ##default

deadlines object[]

Important deadlines in the contract lifecycle

Array [

valuestring<date>

The deadline date

Default value: ##default

]

assets object[]

Assets associated with this contract

Array [

assetErpCodestring

ERP code of the asset

Default value: ##default

Example: ERP123

assetCodestringdeprecated

Asset code (deprecated, use assetErpCode instead)

Default value: ##default

Example: ERP123

areanumber<double>

Area of the asset in square meters

Default value: ##default

Example: 150.5

effectiveDatestring

Date when the asset was added to the contract

Default value: ##default

Example: 2023-01-01

expirationDatestring

Date when the asset will be removed from the contract

Default value: ##default

Example: 2025-12-31

initialRentnumber<double>

Initial rent amount

Default value: ##default

Example: 1200.00

actualRentnumber<double>

Current rent amount

Default value: ##default

Example: 1250.00

stonalIdentifierstring

Stonal identifier of the asset

Default value: ##default

]

integrationDatestring<date-time>

Date when contract was integrated into the system

Default value: ##default

labelstring

Label of the contract

Default value: ##default

equipments object[]

List of equipments linked to the contract

Array [

codestring

Equipment code

Default value: ##default

Example: EQUIPMENT

names object[]

List of names for the equipment

Array [

singularstring

Singular form of the name

Default value: ##default

Example: Building

pluralstring

Plural form of the name

Default value: ##default

Example: Buildings

languagestring

Language code

Default value: ##default

Example: en

]

]

ContractView

{
  "organizationCode": "ORG123",
  "code": "CONT456",
  "contractType": {
    "organizationCode": "ORG123",
    "code": "BUILDING",
    "type": "ASSET",
    "nature": "PHYSICAL",
    "names": [
      {
        "singular": "Building",
        "plural": "Buildings",
        "language": "en"
      }
    ],
    "numberOfAssets": 42,
    "importErrors": {
      "duplicates": 0,
      "others": 0
    }
  },
  "stakeholders": [
    {
      "name": "Acme Corporation",
      "code": "STK789"
    }
  ],
  "effectiveDate": "##default",
  "endDate": "##default",
  "terminationDate": "##default",
  "deadlines": [
    {
      "value": "##default"
    }
  ],
  "assets": [
    {
      "assetErpCode": "ERP123",
      "area": "150.5",
      "effectiveDate": "2023-01-01",
      "expirationDate": "2025-12-31",
      "initialRent": "1200.00",
      "actualRent": "1250.00",
      "stonalIdentifier": "##default"
    }
  ],
  "integrationDate": "##default",
  "label": "##default",
  "equipments": [
    {
      "code": "EQUIPMENT",
      "names": [
        {
          "singular": "Building",
          "plural": "Buildings",
          "language": "en"
        }
      ]
    }
  ]
}