Skip to main content
GET
/
api
/
adm
/
import
/
resultFile
Download Import Result File
curl --request GET \
  --url https://localhost:44371/api/adm/import/resultFile \
  --header 'Authorization: Bearer <token>'
"<string>"

Description

Generates and returns a CSV file containing import results with row-by-row success/failure status and error messages. The result file helps administrators identify which records failed validation or processing and the specific reasons for failure.

Input

  • Query Parameters: model (ImportBatchResultFileQueryRequest) — Request parameters including:
    • batchId (guid, required) — Unique identifier of the import batch.

Output

Returns a CSV file stream containing row-by-row import results with status and error details.

Example Request

GET /api/admin/importBatches/result-file?batchId=9ef15c43-a955-6f4h-c7g3-1h6d4f0e3g9c
Authorization: Bearer {token}

Example Response

RowNumber,Status,ErrorMessage,OriginalColumn1,OriginalColumn2
1,Success,,ValueA,ValueB
2,Failed,Invalid email format,ValueC,InvalidEmail
3,Success,,ValueD,ValueE

Errors

  • 400 Bad Request — Batch not completed (result file only available after import completes).
  • 404 Not Found — No import batch exists with the specified ID or result file has been deleted/expired.

Notes

  • Result files are generated after import completes (status = Completed or Failed).
  • Files include original row data plus Status and ErrorMessage columns.
  • Result files are retained for 90 days before automatic cleanup.
  • Response Content-Type is text/csv.

Authorizations

Authorization
string
header
required

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

Query Parameters

BatchId
string<guid>

Identifier of the import batch whose file is requested. Corresponds to the batch originally uploaded by the administrator and must match an existing processed batch before a result file is returned.

CompanyId
string<guid>

Identifier of the owning company for validation purposes. Ensures the requesting admin cannot access batches belonging to other tenants.

CompanyProjectId
string<guid>

Identifier of the project that owns the import batch. Used by the manager to confirm that the batch being accessed was produced for the same project expected by the caller.

Type
enum<string>

Type of result file that should be returned. Helps select the correct template or storage location when multiple import categories share the same batch identifier.

Available options:
Transactions,
PaymentsInfo,
TransferTransactions,
TransferPaymentsInfo

Response

Always returned with CSV file stream. Content-Type is text/csv.

The response is of type file.