Number Range Config¶
Number Range Config - Get¶
HTTP Request
GET /api/v1/number_range_config/{id}
📋 Description: Retrieves the configuration details for a specific number range associated with a financial entity within the organizational structure, identified by the provided ID.
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 "entityType": "MASTER_AGREEMENT",
32 "identifierType": "COMPANY_CODE",
33 "identifierFrom": "string",
34 "identifierTo": "string",
35 "prefix": "string",
36 "rangeSeparator": "string",
37 "rangeFrom": "string",
38 "rangeTo": "string",
39 "isDefaultRange": true,
40 "status": "CREATED",
41 "numberRangeType": {
42 "name": "string"
43 },
44 "defaultRange": true,
45 "active": true
46 }
47}
Number Range Config - Update¶
HTTP Request
PUT /api/v1/number_range_config/{id}
📋 Description: Updates the number range configuration for a specified financial entity within the organizational structure, allowing for adjustments to the hierarchy and operational 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 configuration data for the specified number range within the financial organization structure, including parameters that define the hierarchy and organizational entity relationships. |
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 "entityType": "MASTER_AGREEMENT",
19 "identifierType": "COMPANY_CODE",
20 "identifierFrom": "string",
21 "identifierTo": "string",
22 "prefix": "string",
23 "rangeSeparator": "string",
24 "rangeFrom": "string",
25 "rangeTo": "string",
26 "isDefaultRange": true,
27 "status": "CREATED",
28 "numberRangeType": {
29 "name": "string"
30 },
31 "defaultRange": true,
32 "active": true
33}
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 "entityType": "MASTER_AGREEMENT",
32 "identifierType": "COMPANY_CODE",
33 "identifierFrom": "string",
34 "identifierTo": "string",
35 "prefix": "string",
36 "rangeSeparator": "string",
37 "rangeFrom": "string",
38 "rangeTo": "string",
39 "isDefaultRange": true,
40 "status": "CREATED",
41 "numberRangeType": {
42 "name": "string"
43 },
44 "defaultRange": true,
45 "active": true
46 }
47}
Number Range Config - Delete¶
HTTP Request
DELETE /api/v1/number_range_config/{id}
📋 Description: Deletes the specified number range configuration identified by the unique ID, thereby updating the financial organization structure by removing the associated hierarchy element.
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}
Number Range Config - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/number_range_config/createOrUpdate/bulk
📋 Description: Creates or updates multiple number range configurations within the financial organization structure, ensuring alignment with the hierarchical framework of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk configuration data for number ranges associated with financial entities within the organizational hierarchy, including relevant attributes and settings. |
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 "entityType": "MASTER_AGREEMENT",
20 "identifierType": "COMPANY_CODE",
21 "identifierFrom": "string",
22 "identifierTo": "string",
23 "prefix": "string",
24 "rangeSeparator": "string",
25 "rangeFrom": "string",
26 "rangeTo": "string",
27 "isDefaultRange": true,
28 "status": "CREATED",
29 "numberRangeType": {
30 "name": "string"
31 },
32 "defaultRange": true,
33 "active": true
34 }
35]
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 "entityType": "MASTER_AGREEMENT",
33 "identifierType": "COMPANY_CODE",
34 "identifierFrom": "string",
35 "identifierTo": "string",
36 "prefix": "string",
37 "rangeSeparator": "string",
38 "rangeFrom": "string",
39 "rangeTo": "string",
40 "isDefaultRange": true,
41 "status": "CREATED",
42 "numberRangeType": {
43 "name": "string"
44 },
45 "defaultRange": true,
46 "active": true
47 }
48 ]
49}
Number Range Config - Create Or Update¶
HTTP Request
PUT /api/v1/number_range_config/createOrUpdate
📋 Description: Creates or updates the number range configuration for financial entities within the organizational structure, ensuring accurate hierarchy management and compliance with financial reporting requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the configuration data for creating or updating number ranges within the financial organization structure, including relevant identifiers and hierarchical attributes. |
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 "entityType": "MASTER_AGREEMENT",
19 "identifierType": "COMPANY_CODE",
20 "identifierFrom": "string",
21 "identifierTo": "string",
22 "prefix": "string",
23 "rangeSeparator": "string",
24 "rangeFrom": "string",
25 "rangeTo": "string",
26 "isDefaultRange": true,
27 "status": "CREATED",
28 "numberRangeType": {
29 "name": "string"
30 },
31 "defaultRange": true,
32 "active": true
33}
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 "entityType": "MASTER_AGREEMENT",
32 "identifierType": "COMPANY_CODE",
33 "identifierFrom": "string",
34 "identifierTo": "string",
35 "prefix": "string",
36 "rangeSeparator": "string",
37 "rangeFrom": "string",
38 "rangeTo": "string",
39 "isDefaultRange": true,
40 "status": "CREATED",
41 "numberRangeType": {
42 "name": "string"
43 },
44 "defaultRange": true,
45 "active": true
46 }
47}
Number Range Config - Bulk Update¶
HTTP Request
PUT /api/v1/number_range_config/bulk
📋 Description: Updates the number range configuration in bulk for financial entities within the organizational structure, allowing for efficient management of hierarchical data settings.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a bulk configuration of number ranges for financial entities, including hierarchical structure and organizational parameters. |
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 "entityType": "MASTER_AGREEMENT",
20 "identifierType": "COMPANY_CODE",
21 "identifierFrom": "string",
22 "identifierTo": "string",
23 "prefix": "string",
24 "rangeSeparator": "string",
25 "rangeFrom": "string",
26 "rangeTo": "string",
27 "isDefaultRange": true,
28 "status": "CREATED",
29 "numberRangeType": {
30 "name": "string"
31 },
32 "defaultRange": true,
33 "active": true
34 }
35]
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 "entityType": "MASTER_AGREEMENT",
33 "identifierType": "COMPANY_CODE",
34 "identifierFrom": "string",
35 "identifierTo": "string",
36 "prefix": "string",
37 "rangeSeparator": "string",
38 "rangeFrom": "string",
39 "rangeTo": "string",
40 "isDefaultRange": true,
41 "status": "CREATED",
42 "numberRangeType": {
43 "name": "string"
44 },
45 "defaultRange": true,
46 "active": true
47 }
48 ]
49}
Number Range Config - Bulk Create¶
HTTP Request
POST /api/v1/number_range_config/bulk
📋 Description: Submits a bulk configuration of number ranges for financial entities within the organizational structure, enabling efficient management of hierarchical data across the financial organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk configuration data for defining number ranges within the financial organization structure, including hierarchical relationships and entity specifications. |
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 "entityType": "MASTER_AGREEMENT",
20 "identifierType": "COMPANY_CODE",
21 "identifierFrom": "string",
22 "identifierTo": "string",
23 "prefix": "string",
24 "rangeSeparator": "string",
25 "rangeFrom": "string",
26 "rangeTo": "string",
27 "isDefaultRange": true,
28 "status": "CREATED",
29 "numberRangeType": {
30 "name": "string"
31 },
32 "defaultRange": true,
33 "active": true
34 }
35]
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 "entityType": "MASTER_AGREEMENT",
33 "identifierType": "COMPANY_CODE",
34 "identifierFrom": "string",
35 "identifierTo": "string",
36 "prefix": "string",
37 "rangeSeparator": "string",
38 "rangeFrom": "string",
39 "rangeTo": "string",
40 "isDefaultRange": true,
41 "status": "CREATED",
42 "numberRangeType": {
43 "name": "string"
44 },
45 "defaultRange": true,
46 "active": true
47 }
48 ]
49}
Number Range Config - Bulk Delete¶
HTTP Request
DELETE /api/v1/number_range_config/bulk
📋 Description: Deletes multiple number range configurations within the financial organization structure, allowing for streamlined management of hierarchical financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of financial entity identifiers for bulk deletion of number range configurations within the organizational structure. |
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}
Number Range Config - Search¶
HTTP Request
POST /api/v1/number_range_config/search
📋 Description: Submits a search request for number range configurations within the financial organization structure, enabling users to identify specific configurations related to organizational hierarchy and 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 number range configurations within the financial organization structure, including parameters related to hierarchy and financial entities. |
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 "entityTypeIn": [
16 "MASTER_AGREEMENT"
17 ],
18 "identifierTypeIn": [
19 "COMPANY_CODE"
20 ],
21 "identifierFromLike": "string",
22 "identifierToLike": "string",
23 "prefixLike": "string",
24 "rangeSeparatorLike": "string",
25 "rangeFromLike": "string",
26 "rangeToLike": "string",
27 "isDefaultRangeEqual": true,
28 "isDefaultRangeIn": [
29 true
30 ],
31 "statusEqual": "CREATED"
32}
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 "entityType": "MASTER_AGREEMENT",
37 "identifierType": "COMPANY_CODE",
38 "identifierFrom": "string",
39 "identifierTo": "string",
40 "prefix": "string",
41 "rangeSeparator": "string",
42 "rangeFrom": "string",
43 "rangeTo": "string",
44 "isDefaultRange": true,
45 "status": "CREATED",
46 "numberRangeType": {
47 "name": "string"
48 },
49 "defaultRange": true,
50 "active": true
51 }
52 ],
53 "number": 0,
54 "sort": {
55 "unsorted": true,
56 "sorted": true,
57 "empty": true
58 },
59 "first": true,
60 "last": true,
61 "empty": true
62}
Number Range Config - Find All¶
HTTP Request
GET /api/v1/number_range_config
📋 Description: Fetches the configuration settings for number ranges within the financial organization structure, enabling users to understand and manage the hierarchy of financial entities effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the financial organization structure query should be returned in a paginated format, facilitating efficient data retrieval and management. |
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 "entityType": "MASTER_AGREEMENT",
37 "identifierType": "COMPANY_CODE",
38 "identifierFrom": "string",
39 "identifierTo": "string",
40 "prefix": "string",
41 "rangeSeparator": "string",
42 "rangeFrom": "string",
43 "rangeTo": "string",
44 "isDefaultRange": true,
45 "status": "CREATED",
46 "numberRangeType": {
47 "name": "string"
48 },
49 "defaultRange": true,
50 "active": true
51 }
52 ],
53 "number": 0,
54 "sort": {
55 "unsorted": true,
56 "sorted": true,
57 "empty": true
58 },
59 "first": true,
60 "last": true,
61 "empty": true
62}
Number Range Config - Create¶
HTTP Request
POST /api/v1/number_range_config
📋 Description: Creates a new number range configuration for a financial entity within the organizational structure, enabling effective management of hierarchical financial data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the configuration data for defining number ranges within the financial organization structure, including parameters for hierarchy and entity specifications. |
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 "entityType": "MASTER_AGREEMENT",
19 "identifierType": "COMPANY_CODE",
20 "identifierFrom": "string",
21 "identifierTo": "string",
22 "prefix": "string",
23 "rangeSeparator": "string",
24 "rangeFrom": "string",
25 "rangeTo": "string",
26 "isDefaultRange": true,
27 "status": "CREATED",
28 "numberRangeType": {
29 "name": "string"
30 },
31 "defaultRange": true,
32 "active": true
33}
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 "entityType": "MASTER_AGREEMENT",
32 "identifierType": "COMPANY_CODE",
33 "identifierFrom": "string",
34 "identifierTo": "string",
35 "prefix": "string",
36 "rangeSeparator": "string",
37 "rangeFrom": "string",
38 "rangeTo": "string",
39 "isDefaultRange": true,
40 "status": "CREATED",
41 "numberRangeType": {
42 "name": "string"
43 },
44 "defaultRange": true,
45 "active": true
46 }
47}
Number Range Config - Get Metadata¶
HTTP Request
GET /api/v1/number_range_config/meta
📋 Description: Retrieves metadata related to the number range configuration within the financial organization structure, providing insights into the hierarchy and structure of financial entities. This operation supports effective management and understanding of organizational configurations.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "ENTITY_TYPE"
3]