GET api/Import/CustomImport/Ready/{date}
Get all uploaded files that are ready to be imported after date (optional)
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
date | date |
Required |
Body Parameters
None.
Response Information
Resource Description
Status message
Collection of ImportDetailName | 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-04-19T00:07:54.3169258+01:00", "ImportStatus": 3, "DateImported": "2025-04-19T00:07:54.3169258+01:00", "Detail": "sample string 4", "Rows": 1, "Progress": 1, "DateImportStarted": "2025-04-19T00:07:54.3169258+01:00", "DateImportFinished": "2025-04-19T00:07:54.3169258+01:00", "Disabled": true, "ImportFormatVersion": "2025-04-19T00:07:54.3169258+01:00", "IsPartial": true, "Guid": "09c30156-8a8e-486f-b32d-ee4306a787ba", "FileData": "QEA=", "DocumentId": "9ff12831-d1d6-4a16-aefa-896e0bf2ebcf", "PayrollId": "2f9f3686-d8ff-43df-bdf1-e7aa9dbe0279", "SheetIds": [ "1f691684-3108-4967-8d2a-353eca567793", "5e30046d-f0ae-4c66-9dcc-f88714adcde7" ] }, { "FileName": "sample string 1", "ImportFormat": "sample string 2", "DateCreated": "2025-04-19T00:07:54.3169258+01:00", "ImportStatus": 3, "DateImported": "2025-04-19T00:07:54.3169258+01:00", "Detail": "sample string 4", "Rows": 1, "Progress": 1, "DateImportStarted": "2025-04-19T00:07:54.3169258+01:00", "DateImportFinished": "2025-04-19T00:07:54.3169258+01:00", "Disabled": true, "ImportFormatVersion": "2025-04-19T00:07:54.3169258+01:00", "IsPartial": true, "Guid": "09c30156-8a8e-486f-b32d-ee4306a787ba", "FileData": "QEA=", "DocumentId": "9ff12831-d1d6-4a16-aefa-896e0bf2ebcf", "PayrollId": "2f9f3686-d8ff-43df-bdf1-e7aa9dbe0279", "SheetIds": [ "1f691684-3108-4967-8d2a-353eca567793", "5e30046d-f0ae-4c66-9dcc-f88714adcde7" ] } ]
application/xml, text/xml
Sample:
<ArrayOfImportDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models"> <ImportDetail> <DateCreated>2025-04-19T00:07:54.3169258+01:00</DateCreated> <DateImportFinished>2025-04-19T00:07:54.3169258+01:00</DateImportFinished> <DateImportStarted>2025-04-19T00:07:54.3169258+01:00</DateImportStarted> <DateImported>2025-04-19T00:07:54.3169258+01:00</DateImported> <Detail>sample string 4</Detail> <Disabled>true</Disabled> <DocumentId>9ff12831-d1d6-4a16-aefa-896e0bf2ebcf</DocumentId> <FileData>QEA=</FileData> <FileName>sample string 1</FileName> <Guid>09c30156-8a8e-486f-b32d-ee4306a787ba</Guid> <ImportFormat>sample string 2</ImportFormat> <ImportFormatVersion>2025-04-19T00:07:54.3169258+01:00</ImportFormatVersion> <ImportStatus>3</ImportStatus> <IsPartial>true</IsPartial> <PayrollId>2f9f3686-d8ff-43df-bdf1-e7aa9dbe0279</PayrollId> <Progress>1</Progress> <Rows>1</Rows> <SheetIds xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:guid>1f691684-3108-4967-8d2a-353eca567793</d3p1:guid> <d3p1:guid>5e30046d-f0ae-4c66-9dcc-f88714adcde7</d3p1:guid> </SheetIds> </ImportDetail> <ImportDetail> <DateCreated>2025-04-19T00:07:54.3169258+01:00</DateCreated> <DateImportFinished>2025-04-19T00:07:54.3169258+01:00</DateImportFinished> <DateImportStarted>2025-04-19T00:07:54.3169258+01:00</DateImportStarted> <DateImported>2025-04-19T00:07:54.3169258+01:00</DateImported> <Detail>sample string 4</Detail> <Disabled>true</Disabled> <DocumentId>9ff12831-d1d6-4a16-aefa-896e0bf2ebcf</DocumentId> <FileData>QEA=</FileData> <FileName>sample string 1</FileName> <Guid>09c30156-8a8e-486f-b32d-ee4306a787ba</Guid> <ImportFormat>sample string 2</ImportFormat> <ImportFormatVersion>2025-04-19T00:07:54.3169258+01:00</ImportFormatVersion> <ImportStatus>3</ImportStatus> <IsPartial>true</IsPartial> <PayrollId>2f9f3686-d8ff-43df-bdf1-e7aa9dbe0279</PayrollId> <Progress>1</Progress> <Rows>1</Rows> <SheetIds xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:guid>1f691684-3108-4967-8d2a-353eca567793</d3p1:guid> <d3p1:guid>5e30046d-f0ae-4c66-9dcc-f88714adcde7</d3p1:guid> </SheetIds> </ImportDetail> </ArrayOfImportDetail>