Lease Classification Setting¶
Lease Classification Setting - Get¶
HTTP Request
GET /api/v1/lease-classification-settings/{id}
📋 Description: Retrieves the lease classification settings for a specified financial entity, enabling organizations to manage their financial structure and hierarchy effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "leaseClassificationSettingType": "CUT_OVER_DATE",
32 "value": "string",
33 "leaseClassificationType": "NON_LEASE"
34 }
35}
Lease Classification Setting - Update¶
HTTP Request
PUT /api/v1/lease-classification-settings/{id}
📋 Description: Updates the lease classification settings for a specified financial entity within the organizational structure, ensuring alignment with the current hierarchy and compliance requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the lease classification settings data, including updated parameters for organizational structure and hierarchy within the financial entity. |
Body Parameters
1{
2 "id": 0,
3 "rowNumber": 0,
4 "rowIdentifier": "string",
5 "errors": [
6 "string"
7 ],
8 "linkedErrors": [
9 "string"
10 ],
11 "warnings": [
12 "string"
13 ],
14 "remarks": [
15 "string"
16 ],
17 "skipMessage": "string",
18 "leaseClassificationSettingType": "CUT_OVER_DATE",
19 "value": "string",
20 "leaseClassificationType": "NON_LEASE"
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "leaseClassificationSettingType": "CUT_OVER_DATE",
32 "value": "string",
33 "leaseClassificationType": "NON_LEASE"
34 }
35}
Lease Classification Setting - Delete¶
HTTP Request
DELETE /api/v1/lease-classification-settings/{id}
📋 Description: Deletes a specified lease classification setting within the financial organization structure, ensuring the integrity of the hierarchy and organizational framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Lease Classification Setting - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/lease-classification-settings/createOrUpdate/bulk
📋 Description: Updates or creates multiple lease classification settings within the financial organization structure, enabling efficient management of hierarchical financial entities. This operation ensures that lease classifications are accurately aligned with organizational requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk lease classification settings data, including organizational hierarchy details and financial entity attributes for effective management of financial structures. |
Body Parameters
1[
2 {
3 "id": 0,
4 "rowNumber": 0,
5 "rowIdentifier": "string",
6 "errors": [
7 "string"
8 ],
9 "linkedErrors": [
10 "string"
11 ],
12 "warnings": [
13 "string"
14 ],
15 "remarks": [
16 "string"
17 ],
18 "skipMessage": "string",
19 "leaseClassificationSettingType": "CUT_OVER_DATE",
20 "value": "string",
21 "leaseClassificationType": "NON_LEASE"
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "leaseClassificationSettingType": "CUT_OVER_DATE",
33 "value": "string",
34 "leaseClassificationType": "NON_LEASE"
35 }
36 ]
37}
Lease Classification Setting - Create Or Update¶
HTTP Request
PUT /api/v1/lease-classification-settings/createOrUpdate
📋 Description: Updates or creates lease classification settings within the financial organization structure, ensuring alignment with the hierarchy of financial entities. This operation facilitates the management of lease classifications to enhance organizational compliance and reporting accuracy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the lease classification settings data, including organizational hierarchy details and financial entity classifications for effective structure management. |
Body Parameters
1{
2 "id": 0,
3 "rowNumber": 0,
4 "rowIdentifier": "string",
5 "errors": [
6 "string"
7 ],
8 "linkedErrors": [
9 "string"
10 ],
11 "warnings": [
12 "string"
13 ],
14 "remarks": [
15 "string"
16 ],
17 "skipMessage": "string",
18 "leaseClassificationSettingType": "CUT_OVER_DATE",
19 "value": "string",
20 "leaseClassificationType": "NON_LEASE"
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "leaseClassificationSettingType": "CUT_OVER_DATE",
32 "value": "string",
33 "leaseClassificationType": "NON_LEASE"
34 }
35}
Lease Classification Setting - Bulk Update¶
HTTP Request
PUT /api/v1/lease-classification-settings/bulk
📋 Description: Updates multiple lease classification settings in bulk for a specified financial organization structure, ensuring alignment with the hierarchical requirements of the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk lease classification settings data, including organizational hierarchy details and financial entity classifications. |
Body Parameters
1[
2 {
3 "id": 0,
4 "rowNumber": 0,
5 "rowIdentifier": "string",
6 "errors": [
7 "string"
8 ],
9 "linkedErrors": [
10 "string"
11 ],
12 "warnings": [
13 "string"
14 ],
15 "remarks": [
16 "string"
17 ],
18 "skipMessage": "string",
19 "leaseClassificationSettingType": "CUT_OVER_DATE",
20 "value": "string",
21 "leaseClassificationType": "NON_LEASE"
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "leaseClassificationSettingType": "CUT_OVER_DATE",
33 "value": "string",
34 "leaseClassificationType": "NON_LEASE"
35 }
36 ]
37}
Lease Classification Setting - Bulk Create¶
HTTP Request
POST /api/v1/lease-classification-settings/bulk
📋 Description: Submits bulk lease classification settings to streamline the organization and hierarchy of financial entities within the financial organization structure.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk lease classification settings data, including organizational hierarchy and financial entity attributes for streamlined management within the financial organization structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "rowNumber": 0,
5 "rowIdentifier": "string",
6 "errors": [
7 "string"
8 ],
9 "linkedErrors": [
10 "string"
11 ],
12 "warnings": [
13 "string"
14 ],
15 "remarks": [
16 "string"
17 ],
18 "skipMessage": "string",
19 "leaseClassificationSettingType": "CUT_OVER_DATE",
20 "value": "string",
21 "leaseClassificationType": "NON_LEASE"
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "leaseClassificationSettingType": "CUT_OVER_DATE",
33 "value": "string",
34 "leaseClassificationType": "NON_LEASE"
35 }
36 ]
37}
Lease Classification Setting - Bulk Delete¶
HTTP Request
DELETE /api/v1/lease-classification-settings/bulk
📋 Description: Deletes multiple lease classification settings in bulk, allowing financial organizations to efficiently manage their organizational structure and hierarchy within the financial entity framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of lease classification settings identifiers to be deleted in bulk, relevant for managing the financial organization structure and hierarchy. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Lease Classification Setting - Search¶
HTTP Request
POST /api/v1/lease-classification-settings/search
📋 Description: Submits a request to search for lease classification settings within the financial organization structure, allowing users to efficiently navigate and manage hierarchical relationships of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the criteria for searching lease classification settings within the financial organization structure, including relevant parameters for organizational hierarchy and financial entity specifications. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "leaseClassificationSettingTypeIn": [
16 "CUT_OVER_DATE"
17 ],
18 "valueEqual": "string",
19 "valueLike": "string",
20 "leaseClassificationTypeEqual": "NON_LEASE"
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "rowNumber": 0,
22 "rowIdentifier": "string",
23 "errors": [
24 "string"
25 ],
26 "linkedErrors": [
27 "string"
28 ],
29 "warnings": [
30 "string"
31 ],
32 "remarks": [
33 "string"
34 ],
35 "skipMessage": "string",
36 "leaseClassificationSettingType": "CUT_OVER_DATE",
37 "value": "string",
38 "leaseClassificationType": "NON_LEASE"
39 }
40 ],
41 "number": 0,
42 "sort": {
43 "unsorted": true,
44 "sorted": true,
45 "empty": true
46 },
47 "first": true,
48 "last": true,
49 "empty": true
50}
Lease Classification Setting - Find All¶
HTTP Request
GET /api/v1/lease-classification-settings
📋 Description: Retrieves lease classification settings for the financial organization structure, providing essential information on the hierarchy and classification of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the lease classification settings should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "rowNumber": 0,
22 "rowIdentifier": "string",
23 "errors": [
24 "string"
25 ],
26 "linkedErrors": [
27 "string"
28 ],
29 "warnings": [
30 "string"
31 ],
32 "remarks": [
33 "string"
34 ],
35 "skipMessage": "string",
36 "leaseClassificationSettingType": "CUT_OVER_DATE",
37 "value": "string",
38 "leaseClassificationType": "NON_LEASE"
39 }
40 ],
41 "number": 0,
42 "sort": {
43 "unsorted": true,
44 "sorted": true,
45 "empty": true
46 },
47 "first": true,
48 "last": true,
49 "empty": true
50}
Lease Classification Setting - Create¶
HTTP Request
POST /api/v1/lease-classification-settings
📋 Description: Creates new lease classification settings within the financial organization structure, enabling the effective management of organizational hierarchy and financial entity classifications.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the lease classification settings data, including parameters for organizational structure and hierarchy relevant to financial entities. |
Body Parameters
1{
2 "id": 0,
3 "rowNumber": 0,
4 "rowIdentifier": "string",
5 "errors": [
6 "string"
7 ],
8 "linkedErrors": [
9 "string"
10 ],
11 "warnings": [
12 "string"
13 ],
14 "remarks": [
15 "string"
16 ],
17 "skipMessage": "string",
18 "leaseClassificationSettingType": "CUT_OVER_DATE",
19 "value": "string",
20 "leaseClassificationType": "NON_LEASE"
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "leaseClassificationSettingType": "CUT_OVER_DATE",
32 "value": "string",
33 "leaseClassificationType": "NON_LEASE"
34 }
35}
Lease Classification Setting - Get Metadata¶
HTTP Request
GET /api/v1/lease-classification-settings/meta
📋 Description: Retrieves metadata related to lease classification settings within the financial organization structure, providing essential insights into the hierarchical relationships of financial entities.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "LEASE_CLASSIFICATION_SETTING_TYPE"
3]