Skip to main content
GET
/
api
/
adm
/
backgroundProcesses
/
processImportBatchEntries
Get Import Batch Entries
curl --request GET \
  --url https://localhost:44371/api/adm/backgroundProcesses/processImportBatchEntries \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Description

Retrieves detailed information about individual entries within a background process import batch. When a background import process is created, it may contain hundreds or thousands of individual entries (e.g., transaction records being imported). This endpoint allows you to inspect each entry’s processing status, validation errors, and other details to troubleshoot import issues or monitor progress at a detailed level.

​
Input

  • Query Parameters: inputModel (BackgroundProcessGetProcessImportBatchQueryRequest) — Filtering options including:
    • backgroundProcessId (guid, required) — ID of the parent background process.
    • status (string, optional) — Filter by entry status (Pending, Processed, Failed).
    • limit (int, optional) — Maximum number of records to return (default: 50).
    • offset (int, optional) — Number of records to skip for pagination.

​
Output

Returns a BackgroundProcessGetProcessImportBatchQueryResponse containing individual batch entry details with processing status and errors.

​
Example Request

GET /api/admin/backgroundProcesses/3fa85f64-5717-4562-b3fc-2c963f66afa6/import-batch-entries?status=Failed&limit=50
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": [
    {
      "id": "7bc94a21-8833-4d2f-a5e1-9f4b2d8c1e7a",
      "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "rowNumber": 42,
      "status": "Failed",
      "errorMessage": "Invalid transaction amount: value must be greater than 0",
      "rawData": "{\"transactionId\":\"TX123\",\"amount\":-10.00}",
      "createdDate": "2025-10-27T10:30:00Z"
    }
  ],
  "totalCount": 1000
}

​
Errors

  • 400 Bad Request — Invalid query parameters or pagination values.
  • 401 Unauthorized — Missing or invalid authentication token.
  • 403 Forbidden — User does not have permission to access this background process.
  • 404 Not Found — No background process exists with the specified ID.

​
Notes

  • Results are paginated; use limit and offset parameters for large import batches.
  • Filter by status to quickly identify failed entries that need attention.
  • The rawData field contains the original input that was processed for troubleshooting.
  • Use rowNumber to identify specific rows in the original import file.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
CompanyProjectId
string<guid>

Project identifier whose import batches should be inspected.

Example:

"f0e352f7-4e5b-46e1-a2e3-4c33805ea3f3"

​
Types
enum<string>[] | null

Collection of import types that should be included.

Available options:
Transactions,
PaymentsInfo,
TransferTransactions,
TransferPaymentsInfo
Example:

"[ImportType.Transactions, ImportType.TransferTransactions]"

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Represents the response returned when requesting import batch background processes.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of import batch background processes that matched the query.

Example:
[
  {
    "Id": "9a0cab4d-d78f-4cef-bf07-02d843dc02d2",
    "Status": "Completed"
  }
]