POST api/Import/CustomImport/Upload
Upload a file to the custom importer
Request Information
URI Parameters
None.
Body Parameters
In request Body: File details
ImportDetailName | Description | Type | Additional information |
---|---|---|---|
FileName |
FileName with extension |
string |
Required |
ImportFormat |
Custom Import Name |
string |
Required |
DateCreated | date |
Nullable |
|
ImportStatus |
Pending = 0, Validated = 1, Imported = 2, Error = 3, Importing = 4 |
integer |
None. |
DateImported | date |
Nullable |
|
Detail | string |
None. |
|
Rows |
How many rows are in the import. |
integer |
Nullable |
Progress |
The progress of the import. |
integer |
Nullable |
DateImportStarted | date |
Nullable |
|
DateImportFinished | date |
Nullable |
|
Disabled |
Indicates whether the import has been disabled (Timeout, etc.) |
boolean |
None. |
ImportFormatVersion | date |
Nullable |
|
IsPartial |
Indicates whether the import is a partial import. |
boolean |
None. |
Guid |
Unique GUID of the Import |
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 |
Request Formats
application/json, text/json
Sample:
{ "FileName": "sample string 1", "ImportFormat": "sample string 2", "DateCreated": "2025-09-10T07:45:18.4673525+01:00", "ImportStatus": 3, "DateImported": "2025-09-10T07:45:18.4673525+01:00", "Detail": "sample string 4", "Rows": 1, "Progress": 1, "DateImportStarted": "2025-09-10T07:45:18.4673525+01:00", "DateImportFinished": "2025-09-10T07:45:18.4673525+01:00", "Disabled": true, "ImportFormatVersion": "2025-09-10T07:45:18.4673525+01:00", "IsPartial": true, "Guid": "e0a069a1-1046-4dd2-b2be-b3d3e13ab986", "FileData": "QEA=", "DocumentId": "f5db33c4-020d-4015-a28f-190001fc453b", "PayrollId": "a16f809a-4f9b-4752-8654-a76133b513a7", "SheetIds": [ "6cc97998-4d77-4cdf-b8b4-805d57730449", "a36c6a3e-0ebd-4937-a77c-295449352c5b" ] }
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-09-10T07:45:18.4673525+01:00</DateCreated> <DateImportFinished>2025-09-10T07:45:18.4673525+01:00</DateImportFinished> <DateImportStarted>2025-09-10T07:45:18.4673525+01:00</DateImportStarted> <DateImported>2025-09-10T07:45:18.4673525+01:00</DateImported> <Detail>sample string 4</Detail> <Disabled>true</Disabled> <DocumentId>f5db33c4-020d-4015-a28f-190001fc453b</DocumentId> <FileData>QEA=</FileData> <FileName>sample string 1</FileName> <Guid>e0a069a1-1046-4dd2-b2be-b3d3e13ab986</Guid> <ImportFormat>sample string 2</ImportFormat> <ImportFormatVersion>2025-09-10T07:45:18.4673525+01:00</ImportFormatVersion> <ImportStatus>3</ImportStatus> <IsPartial>true</IsPartial> <PayrollId>a16f809a-4f9b-4752-8654-a76133b513a7</PayrollId> <Progress>1</Progress> <Rows>1</Rows> <SheetIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:guid>6cc97998-4d77-4cdf-b8b4-805d57730449</d2p1:guid> <d2p1:guid>a36c6a3e-0ebd-4937-a77c-295449352c5b</d2p1:guid> </SheetIds> </ImportDetail>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Status message
ResultWithMessageName | Description | Type | Additional information |
---|---|---|---|
result |
'OK', 'Error' |
string |
None. |
message |
Returns if result is Error |
string |
None. |
returnValue | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "result": "OK" } { "result": "Error", "message": "Unable to save: the..." }
application/xml, text/xml
Sample:
<ResultWithMessage> <result>OK</result> </ResultWithMessage> <ResultWithMessage> <result>Error</result> <message>Unable to save: the...</message> </ResultWithMessage>