Asset Class Determination¶
Asset Class Determination - Get¶
HTTP Request
GET /api/v1/asset-class-determinations/{id}
📋 Description: Retrieves the asset class determination for a specified financial entity, providing insights into the organization’s 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 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "accountingStandardId": 0,
25 "accountingStandardDisplayId": "string",
26 "accountingStandardType": "GAAP",
27 "internalAssetClassId": 0,
28 "internalAssetClassDisplayId": "string",
29 "internalAssetClassName": "string",
30 "ownAssetClassId": 0,
31 "ownAssetClassDisplayId": "string",
32 "ownAssetClassName": "string",
33 "rouFinancialAssetClassId": 0,
34 "rouFinancialAssetClassDisplayId": "string",
35 "rouFinancialAssetClassName": "string",
36 "rouOperatingAssetClassId": 0,
37 "rouOperatingAssetClassDisplayId": "string",
38 "rouOperatingAssetClassName": "string",
39 "usefulLifeYears": 0,
40 "usefulLifeMonths": 0,
41 "usefulLifeDays": 0
42 }
43}
Asset Class Determination - Update¶
HTTP Request
PUT /api/v1/asset-class-determinations/{id}
📋 Description: Updates the asset class determination for a specified financial entity within the organizational structure, ensuring accurate classification and hierarchy alignment.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated asset class determination data, including attributes relevant to the organization’s financial structure and hierarchy. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "companyId": 0,
8 "companyDisplayId": "string",
9 "countryDisplayId": "string",
10 "companyName": "string",
11 "accountingStandardId": 0,
12 "accountingStandardDisplayId": "string",
13 "accountingStandardType": "GAAP",
14 "internalAssetClassId": 0,
15 "internalAssetClassDisplayId": "string",
16 "internalAssetClassName": "string",
17 "ownAssetClassId": 0,
18 "ownAssetClassDisplayId": "string",
19 "ownAssetClassName": "string",
20 "rouFinancialAssetClassId": 0,
21 "rouFinancialAssetClassDisplayId": "string",
22 "rouFinancialAssetClassName": "string",
23 "rouOperatingAssetClassId": 0,
24 "rouOperatingAssetClassDisplayId": "string",
25 "rouOperatingAssetClassName": "string",
26 "usefulLifeYears": 0,
27 "usefulLifeMonths": 0,
28 "usefulLifeDays": 0
29}
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "accountingStandardId": 0,
25 "accountingStandardDisplayId": "string",
26 "accountingStandardType": "GAAP",
27 "internalAssetClassId": 0,
28 "internalAssetClassDisplayId": "string",
29 "internalAssetClassName": "string",
30 "ownAssetClassId": 0,
31 "ownAssetClassDisplayId": "string",
32 "ownAssetClassName": "string",
33 "rouFinancialAssetClassId": 0,
34 "rouFinancialAssetClassDisplayId": "string",
35 "rouFinancialAssetClassName": "string",
36 "rouOperatingAssetClassId": 0,
37 "rouOperatingAssetClassDisplayId": "string",
38 "rouOperatingAssetClassName": "string",
39 "usefulLifeYears": 0,
40 "usefulLifeMonths": 0,
41 "usefulLifeDays": 0
42 }
43}
Asset Class Determination - Delete¶
HTTP Request
DELETE /api/v1/asset-class-determinations/{id}
📋 Description: Deletes a specified asset class determination from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.
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}
Asset Class Determination - Delete Or Decommission¶
HTTP Request
PUT /api/v1/asset-class-determinations/remove/{id}
📋 Description: Removes a specified asset class determination from the financial organization structure, ensuring the hierarchy accurately reflects current classifications within the financial entity.
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}
Asset Class Determination - Delete Or Decommission All¶
HTTP Request
PUT /api/v1/asset-class-determinations/remove/bulk
📋 Description: Removes multiple asset class determinations from the financial organization structure, enabling efficient management of the hierarchy within financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of asset class determination identifiers to be removed in bulk from the financial organization’s structure 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}
Asset Class Determination - Decommission¶
HTTP Request
PUT /api/v1/asset-class-determinations/decommission/{id}
📋 Description: Decommissions a specified asset class determination within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures accurate representation and management of organizational assets.
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "accountingStandardId": 0,
25 "accountingStandardDisplayId": "string",
26 "accountingStandardType": "GAAP",
27 "internalAssetClassId": 0,
28 "internalAssetClassDisplayId": "string",
29 "internalAssetClassName": "string",
30 "ownAssetClassId": 0,
31 "ownAssetClassDisplayId": "string",
32 "ownAssetClassName": "string",
33 "rouFinancialAssetClassId": 0,
34 "rouFinancialAssetClassDisplayId": "string",
35 "rouFinancialAssetClassName": "string",
36 "rouOperatingAssetClassId": 0,
37 "rouOperatingAssetClassDisplayId": "string",
38 "rouOperatingAssetClassName": "string",
39 "usefulLifeYears": 0,
40 "usefulLifeMonths": 0,
41 "usefulLifeDays": 0
42 }
43}
Asset Class Determination - Decommission By Modification Date Before¶
HTTP Request
PUT /api/v1/asset-class-determinations/decommission/modified-before/{modified_before}
📋 Description: Updates the decommission status of asset class determinations modified before the specified date, enabling organizations to maintain an accurate financial entity hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
Specifies the cutoff date for decommissioning asset class determinations within the financial organization structure, ensuring that only records modified before this date are processed. |
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "accountingStandardId": 0,
26 "accountingStandardDisplayId": "string",
27 "accountingStandardType": "GAAP",
28 "internalAssetClassId": 0,
29 "internalAssetClassDisplayId": "string",
30 "internalAssetClassName": "string",
31 "ownAssetClassId": 0,
32 "ownAssetClassDisplayId": "string",
33 "ownAssetClassName": "string",
34 "rouFinancialAssetClassId": 0,
35 "rouFinancialAssetClassDisplayId": "string",
36 "rouFinancialAssetClassName": "string",
37 "rouOperatingAssetClassId": 0,
38 "rouOperatingAssetClassDisplayId": "string",
39 "rouOperatingAssetClassName": "string",
40 "usefulLifeYears": 0,
41 "usefulLifeMonths": 0,
42 "usefulLifeDays": 0
43 }
44 ]
45}
Asset Class Determination - Decommission Before Now¶
HTTP Request
PUT /api/v1/asset-class-determinations/decommission/modified-before-now
📋 Description: Updates the status of asset class determinations that were modified before the current date to ‘decommissioned,’ ensuring the financial organization structure remains accurate and up-to-date.
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "accountingStandardId": 0,
26 "accountingStandardDisplayId": "string",
27 "accountingStandardType": "GAAP",
28 "internalAssetClassId": 0,
29 "internalAssetClassDisplayId": "string",
30 "internalAssetClassName": "string",
31 "ownAssetClassId": 0,
32 "ownAssetClassDisplayId": "string",
33 "ownAssetClassName": "string",
34 "rouFinancialAssetClassId": 0,
35 "rouFinancialAssetClassDisplayId": "string",
36 "rouFinancialAssetClassName": "string",
37 "rouOperatingAssetClassId": 0,
38 "rouOperatingAssetClassDisplayId": "string",
39 "rouOperatingAssetClassName": "string",
40 "usefulLifeYears": 0,
41 "usefulLifeMonths": 0,
42 "usefulLifeDays": 0
43 }
44 ]
45}
Asset Class Determination - Decommission All¶
HTTP Request
PUT /api/v1/asset-class-determinations/decommission/bulk
📋 Description: Updates the status of multiple asset class determinations to ‘decommission’ in bulk, facilitating the management of financial organization structures and ensuring accurate hierarchy representation within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a bulk list of asset class determinations for decommissioning, including relevant identifiers and metadata to support organizational financial 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 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "accountingStandardId": 0,
26 "accountingStandardDisplayId": "string",
27 "accountingStandardType": "GAAP",
28 "internalAssetClassId": 0,
29 "internalAssetClassDisplayId": "string",
30 "internalAssetClassName": "string",
31 "ownAssetClassId": 0,
32 "ownAssetClassDisplayId": "string",
33 "ownAssetClassName": "string",
34 "rouFinancialAssetClassId": 0,
35 "rouFinancialAssetClassDisplayId": "string",
36 "rouFinancialAssetClassName": "string",
37 "rouOperatingAssetClassId": 0,
38 "rouOperatingAssetClassDisplayId": "string",
39 "rouOperatingAssetClassName": "string",
40 "usefulLifeYears": 0,
41 "usefulLifeMonths": 0,
42 "usefulLifeDays": 0
43 }
44 ]
45}
Asset Class Determination - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/asset-class-determinations/createOrUpdate/bulk
📋 Description: Creates or updates multiple asset class determinations in bulk for financial entities, ensuring alignment within the organizational structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk asset class determination data, including organizational hierarchy and financial entity attributes for effective structure management. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "countryDisplayId": "string",
11 "companyName": "string",
12 "accountingStandardId": 0,
13 "accountingStandardDisplayId": "string",
14 "accountingStandardType": "GAAP",
15 "internalAssetClassId": 0,
16 "internalAssetClassDisplayId": "string",
17 "internalAssetClassName": "string",
18 "ownAssetClassId": 0,
19 "ownAssetClassDisplayId": "string",
20 "ownAssetClassName": "string",
21 "rouFinancialAssetClassId": 0,
22 "rouFinancialAssetClassDisplayId": "string",
23 "rouFinancialAssetClassName": "string",
24 "rouOperatingAssetClassId": 0,
25 "rouOperatingAssetClassDisplayId": "string",
26 "rouOperatingAssetClassName": "string",
27 "usefulLifeYears": 0,
28 "usefulLifeMonths": 0,
29 "usefulLifeDays": 0
30 }
31]
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "accountingStandardId": 0,
26 "accountingStandardDisplayId": "string",
27 "accountingStandardType": "GAAP",
28 "internalAssetClassId": 0,
29 "internalAssetClassDisplayId": "string",
30 "internalAssetClassName": "string",
31 "ownAssetClassId": 0,
32 "ownAssetClassDisplayId": "string",
33 "ownAssetClassName": "string",
34 "rouFinancialAssetClassId": 0,
35 "rouFinancialAssetClassDisplayId": "string",
36 "rouFinancialAssetClassName": "string",
37 "rouOperatingAssetClassId": 0,
38 "rouOperatingAssetClassDisplayId": "string",
39 "rouOperatingAssetClassName": "string",
40 "usefulLifeYears": 0,
41 "usefulLifeMonths": 0,
42 "usefulLifeDays": 0
43 }
44 ]
45}
Asset Class Determination - Create Or Update¶
HTTP Request
PUT /api/v1/asset-class-determinations/createOrUpdate
📋 Description: Creates or updates asset class determinations within the financial organization structure, ensuring accurate alignment of financial entities within the established hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the asset class determination data, including attributes for organizational structure and hierarchy relevant to the financial entity. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "companyId": 0,
8 "companyDisplayId": "string",
9 "countryDisplayId": "string",
10 "companyName": "string",
11 "accountingStandardId": 0,
12 "accountingStandardDisplayId": "string",
13 "accountingStandardType": "GAAP",
14 "internalAssetClassId": 0,
15 "internalAssetClassDisplayId": "string",
16 "internalAssetClassName": "string",
17 "ownAssetClassId": 0,
18 "ownAssetClassDisplayId": "string",
19 "ownAssetClassName": "string",
20 "rouFinancialAssetClassId": 0,
21 "rouFinancialAssetClassDisplayId": "string",
22 "rouFinancialAssetClassName": "string",
23 "rouOperatingAssetClassId": 0,
24 "rouOperatingAssetClassDisplayId": "string",
25 "rouOperatingAssetClassName": "string",
26 "usefulLifeYears": 0,
27 "usefulLifeMonths": 0,
28 "usefulLifeDays": 0
29}
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "accountingStandardId": 0,
25 "accountingStandardDisplayId": "string",
26 "accountingStandardType": "GAAP",
27 "internalAssetClassId": 0,
28 "internalAssetClassDisplayId": "string",
29 "internalAssetClassName": "string",
30 "ownAssetClassId": 0,
31 "ownAssetClassDisplayId": "string",
32 "ownAssetClassName": "string",
33 "rouFinancialAssetClassId": 0,
34 "rouFinancialAssetClassDisplayId": "string",
35 "rouFinancialAssetClassName": "string",
36 "rouOperatingAssetClassId": 0,
37 "rouOperatingAssetClassDisplayId": "string",
38 "rouOperatingAssetClassName": "string",
39 "usefulLifeYears": 0,
40 "usefulLifeMonths": 0,
41 "usefulLifeDays": 0
42 }
43}
Asset Class Determination - Bulk Update¶
HTTP Request
PUT /api/v1/asset-class-determinations/bulk
📋 Description: Updates multiple asset class determinations in bulk for financial entities, enabling efficient management of organizational structure and hierarchy within the financial organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a bulk set of asset class determination data, including organizational hierarchy details and financial entity attributes for streamlined processing within the financial organization structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "countryDisplayId": "string",
11 "companyName": "string",
12 "accountingStandardId": 0,
13 "accountingStandardDisplayId": "string",
14 "accountingStandardType": "GAAP",
15 "internalAssetClassId": 0,
16 "internalAssetClassDisplayId": "string",
17 "internalAssetClassName": "string",
18 "ownAssetClassId": 0,
19 "ownAssetClassDisplayId": "string",
20 "ownAssetClassName": "string",
21 "rouFinancialAssetClassId": 0,
22 "rouFinancialAssetClassDisplayId": "string",
23 "rouFinancialAssetClassName": "string",
24 "rouOperatingAssetClassId": 0,
25 "rouOperatingAssetClassDisplayId": "string",
26 "rouOperatingAssetClassName": "string",
27 "usefulLifeYears": 0,
28 "usefulLifeMonths": 0,
29 "usefulLifeDays": 0
30 }
31]
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "accountingStandardId": 0,
26 "accountingStandardDisplayId": "string",
27 "accountingStandardType": "GAAP",
28 "internalAssetClassId": 0,
29 "internalAssetClassDisplayId": "string",
30 "internalAssetClassName": "string",
31 "ownAssetClassId": 0,
32 "ownAssetClassDisplayId": "string",
33 "ownAssetClassName": "string",
34 "rouFinancialAssetClassId": 0,
35 "rouFinancialAssetClassDisplayId": "string",
36 "rouFinancialAssetClassName": "string",
37 "rouOperatingAssetClassId": 0,
38 "rouOperatingAssetClassDisplayId": "string",
39 "rouOperatingAssetClassName": "string",
40 "usefulLifeYears": 0,
41 "usefulLifeMonths": 0,
42 "usefulLifeDays": 0
43 }
44 ]
45}
Asset Class Determination - Bulk Create¶
HTTP Request
POST /api/v1/asset-class-determinations/bulk
📋 Description: Submits bulk asset class determinations for financial entities within the organizational structure, enabling efficient classification and hierarchy management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a bulk submission of asset class determination data, including relevant financial entity identifiers and hierarchical structure details. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "countryDisplayId": "string",
11 "companyName": "string",
12 "accountingStandardId": 0,
13 "accountingStandardDisplayId": "string",
14 "accountingStandardType": "GAAP",
15 "internalAssetClassId": 0,
16 "internalAssetClassDisplayId": "string",
17 "internalAssetClassName": "string",
18 "ownAssetClassId": 0,
19 "ownAssetClassDisplayId": "string",
20 "ownAssetClassName": "string",
21 "rouFinancialAssetClassId": 0,
22 "rouFinancialAssetClassDisplayId": "string",
23 "rouFinancialAssetClassName": "string",
24 "rouOperatingAssetClassId": 0,
25 "rouOperatingAssetClassDisplayId": "string",
26 "rouOperatingAssetClassName": "string",
27 "usefulLifeYears": 0,
28 "usefulLifeMonths": 0,
29 "usefulLifeDays": 0
30 }
31]
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "accountingStandardId": 0,
26 "accountingStandardDisplayId": "string",
27 "accountingStandardType": "GAAP",
28 "internalAssetClassId": 0,
29 "internalAssetClassDisplayId": "string",
30 "internalAssetClassName": "string",
31 "ownAssetClassId": 0,
32 "ownAssetClassDisplayId": "string",
33 "ownAssetClassName": "string",
34 "rouFinancialAssetClassId": 0,
35 "rouFinancialAssetClassDisplayId": "string",
36 "rouFinancialAssetClassName": "string",
37 "rouOperatingAssetClassId": 0,
38 "rouOperatingAssetClassDisplayId": "string",
39 "rouOperatingAssetClassName": "string",
40 "usefulLifeYears": 0,
41 "usefulLifeMonths": 0,
42 "usefulLifeDays": 0
43 }
44 ]
45}
Asset Class Determination - Bulk Delete¶
HTTP Request
DELETE /api/v1/asset-class-determinations/bulk
📋 Description: Deletes multiple asset class determinations 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 asset class determination identifiers for bulk deletion within the financial organization 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}
Asset Class Determination - Search¶
HTTP Request
POST /api/v1/asset-class-determinations/search
📋 Description: Submits a request to search for asset class determinations within the financial organization structure, enabling users to identify and analyze the hierarchy and classification 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 asset class determination criteria, including relevant organizational hierarchy and financial entity attributes for effective search operations. |
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 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "erpSystemIdEqual": 0,
24 "erpSystemDisplayIdLike": "string",
25 "companyDisplayIdLike": "string",
26 "internalAssetClassDisplayIdLike": "string",
27 "ownAssetClassDisplayIdLike": "string",
28 "rouFinancialAssetClassDisplayIdLike": "string",
29 "rouOperatingAssetClassDisplayIdLike": "string",
30 "companyIdEqual": 0,
31 "countryDisplayIdLike": "string",
32 "companyNameLike": "string",
33 "accountingStandardIdEqual": 0,
34 "accountingStandardDisplayIdLike": "string",
35 "internalAssetClassIdEqual": 0,
36 "internalAssetClassNameLike": "string",
37 "ownAssetClassIdEqual": 0,
38 "ownAssetClassNameLike": "string",
39 "rouFinancialAssetClassIdEqual": 0,
40 "rouFinancialAssetClassNameLike": "string",
41 "rouOperatingAssetClassIdEqual": 0,
42 "rouOperatingAssetClassNameLike": "string",
43 "usefulLifeYearsLike": "string",
44 "usefulLifeMonthsLike": "string",
45 "usefulLifeDaysLike": "string"
46}
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "countryDisplayId": "string",
28 "companyName": "string",
29 "accountingStandardId": 0,
30 "accountingStandardDisplayId": "string",
31 "accountingStandardType": "GAAP",
32 "internalAssetClassId": 0,
33 "internalAssetClassDisplayId": "string",
34 "internalAssetClassName": "string",
35 "ownAssetClassId": 0,
36 "ownAssetClassDisplayId": "string",
37 "ownAssetClassName": "string",
38 "rouFinancialAssetClassId": 0,
39 "rouFinancialAssetClassDisplayId": "string",
40 "rouFinancialAssetClassName": "string",
41 "rouOperatingAssetClassId": 0,
42 "rouOperatingAssetClassDisplayId": "string",
43 "rouOperatingAssetClassName": "string",
44 "usefulLifeYears": 0,
45 "usefulLifeMonths": 0,
46 "usefulLifeDays": 0
47 }
48 ],
49 "number": 0,
50 "sort": {
51 "unsorted": true,
52 "sorted": true,
53 "empty": true
54 },
55 "first": true,
56 "last": true,
57 "empty": true
58}
Asset Class Determination - Find All¶
HTTP Request
GET /api/v1/asset-class-determinations
📋 Description: Retrieves asset class determinations for financial entities within the organizational structure, enabling users to understand the classification and hierarchy of assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the asset class determinations should be returned in a paginated format, facilitating efficient navigation through large datasets 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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "countryDisplayId": "string",
28 "companyName": "string",
29 "accountingStandardId": 0,
30 "accountingStandardDisplayId": "string",
31 "accountingStandardType": "GAAP",
32 "internalAssetClassId": 0,
33 "internalAssetClassDisplayId": "string",
34 "internalAssetClassName": "string",
35 "ownAssetClassId": 0,
36 "ownAssetClassDisplayId": "string",
37 "ownAssetClassName": "string",
38 "rouFinancialAssetClassId": 0,
39 "rouFinancialAssetClassDisplayId": "string",
40 "rouFinancialAssetClassName": "string",
41 "rouOperatingAssetClassId": 0,
42 "rouOperatingAssetClassDisplayId": "string",
43 "rouOperatingAssetClassName": "string",
44 "usefulLifeYears": 0,
45 "usefulLifeMonths": 0,
46 "usefulLifeDays": 0
47 }
48 ],
49 "number": 0,
50 "sort": {
51 "unsorted": true,
52 "sorted": true,
53 "empty": true
54 },
55 "first": true,
56 "last": true,
57 "empty": true
58}
Asset Class Determination - Create¶
HTTP Request
POST /api/v1/asset-class-determinations
📋 Description: Creates new asset class determinations within the financial organization structure, enabling users to define and categorize financial entities according to their hierarchical relationships.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the asset class determination data, including organizational hierarchy and financial entity attributes essential for structuring financial operations. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "companyId": 0,
8 "companyDisplayId": "string",
9 "countryDisplayId": "string",
10 "companyName": "string",
11 "accountingStandardId": 0,
12 "accountingStandardDisplayId": "string",
13 "accountingStandardType": "GAAP",
14 "internalAssetClassId": 0,
15 "internalAssetClassDisplayId": "string",
16 "internalAssetClassName": "string",
17 "ownAssetClassId": 0,
18 "ownAssetClassDisplayId": "string",
19 "ownAssetClassName": "string",
20 "rouFinancialAssetClassId": 0,
21 "rouFinancialAssetClassDisplayId": "string",
22 "rouFinancialAssetClassName": "string",
23 "rouOperatingAssetClassId": 0,
24 "rouOperatingAssetClassDisplayId": "string",
25 "rouOperatingAssetClassName": "string",
26 "usefulLifeYears": 0,
27 "usefulLifeMonths": 0,
28 "usefulLifeDays": 0
29}
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "accountingStandardId": 0,
25 "accountingStandardDisplayId": "string",
26 "accountingStandardType": "GAAP",
27 "internalAssetClassId": 0,
28 "internalAssetClassDisplayId": "string",
29 "internalAssetClassName": "string",
30 "ownAssetClassId": 0,
31 "ownAssetClassDisplayId": "string",
32 "ownAssetClassName": "string",
33 "rouFinancialAssetClassId": 0,
34 "rouFinancialAssetClassDisplayId": "string",
35 "rouFinancialAssetClassName": "string",
36 "rouOperatingAssetClassId": 0,
37 "rouOperatingAssetClassDisplayId": "string",
38 "rouOperatingAssetClassName": "string",
39 "usefulLifeYears": 0,
40 "usefulLifeMonths": 0,
41 "usefulLifeDays": 0
42 }
43}
Asset Class Determination - Get Metadata¶
HTTP Request
GET /api/v1/asset-class-determinations/meta
📋 Description: Retrieves metadata related to asset class determinations within the financial organization structure, providing insights into the hierarchy and classification of financial entities.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "USEFUL_LIFE_YEARS"
3]