Assessment Year

Assessment Year - Get Assessment Year

HTTP Request

GET /api/assessment-years/{assessmentYearId}

📋 Description: Retrieves detailed information about a specific assessment year, identified by the assessmentYearId, to support portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

Responses

Status

Meaning

Description

Schema

200

OK

OK

AssessmentYearDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "year": 1900,
10  "rollNumber": "string",
11  "referenceNumber": "string",
12  "name": "string",
13  "propertyTypeId": 0,
14  "matriculeNumber": "string",
15  "proShare": 0,
16  "payToId": 0,
17  "rollStartYear": 1900,
18  "rollDuration": "string",
19  "commencementFrom": "2019-08-24",
20  "commencementTo": "2019-08-24",
21  "description": "string",
22  "propertyType": {
23    "createdBy": "string",
24    "lastModifiedBy": "string",
25    "createdDate": "2019-08-24T14:15:22Z",
26    "lastModifiedDate": "2019-08-24T14:15:22Z",
27    "archived": true,
28    "externalId": "string",
29    "id": 0,
30    "priority": 0,
31    "internalId": 0,
32    "pickListCode": "string",
33    "pickListLabel": "string",
34    "label": "string",
35    "cultureId": 0,
36    "labelDtos": [
37      {
38        "createdBy": "string",
39        "lastModifiedBy": "string",
40        "createdDate": "2019-08-24T14:15:22Z",
41        "lastModifiedDate": "2019-08-24T14:15:22Z",
42        "archived": true,
43        "externalId": "string",
44        "id": 0,
45        "cultureId": 0,
46        "value": "string"
47      }
48    ]
49  },
50  "payTo": {
51    "createdBy": "string",
52    "lastModifiedBy": "string",
53    "createdDate": "2019-08-24T14:15:22Z",
54    "lastModifiedDate": "2019-08-24T14:15:22Z",
55    "archived": true,
56    "externalId": "string",
57    "id": 0,
58    "priority": 0,
59    "internalId": 0,
60    "pickListCode": "string",
61    "pickListLabel": "string",
62    "label": "string",
63    "cultureId": 0,
64    "labelDtos": [
65      {
66        "createdBy": "string",
67        "lastModifiedBy": "string",
68        "createdDate": "2019-08-24T14:15:22Z",
69        "lastModifiedDate": "2019-08-24T14:15:22Z",
70        "archived": true,
71        "externalId": "string",
72        "id": 0,
73        "cultureId": 0,
74        "value": "string"
75      }
76    ]
77  }
78}

Assessment Year - Update Assessment Year

HTTP Request

PUT /api/assessment-years/{assessmentYearId}

📋 Description: Updates the details of a specific assessment year within the Nakisa Portfolio Management Suite, enabling users to manage portfolio analytics and asset evaluations effectively in the context of real estate properties.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

body

body

AssessmentYearDto

true

Request body containing updated assessment year details, including portfolio allocation and asset performance metrics, for effective analytics in real estate property management.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "year": 1900,
10  "rollNumber": "string",
11  "referenceNumber": "string",
12  "name": "string",
13  "propertyTypeId": 0,
14  "matriculeNumber": "string",
15  "proShare": 0,
16  "payToId": 0,
17  "rollStartYear": 1900,
18  "rollDuration": "string",
19  "commencementFrom": "2019-08-24",
20  "commencementTo": "2019-08-24",
21  "description": "string",
22  "propertyType": {
23    "createdBy": "string",
24    "lastModifiedBy": "string",
25    "createdDate": "2019-08-24T14:15:22Z",
26    "lastModifiedDate": "2019-08-24T14:15:22Z",
27    "archived": true,
28    "externalId": "string",
29    "id": 0,
30    "priority": 0,
31    "internalId": 0,
32    "pickListCode": "string",
33    "pickListLabel": "string",
34    "label": "string",
35    "cultureId": 0,
36    "labelDtos": [
37      {
38        "createdBy": "string",
39        "lastModifiedBy": "string",
40        "createdDate": "2019-08-24T14:15:22Z",
41        "lastModifiedDate": "2019-08-24T14:15:22Z",
42        "archived": true,
43        "externalId": "string",
44        "id": 0,
45        "cultureId": 0,
46        "value": "string"
47      }
48    ]
49  },
50  "payTo": {
51    "createdBy": "string",
52    "lastModifiedBy": "string",
53    "createdDate": "2019-08-24T14:15:22Z",
54    "lastModifiedDate": "2019-08-24T14:15:22Z",
55    "archived": true,
56    "externalId": "string",
57    "id": 0,
58    "priority": 0,
59    "internalId": 0,
60    "pickListCode": "string",
61    "pickListLabel": "string",
62    "label": "string",
63    "cultureId": 0,
64    "labelDtos": [
65      {
66        "createdBy": "string",
67        "lastModifiedBy": "string",
68        "createdDate": "2019-08-24T14:15:22Z",
69        "lastModifiedDate": "2019-08-24T14:15:22Z",
70        "archived": true,
71        "externalId": "string",
72        "id": 0,
73        "cultureId": 0,
74        "value": "string"
75      }
76    ]
77  }
78}

Responses

Status

Meaning

Description

Schema

200

OK

OK

AssessmentYearDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "year": 1900,
10  "rollNumber": "string",
11  "referenceNumber": "string",
12  "name": "string",
13  "propertyTypeId": 0,
14  "matriculeNumber": "string",
15  "proShare": 0,
16  "payToId": 0,
17  "rollStartYear": 1900,
18  "rollDuration": "string",
19  "commencementFrom": "2019-08-24",
20  "commencementTo": "2019-08-24",
21  "description": "string",
22  "propertyType": {
23    "createdBy": "string",
24    "lastModifiedBy": "string",
25    "createdDate": "2019-08-24T14:15:22Z",
26    "lastModifiedDate": "2019-08-24T14:15:22Z",
27    "archived": true,
28    "externalId": "string",
29    "id": 0,
30    "priority": 0,
31    "internalId": 0,
32    "pickListCode": "string",
33    "pickListLabel": "string",
34    "label": "string",
35    "cultureId": 0,
36    "labelDtos": [
37      {
38        "createdBy": "string",
39        "lastModifiedBy": "string",
40        "createdDate": "2019-08-24T14:15:22Z",
41        "lastModifiedDate": "2019-08-24T14:15:22Z",
42        "archived": true,
43        "externalId": "string",
44        "id": 0,
45        "cultureId": 0,
46        "value": "string"
47      }
48    ]
49  },
50  "payTo": {
51    "createdBy": "string",
52    "lastModifiedBy": "string",
53    "createdDate": "2019-08-24T14:15:22Z",
54    "lastModifiedDate": "2019-08-24T14:15:22Z",
55    "archived": true,
56    "externalId": "string",
57    "id": 0,
58    "priority": 0,
59    "internalId": 0,
60    "pickListCode": "string",
61    "pickListLabel": "string",
62    "label": "string",
63    "cultureId": 0,
64    "labelDtos": [
65      {
66        "createdBy": "string",
67        "lastModifiedBy": "string",
68        "createdDate": "2019-08-24T14:15:22Z",
69        "lastModifiedDate": "2019-08-24T14:15:22Z",
70        "archived": true,
71        "externalId": "string",
72        "id": 0,
73        "cultureId": 0,
74        "value": "string"
75      }
76    ]
77  }
78}

Assessment Year - Delete Assessment Year

HTTP Request

DELETE /api/assessment-years/{assessmentYearId}

📋 Description: Deletes a specified assessment year from the Nakisa Portfolio Management Suite, enabling users to maintain accurate and relevant portfolio analytics for real estate properties and assets.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Assessment Year - Archive Assessment Year

HTTP Request

POST /api/assessment-years/{id}/archive

📋 Description: Archives the specified assessment year within the Nakisa Portfolio Management Suite, enabling efficient management of portfolio and asset data related to real estate properties and 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

AssessmentYearDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "year": 1900,
10  "rollNumber": "string",
11  "referenceNumber": "string",
12  "name": "string",
13  "propertyTypeId": 0,
14  "matriculeNumber": "string",
15  "proShare": 0,
16  "payToId": 0,
17  "rollStartYear": 1900,
18  "rollDuration": "string",
19  "commencementFrom": "2019-08-24",
20  "commencementTo": "2019-08-24",
21  "description": "string",
22  "propertyType": {
23    "createdBy": "string",
24    "lastModifiedBy": "string",
25    "createdDate": "2019-08-24T14:15:22Z",
26    "lastModifiedDate": "2019-08-24T14:15:22Z",
27    "archived": true,
28    "externalId": "string",
29    "id": 0,
30    "priority": 0,
31    "internalId": 0,
32    "pickListCode": "string",
33    "pickListLabel": "string",
34    "label": "string",
35    "cultureId": 0,
36    "labelDtos": [
37      {
38        "createdBy": "string",
39        "lastModifiedBy": "string",
40        "createdDate": "2019-08-24T14:15:22Z",
41        "lastModifiedDate": "2019-08-24T14:15:22Z",
42        "archived": true,
43        "externalId": "string",
44        "id": 0,
45        "cultureId": 0,
46        "value": "string"
47      }
48    ]
49  },
50  "payTo": {
51    "createdBy": "string",
52    "lastModifiedBy": "string",
53    "createdDate": "2019-08-24T14:15:22Z",
54    "lastModifiedDate": "2019-08-24T14:15:22Z",
55    "archived": true,
56    "externalId": "string",
57    "id": 0,
58    "priority": 0,
59    "internalId": 0,
60    "pickListCode": "string",
61    "pickListLabel": "string",
62    "label": "string",
63    "cultureId": 0,
64    "labelDtos": [
65      {
66        "createdBy": "string",
67        "lastModifiedBy": "string",
68        "createdDate": "2019-08-24T14:15:22Z",
69        "lastModifiedDate": "2019-08-24T14:15:22Z",
70        "archived": true,
71        "externalId": "string",
72        "id": 0,
73        "cultureId": 0,
74        "value": "string"
75      }
76    ]
77  }
78}

Assessment Year - Get Assessment For Assessment Year

HTTP Request

GET /api/assessment-years/{assessmentYearId}/assessments

📋 Description: Retrieves assessments associated with a specific assessment year, enabling users to analyze portfolio performance and asset valuation within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the assessments for the specified assessment year should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis.

assessmentYearId

path

string

true

Unique identifier for the assessment year

no-appeal

query

string

false

Specifies whether to exclude appeal assessments from the retrieved data for the given assessment year, facilitating focused analytics on portfolio and asset performance in real estate property management.

appeal-id

query

string

false

Unique identifier for the appeal associated with the specified assessment year, facilitating accurate retrieval of assessment data within the Nakisa Portfolio Management Suite.

no-vacancy

query

string

false

Indicates whether to exclude assessments for properties with no available vacancies in the portfolio analytics for the specified assessment year.

vacancy-id

query

string

false

Unique identifier for the specific vacancy within the assessment year, facilitating targeted retrieval of assessment data related to portfolio and asset analytics in real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelAssessmentDto

Example Responses

 1{
 2  "_embedded": {
 3    "assessments": [
 4      {
 5        "createdBy": "string",
 6        "lastModifiedBy": "string",
 7        "createdDate": "2019-08-24T14:15:22Z",
 8        "lastModifiedDate": "2019-08-24T14:15:22Z",
 9        "archived": true,
10        "externalId": "string",
11        "id": 0,
12        "assessmentTypeId": 0,
13        "referenceDate": "2019-08-24",
14        "dateFrom": "2019-08-24",
15        "dateTo": "2019-08-24",
16        "buildingAssessment": 0,
17        "landAssessment": 0,
18        "equipmentAssessment": 0,
19        "otherAssessment": 0,
20        "totalAssessment": 0,
21        "assessmentType": {
22          "createdBy": "string",
23          "lastModifiedBy": "string",
24          "createdDate": "2019-08-24T14:15:22Z",
25          "lastModifiedDate": "2019-08-24T14:15:22Z",
26          "archived": true,
27          "externalId": "string",
28          "id": 0,
29          "priority": 0,
30          "internalId": 0,
31          "pickListCode": "string",
32          "pickListLabel": "string",
33          "label": "string",
34          "cultureId": 0,
35          "labelDtos": [
36            {
37              "createdBy": "string",
38              "lastModifiedBy": "string",
39              "createdDate": "2019-08-24T14:15:22Z",
40              "lastModifiedDate": "2019-08-24T14:15:22Z",
41              "archived": true,
42              "externalId": "string",
43              "id": 0,
44              "cultureId": 0,
45              "value": "string"
46            }
47          ]
48        }
49      }
50    ]
51  },
52  "page": {
53    "size": 0,
54    "totalElements": 0,
55    "totalPages": 0,
56    "number": 0
57  }
58}

Assessment Year - Create Assessment Year Assessment

HTTP Request

POST /api/assessment-years/{assessmentYearId}/assessments

📋 Description: Creates a new assessment for the specified assessment year, enabling users to evaluate portfolio assets and analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

body

body

AssessmentDto

true

Request body containing the assessment details, including portfolio identifiers, asset metrics, and analytical parameters relevant to the specified assessment year.

Body Parameters

 1[
 2  {
 3    "createdBy": "string",
 4    "lastModifiedBy": "string",
 5    "createdDate": "2019-08-24T14:15:22Z",
 6    "lastModifiedDate": "2019-08-24T14:15:22Z",
 7    "archived": true,
 8    "externalId": "string",
 9    "id": 0,
10    "assessmentTypeId": 0,
11    "referenceDate": "2019-08-24",
12    "dateFrom": "2019-08-24",
13    "dateTo": "2019-08-24",
14    "buildingAssessment": 0,
15    "landAssessment": 0,
16    "equipmentAssessment": 0,
17    "otherAssessment": 0,
18    "totalAssessment": 0,
19    "assessmentType": {
20      "createdBy": "string",
21      "lastModifiedBy": "string",
22      "createdDate": "2019-08-24T14:15:22Z",
23      "lastModifiedDate": "2019-08-24T14:15:22Z",
24      "archived": true,
25      "externalId": "string",
26      "id": 0,
27      "priority": 0,
28      "internalId": 0,
29      "pickListCode": "string",
30      "pickListLabel": "string",
31      "label": "string",
32      "cultureId": 0,
33      "labelDtos": [
34        {
35          "createdBy": "string",
36          "lastModifiedBy": "string",
37          "createdDate": "2019-08-24T14:15:22Z",
38          "lastModifiedDate": "2019-08-24T14:15:22Z",
39          "archived": true,
40          "externalId": "string",
41          "id": 0,
42          "cultureId": 0,
43          "value": "string"
44        }
45      ]
46    }
47  }
48]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

 1[
 2  {
 3    "createdBy": "string",
 4    "lastModifiedBy": "string",
 5    "createdDate": "2019-08-24T14:15:22Z",
 6    "lastModifiedDate": "2019-08-24T14:15:22Z",
 7    "archived": true,
 8    "externalId": "string",
 9    "id": 0,
10    "assessmentTypeId": 0,
11    "referenceDate": "2019-08-24",
12    "dateFrom": "2019-08-24",
13    "dateTo": "2019-08-24",
14    "buildingAssessment": 0,
15    "landAssessment": 0,
16    "equipmentAssessment": 0,
17    "otherAssessment": 0,
18    "totalAssessment": 0,
19    "assessmentType": {
20      "createdBy": "string",
21      "lastModifiedBy": "string",
22      "createdDate": "2019-08-24T14:15:22Z",
23      "lastModifiedDate": "2019-08-24T14:15:22Z",
24      "archived": true,
25      "externalId": "string",
26      "id": 0,
27      "priority": 0,
28      "internalId": 0,
29      "pickListCode": "string",
30      "pickListLabel": "string",
31      "label": "string",
32      "cultureId": 0,
33      "labelDtos": [
34        {
35          "createdBy": "string",
36          "lastModifiedBy": "string",
37          "createdDate": "2019-08-24T14:15:22Z",
38          "lastModifiedDate": "2019-08-24T14:15:22Z",
39          "archived": true,
40          "externalId": "string",
41          "id": 0,
42          "cultureId": 0,
43          "value": "string"
44        }
45      ]
46    }
47  }
48]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[AssessmentDto]

false

none

[Data transfer object representing an assessment within the Nakisa Portfolio Management Suite, encompassing key metrics and insights related to portfolio performance, asset valuation, and real estate property analytics.]

» 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

» assessmentTypeId

integer(int64)

true

none

Unique identifier for the assessment type

» referenceDate

string(date)

false

none

Date of the reference

» dateFrom

string(date)

false

none

Specifies the starting date for the assessment period, facilitating portfolio and asset analytics within the Nakisa Portfolio Management Suite.

» dateTo

string(date)

false

none

Specifies the end date for the assessment period within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analysis in the context of real estate property management.

» buildingAssessment

number

false

none

Value for buildingAssessment field

» landAssessment

number

false

none

Value for landAssessment field

» equipmentAssessment

number

false

none

Value for equipmentAssessment field

» otherAssessment

number

false

none

Value for otherAssessment field

» totalAssessment

number

false

none

Value for totalAssessment field

» assessmentType

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.

Assessment Year - Get Assessment Taxes For Assessment Year

HTTP Request

GET /api/assessment-years/{assessmentYearId}/assessment-taxes

📋 Description: Retrieves assessment tax details for a specified assessment year, enabling users to analyze financial obligations related to real estate properties within their portfolio.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the assessment taxes query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

assessmentYearId

path

string

true

Unique identifier for the assessment year

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelAssessmentTaxDto

Example Responses

  1{
  2  "_embedded": {
  3    "assessmentTaxes": [
  4      {
  5        "createdBy": "string",
  6        "lastModifiedBy": "string",
  7        "createdDate": "2019-08-24T14:15:22Z",
  8        "lastModifiedDate": "2019-08-24T14:15:22Z",
  9        "archived": true,
 10        "externalId": "string",
 11        "id": 0,
 12        "referenceNumber": "string",
 13        "billingDate": "2019-08-24",
 14        "taxTypeId": 0,
 15        "taxPeriodStartDate": "2019-08-24",
 16        "taxPeriodEndDate": "2019-08-24",
 17        "taxableAssessment": 0,
 18        "totalTaxes": 0,
 19        "taxRate": 0,
 20        "firstPaymentDate": "2019-08-24",
 21        "taxBillVersionId": 0,
 22        "taxStatusId": 0,
 23        "taxType": {
 24          "createdBy": "string",
 25          "lastModifiedBy": "string",
 26          "createdDate": "2019-08-24T14:15:22Z",
 27          "lastModifiedDate": "2019-08-24T14:15:22Z",
 28          "archived": true,
 29          "externalId": "string",
 30          "id": 0,
 31          "priority": 0,
 32          "internalId": 0,
 33          "pickListCode": "string",
 34          "pickListLabel": "string",
 35          "label": "string",
 36          "cultureId": 0,
 37          "labelDtos": [
 38            {
 39              "createdBy": "string",
 40              "lastModifiedBy": "string",
 41              "createdDate": "2019-08-24T14:15:22Z",
 42              "lastModifiedDate": "2019-08-24T14:15:22Z",
 43              "archived": true,
 44              "externalId": "string",
 45              "id": 0,
 46              "cultureId": 0,
 47              "value": "string"
 48            }
 49          ]
 50        },
 51        "taxBillVersion": {
 52          "createdBy": "string",
 53          "lastModifiedBy": "string",
 54          "createdDate": "2019-08-24T14:15:22Z",
 55          "lastModifiedDate": "2019-08-24T14:15:22Z",
 56          "archived": true,
 57          "externalId": "string",
 58          "id": 0,
 59          "priority": 0,
 60          "internalId": 0,
 61          "pickListCode": "string",
 62          "pickListLabel": "string",
 63          "label": "string",
 64          "cultureId": 0,
 65          "labelDtos": [
 66            {
 67              "createdBy": "string",
 68              "lastModifiedBy": "string",
 69              "createdDate": "2019-08-24T14:15:22Z",
 70              "lastModifiedDate": "2019-08-24T14:15:22Z",
 71              "archived": true,
 72              "externalId": "string",
 73              "id": 0,
 74              "cultureId": 0,
 75              "value": "string"
 76            }
 77          ]
 78        },
 79        "taxStatus": {
 80          "createdBy": "string",
 81          "lastModifiedBy": "string",
 82          "createdDate": "2019-08-24T14:15:22Z",
 83          "lastModifiedDate": "2019-08-24T14:15:22Z",
 84          "archived": true,
 85          "externalId": "string",
 86          "id": 0,
 87          "priority": 0,
 88          "internalId": 0,
 89          "pickListCode": "string",
 90          "pickListLabel": "string",
 91          "label": "string",
 92          "cultureId": 0,
 93          "labelDtos": [
 94            {
 95              "createdBy": "string",
 96              "lastModifiedBy": "string",
 97              "createdDate": "2019-08-24T14:15:22Z",
 98              "lastModifiedDate": "2019-08-24T14:15:22Z",
 99              "archived": true,
100              "externalId": "string",
101              "id": 0,
102              "cultureId": 0,
103              "value": "string"
104            }
105          ]
106        }
107      }
108    ]
109  },
110  "page": {
111    "size": 0,
112    "totalElements": 0,
113    "totalPages": 0,
114    "number": 0
115  }
116}

Assessment Year - Create Assessment Year Assessment Tax

HTTP Request

POST /api/assessment-years/{assessmentYearId}/assessment-taxes

📋 Description: Creates a new assessment tax entry for the specified assessment year, enabling accurate financial analytics and portfolio management for real estate assets within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

body

body

AssessmentTaxDto

true

Request body containing the assessment tax details, including tax rates and applicable properties, for the specified assessment year within the Nakisa Portfolio Management Suite.

Body Parameters

  1[
  2  {
  3    "createdBy": "string",
  4    "lastModifiedBy": "string",
  5    "createdDate": "2019-08-24T14:15:22Z",
  6    "lastModifiedDate": "2019-08-24T14:15:22Z",
  7    "archived": true,
  8    "externalId": "string",
  9    "id": 0,
 10    "referenceNumber": "string",
 11    "billingDate": "2019-08-24",
 12    "taxTypeId": 0,
 13    "taxPeriodStartDate": "2019-08-24",
 14    "taxPeriodEndDate": "2019-08-24",
 15    "taxableAssessment": 0,
 16    "totalTaxes": 0,
 17    "taxRate": 0,
 18    "firstPaymentDate": "2019-08-24",
 19    "taxBillVersionId": 0,
 20    "taxStatusId": 0,
 21    "taxType": {
 22      "createdBy": "string",
 23      "lastModifiedBy": "string",
 24      "createdDate": "2019-08-24T14:15:22Z",
 25      "lastModifiedDate": "2019-08-24T14:15:22Z",
 26      "archived": true,
 27      "externalId": "string",
 28      "id": 0,
 29      "priority": 0,
 30      "internalId": 0,
 31      "pickListCode": "string",
 32      "pickListLabel": "string",
 33      "label": "string",
 34      "cultureId": 0,
 35      "labelDtos": [
 36        {
 37          "createdBy": "string",
 38          "lastModifiedBy": "string",
 39          "createdDate": "2019-08-24T14:15:22Z",
 40          "lastModifiedDate": "2019-08-24T14:15:22Z",
 41          "archived": true,
 42          "externalId": "string",
 43          "id": 0,
 44          "cultureId": 0,
 45          "value": "string"
 46        }
 47      ]
 48    },
 49    "taxBillVersion": {
 50      "createdBy": "string",
 51      "lastModifiedBy": "string",
 52      "createdDate": "2019-08-24T14:15:22Z",
 53      "lastModifiedDate": "2019-08-24T14:15:22Z",
 54      "archived": true,
 55      "externalId": "string",
 56      "id": 0,
 57      "priority": 0,
 58      "internalId": 0,
 59      "pickListCode": "string",
 60      "pickListLabel": "string",
 61      "label": "string",
 62      "cultureId": 0,
 63      "labelDtos": [
 64        {
 65          "createdBy": "string",
 66          "lastModifiedBy": "string",
 67          "createdDate": "2019-08-24T14:15:22Z",
 68          "lastModifiedDate": "2019-08-24T14:15:22Z",
 69          "archived": true,
 70          "externalId": "string",
 71          "id": 0,
 72          "cultureId": 0,
 73          "value": "string"
 74        }
 75      ]
 76    },
 77    "taxStatus": {
 78      "createdBy": "string",
 79      "lastModifiedBy": "string",
 80      "createdDate": "2019-08-24T14:15:22Z",
 81      "lastModifiedDate": "2019-08-24T14:15:22Z",
 82      "archived": true,
 83      "externalId": "string",
 84      "id": 0,
 85      "priority": 0,
 86      "internalId": 0,
 87      "pickListCode": "string",
 88      "pickListLabel": "string",
 89      "label": "string",
 90      "cultureId": 0,
 91      "labelDtos": [
 92        {
 93          "createdBy": "string",
 94          "lastModifiedBy": "string",
 95          "createdDate": "2019-08-24T14:15:22Z",
 96          "lastModifiedDate": "2019-08-24T14:15:22Z",
 97          "archived": true,
 98          "externalId": "string",
 99          "id": 0,
100          "cultureId": 0,
101          "value": "string"
102        }
103      ]
104    }
105  }
106]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

  1[
  2  {
  3    "createdBy": "string",
  4    "lastModifiedBy": "string",
  5    "createdDate": "2019-08-24T14:15:22Z",
  6    "lastModifiedDate": "2019-08-24T14:15:22Z",
  7    "archived": true,
  8    "externalId": "string",
  9    "id": 0,
 10    "referenceNumber": "string",
 11    "billingDate": "2019-08-24",
 12    "taxTypeId": 0,
 13    "taxPeriodStartDate": "2019-08-24",
 14    "taxPeriodEndDate": "2019-08-24",
 15    "taxableAssessment": 0,
 16    "totalTaxes": 0,
 17    "taxRate": 0,
 18    "firstPaymentDate": "2019-08-24",
 19    "taxBillVersionId": 0,
 20    "taxStatusId": 0,
 21    "taxType": {
 22      "createdBy": "string",
 23      "lastModifiedBy": "string",
 24      "createdDate": "2019-08-24T14:15:22Z",
 25      "lastModifiedDate": "2019-08-24T14:15:22Z",
 26      "archived": true,
 27      "externalId": "string",
 28      "id": 0,
 29      "priority": 0,
 30      "internalId": 0,
 31      "pickListCode": "string",
 32      "pickListLabel": "string",
 33      "label": "string",
 34      "cultureId": 0,
 35      "labelDtos": [
 36        {
 37          "createdBy": "string",
 38          "lastModifiedBy": "string",
 39          "createdDate": "2019-08-24T14:15:22Z",
 40          "lastModifiedDate": "2019-08-24T14:15:22Z",
 41          "archived": true,
 42          "externalId": "string",
 43          "id": 0,
 44          "cultureId": 0,
 45          "value": "string"
 46        }
 47      ]
 48    },
 49    "taxBillVersion": {
 50      "createdBy": "string",
 51      "lastModifiedBy": "string",
 52      "createdDate": "2019-08-24T14:15:22Z",
 53      "lastModifiedDate": "2019-08-24T14:15:22Z",
 54      "archived": true,
 55      "externalId": "string",
 56      "id": 0,
 57      "priority": 0,
 58      "internalId": 0,
 59      "pickListCode": "string",
 60      "pickListLabel": "string",
 61      "label": "string",
 62      "cultureId": 0,
 63      "labelDtos": [
 64        {
 65          "createdBy": "string",
 66          "lastModifiedBy": "string",
 67          "createdDate": "2019-08-24T14:15:22Z",
 68          "lastModifiedDate": "2019-08-24T14:15:22Z",
 69          "archived": true,
 70          "externalId": "string",
 71          "id": 0,
 72          "cultureId": 0,
 73          "value": "string"
 74        }
 75      ]
 76    },
 77    "taxStatus": {
 78      "createdBy": "string",
 79      "lastModifiedBy": "string",
 80      "createdDate": "2019-08-24T14:15:22Z",
 81      "lastModifiedDate": "2019-08-24T14:15:22Z",
 82      "archived": true,
 83      "externalId": "string",
 84      "id": 0,
 85      "priority": 0,
 86      "internalId": 0,
 87      "pickListCode": "string",
 88      "pickListLabel": "string",
 89      "label": "string",
 90      "cultureId": 0,
 91      "labelDtos": [
 92        {
 93          "createdBy": "string",
 94          "lastModifiedBy": "string",
 95          "createdDate": "2019-08-24T14:15:22Z",
 96          "lastModifiedDate": "2019-08-24T14:15:22Z",
 97          "archived": true,
 98          "externalId": "string",
 99          "id": 0,
100          "cultureId": 0,
101          "value": "string"
102        }
103      ]
104    }
105  }
106]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[AssessmentTaxDto]

false

none

[Data transfer object representing the tax assessment details associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics.]

» 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

» referenceNumber

string

false

none

Unique identifier for the assessment tax record associated with a portfolio asset within the Nakisa Portfolio Management Suite.

» billingDate

string(date)

true

none

Date of the billing

» taxTypeId

integer(int64)

false

none

Unique identifier for the tax type

» taxPeriodStartDate

string(date)

false

none

Date of the tax period start

» taxPeriodEndDate

string(date)

false

none

Date of the tax period end

» taxableAssessment

number

false

none

Value for taxableAssessment field

» totalTaxes

number

false

none

Value for totalTaxes field

» taxRate

number

false

none

Rate of tax

» firstPaymentDate

string(date)

false

none

Date of the first payment

» taxBillVersionId

integer(int64)

false

none

Unique identifier for the tax bill version

» taxStatusId

integer(int64)

false

none

Unique identifier for the tax status

» taxType

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.

» taxBillVersion

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.

» taxStatus

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.

Assessment Year - Get Vacancies For Assessment Year

HTTP Request

GET /api/assessment-years/{assessmentYearId}/vacancies

📋 Description: Retrieves a list of vacancies associated with a specific assessment year, enabling users to analyze portfolio and asset opportunities within the real estate property context.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

pageable

query

Pageable

true

Indicates whether the results of the vacancies query for a specific assessment year should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelVacancyDto

Example Responses

 1{
 2  "_embedded": {
 3    "vacancies": [
 4      {
 5        "createdBy": "string",
 6        "lastModifiedBy": "string",
 7        "createdDate": "2019-08-24T14:15:22Z",
 8        "lastModifiedDate": "2019-08-24T14:15:22Z",
 9        "archived": true,
10        "externalId": "string",
11        "id": 0,
12        "unit": "string",
13        "area": 0,
14        "unitMeasureId": 0,
15        "vacantFrom": "2019-08-24",
16        "vacantTo": "2019-08-24",
17        "marketValue": 0,
18        "eligible": true,
19        "applicationDate": "2019-08-24",
20        "followUpDate": "2019-08-24",
21        "vacancyStatusId": 0,
22        "credit": 0,
23        "creditReceived": 0,
24        "note": "string",
25        "assessmentId": 0,
26        "assessmentExternalId": "string",
27        "unitMeasure": {
28          "createdBy": "string",
29          "lastModifiedBy": "string",
30          "createdDate": "2019-08-24T14:15:22Z",
31          "lastModifiedDate": "2019-08-24T14:15:22Z",
32          "archived": true,
33          "externalId": "string",
34          "id": 0,
35          "priority": 0,
36          "internalId": 0,
37          "pickListCode": "string",
38          "pickListLabel": "string",
39          "label": "string",
40          "cultureId": 0,
41          "labelDtos": [
42            {
43              "createdBy": "string",
44              "lastModifiedBy": "string",
45              "createdDate": "2019-08-24T14:15:22Z",
46              "lastModifiedDate": "2019-08-24T14:15:22Z",
47              "archived": true,
48              "externalId": "string",
49              "id": 0,
50              "cultureId": 0,
51              "value": "string"
52            }
53          ]
54        },
55        "vacancyStatus": {
56          "createdBy": "string",
57          "lastModifiedBy": "string",
58          "createdDate": "2019-08-24T14:15:22Z",
59          "lastModifiedDate": "2019-08-24T14:15:22Z",
60          "archived": true,
61          "externalId": "string",
62          "id": 0,
63          "priority": 0,
64          "internalId": 0,
65          "pickListCode": "string",
66          "pickListLabel": "string",
67          "label": "string",
68          "cultureId": 0,
69          "labelDtos": [
70            {
71              "createdBy": "string",
72              "lastModifiedBy": "string",
73              "createdDate": "2019-08-24T14:15:22Z",
74              "lastModifiedDate": "2019-08-24T14:15:22Z",
75              "archived": true,
76              "externalId": "string",
77              "id": 0,
78              "cultureId": 0,
79              "value": "string"
80            }
81          ]
82        }
83      }
84    ]
85  },
86  "page": {
87    "size": 0,
88    "totalElements": 0,
89    "totalPages": 0,
90    "number": 0
91  }
92}

Assessment Year - Get Appeals For Assessment Year

HTTP Request

GET /api/assessment-years/{assessmentYearId}/appeals

📋 Description: Retrieves a list of appeals associated with a specific assessment year, enabling users to analyze portfolio performance and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

pageable

query

Pageable

true

Indicates whether the results of the appeal requests for the specified assessment year should be returned in a paginated format, facilitating efficient data retrieval and analysis within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelAppealDto

Example Responses

  1{
  2  "_embedded": {
  3    "appeals": [
  4      {
  5        "createdBy": "string",
  6        "lastModifiedBy": "string",
  7        "createdDate": "2019-08-24T14:15:22Z",
  8        "lastModifiedDate": "2019-08-24T14:15:22Z",
  9        "archived": true,
 10        "externalId": "string",
 11        "id": 0,
 12        "appealAssessmentId": 0,
 13        "appealReviewedId": 0,
 14        "appealed": true,
 15        "appealActionId": 0,
 16        "followUpDate": "2019-08-24",
 17        "targetedAssessment": 0,
 18        "revisedAssessment": 0,
 19        "appealNegotiationId": 0,
 20        "settlementDate": "2019-08-24",
 21        "note": "string",
 22        "savings": [
 23          {
 24            "year": 0,
 25            "savings": 0
 26          }
 27        ],
 28        "assessmentId": 0,
 29        "assessmentExternalId": "string",
 30        "appealAssessment": {
 31          "createdBy": "string",
 32          "lastModifiedBy": "string",
 33          "createdDate": "2019-08-24T14:15:22Z",
 34          "lastModifiedDate": "2019-08-24T14:15:22Z",
 35          "archived": true,
 36          "externalId": "string",
 37          "id": 0,
 38          "priority": 0,
 39          "internalId": 0,
 40          "pickListCode": "string",
 41          "pickListLabel": "string",
 42          "label": "string",
 43          "cultureId": 0,
 44          "labelDtos": [
 45            {
 46              "createdBy": "string",
 47              "lastModifiedBy": "string",
 48              "createdDate": "2019-08-24T14:15:22Z",
 49              "lastModifiedDate": "2019-08-24T14:15:22Z",
 50              "archived": true,
 51              "externalId": "string",
 52              "id": 0,
 53              "cultureId": 0,
 54              "value": "string"
 55            }
 56          ]
 57        },
 58        "appealReviewed": {
 59          "createdBy": "string",
 60          "lastModifiedBy": "string",
 61          "createdDate": "2019-08-24T14:15:22Z",
 62          "lastModifiedDate": "2019-08-24T14:15:22Z",
 63          "archived": true,
 64          "externalId": "string",
 65          "id": 0,
 66          "priority": 0,
 67          "internalId": 0,
 68          "pickListCode": "string",
 69          "pickListLabel": "string",
 70          "label": "string",
 71          "cultureId": 0,
 72          "labelDtos": [
 73            {
 74              "createdBy": "string",
 75              "lastModifiedBy": "string",
 76              "createdDate": "2019-08-24T14:15:22Z",
 77              "lastModifiedDate": "2019-08-24T14:15:22Z",
 78              "archived": true,
 79              "externalId": "string",
 80              "id": 0,
 81              "cultureId": 0,
 82              "value": "string"
 83            }
 84          ]
 85        },
 86        "appealAction": {
 87          "createdBy": "string",
 88          "lastModifiedBy": "string",
 89          "createdDate": "2019-08-24T14:15:22Z",
 90          "lastModifiedDate": "2019-08-24T14:15:22Z",
 91          "archived": true,
 92          "externalId": "string",
 93          "id": 0,
 94          "priority": 0,
 95          "internalId": 0,
 96          "pickListCode": "string",
 97          "pickListLabel": "string",
 98          "label": "string",
 99          "cultureId": 0,
100          "labelDtos": [
101            {
102              "createdBy": "string",
103              "lastModifiedBy": "string",
104              "createdDate": "2019-08-24T14:15:22Z",
105              "lastModifiedDate": "2019-08-24T14:15:22Z",
106              "archived": true,
107              "externalId": "string",
108              "id": 0,
109              "cultureId": 0,
110              "value": "string"
111            }
112          ]
113        },
114        "appealNegotiation": {
115          "createdBy": "string",
116          "lastModifiedBy": "string",
117          "createdDate": "2019-08-24T14:15:22Z",
118          "lastModifiedDate": "2019-08-24T14:15:22Z",
119          "archived": true,
120          "externalId": "string",
121          "id": 0,
122          "priority": 0,
123          "internalId": 0,
124          "pickListCode": "string",
125          "pickListLabel": "string",
126          "label": "string",
127          "cultureId": 0,
128          "labelDtos": [
129            {
130              "createdBy": "string",
131              "lastModifiedBy": "string",
132              "createdDate": "2019-08-24T14:15:22Z",
133              "lastModifiedDate": "2019-08-24T14:15:22Z",
134              "archived": true,
135              "externalId": "string",
136              "id": 0,
137              "cultureId": 0,
138              "value": "string"
139            }
140          ]
141        }
142      }
143    ]
144  },
145  "page": {
146    "size": 0,
147    "totalElements": 0,
148    "totalPages": 0,
149    "number": 0
150  }
151}