Plant¶
Plant - Get¶
HTTP Request
GET /api/v1/plants/{id}
📋 Description: Retrieves detailed information about a specific financial entity within the organization’s structure and hierarchy, 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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "networkId": 0
24 }
25}
Plant - Update¶
HTTP Request
PUT /api/v1/plants/{id}
📋 Description: Updates the details of a specific financial entity within the organizational structure by modifying the attributes of the plant identified by the provided ID. This operation ensures that the hierarchy remains accurate and reflects any changes in the financial organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated financial entity details, including organizational structure and hierarchy information for the specified plant. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "networkId": 0
11}
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 "name": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "networkId": 0
24 }
25}
Plant - Delete¶
HTTP Request
DELETE /api/v1/plants/{id}
📋 Description: Deletes a specified plant from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective management 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 |
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}
Plant - Delete Or Decommission¶
HTTP Request
PUT /api/v1/plants/remove/{id}
📋 Description: Removes a specified plant from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective management 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 |
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}
Plant - Delete Or Decommission All¶
HTTP Request
PUT /api/v1/plants/remove/bulk
📋 Description: Removes multiple plants from the financial organization structure, facilitating updates to the hierarchy of financial entities within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of plant identifiers to be removed in bulk from the financial organization structure, ensuring efficient management of the entity’s 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}
Plant - Decommission¶
HTTP Request
PUT /api/v1/plants/decommission/{id}
📋 Description: Decommissions a specified financial entity within the organizational structure by updating its status, thereby reflecting changes in the hierarchy. This operation ensures accurate representation of the organization’s financial landscape.
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 "name": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "networkId": 0
24 }
25}
Plant - Decommission By Modification Date Before¶
HTTP Request
PUT /api/v1/plants/decommission/modified-before/{modified_before}
📋 Description: Decommissions financial entities in the organization structure that were modified before the specified date, ensuring the hierarchy remains current and relevant.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
Specifies the cutoff date for decommissioning plants that were modified before the given date, ensuring alignment with the organization’s financial hierarchy and structural integrity. |
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 "name": "string",
22 "companyId": 0,
23 "companyDisplayId": "string",
24 "networkId": 0
25 }
26 ]
27}
Plant - Decommission Before Now¶
HTTP Request
PUT /api/v1/plants/decommission/modified-before-now
📋 Description: Decommissions financial entities in the organization structure that were modified before the current date, ensuring the hierarchy remains up-to-date and compliant with operational standards.
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 "name": "string",
22 "companyId": 0,
23 "companyDisplayId": "string",
24 "networkId": 0
25 }
26 ]
27}
Plant - Decommission All¶
HTTP Request
PUT /api/v1/plants/decommission/bulk
📋 Description: Decommissions multiple financial entities within the organizational structure by updating their status in bulk, ensuring efficient management of the hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of financial entities to be decommissioned in bulk, including their identifiers and relevant metadata for organizational structure updates. |
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 "name": "string",
22 "companyId": 0,
23 "companyDisplayId": "string",
24 "networkId": 0
25 }
26 ]
27}
Plant - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/plants/createOrUpdate/bulk
📋 Description: Updates or creates multiple plant records within the financial organization structure, ensuring that the hierarchy and organization of financial entities are accurately maintained.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating financial entities within the organizational structure, including hierarchical relationships and relevant attributes. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "companyId": 0,
10 "companyDisplayId": "string",
11 "networkId": 0
12 }
13]
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 "name": "string",
22 "companyId": 0,
23 "companyDisplayId": "string",
24 "networkId": 0
25 }
26 ]
27}
Plant - Create Or Update¶
HTTP Request
PUT /api/v1/plants/createOrUpdate
📋 Description: Creates or updates a financial entity within the organizational structure, ensuring that the hierarchy reflects the latest changes in the plant data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity details, including organization structure and hierarchy information, for creating or updating plant records. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "networkId": 0
11}
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 "name": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "networkId": 0
24 }
25}
Plant - Bulk Update¶
HTTP Request
PUT /api/v1/plants/bulk
📋 Description: Updates the financial organization structure by allowing bulk modifications to plant entities, ensuring alignment with the hierarchical framework of the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a bulk update of financial entity plant data, including organizational hierarchy and structure details. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "companyId": 0,
10 "companyDisplayId": "string",
11 "networkId": 0
12 }
13]
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 "name": "string",
22 "companyId": 0,
23 "companyDisplayId": "string",
24 "networkId": 0
25 }
26 ]
27}
Plant - Bulk Create¶
HTTP Request
POST /api/v1/plants/bulk
📋 Description: Submits a bulk upload of plant data to the financial organization structure, enabling efficient management of hierarchical relationships within financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of financial entity data to facilitate the bulk creation of organizational structures and hierarchies. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "companyId": 0,
10 "companyDisplayId": "string",
11 "networkId": 0
12 }
13]
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 "name": "string",
22 "companyId": 0,
23 "companyDisplayId": "string",
24 "networkId": 0
25 }
26 ]
27}
Plant - Bulk Delete¶
HTTP Request
DELETE /api/v1/plants/bulk
📋 Description: Deletes multiple plant records 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 an array of financial entity identifiers for bulk deletion 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}
Plant - Search¶
HTTP Request
POST /api/v1/plants/search
📋 Description: Submits a search query to retrieve financial entities within the organization’s structure and hierarchy, enabling users to efficiently locate specific plants based on defined criteria.
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 entities within the organizational structure, including parameters to refine results based on hierarchy and 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 "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 "companyIdEqual": 0,
31 "companyDisplayIdLike": "string",
32 "networkIdEqual": 0
33}
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 "name": "string",
26 "companyId": 0,
27 "companyDisplayId": "string",
28 "networkId": 0
29 }
30 ],
31 "number": 0,
32 "sort": {
33 "unsorted": true,
34 "sorted": true,
35 "empty": true
36 },
37 "first": true,
38 "last": true,
39 "empty": true
40}
Plant - Detach Company¶
HTTP Request
POST /api/v1/plants/detach/company/{companyId}
📋 Description: Detaches a specified company from its associated financial entity within the organizational structure, facilitating updates to the hierarchy as needed.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
companyId |
path |
integer(int64) |
true |
Unique identifier for the company |
body |
body |
true |
Request body containing the details of the financial entity’s plant attachment to be detached from the specified company, including relevant identifiers and metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "companyId": 0,
10 "companyDisplayId": "string",
11 "networkId": 0
12 }
13]
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}
Plant - Attach Company¶
HTTP Request
POST /api/v1/plants/attach/company/{companyId}
📋 Description: Attaches a specified financial entity to a company within the organizational structure, facilitating the integration of hierarchical relationships in the financial organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
companyId |
path |
integer(int64) |
true |
Unique identifier for the company |
body |
body |
true |
Request body containing the financial entity details required to associate a plant with the specified company’s organizational structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "companyId": 0,
10 "companyDisplayId": "string",
11 "networkId": 0
12 }
13]
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}
Plant - Find All¶
HTTP Request
GET /api/v1/plants
📋 Description: Retrieves a comprehensive list of financial entities within the organization’s structure, reflecting the hierarchical relationships and organizational framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated to facilitate efficient retrieval of 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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "companyId": 0,
27 "companyDisplayId": "string",
28 "networkId": 0
29 }
30 ],
31 "number": 0,
32 "sort": {
33 "unsorted": true,
34 "sorted": true,
35 "empty": true
36 },
37 "first": true,
38 "last": true,
39 "empty": true
40}
Plant - Create¶
HTTP Request
POST /api/v1/plants
📋 Description: Creates a new financial entity within the organization’s structure, enabling the establishment of a hierarchical framework for effective financial management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity details, including organizational structure and hierarchy information necessary for effective management and reporting. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "networkId": 0
11}
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 "name": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "networkId": 0
24 }
25}
Plant - Get Metadata¶
HTTP Request
GET /api/v1/plants/meta
📋 Description: Retrieves metadata related to the financial organization structure, including details on the hierarchy and relationships between financial entities. This operation supports users in understanding and navigating the organizational framework effectively.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "NAME"
3]
Response Schema
Plant - Find All By System ID¶
HTTP Request
GET /api/v1/plants/erp-system/{systemId}
📋 Description: Retrieves the financial organization structure for a specified ERP system, identified by the systemId, providing insights into the hierarchy and relationships of financial entities within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
systemId |
path |
integer(int64) |
true |
Unique identifier for the system |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure associated with the specified ERP system. |
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 "name": "string",
26 "companyId": 0,
27 "companyDisplayId": "string",
28 "networkId": 0
29 }
30 ],
31 "number": 0,
32 "sort": {
33 "unsorted": true,
34 "sorted": true,
35 "empty": true
36 },
37 "first": true,
38 "last": true,
39 "empty": true
40}
Plant - Get All By Company¶
HTTP Request
GET /api/v1/plants/company/{company_id}
📋 Description: Retrieves the hierarchical structure of financial entities associated with a specified company, providing insights into the organization’s financial organization structure.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
company_id |
path |
integer(int64) |
true |
Unique identifier for the financial entity within the organizational structure, used to retrieve specific plant information associated with the designated company. |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure of the specified company. |
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 "name": "string",
26 "companyId": 0,
27 "companyDisplayId": "string",
28 "networkId": 0
29 }
30 ],
31 "number": 0,
32 "sort": {
33 "unsorted": true,
34 "sorted": true,
35 "empty": true
36 },
37 "first": true,
38 "last": true,
39 "empty": true
40}