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-06-07T14:07:49.0535128+01:00",
"ImportStatus": 3,
"DateImported": "2025-06-07T14:07:49.0535128+01:00",
"Detail": "sample string 4",
"Rows": 1,
"Progress": 1,
"DateImportStarted": "2025-06-07T14:07:49.0535128+01:00",
"DateImportFinished": "2025-06-07T14:07:49.0535128+01:00",
"Disabled": true,
"ImportFormatVersion": "2025-06-07T14:07:49.0535128+01:00",
"IsPartial": true,
"Guid": "8f36da1e-1771-4791-a456-7e0321e89020",
"FileData": "QEA=",
"DocumentId": "e6ce4a37-8daa-4e3c-a07a-07b1c70163d8",
"PayrollId": "646f2c27-d68e-47fa-875c-17b2e9c4c872",
"SheetIds": [
"cf44b6bf-a720-45a7-b86a-d1c995d3f4f0",
"518d4e9c-e266-4278-9878-0efc0caa980a"
]
}
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-06-07T14:07:49.0535128+01:00</DateCreated>
<DateImportFinished>2025-06-07T14:07:49.0535128+01:00</DateImportFinished>
<DateImportStarted>2025-06-07T14:07:49.0535128+01:00</DateImportStarted>
<DateImported>2025-06-07T14:07:49.0535128+01:00</DateImported>
<Detail>sample string 4</Detail>
<Disabled>true</Disabled>
<DocumentId>e6ce4a37-8daa-4e3c-a07a-07b1c70163d8</DocumentId>
<FileData>QEA=</FileData>
<FileName>sample string 1</FileName>
<Guid>8f36da1e-1771-4791-a456-7e0321e89020</Guid>
<ImportFormat>sample string 2</ImportFormat>
<ImportFormatVersion>2025-06-07T14:07:49.0535128+01:00</ImportFormatVersion>
<ImportStatus>3</ImportStatus>
<IsPartial>true</IsPartial>
<PayrollId>646f2c27-d68e-47fa-875c-17b2e9c4c872</PayrollId>
<Progress>1</Progress>
<Rows>1</Rows>
<SheetIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:guid>cf44b6bf-a720-45a7-b86a-d1c995d3f4f0</d2p1:guid>
<d2p1:guid>518d4e9c-e266-4278-9878-0efc0caa980a</d2p1:guid>
</SheetIds>
</ImportDetail>