General Setting¶
General Setting - Get¶
HTTP Request
GET /api/v1/sap-posting-bot/spb-general-settings/{id}
📋 Description: Retrieves the general settings for a specific ledger entry identified by the provided ID, facilitating the management of transaction-related configurations within the General Ledger.
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 "sapPostBapi": "string",
17 "sapReversalBapi": "string",
18 "systemType": "NAKISA",
19 "sapVersion": "ECC_EHP5"
20 }
21}
General Setting - Update¶
HTTP Request
PUT /api/v1/sap-posting-bot/spb-general-settings/{id}
📋 Description: Updates the general settings for a specified ledger entry in the financial records, allowing for adjustments to transaction parameters and account configurations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the general settings data for the specified ledger entry, including transaction parameters and account configurations essential for maintaining accurate financial records. |
Body Parameters
1{
2 "id": 0,
3 "sapPostBapi": "string",
4 "sapReversalBapi": "string",
5 "systemType": "NAKISA",
6 "sapVersion": "ECC_EHP5"
7}
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 "sapPostBapi": "string",
17 "sapReversalBapi": "string",
18 "systemType": "NAKISA",
19 "sapVersion": "ECC_EHP5"
20 }
21}
General Setting - Create Or Update¶
HTTP Request
PUT /api/v1/sap-posting-bot/spb-general-settings/createOrUpdate
📋 Description: Updates or creates general settings for the SAP posting bot within the General Ledger domain, ensuring accurate ledger entries and financial records for transactions and accounts.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the general settings data for ledger entries, including transaction parameters and account details necessary for updating or creating financial records. |
Body Parameters
1{
2 "id": 0,
3 "sapPostBapi": "string",
4 "sapReversalBapi": "string",
5 "systemType": "NAKISA",
6 "sapVersion": "ECC_EHP5"
7}
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 "sapPostBapi": "string",
17 "sapReversalBapi": "string",
18 "systemType": "NAKISA",
19 "sapVersion": "ECC_EHP5"
20 }
21}
General Setting - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/sap-posting-bot/spb-general-settings/createOrUpdate/bulk
📋 Description: Updates or creates multiple general ledger settings in bulk, ensuring efficient management of ledger entries, transactions, accounts, and financial records within the SAP Posting Bot framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk ledger entry data for creating or updating general settings related to transactions and financial records. |
Body Parameters
1[
2 {
3 "id": 0,
4 "sapPostBapi": "string",
5 "sapReversalBapi": "string",
6 "systemType": "NAKISA",
7 "sapVersion": "ECC_EHP5"
8 }
9]
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 "sapPostBapi": "string",
18 "sapReversalBapi": "string",
19 "systemType": "NAKISA",
20 "sapVersion": "ECC_EHP5"
21 }
22 ]
23}
General Setting - Bulk Update¶
HTTP Request
PUT /api/v1/sap-posting-bot/spb-general-settings/bulk
📋 Description: Updates multiple general settings for the SAP posting bot in bulk, facilitating efficient management of ledger entries and enhancing the accuracy of financial records associated with transactions and accounts.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk updates for general ledger settings, including transaction parameters and account configurations essential for accurate financial record management. |
Body Parameters
1[
2 {
3 "id": 0,
4 "sapPostBapi": "string",
5 "sapReversalBapi": "string",
6 "systemType": "NAKISA",
7 "sapVersion": "ECC_EHP5"
8 }
9]
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 "sapPostBapi": "string",
18 "sapReversalBapi": "string",
19 "systemType": "NAKISA",
20 "sapVersion": "ECC_EHP5"
21 }
22 ]
23}
General Setting - Search¶
HTTP Request
POST /api/v1/sap-posting-bot/spb-general-settings/search
📋 Description: Submits a search request for general settings related to ledger entries, transactions, accounts, and financial records within the General Ledger domain. This operation facilitates the retrieval of specific configuration details to enhance financial data management.
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 search criteria for general ledger settings, including parameters related to ledger entries, transactions, accounts, and financial records. |
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 "sapPostBapiLike": "string",
16 "sapReversalBapiLike": "string",
17 "systemTypeIn": [
18 "NAKISA"
19 ],
20 "sapVersionEqual": "ECC_EHP5",
21 "sapVersionIn": [
22 "ECC_EHP5"
23 ]
24}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
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 "sapPostBapi": "string",
22 "sapReversalBapi": "string",
23 "systemType": "NAKISA",
24 "sapVersion": "ECC_EHP5"
25 }
26 ],
27 "number": 0,
28 "sort": {
29 "unsorted": true,
30 "sorted": true,
31 "empty": true
32 },
33 "first": true,
34 "last": true,
35 "empty": true
36}
General Setting - Find All¶
HTTP Request
GET /api/v1/sap-posting-bot/spb-general-settings
📋 Description: Retrieves the general settings for the SAP posting bot, providing essential configurations that govern ledger entries and transactions within the General Ledger.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the ledger entry retrieval should be paginated, facilitating efficient access to financial records and transactions. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
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 "sapPostBapi": "string",
22 "sapReversalBapi": "string",
23 "systemType": "NAKISA",
24 "sapVersion": "ECC_EHP5"
25 }
26 ],
27 "number": 0,
28 "sort": {
29 "unsorted": true,
30 "sorted": true,
31 "empty": true
32 },
33 "first": true,
34 "last": true,
35 "empty": true
36}