Adjustment

Adjustment - Get Adjustment Setting

HTTP Request

GET /api/lease/{leaseId}/payment-setting

Interactive Demo

📋 Description: Retrieves the payment settings associated with a specific lease, providing essential information for managing financial obligations within the Nakisa Portfolio Management Suite.

Parameters

Name	In	Type	Required	Description
leaseId	path	integer(int64)	true	Unique identifier for the lease

Responses

Status	Meaning	Description	Schema
200	OK	OK	AdjustmentSettingDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "paymentTermLabels": [
    "string"
  ],
  "adjustmentFrom": "2019-08-24",
  "adjustmentTo": "2019-08-24",
  "adjustmentTermDefinitions": [
    {
      "adjustmentTermDefinitionId": 0,
      "referenceTermDefinitionId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Adjustment - Edit Adjustment Setting

HTTP Request

PUT /api/lease/{leaseId}/payment-setting

Interactive Demo

📋 Description: Updates the payment settings for a specified lease within the Nakisa Portfolio Management Suite, enabling users to manage financial arrangements related to real estate assets effectively.

Parameters

Name	In	Type	Required	Description
leaseId	path	integer(int64)	true	Unique identifier for the lease
body	body	AdjustmentSettingDto	true	Request body containing the payment settings data for a specified lease, including configuration details essential for managing financial transactions within the Nakisa Portfolio Management Suite.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "paymentTermLabels": [
    "string"
  ],
  "adjustmentFrom": "2019-08-24",
  "adjustmentTo": "2019-08-24",
  "adjustmentTermDefinitions": [
    {
      "adjustmentTermDefinitionId": 0,
      "referenceTermDefinitionId": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	AdjustmentSettingDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "paymentTermLabels": [
    "string"
  ],
  "adjustmentFrom": "2019-08-24",
  "adjustmentTo": "2019-08-24",
  "adjustmentTermDefinitions": [
    {
      "adjustmentTermDefinitionId": 0,
      "referenceTermDefinitionId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Adjustment - Add Term Definitions To Settings

HTTP Request

PUT /api/lease/{leaseId}/payment-setting/term-definition-ids

Interactive Demo

📋 Description: Updates the payment setting term definition IDs for a specified lease within the Nakisa Portfolio Management Suite, enabling enhanced management of portfolio and asset financial analytics in real estate properties.

Parameters

Name	In	Type	Required	Description
leaseId	path	integer(int64)	true	Unique identifier for the lease
body	body	AdjustmentTermDefinitions	true	Request body containing the updated term definition IDs for payment settings associated with a specific lease, facilitating accurate financial analytics within the Nakisa Portfolio Management Suite.

Body Parameters

[
  {
    "adjustmentTermDefinitionId": 0,
    "referenceTermDefinitionId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	AdjustmentSettingDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "paymentTermLabels": [
    "string"
  ],
  "adjustmentFrom": "2019-08-24",
  "adjustmentTo": "2019-08-24",
  "adjustmentTermDefinitions": [
    {
      "adjustmentTermDefinitionId": 0,
      "referenceTermDefinitionId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Adjustment - Get Adjustment Setting Term Definitions

HTTP Request

POST /api/lease/{leaseId}/payment-setting/term-definition-list

Interactive Demo

📋 Description: Creates or updates the payment setting term definitions for a specified lease, enabling enhanced management of financial terms within the Nakisa Portfolio Management Suite’s real estate asset portfolio.

Parameters

Name	In	Type	Required	Description
leaseId	path	integer(int64)	true	Unique identifier for the lease

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "paymentFrequencyName": "string",
    "amountFrequencyName": "string",
    "paymentModeName": "string",
    "expenseCategoryId": 0,
    "currencyId": 0,
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "firstPaymentDate": "2019-08-24",
    "endOfMonthPayment": true,
    "proRata": true,
    "note": "string",
    "areaId": 0,
    "parentTermDefinitionId": 0,
    "expenseCategory": {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "editable": true,
      "expenseCategoryType": "PAYMENT"
    },
    "currency": {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "decimalPoints": 0,
      "depreciationAreaId": 0
    },
    "expenseGroup": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "priority": 0,
      "internalId": 0,
      "pickListCode": "string",
      "pickListLabel": "string",
      "label": "string",
      "cultureId": 0,
      "labelDtos": [
        {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "cultureId": 0,
          "value": "string"
        }
      ]
    },
    "costCenterId": 0,
    "leaseComponentId": 0,
    "leaseComponentName": "string",
    "assignmentNumber": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "priority": 0,
      "internalId": 0,
      "pickListCode": "string",
      "pickListLabel": "string",
      "label": "string",
      "cultureId": 0,
      "labelDtos": [
        {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "cultureId": 0,
          "value": "string"
        }
      ]
    },
    "assignmentNumberId": 0,
    "isAdjustmentTerm": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[TermDefinitionDto]	false	none	[Data transfer object representing the definition of a term within the Nakisa Portfolio Management Suite, providing essential context for portfolio, asset, analytics, and real estate property management.]
» createdBy	string	false	none	Username of who created this resource
» lastModifiedBy	string	false	none	Username of who last modified this resource
» createdDate	string(date-time)	false	none	Date of the created
» lastModifiedDate	string(date-time)	false	none	Date of the last modified
» archived	boolean	false	none	Boolean flag indicating archived status
» externalId	string	false	none	Unique identifier for the external
» id	integer(int64)	false	none	Unique identifier for the resource
» paymentFrequencyName	string	true	none	Name of the payment frequency
» amountFrequencyName	string	true	none	Name of the amount frequency
» paymentModeName	string	false	none	Name of the payment mode
» expenseCategoryId	integer(int64)	true	none	Unique identifier for the expense category
» currencyId	integer(int64)	false	none	Unique identifier for the currency
» startDate	string(date)	true	none	Start date of the resource
» endDate	string(date)	true	none	End date of the resource
» firstPaymentDate	string(date)	true	none	Date of the first payment
» endOfMonthPayment	boolean	true	none	Boolean flag indicating endOfMonthPayment status
» proRata	boolean	false	none	Boolean flag indicating proRata status
» note	string	false	none	Textual description or commentary related to the term definition, providing additional context for portfolio, asset, analytics, or real estate property management.
» areaId	integer(int64)	false	none	Unique identifier for the area
» parentTermDefinitionId	integer(int64)	false	none	Unique identifier for the parent term definition
» expenseCategory	ExpenseCategoryDto	false	none	Data transfer object representing an expense category within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of financial data related to portfolio, asset, and real estate property management.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» status	string	false	none	Status of the resource
»» displayId	string	true	none	Unique identifier for the display
»» name	string	true	none	Name of the resource
»» editable	boolean	true	none	Boolean flag indicating editable status
»» expenseCategoryType	string	true	none	Type of the expense category
» currency	CurrencyDto	false	none	Data transfer object representing currency details utilized within the Nakisa Portfolio Management Suite, facilitating accurate financial analysis and reporting for portfolio, asset, and real estate property management.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» status	string	false	none	Status of the resource
»» displayId	string	true	none	Unique identifier for the display
»» erpSystemId	integer(int64)	false	none	Unique identifier for the erp system
»» erpSystemDisplayId	string	false	none	Unique identifier for the erp system display
»» name	string	false	none	Name of the resource
»» decimalPoints	integer(int32)	true	none	Numeric value representing decimalPoints
»» depreciationAreaId	integer(int64)	false	none	Unique identifier for the depreciation area
» expenseGroup	PickListOptionDto	false	none	Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.
»» createdBy	string	false	none	Username of who created this resource
»» lastModifiedBy	string	false	none	Username of who last modified this resource
»» createdDate	string(date-time)	false	none	Date of the created
»» lastModifiedDate	string(date-time)	false	none	Date of the last modified
»» archived	boolean	false	none	Boolean flag indicating archived status
»» externalId	string	false	none	Unique identifier for the external
»» id	integer(int64)	false	none	Unique identifier for the resource
»» priority	integer(int64)	false	none	Priority of the resource
»» internalId	integer(int64)	false	none	Unique identifier for the internal
»» pickListCode	string	false	none	Code for the pick list
»» pickListLabel	string	false	none	Label for the pick list
»» label	string	false	none	Label for the resource
»» cultureId	integer(int64)	false	none	Unique identifier for the culture
»» labelDtos	[LabelDto]	false	none	List of labelDtos items
»»» createdBy	string	false	none	Username of who created this resource
»»» lastModifiedBy	string	false	none	Username of who last modified this resource
»»» createdDate	string(date-time)	false	none	Date of the created
»»» lastModifiedDate	string(date-time)	false	none	Date of the last modified
»»» archived	boolean	false	none	Boolean flag indicating archived status
»»» externalId	string	false	none	Unique identifier for the external
»»» id	integer(int64)	false	none	Unique identifier for the resource
»»» cultureId	integer(int64)	false	none	Unique identifier for the culture
»»» value	string	true	none	Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite.
» costCenterId	integer(int64)	false	none	Unique identifier for the cost center
» leaseComponentId	integer(int64)	false	none	Unique identifier for the lease component
» leaseComponentName	string	false	none	Name of the lease component
» assignmentNumber	PickListOptionDto	false	none	Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.
» assignmentNumberId	integer(int64)	false	none	Unique identifier for the assignment number
» isAdjustmentTerm	boolean	false	none	none

Enumerated Values

Attribute	Value
expenseCategoryType	CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION
status	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Adjustment - Generate Payment Adjustments

HTTP Request

GET /api/lease/{leaseId}/payment-adjustments

Interactive Demo

📋 Description: Retrieves payment adjustments associated with a specific lease, enabling users to analyze financial impacts within the Nakisa Portfolio Management Suite for effective portfolio and asset management.

Parameters

Name	In	Type	Required	Description
leaseId	path	integer(int64)	true	Unique identifier for the lease
adjustmentFrom	query	string	true	Specifies the starting point for retrieving payment adjustments associated with a particular lease, enabling effective portfolio and asset management within the Nakisa Portfolio Management Suite.
adjustmentTo	query	string	true	Specifies the type of adjustment to be applied to the payment for the lease, facilitating accurate financial analytics within the Nakisa Portfolio Management Suite.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "expenseCategoryLabel": "string",
    "postedSchedulePayment": 0,
    "newAdjustedPayment": 0,
    "currencyLabel": "string",
    "termDefinitionId": 0
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[PaymentAdjustmentDto]	false	none	[Data transfer object representing adjustments made to payment transactions within the Nakisa Portfolio Management Suite, facilitating accurate financial analytics and reporting for real estate assets in the portfolio.]
» id	integer(int64)	false	none	Unique identifier for the resource
» startDate	string(date)	false	none	Start date of the resource
» endDate	string(date)	false	none	End date of the resource
» expenseCategoryLabel	string	false	none	Label for the expense category
» postedSchedulePayment	number	false	none	Value for postedSchedulePayment field
» newAdjustedPayment	number	false	none	Value for newAdjustedPayment field
» currencyLabel	string	false	none	Label for the currency
» termDefinitionId	integer(int64)	false	none	Unique identifier for the term definition

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---