POST api/Import/CustomImport/Upload

Upload a file to the custom importer

Request Information

URI Parameters

None.

Body Parameters

In request Body: File details

Name	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-11-04T12:31:05.1298322+00:00",
  "ImportStatus": 3,
  "DateImported": "2025-11-04T12:31:05.1298322+00:00",
  "Detail": "sample string 4",
  "Rows": 1,
  "Progress": 1,
  "DateImportStarted": "2025-11-04T12:31:05.1298322+00:00",
  "DateImportFinished": "2025-11-04T12:31:05.1298322+00:00",
  "Disabled": true,
  "ImportFormatVersion": "2025-11-04T12:31:05.1298322+00:00",
  "IsPartial": true,
  "Guid": "96ea157a-82fa-4d8e-b3ba-46189f3de863",
  "FileData": "QEA=",
  "DocumentId": "54b147e3-6a08-4845-881d-631db53a03b4",
  "PayrollId": "da9b817f-ba5f-4b67-aab9-cf83dd6dbbff",
  "SheetIds": [
    "9849443f-c527-4e0f-97e3-6bc27e973548",
    "92fb1d2e-62bf-42e8-ba0f-9ef40482f27b"
  ]
}

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-11-04T12:31:05.1298322+00:00</DateCreated>
  <DateImportFinished>2025-11-04T12:31:05.1298322+00:00</DateImportFinished>
  <DateImportStarted>2025-11-04T12:31:05.1298322+00:00</DateImportStarted>
  <DateImported>2025-11-04T12:31:05.1298322+00:00</DateImported>
  <Detail>sample string 4</Detail>
  <Disabled>true</Disabled>
  <DocumentId>54b147e3-6a08-4845-881d-631db53a03b4</DocumentId>
  <FileData>QEA=</FileData>
  <FileName>sample string 1</FileName>
  <Guid>96ea157a-82fa-4d8e-b3ba-46189f3de863</Guid>
  <ImportFormat>sample string 2</ImportFormat>
  <ImportFormatVersion>2025-11-04T12:31:05.1298322+00:00</ImportFormatVersion>
  <ImportStatus>3</ImportStatus>
  <IsPartial>true</IsPartial>
  <PayrollId>da9b817f-ba5f-4b67-aab9-cf83dd6dbbff</PayrollId>
  <Progress>1</Progress>
  <Rows>1</Rows>
  <SheetIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:guid>9849443f-c527-4e0f-97e3-6bc27e973548</d2p1:guid>
    <d2p1:guid>92fb1d2e-62bf-42e8-ba0f-9ef40482f27b</d2p1:guid>
  </SheetIds>
</ImportDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Status message

ResultWithMessage

Name	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>