Lease Component

Lease Component - Update Lease Component Financial Term

HTTP Request

PUT /api/lease-component-financial-terms/{id}

📋 Description: Updates the financial terms of a specified lease component within the Nakisa Portfolio Management Suite, enabling users to manage and optimize financial data related to real estate assets effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

any

true

Request body containing the updated financial terms data for a specific lease component, including details relevant to portfolio management and asset analytics.

Body Parameters

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "name": "string",
  5  "expenseCategory": {
  6    "id": 0,
  7    "displayId": "string",
  8    "status": "CREATED",
  9    "name": "string",
 10    "expenseCategoryType": "PAYMENT"
 11  },
 12  "amount": 0.1,
 13  "amountFrequency": "DAY",
 14  "paymentMode": "ADVANCE",
 15  "paymentCalculationMode": "ONE_TIME",
 16  "firstSpecialPaymentDate": "2019-08-24",
 17  "lastSpecialPaymentDate": "2019-08-24",
 18  "paymentFrequency": "ONE_TIME",
 19  "firstPaymentDate": "2019-08-24",
 20  "lastPaymentDate": "2019-08-24",
 21  "firstPaymentAmount": 0.1,
 22  "lastPaymentAmount": 0.1,
 23  "months": 0,
 24  "days": 0,
 25  "notificationDate": "2019-08-24",
 26  "monthEnd": true,
 27  "paymentTiming": "START_OF_DAY",
 28  "escalatingRent": true,
 29  "stopEscalatingAtZero": true,
 30  "escalatingRentAmount": 0.1,
 31  "escalatingRentType": "FIXED",
 32  "escalationFrequencyOffset": 0,
 33  "escalationFrequency": 0,
 34  "escalationFastForward": 0,
 35  "termStartDate": "2019-08-24",
 36  "termEndDate": "2019-08-24",
 37  "expenseCategoryType": "PAYMENT",
 38  "spreadingFrequency": "NONE",
 39  "firstSpreadingAmount": 0.1,
 40  "lastSpreadingAmount": 0.1,
 41  "valid": true,
 42  "parentFinancialTermId": 0,
 43  "termStatus": "EDITABLE",
 44  "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
 45  "vendorPaymentSplits": [
 46    {
 47      "percentage": 0,
 48      "calculateTax": true,
 49      "taxExemptionPercentage": 0,
 50      "partner": {
 51        "id": 0,
 52        "displayId": "string",
 53        "status": "CREATED",
 54        "name": "string",
 55        "erpSystemDisplayId": "string"
 56      },
 57      "partnerRole": {
 58        "id": 0,
 59        "displayId": "string",
 60        "status": "CREATED",
 61        "name": "string"
 62      },
 63      "taxCodeDetermination": {
 64        "id": 0,
 65        "displayId": "string",
 66        "companyId": 0,
 67        "partnerId": 0,
 68        "taxJurisdictionId": 0,
 69        "taxJurisdictionDisplayId": "string",
 70        "defaultTaxCodeId": 0,
 71        "defaultTaxCodeDisplayId": "string",
 72        "defaultExemptionTaxCodeId": 0,
 73        "defaultExemptionTaxCodeDisplayId": "string",
 74        "defaultExemptionPercentage": 0,
 75        "mapping": {
 76          "isLeaseExpense": true,
 77          "nonLeaseTaxCodeId": 0,
 78          "nonLeaseTaxCodeDisplayId": "string",
 79          "nonLeaseExemptionTaxCodeId": 0,
 80          "nonLeaseExemptionTaxCodeDisplayId": "string",
 81          "nonLeaseExemptionTaxPercentage": 0.1,
 82          "principalTaxCodeId": 0,
 83          "principalTaxCodeDisplayId": "string",
 84          "principalExemptionTaxCodeId": 0,
 85          "principalExemptionTaxCodeDisplayId": "string",
 86          "principalExemptionTaxPercentage": 0.1
 87        }
 88      }
 89    }
 90  ],
 91  "revisionDisplayId": "string",
 92  "termType": "PAYMENT_TERM",
 93  "revisionId": 0,
 94  "leaseComponentId": 0,
 95  "leaseComponentDisplayId": "string",
 96  "type": "string",
 97  "numberRangeIdentifierType": {
 98    "name": "string"
 99  },
100  "numberRangeIdentifierValue": "string",
101  "allowsSystemGenerateNewId": true,
102  "numberRangeType": {
103    "name": "string"
104  }
105}

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "name": "string",
  5  "expenseCategory": {
  6    "id": 0,
  7    "displayId": "string",
  8    "status": "CREATED",
  9    "name": "string",
 10    "expenseCategoryType": "PAYMENT"
 11  },
 12  "amount": 0.1,
 13  "amountFrequency": "DAY",
 14  "paymentMode": "ADVANCE",
 15  "paymentCalculationMode": "ONE_TIME",
 16  "firstSpecialPaymentDate": "2019-08-24",
 17  "lastSpecialPaymentDate": "2019-08-24",
 18  "paymentFrequency": "ONE_TIME",
 19  "firstPaymentDate": "2019-08-24",
 20  "lastPaymentDate": "2019-08-24",
 21  "firstPaymentAmount": 0.1,
 22  "lastPaymentAmount": 0.1,
 23  "months": 0,
 24  "days": 0,
 25  "notificationDate": "2019-08-24",
 26  "monthEnd": true,
 27  "paymentTiming": "START_OF_DAY",
 28  "escalatingRent": true,
 29  "stopEscalatingAtZero": true,
 30  "escalatingRentAmount": 0.1,
 31  "escalatingRentType": "FIXED",
 32  "escalationFrequencyOffset": 0,
 33  "escalationFrequency": 0,
 34  "escalationFastForward": 0,
 35  "termStartDate": "2019-08-24",
 36  "termEndDate": "2019-08-24",
 37  "expenseCategoryType": "PAYMENT",
 38  "spreadingFrequency": "NONE",
 39  "firstSpreadingAmount": 0.1,
 40  "lastSpreadingAmount": 0.1,
 41  "valid": true,
 42  "parentFinancialTermId": 0,
 43  "termStatus": "EDITABLE",
 44  "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
 45  "vendorPaymentSplits": [
 46    {
 47      "percentage": 0,
 48      "calculateTax": true,
 49      "taxExemptionPercentage": 0,
 50      "partner": {
 51        "id": 0,
 52        "displayId": "string",
 53        "status": "CREATED",
 54        "name": "string",
 55        "erpSystemDisplayId": "string"
 56      },
 57      "partnerRole": {
 58        "id": 0,
 59        "displayId": "string",
 60        "status": "CREATED",
 61        "name": "string"
 62      },
 63      "taxCodeDetermination": {
 64        "id": 0,
 65        "displayId": "string",
 66        "companyId": 0,
 67        "partnerId": 0,
 68        "taxJurisdictionId": 0,
 69        "taxJurisdictionDisplayId": "string",
 70        "defaultTaxCodeId": 0,
 71        "defaultTaxCodeDisplayId": "string",
 72        "defaultExemptionTaxCodeId": 0,
 73        "defaultExemptionTaxCodeDisplayId": "string",
 74        "defaultExemptionPercentage": 0,
 75        "mapping": {
 76          "isLeaseExpense": true,
 77          "nonLeaseTaxCodeId": 0,
 78          "nonLeaseTaxCodeDisplayId": "string",
 79          "nonLeaseExemptionTaxCodeId": 0,
 80          "nonLeaseExemptionTaxCodeDisplayId": "string",
 81          "nonLeaseExemptionTaxPercentage": 0.1,
 82          "principalTaxCodeId": 0,
 83          "principalTaxCodeDisplayId": "string",
 84          "principalExemptionTaxCodeId": 0,
 85          "principalExemptionTaxCodeDisplayId": "string",
 86          "principalExemptionTaxPercentage": 0.1
 87        }
 88      }
 89    }
 90  ],
 91  "revisionDisplayId": "string",
 92  "termType": "PAYMENT_TERM",
 93  "revisionId": 0,
 94  "leaseComponentId": 0,
 95  "leaseComponentDisplayId": "string",
 96  "type": "string",
 97  "numberRangeIdentifierType": {
 98    "name": "string"
 99  },
100  "numberRangeIdentifierValue": "string",
101  "allowsSystemGenerateNewId": true,
102  "numberRangeType": {
103    "name": "string"
104  }
105}

Response Schema

Enumerated Values

Attribute

Value

amountFrequency

DAY, MONTH, ONE_TIME, YEAR

escalatingRentType

FIXED, PERCENTAGE

expenseCategoryType

CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION

lockReason

ENDS_BEFORE_MODIFICATION_DATE, EXERCISED_IN_ACTIVATION_GROUP, NO_PAYMENT

paymentCalculationMode

DAILY, ONE_TIME, PAYMENT_FOR_MONTH

paymentFrequency

ANNUALLY, BI_MONTHLY, BI_WEEKLY, DAILY, MONTHLY, ONE_TIME, QUARTERLY, SEMI_ANNUALLY, SEMI_MONTHLY, WEEKLY

paymentMode

ADVANCE, ARREARS

paymentTiming

END_OF_DAY, START_OF_DAY

spreadingFrequency

NONE, PERIODIC, STRAIGHT_LINE

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

termStatus

EDITABLE, LOCKED

termType

INITIAL_DIRECT_COST, NON_LEASE_TERM, PAYMENT_TERM

Lease Component - Delete Lease Component Financial Term

HTTP Request

DELETE /api/lease-component-financial-terms/{id}

📋 Description: Deletes the specified lease component financial terms from the Nakisa Portfolio Management Suite, ensuring accurate and up-to-date financial data for portfolio and asset management in real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Lease Component - Create Or Update Lease Component Financial Term

HTTP Request

PUT /api/lease-component-financial-terms/createOrUpdate

📋 Description: Creates or updates financial terms for lease components within the Nakisa Portfolio Management Suite, facilitating effective management of portfolio and asset analytics in real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

any

true

Request body containing the financial terms data for lease components, including details on portfolio allocation, asset valuation, and real estate property analytics.

Body Parameters

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "name": "string",
  5  "expenseCategory": {
  6    "id": 0,
  7    "displayId": "string",
  8    "status": "CREATED",
  9    "name": "string",
 10    "expenseCategoryType": "PAYMENT"
 11  },
 12  "amount": 0.1,
 13  "amountFrequency": "DAY",
 14  "paymentMode": "ADVANCE",
 15  "paymentCalculationMode": "ONE_TIME",
 16  "firstSpecialPaymentDate": "2019-08-24",
 17  "lastSpecialPaymentDate": "2019-08-24",
 18  "paymentFrequency": "ONE_TIME",
 19  "firstPaymentDate": "2019-08-24",
 20  "lastPaymentDate": "2019-08-24",
 21  "firstPaymentAmount": 0.1,
 22  "lastPaymentAmount": 0.1,
 23  "months": 0,
 24  "days": 0,
 25  "notificationDate": "2019-08-24",
 26  "monthEnd": true,
 27  "paymentTiming": "START_OF_DAY",
 28  "escalatingRent": true,
 29  "stopEscalatingAtZero": true,
 30  "escalatingRentAmount": 0.1,
 31  "escalatingRentType": "FIXED",
 32  "escalationFrequencyOffset": 0,
 33  "escalationFrequency": 0,
 34  "escalationFastForward": 0,
 35  "termStartDate": "2019-08-24",
 36  "termEndDate": "2019-08-24",
 37  "expenseCategoryType": "PAYMENT",
 38  "spreadingFrequency": "NONE",
 39  "firstSpreadingAmount": 0.1,
 40  "lastSpreadingAmount": 0.1,
 41  "valid": true,
 42  "parentFinancialTermId": 0,
 43  "termStatus": "EDITABLE",
 44  "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
 45  "vendorPaymentSplits": [
 46    {
 47      "percentage": 0,
 48      "calculateTax": true,
 49      "taxExemptionPercentage": 0,
 50      "partner": {
 51        "id": 0,
 52        "displayId": "string",
 53        "status": "CREATED",
 54        "name": "string",
 55        "erpSystemDisplayId": "string"
 56      },
 57      "partnerRole": {
 58        "id": 0,
 59        "displayId": "string",
 60        "status": "CREATED",
 61        "name": "string"
 62      },
 63      "taxCodeDetermination": {
 64        "id": 0,
 65        "displayId": "string",
 66        "companyId": 0,
 67        "partnerId": 0,
 68        "taxJurisdictionId": 0,
 69        "taxJurisdictionDisplayId": "string",
 70        "defaultTaxCodeId": 0,
 71        "defaultTaxCodeDisplayId": "string",
 72        "defaultExemptionTaxCodeId": 0,
 73        "defaultExemptionTaxCodeDisplayId": "string",
 74        "defaultExemptionPercentage": 0,
 75        "mapping": {
 76          "isLeaseExpense": true,
 77          "nonLeaseTaxCodeId": 0,
 78          "nonLeaseTaxCodeDisplayId": "string",
 79          "nonLeaseExemptionTaxCodeId": 0,
 80          "nonLeaseExemptionTaxCodeDisplayId": "string",
 81          "nonLeaseExemptionTaxPercentage": 0.1,
 82          "principalTaxCodeId": 0,
 83          "principalTaxCodeDisplayId": "string",
 84          "principalExemptionTaxCodeId": 0,
 85          "principalExemptionTaxCodeDisplayId": "string",
 86          "principalExemptionTaxPercentage": 0.1
 87        }
 88      }
 89    }
 90  ],
 91  "revisionDisplayId": "string",
 92  "termType": "PAYMENT_TERM",
 93  "revisionId": 0,
 94  "leaseComponentId": 0,
 95  "leaseComponentDisplayId": "string",
 96  "type": "string",
 97  "numberRangeIdentifierType": {
 98    "name": "string"
 99  },
100  "numberRangeIdentifierValue": "string",
101  "allowsSystemGenerateNewId": true,
102  "numberRangeType": {
103    "name": "string"
104  }
105}

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "name": "string",
  5  "expenseCategory": {
  6    "id": 0,
  7    "displayId": "string",
  8    "status": "CREATED",
  9    "name": "string",
 10    "expenseCategoryType": "PAYMENT"
 11  },
 12  "amount": 0.1,
 13  "amountFrequency": "DAY",
 14  "paymentMode": "ADVANCE",
 15  "paymentCalculationMode": "ONE_TIME",
 16  "firstSpecialPaymentDate": "2019-08-24",
 17  "lastSpecialPaymentDate": "2019-08-24",
 18  "paymentFrequency": "ONE_TIME",
 19  "firstPaymentDate": "2019-08-24",
 20  "lastPaymentDate": "2019-08-24",
 21  "firstPaymentAmount": 0.1,
 22  "lastPaymentAmount": 0.1,
 23  "months": 0,
 24  "days": 0,
 25  "notificationDate": "2019-08-24",
 26  "monthEnd": true,
 27  "paymentTiming": "START_OF_DAY",
 28  "escalatingRent": true,
 29  "stopEscalatingAtZero": true,
 30  "escalatingRentAmount": 0.1,
 31  "escalatingRentType": "FIXED",
 32  "escalationFrequencyOffset": 0,
 33  "escalationFrequency": 0,
 34  "escalationFastForward": 0,
 35  "termStartDate": "2019-08-24",
 36  "termEndDate": "2019-08-24",
 37  "expenseCategoryType": "PAYMENT",
 38  "spreadingFrequency": "NONE",
 39  "firstSpreadingAmount": 0.1,
 40  "lastSpreadingAmount": 0.1,
 41  "valid": true,
 42  "parentFinancialTermId": 0,
 43  "termStatus": "EDITABLE",
 44  "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
 45  "vendorPaymentSplits": [
 46    {
 47      "percentage": 0,
 48      "calculateTax": true,
 49      "taxExemptionPercentage": 0,
 50      "partner": {
 51        "id": 0,
 52        "displayId": "string",
 53        "status": "CREATED",
 54        "name": "string",
 55        "erpSystemDisplayId": "string"
 56      },
 57      "partnerRole": {
 58        "id": 0,
 59        "displayId": "string",
 60        "status": "CREATED",
 61        "name": "string"
 62      },
 63      "taxCodeDetermination": {
 64        "id": 0,
 65        "displayId": "string",
 66        "companyId": 0,
 67        "partnerId": 0,
 68        "taxJurisdictionId": 0,
 69        "taxJurisdictionDisplayId": "string",
 70        "defaultTaxCodeId": 0,
 71        "defaultTaxCodeDisplayId": "string",
 72        "defaultExemptionTaxCodeId": 0,
 73        "defaultExemptionTaxCodeDisplayId": "string",
 74        "defaultExemptionPercentage": 0,
 75        "mapping": {
 76          "isLeaseExpense": true,
 77          "nonLeaseTaxCodeId": 0,
 78          "nonLeaseTaxCodeDisplayId": "string",
 79          "nonLeaseExemptionTaxCodeId": 0,
 80          "nonLeaseExemptionTaxCodeDisplayId": "string",
 81          "nonLeaseExemptionTaxPercentage": 0.1,
 82          "principalTaxCodeId": 0,
 83          "principalTaxCodeDisplayId": "string",
 84          "principalExemptionTaxCodeId": 0,
 85          "principalExemptionTaxCodeDisplayId": "string",
 86          "principalExemptionTaxPercentage": 0.1
 87        }
 88      }
 89    }
 90  ],
 91  "revisionDisplayId": "string",
 92  "termType": "PAYMENT_TERM",
 93  "revisionId": 0,
 94  "leaseComponentId": 0,
 95  "leaseComponentDisplayId": "string",
 96  "type": "string",
 97  "numberRangeIdentifierType": {
 98    "name": "string"
 99  },
100  "numberRangeIdentifierValue": "string",
101  "allowsSystemGenerateNewId": true,
102  "numberRangeType": {
103    "name": "string"
104  }
105}

Response Schema

Enumerated Values

Attribute

Value

amountFrequency

DAY, MONTH, ONE_TIME, YEAR

escalatingRentType

FIXED, PERCENTAGE

expenseCategoryType

CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION

lockReason

ENDS_BEFORE_MODIFICATION_DATE, EXERCISED_IN_ACTIVATION_GROUP, NO_PAYMENT

paymentCalculationMode

DAILY, ONE_TIME, PAYMENT_FOR_MONTH

paymentFrequency

ANNUALLY, BI_MONTHLY, BI_WEEKLY, DAILY, MONTHLY, ONE_TIME, QUARTERLY, SEMI_ANNUALLY, SEMI_MONTHLY, WEEKLY

paymentMode

ADVANCE, ARREARS

paymentTiming

END_OF_DAY, START_OF_DAY

spreadingFrequency

NONE, PERIODIC, STRAIGHT_LINE

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

termStatus

EDITABLE, LOCKED

termType

INITIAL_DIRECT_COST, NON_LEASE_TERM, PAYMENT_TERM

Lease Component - Perform Full Workflow

HTTP Request

POST /api/lease-components/{revisionId}/full-workflow

📋 Description: Initiates the full workflow process for lease components associated with a specific revision ID, enabling comprehensive management and analysis of real estate assets within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

revisionId

path

integer(int64)

true

Unique identifier for the revision

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "principalPositionType": "LESSEE",
  5  "name": "string",
  6  "description": "string",
  7  "bulkAsset": true,
  8  "rouStartDate": "2019-08-24",
  9  "rouEndDate": "2019-08-24",
 10  "approverComment": "string",
 11  "fairMarketValue": 0.1,
 12  "allocationNumber": "string",
 13  "guaranteedResidualValue": 0.1,
 14  "unitDistributions": [
 15    {
 16      "id": 0,
 17      "leaseComponentId": 0,
 18      "leaseComponentDisplayId": "string",
 19      "activationGroupName": "string",
 20      "activationGroupDisplayId": "string",
 21      "numberOfUnits": 0,
 22      "unitDisplayIds": [
 23        "string"
 24      ]
 25    }
 26  ],
 27  "revision": {
 28    "id": 0,
 29    "displayId": "string",
 30    "name": "string",
 31    "inception": true,
 32    "revisionType": "REVISION",
 33    "state": "MLA_DEFINE",
 34    "approvedBy": "string",
 35    "approvedAt": "2019-08-24T14:15:22Z",
 36    "parentRevisionId": 0,
 37    "approverComment": "string",
 38    "leaseComponentId": 0,
 39    "leaseComponentDisplayId": "string",
 40    "leaseComponentName": "string",
 41    "contractRevisionId": 0,
 42    "contractRevisionDisplayId": "string",
 43    "numberRangeIdentifierType": {
 44      "name": "string"
 45    },
 46    "numberRangeIdentifierValue": "string",
 47    "allowsSystemGenerateNewId": true,
 48    "numberRangeType": {
 49      "name": "string"
 50    }
 51  },
 52  "internalAssetClass": {
 53    "id": 0,
 54    "displayId": "string",
 55    "status": "CREATED",
 56    "name": "string",
 57    "assetClassType": "PROPERTY",
 58    "infiniteUsefulLife": true
 59  },
 60  "unitOfMeasure": {
 61    "id": 0,
 62    "displayId": "string",
 63    "status": "CREATED",
 64    "name": "string",
 65    "erpSystemId": 0
 66  },
 67  "notifications": [
 68    {
 69      "id": 0,
 70      "topic": {
 71        "enCaption": "string",
 72        "frCaption": "string",
 73        "name": "string",
 74        "priority": "HIGH"
 75      },
 76      "username": "string",
 77      "leaseComponentId": 0,
 78      "leaseComponentDisplayId": "string",
 79      "targetType": "string",
 80      "targetId": "string"
 81    }
 82  ],
 83  "spreadingFrequency": "NONE",
 84  "contractId": 0,
 85  "contractDisplayId": "string",
 86  "companyCodeId": 0,
 87  "companyCodeDisplayId": "string",
 88  "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
 89  "endOfTermDate": "2019-08-24",
 90  "endOfTermPeriod": 0,
 91  "allowsSystemGenerateNewId": true,
 92  "transferInfo": {
 93    "transferredFromDisplayId": "string",
 94    "transferredFromRevisionId": 0,
 95    "transferredToDisplayId": "string",
 96    "transferredToRevisionId": 0
 97  },
 98  "numberRangeIdentifierType": {
 99    "name": "string"
100  },
101  "numberRangeIdentifierValue": "string",
102  "numberRangeType": {
103    "name": "string"
104  },
105  "type": "string"
106}

Response Schema

Enumerated Values

Attribute

Value

assetClassType

EQUIPMENT, PLANT, PROPERTY

principalPositionType

LESSEE, LESSOR

priority

HIGH, LOW, MEDIUM

revisionType

ACTIVE, DRAFT, INACTIVE, REVERTED, REVISION

spreadingFrequency

NONE, PERIODIC, STRAIGHT_LINE

state

AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

userDeterminedLeaseType

LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE

Lease Component - Send Lease Component To Approval

HTTP Request

POST /api/lease-components/{id}/send-to-approval

📋 Description: Submits the specified lease component for approval within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and enhancing decision-making in real estate portfolio analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LeaseComponentTransitionInput

true

Request body containing the lease component details, including approval status and relevant metadata, for submission within the Nakisa Portfolio Management Suite’s asset management workflow.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "cascadeParentClosure": true,
5  "processingTaskId": 0,
6  "processingJobType": "string",
7  "objectId": 0
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Lease Component - Rework Lease Component

HTTP Request

POST /api/lease-components/{id}/rework

📋 Description: Initiates a rework process for a specified lease component, enabling users to update and refine asset details within the Nakisa Portfolio Management Suite for enhanced portfolio and real estate analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LeaseComponentTransitionInput

true

Request body containing the rework details for the specified lease component, including updated terms and conditions relevant to portfolio and asset management.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "cascadeParentClosure": true,
5  "processingTaskId": 0,
6  "processingJobType": "string",
7  "objectId": 0
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Lease Component - Discard Lease Component

HTTP Request

POST /api/lease-components/{id}/discard

📋 Description: Discards the specified lease component identified by the provided ID within the Nakisa Portfolio Management Suite, facilitating effective portfolio management and asset analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LeaseComponentTransitionInput

true

Request body containing the lease component details to be discarded, including associated metadata and status information relevant to portfolio and asset management.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "cascadeParentClosure": true,
5  "processingTaskId": 0,
6  "processingJobType": "string",
7  "objectId": 0
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Lease Component - Close Lease Component

HTTP Request

POST /api/lease-components/{id}/close

📋 Description: Closes the specified lease component identified by the given ID within the Nakisa Portfolio Management Suite, facilitating effective portfolio management and asset analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LeaseComponentTransitionInput

true

Request body containing the closure details for a lease component, including relevant financial and asset information, to facilitate accurate portfolio management and analytics.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "cascadeParentClosure": true,
5  "processingTaskId": 0,
6  "processingJobType": "string",
7  "objectId": 0
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Lease Component - Callback Lease Component

HTTP Request

POST /api/lease-components/{id}/callback

📋 Description: Submits a callback request for a specific lease component identified by the provided ID, facilitating real-time updates and analytics within the Nakisa Portfolio Management Suite for effective portfolio and asset management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LeaseComponentTransitionInput

true

Request body containing the callback data related to lease components, including relevant portfolio and asset analytics for real estate property management.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "cascadeParentClosure": true,
5  "processingTaskId": 0,
6  "processingJobType": "string",
7  "objectId": 0
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Lease Component - Approve Lease Component

HTTP Request

POST /api/lease-components/{id}/approve

📋 Description: Approves the specified lease component within the Nakisa Portfolio Management Suite, facilitating timely decision-making in portfolio and asset management for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LeaseComponentTransitionInput

true

Request body containing the approval details for the specified lease component, including relevant metadata and status updates to facilitate portfolio and asset management within the Nakisa Portfolio Management Suite.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "cascadeParentClosure": true,
5  "processingTaskId": 0,
6  "processingJobType": "string",
7  "objectId": 0
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Lease Component - Search Lease Components

HTTP Request

POST /api/lease-components/search

📋 Description: Submits a search request for lease components within the Nakisa Portfolio Management Suite, enabling users to efficiently analyze and manage real estate properties and assets in their portfolio.

Parameters

Name

In

Type

Required

Description

unused

query

boolean

false

Indicates whether to include unused lease components in the search results for portfolio analytics within the Nakisa Portfolio Management Suite.

body

body

any

true

Request body containing search criteria and filters for portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "displayIdIn": [
16    "string"
17  ],
18  "displayIdLike": "string",
19  "nameOrDisplayIdLike": "string",
20  "principalPositionTypeEqual": "LESSEE",
21  "nameLike": "string",
22  "rouStartDateGreaterThanOrEqual": "2019-08-24",
23  "rouStartDateLessThanOrEqual": "2019-08-24",
24  "rouEndDateGreaterThanOrEqual": "2019-08-24",
25  "rouEndDateLessThanOrEqual": "2019-08-24",
26  "revisionIdEqual": 0,
27  "revisionTypeEqual": "REVISION",
28  "revisionStateEqual": "MLA_DEFINE",
29  "internalAssetClassIdIn": [
30    0
31  ],
32  "internalAssetClassDisplayIdIn": [
33    "string"
34  ],
35  "unitOfMeasureIdIn": [
36    0
37  ],
38  "unitOfMeasureDisplayIdIn": [
39    "string"
40  ],
41  "spreadingFrequencyIn": [
42    "NONE"
43  ],
44  "spreadingFrequencyEqual": "NONE",
45  "contractIdIn": [
46    0
47  ],
48  "contractDisplayIdIn": [
49    "string"
50  ],
51  "companyCodeIdIn": [
52    0
53  ],
54  "companyCodeDisplayIdIn": [
55    "string"
56  ],
57  "type": "string"
58}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLeaseComponentDto

Example Responses

  1{
  2  "totalElements": 0,
  3  "totalPages": 0,
  4  "pageable": {
  5    "pageNumber": 0,
  6    "pageSize": 0,
  7    "unpaged": true,
  8    "paged": true,
  9    "offset": 0,
 10    "sort": {
 11      "sorted": true,
 12      "unsorted": true,
 13      "empty": true
 14    }
 15  },
 16  "numberOfElements": 0,
 17  "size": 0,
 18  "content": [
 19    {
 20      "id": 0,
 21      "displayId": "string",
 22      "principalPositionType": "LESSEE",
 23      "name": "string",
 24      "description": "string",
 25      "bulkAsset": true,
 26      "rouStartDate": "2019-08-24",
 27      "rouEndDate": "2019-08-24",
 28      "approverComment": "string",
 29      "fairMarketValue": 0.1,
 30      "allocationNumber": "string",
 31      "guaranteedResidualValue": 0.1,
 32      "unitDistributions": [
 33        {
 34          "id": 0,
 35          "leaseComponentId": 0,
 36          "leaseComponentDisplayId": "string",
 37          "activationGroupName": "string",
 38          "activationGroupDisplayId": "string",
 39          "numberOfUnits": 0,
 40          "unitDisplayIds": [
 41            "string"
 42          ]
 43        }
 44      ],
 45      "revision": {
 46        "id": 0,
 47        "displayId": "string",
 48        "name": "string",
 49        "inception": true,
 50        "revisionType": "REVISION",
 51        "state": "MLA_DEFINE",
 52        "approvedBy": "string",
 53        "approvedAt": "2019-08-24T14:15:22Z",
 54        "parentRevisionId": 0,
 55        "approverComment": "string",
 56        "leaseComponentId": 0,
 57        "leaseComponentDisplayId": "string",
 58        "leaseComponentName": "string",
 59        "contractRevisionId": 0,
 60        "contractRevisionDisplayId": "string",
 61        "numberRangeIdentifierType": {
 62          "name": "string"
 63        },
 64        "numberRangeIdentifierValue": "string",
 65        "allowsSystemGenerateNewId": true,
 66        "numberRangeType": {
 67          "name": "string"
 68        }
 69      },
 70      "internalAssetClass": {
 71        "id": 0,
 72        "displayId": "string",
 73        "status": "CREATED",
 74        "name": "string",
 75        "assetClassType": "PROPERTY",
 76        "infiniteUsefulLife": true
 77      },
 78      "unitOfMeasure": {
 79        "id": 0,
 80        "displayId": "string",
 81        "status": "CREATED",
 82        "name": "string",
 83        "erpSystemId": 0
 84      },
 85      "notifications": [
 86        {
 87          "id": 0,
 88          "topic": {
 89            "enCaption": "string",
 90            "frCaption": "string",
 91            "name": "string",
 92            "priority": "HIGH"
 93          },
 94          "username": "string",
 95          "leaseComponentId": 0,
 96          "leaseComponentDisplayId": "string",
 97          "targetType": "string",
 98          "targetId": "string"
 99        }
100      ],
101      "spreadingFrequency": "NONE",
102      "contractId": 0,
103      "contractDisplayId": "string",
104      "companyCodeId": 0,
105      "companyCodeDisplayId": "string",
106      "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
107      "endOfTermDate": "2019-08-24",
108      "endOfTermPeriod": 0,
109      "allowsSystemGenerateNewId": true,
110      "transferInfo": {
111        "transferredFromDisplayId": "string",
112        "transferredFromRevisionId": 0,
113        "transferredToDisplayId": "string",
114        "transferredToRevisionId": 0
115      },
116      "numberRangeIdentifierType": {
117        "name": "string"
118      },
119      "numberRangeIdentifierValue": "string",
120      "numberRangeType": {
121        "name": "string"
122      },
123      "type": "string"
124    }
125  ],
126  "number": 0,
127  "sort": {
128    "sorted": true,
129    "unsorted": true,
130    "empty": true
131  },
132  "first": true,
133  "last": true,
134  "empty": true
135}

Lease Component - Create Lease Component Revision

HTTP Request

POST /api/lease-component/event

📋 Description: Creates a new event within the lease component of the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset-related activities effectively in the context of real estate property analytics.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentModificationRequest

true

Request body containing event details related to lease components, including portfolio identifiers, asset information, and relevant analytics for real estate property management.

Body Parameters

1{
2  "name": "string",
3  "leaseComponentRevisionId": 0
4}

Responses

Status

Meaning

Description

Schema

200

OK

OK

LeaseComponentRevisionDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "name": "string",
 5  "inception": true,
 6  "revisionType": "REVISION",
 7  "state": "MLA_DEFINE",
 8  "approvedBy": "string",
 9  "approvedAt": "2019-08-24T14:15:22Z",
10  "parentRevisionId": 0,
11  "approverComment": "string",
12  "leaseComponentId": 0,
13  "leaseComponentDisplayId": "string",
14  "leaseComponentName": "string",
15  "contractRevisionId": 0,
16  "contractRevisionDisplayId": "string",
17  "numberRangeIdentifierType": {
18    "name": "string"
19  },
20  "numberRangeIdentifierValue": "string",
21  "allowsSystemGenerateNewId": true,
22  "numberRangeType": {
23    "name": "string"
24  }
25}

Lease Component - Search Lease Component Financial Terms

HTTP Request

POST /api/lease-component-financial-terms/search

📋 Description: Submits a search request for lease component financial terms within the Nakisa Portfolio Management Suite, enabling users to analyze and manage financial data related to real estate assets and portfolios.

Parameters

Name

In

Type

Required

Description

body

body

any

true

Request body containing the financial terms data for lease components, including relevant portfolio and asset details to facilitate comprehensive analytics within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "displayIdIn": [
16    "string"
17  ],
18  "displayIdLike": "string",
19  "nameLike": "string",
20  "expenseCategoryIdIn": [
21    0
22  ],
23  "expenseCategoryDisplayIdIn": [
24    "string"
25  ],
26  "amountGreaterThanOrEqual": 0.1,
27  "amountLessThanOrEqual": 0.1,
28  "amountFrequencyIn": [
29    "DAY"
30  ],
31  "paymentModeIn": [
32    "ADVANCE"
33  ],
34  "paymentCalculationModeIn": [
35    "ONE_TIME"
36  ],
37  "paymentFrequencyIn": [
38    "ONE_TIME"
39  ],
40  "firstPaymentDateGreaterThanOrEqual": "2019-08-24",
41  "firstPaymentDateLessThanOrEqual": "2019-08-24",
42  "lastPaymentDateGreaterThanOrEqual": "2019-08-24",
43  "lastPaymentDateLessThanOrEqual": "2019-08-24",
44  "notificationDateGreaterThanOrEqual": "2019-08-24",
45  "notificationDateLessThanOrEqual": "2019-08-24",
46  "termStartDateGreaterThanOrEqual": "2019-08-24",
47  "termStartDateLessThanOrEqual": "2019-08-24",
48  "termEndDateGreaterThanOrEqual": "2019-08-24",
49  "termEndDateLessThanOrEqual": "2019-08-24",
50  "expenseCategoryTypeIn": [
51    "PAYMENT"
52  ],
53  "expenseCategoryTypeEqual": "PAYMENT",
54  "revisionDisplayIdIn": [
55    "string"
56  ],
57  "revisionIdIn": [
58    0
59  ],
60  "leaseComponentIdIn": [
61    0
62  ],
63  "leaseComponentDisplayIdIn": [
64    "string"
65  ],
66  "type": "string"
67}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLeaseComponentFinancialTermDto

Example Responses

  1{
  2  "totalElements": 0,
  3  "totalPages": 0,
  4  "pageable": {
  5    "pageNumber": 0,
  6    "pageSize": 0,
  7    "unpaged": true,
  8    "paged": true,
  9    "offset": 0,
 10    "sort": {
 11      "sorted": true,
 12      "unsorted": true,
 13      "empty": true
 14    }
 15  },
 16  "numberOfElements": 0,
 17  "size": 0,
 18  "content": [
 19    {
 20      "id": 0,
 21      "displayId": "string",
 22      "name": "string",
 23      "expenseCategory": {
 24        "id": 0,
 25        "displayId": "string",
 26        "status": "CREATED",
 27        "name": "string",
 28        "expenseCategoryType": "PAYMENT"
 29      },
 30      "amount": 0.1,
 31      "amountFrequency": "DAY",
 32      "paymentMode": "ADVANCE",
 33      "paymentCalculationMode": "ONE_TIME",
 34      "firstSpecialPaymentDate": "2019-08-24",
 35      "lastSpecialPaymentDate": "2019-08-24",
 36      "paymentFrequency": "ONE_TIME",
 37      "firstPaymentDate": "2019-08-24",
 38      "lastPaymentDate": "2019-08-24",
 39      "firstPaymentAmount": 0.1,
 40      "lastPaymentAmount": 0.1,
 41      "months": 0,
 42      "days": 0,
 43      "notificationDate": "2019-08-24",
 44      "monthEnd": true,
 45      "paymentTiming": "START_OF_DAY",
 46      "escalatingRent": true,
 47      "stopEscalatingAtZero": true,
 48      "escalatingRentAmount": 0.1,
 49      "escalatingRentType": "FIXED",
 50      "escalationFrequencyOffset": 0,
 51      "escalationFrequency": 0,
 52      "escalationFastForward": 0,
 53      "termStartDate": "2019-08-24",
 54      "termEndDate": "2019-08-24",
 55      "expenseCategoryType": "PAYMENT",
 56      "spreadingFrequency": "NONE",
 57      "firstSpreadingAmount": 0.1,
 58      "lastSpreadingAmount": 0.1,
 59      "valid": true,
 60      "parentFinancialTermId": 0,
 61      "termStatus": "EDITABLE",
 62      "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
 63      "vendorPaymentSplits": [
 64        {
 65          "percentage": 0,
 66          "calculateTax": true,
 67          "taxExemptionPercentage": 0,
 68          "partner": {
 69            "id": 0,
 70            "displayId": "string",
 71            "status": "CREATED",
 72            "name": "string",
 73            "erpSystemDisplayId": "string"
 74          },
 75          "partnerRole": {
 76            "id": 0,
 77            "displayId": "string",
 78            "status": "CREATED",
 79            "name": "string"
 80          },
 81          "taxCodeDetermination": {
 82            "id": 0,
 83            "displayId": "string",
 84            "companyId": 0,
 85            "partnerId": 0,
 86            "taxJurisdictionId": 0,
 87            "taxJurisdictionDisplayId": "string",
 88            "defaultTaxCodeId": 0,
 89            "defaultTaxCodeDisplayId": "string",
 90            "defaultExemptionTaxCodeId": 0,
 91            "defaultExemptionTaxCodeDisplayId": "string",
 92            "defaultExemptionPercentage": 0,
 93            "mapping": {
 94              "isLeaseExpense": true,
 95              "nonLeaseTaxCodeId": 0,
 96              "nonLeaseTaxCodeDisplayId": "string",
 97              "nonLeaseExemptionTaxCodeId": 0,
 98              "nonLeaseExemptionTaxCodeDisplayId": "string",
 99              "nonLeaseExemptionTaxPercentage": 0.1,
100              "principalTaxCodeId": 0,
101              "principalTaxCodeDisplayId": "string",
102              "principalExemptionTaxCodeId": 0,
103              "principalExemptionTaxCodeDisplayId": "string",
104              "principalExemptionTaxPercentage": 0.1
105            }
106          }
107        }
108      ],
109      "revisionDisplayId": "string",
110      "termType": "PAYMENT_TERM",
111      "revisionId": 0,
112      "leaseComponentId": 0,
113      "leaseComponentDisplayId": "string",
114      "type": "string",
115      "numberRangeIdentifierType": {
116        "name": "string"
117      },
118      "numberRangeIdentifierValue": "string",
119      "allowsSystemGenerateNewId": true,
120      "numberRangeType": {
121        "name": "string"
122      }
123    }
124  ],
125  "number": 0,
126  "sort": {
127    "sorted": true,
128    "unsorted": true,
129    "empty": true
130  },
131  "first": true,
132  "last": true,
133  "empty": true
134}

Lease Component - Get Lease Component

HTTP Request

GET /api/lease-components/{id}

📋 Description: Retrieves detailed information about a specific lease component identified by its unique ID, facilitating informed decision-making within the context of portfolio and asset management in real estate analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "principalPositionType": "LESSEE",
  5  "name": "string",
  6  "description": "string",
  7  "bulkAsset": true,
  8  "rouStartDate": "2019-08-24",
  9  "rouEndDate": "2019-08-24",
 10  "approverComment": "string",
 11  "fairMarketValue": 0.1,
 12  "allocationNumber": "string",
 13  "guaranteedResidualValue": 0.1,
 14  "unitDistributions": [
 15    {
 16      "id": 0,
 17      "leaseComponentId": 0,
 18      "leaseComponentDisplayId": "string",
 19      "activationGroupName": "string",
 20      "activationGroupDisplayId": "string",
 21      "numberOfUnits": 0,
 22      "unitDisplayIds": [
 23        "string"
 24      ]
 25    }
 26  ],
 27  "revision": {
 28    "id": 0,
 29    "displayId": "string",
 30    "name": "string",
 31    "inception": true,
 32    "revisionType": "REVISION",
 33    "state": "MLA_DEFINE",
 34    "approvedBy": "string",
 35    "approvedAt": "2019-08-24T14:15:22Z",
 36    "parentRevisionId": 0,
 37    "approverComment": "string",
 38    "leaseComponentId": 0,
 39    "leaseComponentDisplayId": "string",
 40    "leaseComponentName": "string",
 41    "contractRevisionId": 0,
 42    "contractRevisionDisplayId": "string",
 43    "numberRangeIdentifierType": {
 44      "name": "string"
 45    },
 46    "numberRangeIdentifierValue": "string",
 47    "allowsSystemGenerateNewId": true,
 48    "numberRangeType": {
 49      "name": "string"
 50    }
 51  },
 52  "internalAssetClass": {
 53    "id": 0,
 54    "displayId": "string",
 55    "status": "CREATED",
 56    "name": "string",
 57    "assetClassType": "PROPERTY",
 58    "infiniteUsefulLife": true
 59  },
 60  "unitOfMeasure": {
 61    "id": 0,
 62    "displayId": "string",
 63    "status": "CREATED",
 64    "name": "string",
 65    "erpSystemId": 0
 66  },
 67  "notifications": [
 68    {
 69      "id": 0,
 70      "topic": {
 71        "enCaption": "string",
 72        "frCaption": "string",
 73        "name": "string",
 74        "priority": "HIGH"
 75      },
 76      "username": "string",
 77      "leaseComponentId": 0,
 78      "leaseComponentDisplayId": "string",
 79      "targetType": "string",
 80      "targetId": "string"
 81    }
 82  ],
 83  "spreadingFrequency": "NONE",
 84  "contractId": 0,
 85  "contractDisplayId": "string",
 86  "companyCodeId": 0,
 87  "companyCodeDisplayId": "string",
 88  "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
 89  "endOfTermDate": "2019-08-24",
 90  "endOfTermPeriod": 0,
 91  "allowsSystemGenerateNewId": true,
 92  "transferInfo": {
 93    "transferredFromDisplayId": "string",
 94    "transferredFromRevisionId": 0,
 95    "transferredToDisplayId": "string",
 96    "transferredToRevisionId": 0
 97  },
 98  "numberRangeIdentifierType": {
 99    "name": "string"
100  },
101  "numberRangeIdentifierValue": "string",
102  "numberRangeType": {
103    "name": "string"
104  },
105  "type": "string"
106}

Response Schema

Enumerated Values

Attribute

Value

assetClassType

EQUIPMENT, PLANT, PROPERTY

principalPositionType

LESSEE, LESSOR

priority

HIGH, LOW, MEDIUM

revisionType

ACTIVE, DRAFT, INACTIVE, REVERTED, REVISION

spreadingFrequency

NONE, PERIODIC, STRAIGHT_LINE

state

AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

userDeterminedLeaseType

LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE

Lease Component - Get Lease Component Revisions

HTTP Request

GET /api/lease-components/{id}/lease-component-revisions

📋 Description: Fetches the revision history of a specific lease component identified by its unique ID, enabling users to analyze changes and updates within the context of portfolio and asset management in real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLeaseComponentRevisionDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "pageSize": 0,
 7    "unpaged": true,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "sorted": true,
12      "unsorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "displayId": "string",
22      "name": "string",
23      "inception": true,
24      "revisionType": "REVISION",
25      "state": "MLA_DEFINE",
26      "approvedBy": "string",
27      "approvedAt": "2019-08-24T14:15:22Z",
28      "parentRevisionId": 0,
29      "approverComment": "string",
30      "leaseComponentId": 0,
31      "leaseComponentDisplayId": "string",
32      "leaseComponentName": "string",
33      "contractRevisionId": 0,
34      "contractRevisionDisplayId": "string",
35      "numberRangeIdentifierType": {
36        "name": "string"
37      },
38      "numberRangeIdentifierValue": "string",
39      "allowsSystemGenerateNewId": true,
40      "numberRangeType": {
41        "name": "string"
42      }
43    }
44  ],
45  "number": 0,
46  "sort": {
47    "sorted": true,
48    "unsorted": true,
49    "empty": true
50  },
51  "first": true,
52  "last": true,
53  "empty": true
54}

Lease Component - Get Lease Component By Revision ID

HTTP Request

GET /api/lease-components/revision/{revisionId}

📋 Description: Retrieves detailed information about a specific lease component revision identified by the provided revision ID, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

revisionId

path

integer(int64)

true

Unique identifier for the revision

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "principalPositionType": "LESSEE",
  5  "name": "string",
  6  "description": "string",
  7  "bulkAsset": true,
  8  "rouStartDate": "2019-08-24",
  9  "rouEndDate": "2019-08-24",
 10  "approverComment": "string",
 11  "fairMarketValue": 0.1,
 12  "allocationNumber": "string",
 13  "guaranteedResidualValue": 0.1,
 14  "unitDistributions": [
 15    {
 16      "id": 0,
 17      "leaseComponentId": 0,
 18      "leaseComponentDisplayId": "string",
 19      "activationGroupName": "string",
 20      "activationGroupDisplayId": "string",
 21      "numberOfUnits": 0,
 22      "unitDisplayIds": [
 23        "string"
 24      ]
 25    }
 26  ],
 27  "revision": {
 28    "id": 0,
 29    "displayId": "string",
 30    "name": "string",
 31    "inception": true,
 32    "revisionType": "REVISION",
 33    "state": "MLA_DEFINE",
 34    "approvedBy": "string",
 35    "approvedAt": "2019-08-24T14:15:22Z",
 36    "parentRevisionId": 0,
 37    "approverComment": "string",
 38    "leaseComponentId": 0,
 39    "leaseComponentDisplayId": "string",
 40    "leaseComponentName": "string",
 41    "contractRevisionId": 0,
 42    "contractRevisionDisplayId": "string",
 43    "numberRangeIdentifierType": {
 44      "name": "string"
 45    },
 46    "numberRangeIdentifierValue": "string",
 47    "allowsSystemGenerateNewId": true,
 48    "numberRangeType": {
 49      "name": "string"
 50    }
 51  },
 52  "internalAssetClass": {
 53    "id": 0,
 54    "displayId": "string",
 55    "status": "CREATED",
 56    "name": "string",
 57    "assetClassType": "PROPERTY",
 58    "infiniteUsefulLife": true
 59  },
 60  "unitOfMeasure": {
 61    "id": 0,
 62    "displayId": "string",
 63    "status": "CREATED",
 64    "name": "string",
 65    "erpSystemId": 0
 66  },
 67  "notifications": [
 68    {
 69      "id": 0,
 70      "topic": {
 71        "enCaption": "string",
 72        "frCaption": "string",
 73        "name": "string",
 74        "priority": "HIGH"
 75      },
 76      "username": "string",
 77      "leaseComponentId": 0,
 78      "leaseComponentDisplayId": "string",
 79      "targetType": "string",
 80      "targetId": "string"
 81    }
 82  ],
 83  "spreadingFrequency": "NONE",
 84  "contractId": 0,
 85  "contractDisplayId": "string",
 86  "companyCodeId": 0,
 87  "companyCodeDisplayId": "string",
 88  "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
 89  "endOfTermDate": "2019-08-24",
 90  "endOfTermPeriod": 0,
 91  "allowsSystemGenerateNewId": true,
 92  "transferInfo": {
 93    "transferredFromDisplayId": "string",
 94    "transferredFromRevisionId": 0,
 95    "transferredToDisplayId": "string",
 96    "transferredToRevisionId": 0
 97  },
 98  "numberRangeIdentifierType": {
 99    "name": "string"
100  },
101  "numberRangeIdentifierValue": "string",
102  "numberRangeType": {
103    "name": "string"
104  },
105  "type": "string"
106}

Response Schema

Enumerated Values

Attribute

Value

assetClassType

EQUIPMENT, PLANT, PROPERTY

principalPositionType

LESSEE, LESSOR

priority

HIGH, LOW, MEDIUM

revisionType

ACTIVE, DRAFT, INACTIVE, REVERTED, REVISION

spreadingFrequency

NONE, PERIODIC, STRAIGHT_LINE

state

AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

userDeterminedLeaseType

LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE

Lease Component - Check Lease Component State

HTTP Request

GET /api/lease-components/check/{id}

📋 Description: Retrieves the details of a specific lease component identified by the provided ID, enabling users to analyze and manage real estate assets within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateMachineState

Example Responses

 1{
 2  "id": "string",
 3  "name": "string",
 4  "captionKey": "string",
 5  "latestStateHistoryFailureMessage": "string",
 6  "latestStateHistoryWarningMessage": "string",
 7  "initial": true,
 8  "final": true,
 9  "transitionState": true,
10  "caption": "string"
11}

Lease Component - Delete Lease Component Event

HTTP Request

DELETE /api/lease-components/event/{revisionId}

📋 Description: Deletes a specified lease component event identified by the revision ID, facilitating effective portfolio management and asset analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

revisionId

path

integer(int64)

true

Unique identifier for the revision

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None