ERP System Setting

ERP System Setting - Get

HTTP Request

GET /api/v1/sap-posting-bot/spb-system-settings/{id}

Interactive Demo

📋 Description: Fetches the system settings for a specific SAP posting bot identified by the provided ID, facilitating the management of ledger entries and financial records within the General Ledger domain.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseSpbErpSystemSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "systemType": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
    "duplicateConsistencyCheckDefaultReversalReason": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    },
    "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
  }
}

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

ERP System Setting - Update

HTTP Request

PUT /api/v1/sap-posting-bot/spb-system-settings/{id}

Interactive Demo

📋 Description: Updates the system settings for a specified SAP posting bot, allowing for modifications to ledger entry configurations, transaction parameters, and account management to ensure accurate financial record maintenance.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	SpbErpSystemSettingDto	true	Request body containing the updated system settings for the specified posting bot, including parameters related to ledger entries, transactions, accounts, and financial records.

Body Parameters

{
  "id": 0,
  "sapPostBapi": "string",
  "sapReversalBapi": "string",
  "systemType": "NAKISA",
  "sapVersion": "ECC_EHP5",
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
  "duplicateConsistencyCheckDefaultReversalReason": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "name": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  },
  "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseSpbErpSystemSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "systemType": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
    "duplicateConsistencyCheckDefaultReversalReason": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    },
    "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
  }
}

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

ERP System Setting - Delete

HTTP Request

DELETE /api/v1/sap-posting-bot/spb-system-settings/{id}

Interactive Demo

📋 Description: Deletes the specified system settings for the SAP posting bot, ensuring the removal of outdated or unnecessary configurations related to ledger entries and financial records.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

ERP System Setting - Create Or Update

HTTP Request

PUT /api/v1/sap-posting-bot/spb-system-settings/createOrUpdate

Interactive Demo

📋 Description: Updates or creates system settings for the SAP Posting Bot within the General Ledger, ensuring accurate ledger entries and transaction management for financial records.

Parameters

Name	In	Type	Required	Description
body	body	SpbErpSystemSettingDto	true	Request body containing the financial record data necessary for creating or updating ledger entries, including transaction details and account information.

Body Parameters

{
  "id": 0,
  "sapPostBapi": "string",
  "sapReversalBapi": "string",
  "systemType": "NAKISA",
  "sapVersion": "ECC_EHP5",
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
  "duplicateConsistencyCheckDefaultReversalReason": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "name": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  },
  "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseSpbErpSystemSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "systemType": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
    "duplicateConsistencyCheckDefaultReversalReason": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    },
    "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
  }
}

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

ERP System Setting - Create Or Update Bulk

HTTP Request

PUT /api/v1/sap-posting-bot/spb-system-settings/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple system settings for the SAP Posting Bot within the General Ledger, ensuring accurate ledger entries and financial records for transactions and accounts.

Parameters

Name	In	Type	Required	Description
body	body	SpbErpSystemSettingDto	true	Request body containing bulk ledger entry data, including transaction details, account identifiers, and associated financial records for creating or updating system settings.

Body Parameters

[
  {
    "id": 0,
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "systemType": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
    "duplicateConsistencyCheckDefaultReversalReason": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    },
    "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListSpbErpSystemSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "sapPostBapi": "string",
      "sapReversalBapi": "string",
      "systemType": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
      "duplicateConsistencyCheckDefaultReversalReason": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      },
      "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
    }
  ]
}

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

ERP System Setting - Bulk Update

HTTP Request

PUT /api/v1/sap-posting-bot/spb-system-settings/bulk

Interactive Demo

📋 Description: Updates multiple system settings for the SAP Posting Bot in bulk, ensuring accurate configuration of ledger entries and financial records within the General Ledger domain.

Parameters

Name	In	Type	Required	Description
body	body	SpbErpSystemSettingDto	true	Request body containing bulk updates for system settings related to ledger entries, transactions, accounts, and financial records in the General Ledger.

Body Parameters

[
  {
    "id": 0,
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "systemType": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
    "duplicateConsistencyCheckDefaultReversalReason": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    },
    "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListSpbErpSystemSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "sapPostBapi": "string",
      "sapReversalBapi": "string",
      "systemType": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
      "duplicateConsistencyCheckDefaultReversalReason": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      },
      "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
    }
  ]
}

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

ERP System Setting - Bulk Delete

HTTP Request

DELETE /api/v1/sap-posting-bot/spb-system-settings/bulk

Interactive Demo

📋 Description: Deletes multiple system settings for the SAP Posting Bot, ensuring the removal of outdated or unnecessary configurations related to ledger entries, transactions, accounts, and financial records.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of account identifiers and associated transaction details for bulk deletion of financial records in the General Ledger.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

ERP System Setting - Search

HTTP Request

POST /api/v1/sap-posting-bot/spb-system-settings/search

Interactive Demo

📋 Description: Submits a search request for system settings related to ledger entries, transactions, accounts, and financial records within the General Ledger 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	SpbErpSystemSettingDtoFilter	false	Request body containing the search criteria for ledger entries, including transaction details, account identifiers, and relevant financial record parameters.

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",
  "sapPostBapiLike": "string",
  "sapReversalBapiLike": "string",
  "systemTypeIn": [
    "NAKISA"
  ],
  "sapVersionEqual": "ECC_EHP5",
  "sapVersionIn": [
    "ECC_EHP5"
  ],
  "systemIdIn": [
    0
  ],
  "systemIdEqual": 0,
  "systemDisplayIdLike": "string",
  "itemCountThresholdToQueueDuplicateConsistencyTaskLike": "string",
  "duplicateConsistencyCheckDefaultReversalReasonIdIn": [
    0
  ],
  "duplicateConsistencyCheckDefaultReversalReasonDisplayIdIn": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageSpbErpSystemSettingDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "sapPostBapi": "string",
      "sapReversalBapi": "string",
      "systemType": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
      "duplicateConsistencyCheckDefaultReversalReason": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      },
      "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
    }
  ],
  "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 Setting - Find All

HTTP Request

GET /api/v1/sap-posting-bot/spb-system-settings

Interactive Demo

📋 Description: Retrieves the system settings for the SAP Posting Bot, providing essential configurations that govern ledger entries, transactions, and account management within the General Ledger.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the ledger entry retrieval should be paginated, enhancing the management of transaction data within financial records.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageSpbErpSystemSettingDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "sapPostBapi": "string",
      "sapReversalBapi": "string",
      "systemType": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "itemCountThresholdToQueueDuplicateConsistencyTask": 0,
      "duplicateConsistencyCheckDefaultReversalReason": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      },
      "duplicateConsistencyCheckDefaultPostingDate": "2019-08-24"
    }
  ],
  "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

---