Network

Get A Resource By ID

HTTP Request

GET /api/v1/networks/{id}

📋 Description: Retrieves detailed information about a specific financial entity’s network structure by its unique identifier, facilitating insights into the organization’s hierarchy and relationships.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNetworkDto

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    "name": "string",
21    "plantId": 0,
22    "plantDisplayId": "string"
23  }
24}

Update A Resource

HTTP Request

PUT /api/v1/networks/{id}

📋 Description: Updates the details of a specific financial organization network identified by its unique ID, allowing for modifications to the structure and hierarchy of financial entities within the organization.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

NetworkDto

true

Request body containing updated financial organization structure details, including hierarchy adjustments and relevant metadata for the specified financial entity.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "plantId": 0,
 9  "plantDisplayId": "string"
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNetworkDto

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    "name": "string",
21    "plantId": 0,
22    "plantDisplayId": "string"
23  }
24}

Delete

HTTP Request

DELETE /api/v1/networks/{id}

📋 Description: Deletes a specified network within the financial organization structure, thereby removing it from the hierarchy of financial entities.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

Delete Or Decommission

HTTP Request

PUT /api/v1/networks/remove/{id}

📋 Description: Removes a specified network from the financial organization structure, ensuring the hierarchy reflects the current organizational needs and maintains accurate representation of financial entities.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

Delete Or Decommission All

HTTP Request

PUT /api/v1/networks/remove/bulk

📋 Description: Removes multiple networks from the financial organization structure in a single operation, streamlining the management of organizational hierarchies within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of financial entity identifiers for bulk removal from the organizational structure hierarchy.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

Decommission

HTTP Request

PUT /api/v1/networks/decommission/{id}

📋 Description: Decommissions a specified network within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or redundant networks are properly managed and maintained within the 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

OK

ResponseNetworkDto

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    "name": "string",
21    "plantId": 0,
22    "plantDisplayId": "string"
23  }
24}

Decommission By Modification Date Before

HTTP Request

PUT /api/v1/networks/decommission/modified-before/{modified_before}

📋 Description: Decommissions financial entities within the organization structure that have been modified before the specified date, ensuring the hierarchy remains up-to-date and aligned with current business needs.

Parameters

Name

In

Type

Required

Description

modified_before

path

string(date-time)

true

Specifies the cutoff date for decommissioning networks in the financial organization structure, allowing users to target modifications made before this date.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNetworkDto

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      "name": "string",
22      "plantId": 0,
23      "plantDisplayId": "string"
24    }
25  ]
26}

Decommission Before Now

HTTP Request

PUT /api/v1/networks/decommission/modified-before-now

📋 Description: Decommissions financial networks that were modified before the current date, ensuring the organization’s structure remains up-to-date and aligned with operational requirements.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNetworkDto

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      "name": "string",
22      "plantId": 0,
23      "plantDisplayId": "string"
24    }
25  ]
26}

Decommission All

HTTP Request

PUT /api/v1/networks/decommission/bulk

📋 Description: Decommissions multiple financial entities within the organization’s structure in a single request, streamlining the management of the financial hierarchy.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of financial entity identifiers and their corresponding decommissioning details for bulk processing within the organizational structure.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNetworkDto

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      "name": "string",
22      "plantId": 0,
23      "plantDisplayId": "string"
24    }
25  ]
26}

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/networks/createOrUpdate/bulk

📋 Description: Updates or creates multiple financial organization structures in bulk, allowing for efficient management of hierarchies and relationships within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

NetworkDto

true

Request body containing a bulk array of financial entity network structures, including organization hierarchy details for creation or update.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "plantId": 0,
10    "plantDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNetworkDto

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      "name": "string",
22      "plantId": 0,
23      "plantDisplayId": "string"
24    }
25  ]
26}

Create Or Update A Resource

HTTP Request

PUT /api/v1/networks/createOrUpdate

📋 Description: Updates or creates a network within the financial organization structure, allowing for the efficient management of organizational hierarchies and relationships among financial entities.

Parameters

Name

In

Type

Required

Description

body

body

NetworkDto

true

Request body containing the financial organization structure data, including details for creating or updating the hierarchy of financial entities.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "plantId": 0,
 9  "plantDisplayId": "string"
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNetworkDto

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    "name": "string",
21    "plantId": 0,
22    "plantDisplayId": "string"
23  }
24}

Bulk-Update Resources

HTTP Request

PUT /api/v1/networks/bulk

📋 Description: Updates the financial organization structure by allowing bulk modifications to network configurations, ensuring alignment with the hierarchical requirements of financial entities.

Parameters

Name

In

Type

Required

Description

body

body

NetworkDto

true

Request body containing a bulk update of financial organization structure data, including hierarchical relationships and attributes of financial entities.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "plantId": 0,
10    "plantDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNetworkDto

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      "name": "string",
22      "plantId": 0,
23      "plantDisplayId": "string"
24    }
25  ]
26}

Bulk Create

HTTP Request

POST /api/v1/networks/bulk

📋 Description: Creates multiple financial organization structures in bulk, allowing for efficient management of hierarchies and relationships within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

NetworkDto

true

Request body containing a bulk upload of financial organization structure data, including hierarchical relationships and attributes of financial entities.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "plantId": 0,
10    "plantDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNetworkDto

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      "name": "string",
22      "plantId": 0,
23      "plantDisplayId": "string"
24    }
25  ]
26}

Bulk Delete

HTTP Request

DELETE /api/v1/networks/bulk

📋 Description: Deletes multiple network entries within the financial organization structure, allowing for efficient management of organizational hierarchies and entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of financial entity identifiers for bulk deletion within the organization’s hierarchical structure.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

Search Resources

HTTP Request

POST /api/v1/networks/search

📋 Description: Submits a search request to identify financial entities within the organizational structure, allowing users to explore the hierarchy and relationships of various networks.

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

NetworkDtoFilter

false

Request body containing search criteria and filters for identifying financial entities within the organizational structure and hierarchy.

Default Values

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

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  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "uiSelector": "string",
29  "nameLike": "string",
30  "plantIdEqual": 0,
31  "plantDisplayIdLike": "string"
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNetworkDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": 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      "name": "string",
26      "plantId": 0,
27      "plantDisplayId": "string"
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Detach Plant

HTTP Request

POST /api/v1/networks/detach/plant/{plantId}

📋 Description: Detaches a specified plant from the financial organization structure, facilitating updates to the hierarchy and ensuring accurate representation of the financial entity’s operational framework.

Parameters

Name

In

Type

Required

Description

plantId

path

integer(int64)

true

Unique identifier for the plant

body

body

NetworkDto

true

Request body containing the financial entity details required to detach a specified plant from the organizational structure, including relevant identifiers and hierarchy information.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "plantId": 0,
10    "plantDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

Attach Plant

HTTP Request

POST /api/v1/networks/attach/plant/{plantId}

📋 Description: Attaches a specified plant to the financial organization structure, enabling hierarchical integration within the entity’s operational framework.

Parameters

Name

In

Type

Required

Description

plantId

path

integer(int64)

true

Unique identifier for the plant

body

body

NetworkDto

true

Request body containing the financial entity attachment data, including organizational hierarchy details and associated metadata for the specified plant.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "plantId": 0,
10    "plantDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

List All Resources

HTTP Request

GET /api/v1/networks

📋 Description: Retrieves the hierarchical structure of financial organizations, providing insights into the organization and relationships between various financial entities.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the financial organization structure query should be returned in a paginated format, facilitating efficient navigation through hierarchical data.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNetworkDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": 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      "name": "string",
26      "plantId": 0,
27      "plantDisplayId": "string"
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Create

HTTP Request

POST /api/v1/networks

📋 Description: Creates a new financial organization network, establishing the hierarchical structure necessary for managing financial entities within the organization.

Parameters

Name

In

Type

Required

Description

body

body

NetworkDto

true

Request body containing the hierarchical structure data of a financial organization, including details on entities and their relationships.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "plantId": 0,
 9  "plantDisplayId": "string"
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNetworkDto

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    "name": "string",
21    "plantId": 0,
22    "plantDisplayId": "string"
23  }
24}

Get Metadata

HTTP Request

GET /api/v1/networks/meta

📋 Description: Retrieves metadata related to the financial organization structure, including details about the hierarchy and relationships between financial entities.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "NAME"
3]

Response Schema

Find All By System ID

HTTP Request

GET /api/v1/networks/erp-system/{systemId}

📋 Description: Retrieves the details of a specific ERP system within the financial organization structure, identified by the provided system ID, to facilitate understanding of the organization’s hierarchy and financial entity relationships.

Parameters

Name

In

Type

Required

Description

systemId

path

integer(int64)

true

Unique identifier for the system

pageable

query

Pageable

true

Indicates whether the response should be paginated, facilitating efficient retrieval of financial organization structure data for the specified ERP system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNetworkDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": 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      "name": "string",
26      "plantId": 0,
27      "plantDisplayId": "string"
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}