Posting Job Task

Posting Job Task - Get

HTTP Request

GET /api/v1/sap-posting-bot/posting/tasks/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific ledger entry transaction by its unique identifier, facilitating access to financial records associated with 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	OK	ResponsePostingJobTaskDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "interruptedAt": "2019-08-24T14:15:22Z",
    "recoveredAt": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "recover": true,
    "interrupted": true,
    "interruptionMessage": "string",
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "ledgerTransactionIds": [
      0
    ],
    "postingTypes": [
      "PAYMENT"
    ],
    "jobPostingStatuses": [
      "NA"
    ],
    "totalPostingCount": 0,
    "jobExecutionDateTime": "2019-08-24T14:15:22Z",
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "failedTransactionIds": [
      0
    ],
    "jobTaskReports": [
      {
        "id": 0,
        "postingType": "PAYMENT",
        "scheduledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "processingItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "doneItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "failedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "cancelledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "skippedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "totalItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "jobTaskId": 0
      }
    ],
    "jobTaskFailureReports": [
      {
        "id": 0,
        "detail1": "string",
        "detail2": "string",
        "systemId": 0,
        "systemDisplayId": "string",
        "jobId": 0,
        "internalDocumentNumber": "string",
        "postingType": "PAYMENT",
        "ledgerTransactionId": 0,
        "failureReason": "string",
        "taskId": 0
      }
    ],
    "jobId": 0
  }
}

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

Posting Job Task - Update

HTTP Request

PUT /api/v1/sap-posting-bot/posting/tasks/{id}

Interactive Demo

📋 Description: Updates the specified ledger entry task in the General Ledger system, allowing for modifications to transaction details and associated financial records.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PostingJobTaskDto	true	Request body containing the updated ledger entry data, including transaction details, account information, and financial record attributes for the specified task.

Body Parameters

{
  "id": 0,
  "queueTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "interruptedAt": "2019-08-24T14:15:22Z",
  "recoveredAt": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "recover": true,
  "interrupted": true,
  "interruptionMessage": "string",
  "errorMessage": "string",
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "ledgerTransactionIds": [
    0
  ],
  "postingTypes": [
    "PAYMENT"
  ],
  "jobPostingStatuses": [
    "NA"
  ],
  "totalPostingCount": 0,
  "jobExecutionDateTime": "2019-08-24T14:15:22Z",
  "sapPostBapi": "string",
  "sapReversalBapi": "string",
  "failedTransactionIds": [
    0
  ],
  "jobTaskReports": [
    {
      "id": 0,
      "postingType": "PAYMENT",
      "scheduledItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "processingItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "doneItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "failedItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "cancelledItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "skippedItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "totalItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "jobTaskId": 0
    }
  ],
  "jobTaskFailureReports": [
    {
      "id": 0,
      "detail1": "string",
      "detail2": "string",
      "systemId": 0,
      "systemDisplayId": "string",
      "jobId": 0,
      "internalDocumentNumber": "string",
      "postingType": "PAYMENT",
      "ledgerTransactionId": 0,
      "failureReason": "string",
      "taskId": 0
    }
  ],
  "jobId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingJobTaskDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "interruptedAt": "2019-08-24T14:15:22Z",
    "recoveredAt": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "recover": true,
    "interrupted": true,
    "interruptionMessage": "string",
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "ledgerTransactionIds": [
      0
    ],
    "postingTypes": [
      "PAYMENT"
    ],
    "jobPostingStatuses": [
      "NA"
    ],
    "totalPostingCount": 0,
    "jobExecutionDateTime": "2019-08-24T14:15:22Z",
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "failedTransactionIds": [
      0
    ],
    "jobTaskReports": [
      {
        "id": 0,
        "postingType": "PAYMENT",
        "scheduledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "processingItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "doneItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "failedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "cancelledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "skippedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "totalItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "jobTaskId": 0
      }
    ],
    "jobTaskFailureReports": [
      {
        "id": 0,
        "detail1": "string",
        "detail2": "string",
        "systemId": 0,
        "systemDisplayId": "string",
        "jobId": 0,
        "internalDocumentNumber": "string",
        "postingType": "PAYMENT",
        "ledgerTransactionId": 0,
        "failureReason": "string",
        "taskId": 0
      }
    ],
    "jobId": 0
  }
}

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

Posting Job Task - Create Or Update

HTTP Request

PUT /api/v1/sap-posting-bot/posting/tasks/createOrUpdate

Interactive Demo

📋 Description: Creates or updates ledger entries in the General Ledger by processing transaction details and associated accounts, ensuring accurate financial records are maintained.

Parameters

Name	In	Type	Required	Description
body	body	PostingJobTaskDto	true	Request body containing the ledger entry data, including transaction details, account information, and relevant financial record attributes for creating or updating posting tasks.

Body Parameters

{
  "id": 0,
  "queueTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "interruptedAt": "2019-08-24T14:15:22Z",
  "recoveredAt": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "recover": true,
  "interrupted": true,
  "interruptionMessage": "string",
  "errorMessage": "string",
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "ledgerTransactionIds": [
    0
  ],
  "postingTypes": [
    "PAYMENT"
  ],
  "jobPostingStatuses": [
    "NA"
  ],
  "totalPostingCount": 0,
  "jobExecutionDateTime": "2019-08-24T14:15:22Z",
  "sapPostBapi": "string",
  "sapReversalBapi": "string",
  "failedTransactionIds": [
    0
  ],
  "jobTaskReports": [
    {
      "id": 0,
      "postingType": "PAYMENT",
      "scheduledItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "processingItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "doneItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "failedItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "cancelledItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "skippedItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "totalItemCount": {
        "postCount": 0,
        "reverseCount": 0
      },
      "jobTaskId": 0
    }
  ],
  "jobTaskFailureReports": [
    {
      "id": 0,
      "detail1": "string",
      "detail2": "string",
      "systemId": 0,
      "systemDisplayId": "string",
      "jobId": 0,
      "internalDocumentNumber": "string",
      "postingType": "PAYMENT",
      "ledgerTransactionId": 0,
      "failureReason": "string",
      "taskId": 0
    }
  ],
  "jobId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingJobTaskDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "interruptedAt": "2019-08-24T14:15:22Z",
    "recoveredAt": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "recover": true,
    "interrupted": true,
    "interruptionMessage": "string",
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "ledgerTransactionIds": [
      0
    ],
    "postingTypes": [
      "PAYMENT"
    ],
    "jobPostingStatuses": [
      "NA"
    ],
    "totalPostingCount": 0,
    "jobExecutionDateTime": "2019-08-24T14:15:22Z",
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "failedTransactionIds": [
      0
    ],
    "jobTaskReports": [
      {
        "id": 0,
        "postingType": "PAYMENT",
        "scheduledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "processingItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "doneItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "failedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "cancelledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "skippedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "totalItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "jobTaskId": 0
      }
    ],
    "jobTaskFailureReports": [
      {
        "id": 0,
        "detail1": "string",
        "detail2": "string",
        "systemId": 0,
        "systemDisplayId": "string",
        "jobId": 0,
        "internalDocumentNumber": "string",
        "postingType": "PAYMENT",
        "ledgerTransactionId": 0,
        "failureReason": "string",
        "taskId": 0
      }
    ],
    "jobId": 0
  }
}

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

Posting Job Task - Create Or Update Bulk

HTTP Request

PUT /api/v1/sap-posting-bot/posting/tasks/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple ledger entries in bulk, facilitating efficient management of financial records and transactions within the General Ledger.

Parameters

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

Body Parameters

[
  {
    "id": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "interruptedAt": "2019-08-24T14:15:22Z",
    "recoveredAt": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "recover": true,
    "interrupted": true,
    "interruptionMessage": "string",
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "ledgerTransactionIds": [
      0
    ],
    "postingTypes": [
      "PAYMENT"
    ],
    "jobPostingStatuses": [
      "NA"
    ],
    "totalPostingCount": 0,
    "jobExecutionDateTime": "2019-08-24T14:15:22Z",
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "failedTransactionIds": [
      0
    ],
    "jobTaskReports": [
      {
        "id": 0,
        "postingType": "PAYMENT",
        "scheduledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "processingItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "doneItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "failedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "cancelledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "skippedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "totalItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "jobTaskId": 0
      }
    ],
    "jobTaskFailureReports": [
      {
        "id": 0,
        "detail1": "string",
        "detail2": "string",
        "systemId": 0,
        "systemDisplayId": "string",
        "jobId": 0,
        "internalDocumentNumber": "string",
        "postingType": "PAYMENT",
        "ledgerTransactionId": 0,
        "failureReason": "string",
        "taskId": 0
      }
    ],
    "jobId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingJobTaskDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "recoveredAt": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "recover": true,
      "interrupted": true,
      "interruptionMessage": "string",
      "errorMessage": "string",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "ledgerTransactionIds": [
        0
      ],
      "postingTypes": [
        "PAYMENT"
      ],
      "jobPostingStatuses": [
        "NA"
      ],
      "totalPostingCount": 0,
      "jobExecutionDateTime": "2019-08-24T14:15:22Z",
      "sapPostBapi": "string",
      "sapReversalBapi": "string",
      "failedTransactionIds": [
        0
      ],
      "jobTaskReports": [
        {
          "id": 0,
          "postingType": "PAYMENT",
          "scheduledItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "processingItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "doneItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "failedItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "cancelledItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "skippedItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "totalItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "jobTaskId": 0
        }
      ],
      "jobTaskFailureReports": [
        {
          "id": 0,
          "detail1": "string",
          "detail2": "string",
          "systemId": 0,
          "systemDisplayId": "string",
          "jobId": 0,
          "internalDocumentNumber": "string",
          "postingType": "PAYMENT",
          "ledgerTransactionId": 0,
          "failureReason": "string",
          "taskId": 0
        }
      ],
      "jobId": 0
    }
  ]
}

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

Posting Job Task - Bulk Update

HTTP Request

PUT /api/v1/sap-posting-bot/posting/tasks/bulk

Interactive Demo

📋 Description: Updates multiple ledger entries in bulk for financial transactions, ensuring accurate and efficient management of account records within the General Ledger.

Parameters

Name	In	Type	Required	Description
body	body	PostingJobTaskDto	true	Request body containing bulk ledger entry data, including transaction details, account information, and associated financial records for processing in the General Ledger.

Body Parameters

[
  {
    "id": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "interruptedAt": "2019-08-24T14:15:22Z",
    "recoveredAt": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "recover": true,
    "interrupted": true,
    "interruptionMessage": "string",
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "ledgerTransactionIds": [
      0
    ],
    "postingTypes": [
      "PAYMENT"
    ],
    "jobPostingStatuses": [
      "NA"
    ],
    "totalPostingCount": 0,
    "jobExecutionDateTime": "2019-08-24T14:15:22Z",
    "sapPostBapi": "string",
    "sapReversalBapi": "string",
    "failedTransactionIds": [
      0
    ],
    "jobTaskReports": [
      {
        "id": 0,
        "postingType": "PAYMENT",
        "scheduledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "processingItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "doneItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "failedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "cancelledItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "skippedItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "totalItemCount": {
          "postCount": 0,
          "reverseCount": 0
        },
        "jobTaskId": 0
      }
    ],
    "jobTaskFailureReports": [
      {
        "id": 0,
        "detail1": "string",
        "detail2": "string",
        "systemId": 0,
        "systemDisplayId": "string",
        "jobId": 0,
        "internalDocumentNumber": "string",
        "postingType": "PAYMENT",
        "ledgerTransactionId": 0,
        "failureReason": "string",
        "taskId": 0
      }
    ],
    "jobId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingJobTaskDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "recoveredAt": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "recover": true,
      "interrupted": true,
      "interruptionMessage": "string",
      "errorMessage": "string",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "ledgerTransactionIds": [
        0
      ],
      "postingTypes": [
        "PAYMENT"
      ],
      "jobPostingStatuses": [
        "NA"
      ],
      "totalPostingCount": 0,
      "jobExecutionDateTime": "2019-08-24T14:15:22Z",
      "sapPostBapi": "string",
      "sapReversalBapi": "string",
      "failedTransactionIds": [
        0
      ],
      "jobTaskReports": [
        {
          "id": 0,
          "postingType": "PAYMENT",
          "scheduledItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "processingItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "doneItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "failedItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "cancelledItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "skippedItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "totalItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "jobTaskId": 0
        }
      ],
      "jobTaskFailureReports": [
        {
          "id": 0,
          "detail1": "string",
          "detail2": "string",
          "systemId": 0,
          "systemDisplayId": "string",
          "jobId": 0,
          "internalDocumentNumber": "string",
          "postingType": "PAYMENT",
          "ledgerTransactionId": 0,
          "failureReason": "string",
          "taskId": 0
        }
      ],
      "jobId": 0
    }
  ]
}

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

Posting Job Task - Search

HTTP Request

POST /api/v1/sap-posting-bot/posting/tasks/search

Interactive Demo

📋 Description: Submits a request to search for ledger entries and financial records related to specific transactions and accounts, facilitating efficient retrieval of relevant posting tasks.

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	PostingJobTaskDtoFilter	false	Request body containing search criteria and filters for locating specific ledger entries and financial records related to transactions and accounts.

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",
  "queueTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "queueTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
  "startTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "startTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
  "endTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "endTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
  "statusIn": [
    "CREATED"
  ],
  "statusEqual": "CREATED",
  "systemIdEqual": 0,
  "systemDisplayIdLike": "string",
  "jobIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingJobTaskDto

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,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "recoveredAt": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "recover": true,
      "interrupted": true,
      "interruptionMessage": "string",
      "errorMessage": "string",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "ledgerTransactionIds": [
        0
      ],
      "postingTypes": [
        "PAYMENT"
      ],
      "jobPostingStatuses": [
        "NA"
      ],
      "totalPostingCount": 0,
      "jobExecutionDateTime": "2019-08-24T14:15:22Z",
      "sapPostBapi": "string",
      "sapReversalBapi": "string",
      "failedTransactionIds": [
        0
      ],
      "jobTaskReports": [
        {
          "id": 0,
          "postingType": "PAYMENT",
          "scheduledItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "processingItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "doneItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "failedItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "cancelledItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "skippedItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "totalItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "jobTaskId": 0
        }
      ],
      "jobTaskFailureReports": [
        {
          "id": 0,
          "detail1": "string",
          "detail2": "string",
          "systemId": 0,
          "systemDisplayId": "string",
          "jobId": 0,
          "internalDocumentNumber": "string",
          "postingType": "PAYMENT",
          "ledgerTransactionId": 0,
          "failureReason": "string",
          "taskId": 0
        }
      ],
      "jobId": 0
    }
  ],
  "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

Posting Job Task - Find Posting Task Failure Reports

HTTP Request

POST /api/v1/sap-posting-bot/posting/tasks/failure-report-by-filters

Interactive Demo

📋 Description: Submits a failure report for ledger entry tasks based on specified filters, enabling users to efficiently track and manage transaction discrepancies within financial records.

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the failure report data for ledger entries filtered by specific transaction and account criteria to facilitate accurate financial record management.
» filter	body	PostingTaskFailureReportDtoFilter	false	Data transfer object representing a filter for generating reports on posting task failures within the General Ledger, facilitating the analysis of ledger entries, transactions, accounts, and financial records.
»» idIn	body	[integer]	false	Filter by multiple values of id
»» idEqual	body	integer(int64)	false	Filter by exact match of id
»» idLike	body	string	false	Filter by partial match of id
»» detail1Like	body	string	false	Filter by partial match of detail1
»» detail2Like	body	string	false	Filter by partial match of detail2
»» systemIdEqual	body	integer(int64)	false	Filter by exact match of system id
»» systemDisplayIdLike	body	string	false	Filter by partial match of system display id
»» internalDocumentNumberLike	body	string	false	Filter by partial match of internal document number
»» postingTypeEqual	body	string	false	Filter by exact match of posting type
»» ledgerTransactionIdLike	body	string	false	Filter by partial match of ledger transaction id
»» taskIdEqual	body	integer(int64)	false	Filter by exact match of task id
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain.
»» page	body	integer(int32)	false	Page number for pagination
»» size	body	integer(int32)	false	Number of items per page
»» sort	body	[string]	false	Sort order specification

Enumerated Values

Attribute	Value
»» postingTypeEqual	ACCRUAL, CHARGE, DEPRECIATION, FX_REMEASUREMENT, INVOICE_POSTING, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER

Parameter Constraints

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "filter": {
    "idIn": [
      0
    ],
    "idEqual": 0,
    "idLike": "string",
    "detail1Like": "string",
    "detail2Like": "string",
    "systemIdEqual": 0,
    "systemDisplayIdLike": "string",
    "internalDocumentNumberLike": "string",
    "postingTypeEqual": "PAYMENT",
    "ledgerTransactionIdLike": "string",
    "taskIdEqual": 0
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingTaskFailureReportDto

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,
      "detail1": "string",
      "detail2": "string",
      "systemId": 0,
      "systemDisplayId": "string",
      "jobId": 0,
      "internalDocumentNumber": "string",
      "postingType": "PAYMENT",
      "ledgerTransactionId": 0,
      "failureReason": "string",
      "taskId": 0
    }
  ],
  "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

Posting Job Task - Cancel

HTTP Request

POST /api/v1/sap-posting-bot/posting/tasks/cancel/{id}

Interactive Demo

📋 Description: Cancels a specific ledger entry transaction identified by the provided ID, ensuring the integrity of financial records within the General Ledger. This operation is essential for managing account adjustments and maintaining accurate financial documentation.

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

Posting Job Task - Bulk Cancel

HTTP Request

POST /api/v1/sap-posting-bot/posting/tasks/cancel/bulk

Interactive Demo

📋 Description: Submits a bulk request to cancel multiple ledger entries, ensuring the accurate management of financial records and transactions within the General Ledger.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a collection of transaction identifiers and associated metadata for bulk cancellation of ledger entries within 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

Posting Job Task - Find All

HTTP Request

GET /api/v1/sap-posting-bot/posting/tasks

Interactive Demo

📋 Description: Retrieves a list of posting tasks related to ledger entries, transactions, and accounts within the General Ledger, enabling users to manage and review financial records efficiently.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the ledger entry tasks should be returned in a paginated format, facilitating efficient retrieval of transaction data within financial records.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingJobTaskDto

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,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "recoveredAt": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "recover": true,
      "interrupted": true,
      "interruptionMessage": "string",
      "errorMessage": "string",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "ledgerTransactionIds": [
        0
      ],
      "postingTypes": [
        "PAYMENT"
      ],
      "jobPostingStatuses": [
        "NA"
      ],
      "totalPostingCount": 0,
      "jobExecutionDateTime": "2019-08-24T14:15:22Z",
      "sapPostBapi": "string",
      "sapReversalBapi": "string",
      "failedTransactionIds": [
        0
      ],
      "jobTaskReports": [
        {
          "id": 0,
          "postingType": "PAYMENT",
          "scheduledItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "processingItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "doneItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "failedItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "cancelledItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "skippedItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "totalItemCount": {
            "postCount": 0,
            "reverseCount": 0
          },
          "jobTaskId": 0
        }
      ],
      "jobTaskFailureReports": [
        {
          "id": 0,
          "detail1": "string",
          "detail2": "string",
          "systemId": 0,
          "systemDisplayId": "string",
          "jobId": 0,
          "internalDocumentNumber": "string",
          "postingType": "PAYMENT",
          "ledgerTransactionId": 0,
          "failureReason": "string",
          "taskId": 0
        }
      ],
      "jobId": 0
    }
  ],
  "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

Posting Job Task - Get Posting Task Failure Reports By Task ID

HTTP Request

GET /api/v1/sap-posting-bot/posting/tasks/failure-report/{taskId}

Interactive Demo

📋 Description: Retrieves the failure report for a specific posting task identified by the {taskId}, providing insights into issues encountered during ledger entry transactions within the General Ledger. This operation aids in the resolution of discrepancies in financial records and enhances account management efficiency.

Parameters

Name	In	Type	Required	Description
taskId	path	integer(int64)	true	Unique identifier for the task
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently retrieve financial records related to ledger entries and transaction failures for a specified task.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingTaskFailureReportDto

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,
      "detail1": "string",
      "detail2": "string",
      "systemId": 0,
      "systemDisplayId": "string",
      "jobId": 0,
      "internalDocumentNumber": "string",
      "postingType": "PAYMENT",
      "ledgerTransactionId": 0,
      "failureReason": "string",
      "taskId": 0
    }
  ],
  "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

Posting Job Task - Download Xlsx Report

HTTP Request

GET /api/v1/sap-posting-bot/posting/tasks/download_xlsx_report/{taskId}

Interactive Demo

📋 Description: Downloads the XLSX report for a specified ledger entry task, providing a comprehensive overview of financial records and transactions associated with the given task ID.

Parameters

Name	In	Type	Required	Description
taskId	path	integer(int64)	true	Unique identifier for the task

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

---