Schedule

Schedule - Get Schedule Periods

HTTP Request

POST /api/schedules/periods

📋 Description: Creates new scheduling periods for assets within the Nakisa Portfolio Management Suite, enabling enhanced portfolio and asset analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ScheduleViewRequest

true

Request body containing the scheduling period details, including portfolio identifiers, asset allocations, and relevant analytics for real estate property management.

Body Parameters

 1{
 2  "principalPositionTypeStr": "LESSEE",
 3  "unitId": 0,
 4  "viewId": "lessee-all-columns",
 5  "leaseMeasurementId": 0,
 6  "activationGroupRevisionId": 10001,
 7  "fromYear": 2020,
 8  "toYear": 2020,
 9  "scheduleAggregationLevel": "PER_ACTIVATION_GROUP"
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1[
  2  {
  3    "id": 0,
  4    "period": 0,
  5    "periodStartDate": {
  6      "timing": "START_OF_DAY",
  7      "year": 0,
  8      "monthValue": 0,
  9      "dayOfMonth": 0,
 10      "leapYear": true,
 11      "month": "JANUARY",
 12      "dayOfWeek": "MONDAY",
 13      "dayOfYear": 0
 14    },
 15    "periodEndDate": {
 16      "timing": "START_OF_DAY",
 17      "year": 0,
 18      "monthValue": 0,
 19      "dayOfMonth": 0,
 20      "leapYear": true,
 21      "month": "JANUARY",
 22      "dayOfWeek": "MONDAY",
 23      "dayOfYear": 0
 24    },
 25    "payment": 0,
 26    "nonLeasePayment": 0,
 27    "nonLeasePaymentClosingBalance": 0,
 28    "paymentClosingBalance": 0,
 29    "basePayment": 0,
 30    "indexationAmount": 0,
 31    "negativeIndexationAmount": 0,
 32    "escalatingRentAmount": 0,
 33    "negativeEscalatingRentAmount": 0,
 34    "incentiveLeasePayment": 0,
 35    "leaseEndLeasePayment": 0,
 36    "baseNonLeasePayment": 0,
 37    "negativeNonLeasePayment": 0,
 38    "nonLeaseIndexationAmount": 0,
 39    "nonLeaseNegativeIndexationAmount": 0,
 40    "escalatingRentNonLeaseAmount": 0,
 41    "negativeEscalatingRentNonLeaseAmount": 0,
 42    "openingGrossBookValue": 0,
 43    "grossBookValue": 0,
 44    "openingNBV": 0,
 45    "closingNBV": 0,
 46    "openingAD": 0,
 47    "closingAD": 0,
 48    "depreciation": 0,
 49    "effectiveInterestRate": 0,
 50    "paymentTotals": [
 51      {
 52        "id": 0,
 53        "paymentDate": {
 54          "timing": "START_OF_DAY",
 55          "year": 0,
 56          "monthValue": 0,
 57          "dayOfMonth": 0,
 58          "leapYear": true,
 59          "month": "JANUARY",
 60          "dayOfWeek": "MONDAY",
 61          "dayOfYear": 0
 62        },
 63        "periodCount": 0,
 64        "accrualStartDate": {
 65          "timing": "START_OF_DAY",
 66          "year": 0,
 67          "monthValue": 0,
 68          "dayOfMonth": 0,
 69          "leapYear": true,
 70          "month": "JANUARY",
 71          "dayOfWeek": "MONDAY",
 72          "dayOfYear": 0
 73        },
 74        "accrualEndDate": {
 75          "timing": "START_OF_DAY",
 76          "year": 0,
 77          "monthValue": 0,
 78          "dayOfMonth": 0,
 79          "leapYear": true,
 80          "month": "JANUARY",
 81          "dayOfWeek": "MONDAY",
 82          "dayOfYear": 0
 83        },
 84        "accrualDays": 0,
 85        "leasePayment": 0,
 86        "basePayment": 0,
 87        "negativeBaseLeasePayment": 0,
 88        "indexationAmount": 0,
 89        "negativeIndexationAmount": 0,
 90        "escalatingRentAmount": 0,
 91        "negativeEscalatingRentAmount": 0,
 92        "totalPayment": 0,
 93        "nonLeasePayment": 0,
 94        "baseNonLeasePayment": 0,
 95        "negativeBaseNonLeasePayment": 0,
 96        "nonLeaseIndexationAmount": 0,
 97        "nonLeaseNegativeIndexationAmount": 0,
 98        "escalatingRentNonLeaseAmount": 0,
 99        "negativeEscalatingRentNonLeaseAmount": 0,
100        "periodId": 0,
101        "payments": [
102          {
103            "id": 0,
104            "paymentDate": {
105              "timing": "START_OF_DAY",
106              "year": 0,
107              "monthValue": 0,
108              "dayOfMonth": 0,
109              "leapYear": true,
110              "month": "JANUARY",
111              "dayOfWeek": "MONDAY",
112              "dayOfYear": 0
113            },
114            "amount": 0,
115            "paymentTermId": "string",
116            "paymentTotalId": 0,
117            "basePayment": 0,
118            "negativeBaseLeasePayment": 0,
119            "indexationAmount": 0,
120            "negativeIndexationAmount": 0,
121            "escalatingRentAmount": 0,
122            "negativeEscalatingRentAmount": 0,
123            "nonLeaseAmount": 0,
124            "baseNonLeasePayment": 0,
125            "negativeBaseNonLeasePayment": 0,
126            "nonLeaseIndexationAmount": 0,
127            "nonLeaseNegativeIndexationAmount": 0,
128            "escalatingRentNonLeaseAmount": 0,
129            "negativeEscalatingRentNonLeaseAmount": 0,
130            "paymentTermTag": "string",
131            "paymentType": "ACTUAL",
132            "presentValue": 0,
133            "vendorSplits": [
134              {
135                "vendorId": 0,
136                "amount": 0,
137                "percentage": "string"
138              }
139            ],
140            "type": "string",
141            "paymentTermType": "STANDARD_TERM_LEASE_PAYMENT"
142          }
143        ],
144        "type": "string",
145        "interestPaid": {
146          "openingBalance": 0,
147          "periodAmount": 0,
148          "closingBalance": 0
149        },
150        "accruedInterestExpense": {
151          "openingBalance": 0,
152          "periodAmount": 0,
153          "closingBalance": 0
154        },
155        "principalPaid": {
156          "openingBalance": 0,
157          "periodAmount": 0,
158          "closingBalance": 0
159        },
160        "interestExpense": {
161          "openingBalance": 0,
162          "periodAmount": 0,
163          "closingBalance": 0
164        },
165        "grvTransferToLiability": 0
166      }
167    ],
168    "fiscalYear": 0,
169    "fiscalPeriod": 0,
170    "leaseMeasurementId": 0,
171    "type": "string",
172    "principalPayable": {
173      "openingBalance": 0,
174      "periodAmount": 0,
175      "closingBalance": 0,
176      "stOpeningBalance": 0,
177      "stClosingBalance": 0,
178      "ltOpeningBalance": 0,
179      "ltClosingBalance": 0,
180      "transfer": 0,
181      "rawTransfer": 0
182    },
183    "interestPayable": {
184      "openingBalance": 0,
185      "periodAmount": 0,
186      "closingBalance": 0
187    },
188    "accruedInterestExpense": {
189      "openingBalance": 0,
190      "periodAmount": 0,
191      "closingBalance": 0,
192      "stOpeningBalance": 0,
193      "stClosingBalance": 0,
194      "ltOpeningBalance": 0,
195      "ltClosingBalance": 0,
196      "transfer": 0,
197      "rawTransfer": 0
198    },
199    "grvTransferToLiability": 0,
200    "totalIdc": 0,
201    "totalPositivePrepaid": 0,
202    "totalNegativePrepaid": 0,
203    "liabilityAdjustment": 0,
204    "accruedRent": {
205      "openingBalance": 0,
206      "periodAmount": 0,
207      "closingBalance": 0
208    },
209    "accruedRentNonLease": {
210      "openingBalance": 0,
211      "periodAmount": 0,
212      "closingBalance": 0
213    },
214    "rouAddition": 0,
215    "idcPrepaidAddition": 0,
216    "adChange": 0,
217    "rouAdjustment": {
218      "openingBalance": 0,
219      "periodAmount": 0,
220      "closingBalance": 0
221    },
222    "gainLoss": 0,
223    "impairmentAdjustment": {
224      "openingBalance": 0,
225      "periodAmount": 0,
226      "closingBalance": 0
227    },
228    "impairmentReserve": {
229      "openingBalance": 0,
230      "periodAmount": 0,
231      "closingBalance": 0
232    },
233    "nonRecoverableImpairmentLoss": 0,
234    "periodEndLeaseType": "FINANCE_LEASE",
235    "averageLeaseExpense": 0,
236    "averageNonLeaseExpense": 0,
237    "residualValue": 0,
238    "spreadingTotal": {
239      "id": 0,
240      "spreadingDate": {
241        "timing": "START_OF_DAY",
242        "year": 0,
243        "monthValue": 0,
244        "dayOfMonth": 0,
245        "leapYear": true,
246        "month": "JANUARY",
247        "dayOfWeek": "MONDAY",
248        "dayOfYear": 0
249      },
250      "leaseAmount": 0,
251      "nonLeaseAmount": 0,
252      "periodId": 0,
253      "spreadingList": [
254        {
255          "id": 0,
256          "spreadingDate": {
257            "timing": "START_OF_DAY",
258            "year": 0,
259            "monthValue": 0,
260            "dayOfMonth": 0,
261            "leapYear": true,
262            "month": "JANUARY",
263            "dayOfWeek": "MONDAY",
264            "dayOfYear": 0
265          },
266          "paymentTermId": "string",
267          "numberOfDays": 0,
268          "paymentPeriod": 0,
269          "schedulePeriodId": 0,
270          "spreadingTotalId": 0,
271          "leaseAmount": 0,
272          "nonLeaseAmount": 0
273        }
274      ]
275    },
276    "totalPayment": 0,
277    "totalLiability": {
278      "openingBalance": 0,
279      "periodAmount": 0,
280      "closingBalance": 0
281    }
282  }
283]

Response Schema

Enumerated Values

Attribute

Value

dayOfWeek

FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY

month

APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER

paymentTermType

ACCRUED_RENT_CLEARING, CASH_INCENTIVE, CASUALTY, DEFERRED_INFLOW_OF_RECOURCES, GUARANTEED_RESIDUAL_VALUE, IDC_PAYMENT, IGNORABLE_CALCULATION_PAYMENT, INCENTIVE_LEASE_PAYMENT, INDEX_LEASE_PAYMENT, LEASE_END_LEASE_PAYMENT, LEASE_END_NON_LEASE_PAYMENT, PREPAID_LEASE_PAYMENT, PURCHASE_OPTION, STANDARD_TERM_LEASE_PAYMENT, STANDARD_TERM_NON_LEASE_PAYMENT, TERMINATION_OPTION, UNGUARANTEED_RESIDUAL_VALUE, UNKNOWN

paymentType

ACTUAL, CALCULATION, REPORTING

periodEndLeaseType

DIRECT_FINANCING, FINANCE_LEASE, GASB_87, LOW_VALUE, NON_LEASE, OFF_BALANCE_SHEET, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM

timing

END_OF_DAY, START_OF_DAY