GET api/Import/CustomImport/Get/{importGUID}
Gets all information about a custom import
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| importGUID | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Status message
ImportDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| FileName |
FileName with extension |
string |
Required |
| ImportFormat |
Custom Import Name |
string |
Required |
| DateCreated | date |
Nullable |
|
| ImportStatus | integer |
None. |
|
| DateImported | date |
Nullable |
|
| Detail | string |
None. |
|
| Rows | integer |
Nullable |
|
| Progress | integer |
Nullable |
|
| DateImportStarted | date |
Nullable |
|
| DateImportFinished | date |
Nullable |
|
| Disabled | boolean |
None. |
|
| ImportFormatVersion | date |
Nullable |
|
| IsPartial | boolean |
None. |
|
| Guid | globally unique identifier |
Nullable |
|
| FileData |
Byte Array of file data - used in import |
Collection of byte |
None. |
| DocumentId | globally unique identifier |
None. |
|
| PayrollId | globally unique identifier |
Nullable |
|
| SheetIds | Collection of globally unique identifier |
Nullable |
Response Formats
application/json, text/json
Sample:
{
"FileName": "sample string 1",
"ImportFormat": "sample string 2",
"DateCreated": "2025-07-22T19:05:35.042944+01:00",
"ImportStatus": 3,
"DateImported": "2025-07-22T19:05:35.042944+01:00",
"Detail": "sample string 4",
"Rows": 1,
"Progress": 1,
"DateImportStarted": "2025-07-22T19:05:35.042944+01:00",
"DateImportFinished": "2025-07-22T19:05:35.042944+01:00",
"Disabled": true,
"ImportFormatVersion": "2025-07-22T19:05:35.058569+01:00",
"IsPartial": true,
"Guid": "b2291c2c-c6b0-4e22-9650-b91b689bbeed",
"FileData": "QEA=",
"DocumentId": "de8d4c4a-0f58-4b3e-80b6-6fdcef69bd77",
"PayrollId": "77b9fad6-feca-446d-b0e0-35b196855406",
"SheetIds": [
"74fd86e3-372d-4cb0-bf6e-ecbe73aac4c5",
"aa270ecc-87ec-492d-ae24-66d5075363ac"
]
}
application/xml, text/xml
Sample:
<ImportDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models">
<DateCreated>2025-07-22T19:05:35.042944+01:00</DateCreated>
<DateImportFinished>2025-07-22T19:05:35.042944+01:00</DateImportFinished>
<DateImportStarted>2025-07-22T19:05:35.042944+01:00</DateImportStarted>
<DateImported>2025-07-22T19:05:35.042944+01:00</DateImported>
<Detail>sample string 4</Detail>
<Disabled>true</Disabled>
<DocumentId>de8d4c4a-0f58-4b3e-80b6-6fdcef69bd77</DocumentId>
<FileData>QEA=</FileData>
<FileName>sample string 1</FileName>
<Guid>b2291c2c-c6b0-4e22-9650-b91b689bbeed</Guid>
<ImportFormat>sample string 2</ImportFormat>
<ImportFormatVersion>2025-07-22T19:05:35.058569+01:00</ImportFormatVersion>
<ImportStatus>3</ImportStatus>
<IsPartial>true</IsPartial>
<PayrollId>77b9fad6-feca-446d-b0e0-35b196855406</PayrollId>
<Progress>1</Progress>
<Rows>1</Rows>
<SheetIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:guid>74fd86e3-372d-4cb0-bf6e-ecbe73aac4c5</d2p1:guid>
<d2p1:guid>aa270ecc-87ec-492d-ae24-66d5075363ac</d2p1:guid>
</SheetIds>
</ImportDetail>