Assessment Year

Get Assessment Year

HTTP Request

GET /api/assessment-years/{assessmentYearId}

📋 Description: Retrieves detailed information about a specific assessment year identified by the provided assessmentYearId, enabling users to access relevant data for analysis and reporting.

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}

Update Assessment Year

HTTP Request

PUT /api/assessment-years/{assessmentYearId}

📋 Description: Updates the details of a specific assessment year identified by the provided assessmentYearId, allowing for modifications to key attributes as necessary for accurate reporting and compliance.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

body

body

AssessmentYearDto

true

Request body containing the updated assessment year details, including relevant attributes and metadata for the specified assessment year.

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}

Delete Assessment Year

HTTP Request

DELETE /api/assessment-years/{assessmentYearId}

📋 Description: Deletes the specified assessment year identified by the assessmentYearId, ensuring the removal of associated data and maintaining data integrity within the assessment framework.

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

Create Assessment Year

HTTP Request

POST /api/assessment-years

📋 Description: Creates a new assessment year entry in the system, enabling organizations to manage and evaluate performance metrics effectively.

Parameters

Name

In

Type

Required

Description

body

body

AssessmentYearDto

true

Request body containing the assessment year details, including relevant attributes and metadata necessary for creating a new assessment period.

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

201

Created

Created

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}

Get Assessments

HTTP Request

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

📋 Description: Fetches assessments associated with a specified assessment year, enabling users to review and analyze performance metrics for that period.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

archived

query

boolean

false

Indicates whether to retrieve assessments that have been archived, allowing users to filter results based on the status of the assessments.

page

query

integer(int32)

false

Page number for pagination

size

query

integer(int32)

false

Number of items per page

sort

query

string

false

Sort order specification

type-id-in

query

string

false

Identifier for the specific type of assessment to filter results in the assessment year query.

no-appeal

query

boolean

false

Indicates whether to exclude assessments that are subject to appeal for the specified assessment year.

no-vacancy

query

boolean

false

Indicates whether to exclude assessments that have no available vacancies for the specified assessment year.

Default Values

Parameter

Default

Type

archived

false

query

page

0

query

size

5

query

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedResponseAssessmentDto

Example Responses

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

Create Assessments

HTTP Request

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

📋 Description: Creates a new assessment record for the specified assessment year, enabling organizations to manage and evaluate performance metrics effectively.

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 evaluation criteria and associated metadata, for 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, encapsulating key details such as evaluation criteria, results, and associated metadata to facilitate informed decision-making in performance 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

Indicates whether the assessment has been archived, reflecting its status in the system for record-keeping and retrieval purposes.

» 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, enabling accurate tracking and reporting of assessment activities.

» dateTo

string(date)

false

none

Specifies the end date for the assessment period, enabling accurate tracking and reporting of assessment timelines.

» buildingAssessment

number

false

none

Represents the numerical value of the building assessment, which is used to evaluate the condition and compliance of the property within the assessment framework.

» landAssessment

number

false

none

Represents the numerical value of the land assessment, which is essential for determining property valuation and tax implications.

» equipmentAssessment

number

false

none

Numeric value representing the assessment score of the equipment, used to evaluate its condition and performance within the operational framework.

» otherAssessment

number

false

none

Represents the numerical value of an additional assessment, providing insights for comprehensive evaluation within the assessment framework.

» totalAssessment

number

false

none

TotalAssessment represents the cumulative score or evaluation metric for the assessment, providing a quantitative measure of performance or achievement.

» assessmentType

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience.

»» 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

Indicates whether the pick list option has been archived, allowing for effective management of active and inactive options within the system.

»» 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

An array of pick list options that allows users to select and categorize relevant data points within the application.

»»» 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

Indicates whether the label has been archived, reflecting its current status within the system.

»»» 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 textual value associated with the label, providing essential context for categorization and identification within the system.

Get Assessment Taxes

HTTP Request

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

📋 Description: Fetches assessment tax details for a specified assessment year, enabling users to review and analyze tax data associated with that period.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

archived

query

boolean

false

Indicates whether to retrieve assessment taxes that have been archived, allowing users to filter results based on their current relevance.

page

query

integer(int32)

false

Page number for pagination

size

query

integer(int32)

false

Number of items per page

sort

query

string

false

Sort order specification

tax-type-id-in

query

string

false

Unique identifier for the type of tax applicable to the specified assessment year, facilitating accurate retrieval of assessment tax details.

tax-bill-version-id-in

query

string

false

Unique identifier for the specific version of the tax bill being queried, enabling precise retrieval of assessment tax data for the specified assessment year.

tax-status-id-in

query

string

false

Identifier for the specific tax status to filter assessment taxes associated with the given assessment year.

Default Values

Parameter

Default

Type

archived

false

query

page

0

query

size

5

query

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedResponseAssessmentTaxDto

Example Responses

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

Create Assessment Taxes

HTTP Request

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

📋 Description: Creates a new assessment tax record for the specified assessment year, enabling accurate financial tracking and compliance within the assessment framework.

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 amounts and applicable rates for 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    "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 a specific evaluation, including relevant financial metrics and compliance information for effective decision-making.]

» 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

Indicates whether the assessment has been archived, reflecting its status in the system for record-keeping and retrieval purposes.

» 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, facilitating efficient tracking and management within the system.

» 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

Represents the total taxable assessment amount used for calculating tax liabilities within the financial reporting framework.

» totalTaxes

number

false

none

Total amount of taxes assessed for the transaction, providing a comprehensive view of tax liabilities associated with the assessment.

» 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 selecting predefined values in business processes, enhancing data consistency and user experience.

»» 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

Indicates whether the pick list option has been archived, allowing for effective management of active and inactive options within the system.

»» 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

An array of pick list options that allows users to select and categorize relevant data points within the application.

»»» 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

Indicates whether the label has been archived, reflecting its current status within the system.

»»» 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 textual value associated with the label, providing essential context for categorization and identification within the system.

» taxBillVersion

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience.

» taxStatus

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience.

Archive Assessment Year

HTTP Request

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

📋 Description: Archives the specified assessment year, effectively marking it as inactive and preventing further modifications, thereby ensuring data integrity and compliance with business record-keeping practices.

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}

Get Vacancies

HTTP Request

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

📋 Description: Retrieves a list of vacancies associated with a specific assessment year, enabling users to effectively manage and allocate resources for workforce planning.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

page

query

integer(int32)

false

Page number for pagination

size

query

integer(int32)

false

Number of items per page

sort

query

string

false

Sort order specification

Default Values

Parameter

Default

Type

page

0

query

size

5

query

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedResponseVacancyDto

Example Responses

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

Get Appeals

HTTP Request

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

📋 Description: Retrieves a list of appeals associated with a specific assessment year, identified by the provided assessmentYearId, to facilitate review and management of appeal cases.

Parameters

Name

In

Type

Required

Description

assessmentYearId

path

integer(int64)

true

Unique identifier for the assessment year

page

query

integer(int32)

false

Page number for pagination

size

query

integer(int32)

false

Number of items per page

sort

query

string

false

Sort order specification

Default Values

Parameter

Default

Type

page

0

query

size

5

query

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedResponseAppealDto

Example Responses

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