ERP System

ERP System - Get

HTTP Request

GET /api/v1/erp-systems/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific financial organization structure by its unique identifier, enabling users to understand the hierarchy and relationships 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	OK	ResponseErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "encryptedPassword": "string",
    "connectionString": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Update

HTTP Request

PUT /api/v1/erp-systems/{id}

Interactive Demo

📋 Description: Updates the financial organization structure of a specified ERP system, allowing for modifications to the hierarchy and attributes of the financial entity identified by the given ID. This operation ensures that the organizational framework remains aligned with business requirements and operational efficiencies.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ErpSystemDto	true	Request body containing the updated financial organization structure data, including hierarchical relationships and attributes of the specified financial entity.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "type": "NAKISA",
  "sapVersion": "ECC_EHP5",
  "encryptedPassword": "string",
  "connectionString": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "encryptedPassword": "string",
    "connectionString": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Delete

HTTP Request

DELETE /api/v1/erp-systems/{id}

Interactive Demo

📋 Description: Deletes a specified ERP system from the financial organization structure, effectively 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

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Delete Or Decommission

HTTP Request

PUT /api/v1/erp-systems/remove/{id}

Interactive Demo

📋 Description: Removes a specified financial entity from the organizational structure, ensuring the hierarchy remains accurate and up-to-date.

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

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Delete Or Decommission All

HTTP Request

PUT /api/v1/erp-systems/remove/bulk

Interactive Demo

📋 Description: Removes multiple financial entities from the organizational structure in a single operation, ensuring efficient management of the hierarchy within the financial organization.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers to be removed in bulk from the organization structure hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Decommission

HTTP Request

PUT /api/v1/erp-systems/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified financial entity within the organizational structure, effectively removing it from the active hierarchy and ensuring compliance with financial governance protocols.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "encryptedPassword": "string",
    "connectionString": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/erp-systems/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions financial entities in the organization structure that were modified before the specified date, ensuring the hierarchy remains current and aligned with business objectives.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning financial entities in the organization’s structure, ensuring that only those modified before this date are processed.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "encryptedPassword": "string",
      "connectionString": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Decommission Before Now

HTTP Request

PUT /api/v1/erp-systems/decommission/modified-before-now

Interactive Demo

📋 Description: Updates the status of financial entities within the organizational hierarchy, decommissioning those modified before the current date. This operation ensures the integrity and relevance of the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "encryptedPassword": "string",
      "connectionString": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Decommission All

HTTP Request

PUT /api/v1/erp-systems/decommission/bulk

Interactive Demo

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

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 to facilitate the bulk removal of organization structures within the financial hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "encryptedPassword": "string",
      "connectionString": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Create Or Update Bulk

HTTP Request

PUT /api/v1/erp-systems/createOrUpdate/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	ErpSystemDto	true	Request body containing bulk data for creating or updating financial organization structures, including details on hierarchy and entity relationships.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "encryptedPassword": "string",
    "connectionString": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "encryptedPassword": "string",
      "connectionString": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Create Or Update

HTTP Request

PUT /api/v1/erp-systems/createOrUpdate

Interactive Demo

📋 Description: Updates or creates a financial organization structure within the ERP system, allowing for the effective management of organizational hierarchies and entities. This operation ensures that the financial entity’s structure is accurately reflected and maintained.

Parameters

Name	In	Type	Required	Description
body	body	ErpSystemDto	true	Request body containing the financial organization structure data, including details for creating or updating the hierarchy of financial entities.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "type": "NAKISA",
  "sapVersion": "ECC_EHP5",
  "encryptedPassword": "string",
  "connectionString": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "encryptedPassword": "string",
    "connectionString": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Bulk Update

HTTP Request

PUT /api/v1/erp-systems/bulk

Interactive Demo

📋 Description: Updates the financial organization structure in bulk, allowing for the efficient modification of multiple financial entities’ hierarchies and relationships within the system.

Parameters

Name	In	Type	Required	Description
body	body	ErpSystemDto	true	Request body containing a bulk update of financial organization structure data, including hierarchical relationships and attributes of financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "encryptedPassword": "string",
    "connectionString": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "encryptedPassword": "string",
      "connectionString": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Bulk Create

HTTP Request

POST /api/v1/erp-systems/bulk

Interactive Demo

📋 Description: Submits a bulk upload of financial organization structures, enabling the efficient creation or update of multiple financial entities and their hierarchical relationships within the system.

Parameters

Name	In	Type	Required	Description
body	body	ErpSystemDto	true	Request body containing a structured array of financial entity data, including organization hierarchy and structural details for bulk processing within the ERP system.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "encryptedPassword": "string",
    "connectionString": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "encryptedPassword": "string",
      "connectionString": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Bulk Delete

HTTP Request

DELETE /api/v1/erp-systems/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers to be deleted from the organization structure hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Search

HTTP Request

POST /api/v1/erp-systems/search

Interactive Demo

📋 Description: Submits a request to search for financial organization structures, allowing users to retrieve specific hierarchies and entities within the financial domain.

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	ErpSystemDtoFilter	false	Request body containing the financial organization structure data, including details on hierarchy and relationships among financial entities.

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

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string",
  "typeIn": [
    "NAKISA"
  ],
  "typeNotEqual": "NAKISA",
  "sapVersionEqual": "ECC_EHP5",
  "sapVersionIn": [
    "ECC_EHP5"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageErpSystemDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "encryptedPassword": "string",
      "connectionString": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Find All

HTTP Request

GET /api/v1/erp-systems

Interactive Demo

📋 Description: Retrieves a comprehensive list of ERP systems within the financial organization structure, providing insights into the organizational hierarchy and 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 large sets of hierarchical data.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageErpSystemDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "encryptedPassword": "string",
      "connectionString": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Create

HTTP Request

POST /api/v1/erp-systems

Interactive Demo

📋 Description: Creates a new financial organization structure within the ERP system, enabling the establishment of hierarchical relationships and organizational units essential for effective financial management.

Parameters

Name	In	Type	Required	Description
body	body	ErpSystemDto	true	Request body containing the organizational structure data for a financial entity, including hierarchy details and relevant attributes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "type": "NAKISA",
  "sapVersion": "ECC_EHP5",
  "encryptedPassword": "string",
  "connectionString": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseErpSystemDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "encryptedPassword": "string",
    "connectionString": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Test Connection

HTTP Request

GET /api/v1/erp-systems/test-connection/{erpSystemId}

Interactive Demo

📋 Description: Tests the connection to a specified ERP system by its ID, ensuring the integrity and accessibility of the financial organization structure within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
erpSystemId	path	integer(int64)	true	Unique identifier for the erp system

Responses

Status	Meaning	Description	Schema
200	OK	OK	boolean

Example Responses

true

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Get Metadata

HTTP Request

GET /api/v1/erp-systems/meta

Interactive Demo

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

ERP System - Get Definition

HTTP Request

GET /api/v1/erp-systems/definition

Interactive Demo

📋 Description: Retrieves the definition of the financial organization structure, including details on the hierarchy and relationships of financial entities within the system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

Example Responses

"PARTNER_ROLE_DTO"

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---