General Setting¶
General Setting - Get¶
HTTP Request
GET /api/v1/general-settings/{id}
📋 Description: Retrieves the general settings for a specified financial entity within the organization’s structure, providing essential configuration details that support hierarchical management.
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
32 "value": "string"
33 }
34}
General Setting - Update¶
HTTP Request
PUT /api/v1/general-settings/{id}
📋 Description: Updates the general settings of a specified financial entity within the organization’s structure, allowing for modifications to hierarchy and configuration parameters.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated general settings data for a specific financial entity, including organizational structure and hierarchy details. |
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
19 "value": "string"
20}
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
32 "value": "string"
33 }
34}
General Setting - Delete¶
HTTP Request
DELETE /api/v1/general-settings/{id}
📋 Description: Deletes a specified general setting identified by its unique ID, thereby allowing for the effective management of the financial organization structure and hierarchy.
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}
General Setting - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/general-settings/createOrUpdate/bulk
📋 Description: Updates or creates multiple general settings for the financial organization structure in a single request, ensuring efficient management of organizational hierarchy and financial entity configurations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating the financial organization structure, including details on hierarchy and 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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
20 "value": "string"
21 }
22]
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
33 "value": "string"
34 }
35 ]
36}
General Setting - Create Or Update¶
HTTP Request
PUT /api/v1/general-settings/createOrUpdate
📋 Description: Updates or creates general settings for the financial organization structure, allowing users to define or modify the hierarchy and configuration of financial entities within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial organization structure data, including details for creating or updating the hierarchy and attributes of 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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
19 "value": "string"
20}
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
32 "value": "string"
33 }
34}
General Setting - Bulk Update¶
HTTP Request
PUT /api/v1/general-settings/bulk
📋 Description: Updates multiple general settings for the financial organization structure in a single request, enabling efficient management of organizational hierarchy and financial entity configurations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk updates for the financial organization structure, including details on hierarchy and entity relationships. |
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
20 "value": "string"
21 }
22]
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
33 "value": "string"
34 }
35 ]
36}
General Setting - Bulk Create¶
HTTP Request
POST /api/v1/general-settings/bulk
📋 Description: Submits bulk updates to the financial organization structure settings, allowing for efficient management of hierarchical configurations across multiple financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of financial entity settings, including organizational hierarchy and structural configurations for bulk updates. |
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
20 "value": "string"
21 }
22]
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
33 "value": "string"
34 }
35 ]
36}
General Setting - Bulk Delete¶
HTTP Request
DELETE /api/v1/general-settings/bulk
📋 Description: Deletes multiple general settings related to the financial organization structure, allowing for streamlined management of organizational hierarchy and configuration within financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of financial entity identifiers to facilitate the bulk deletion of organization structure settings. |
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}
General Setting - Search¶
HTTP Request
POST /api/v1/general-settings/search
📋 Description: Submits a search request to retrieve financial organization structure settings, enabling users to explore and analyze the hierarchy of financial entities within the organization.
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 search criteria for financial organization structure, including parameters related to organization hierarchy and entity classification. |
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 "generalSettingTypeIn": [
16 "PRINCIPAL_POSITION_MODE"
17 ],
18 "valueEqual": "string",
19 "valueLike": "string"
20}
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
37 "value": "string"
38 }
39 ],
40 "number": 0,
41 "sort": {
42 "unsorted": true,
43 "sorted": true,
44 "empty": true
45 },
46 "first": true,
47 "last": true,
48 "empty": true
49}
General Setting - Find All¶
HTTP Request
GET /api/v1/general-settings
📋 Description: Fetches the general settings related to the financial organization structure, providing essential information about the hierarchy and configuration of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure data. |
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
37 "value": "string"
38 }
39 ],
40 "number": 0,
41 "sort": {
42 "unsorted": true,
43 "sorted": true,
44 "empty": true
45 },
46 "first": true,
47 "last": true,
48 "empty": true
49}
General Setting - Create¶
HTTP Request
POST /api/v1/general-settings
📋 Description: Creates or updates general settings for the financial organization structure, enabling the configuration of hierarchy and entity relationships within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial organization structure data, including details on hierarchy and entity relationships essential for effective organizational 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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
19 "value": "string"
20}
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
32 "value": "string"
33 }
34}
General Setting - Get Metadata¶
HTTP Request
GET /api/v1/general-settings/meta
📋 Description: Retrieves metadata related to the financial organization structure, including details on the hierarchy and configuration of financial entities. This operation supports the effective management and understanding of organizational settings.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "GENERAL_SETTING_TYPE"
3]