GET api/Import/CustomImport/Ready/{date}

Get all uploaded files that are ready to be imported after date (optional)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
date

date

Required

Body Parameters

None.

Response Information

Resource Description

Status message

Collection of ImportDetail
NameDescriptionTypeAdditional 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": "2024-12-23T06:11:05.8176384+00:00",
    "ImportStatus": 3,
    "DateImported": "2024-12-23T06:11:05.8176384+00:00",
    "Detail": "sample string 4",
    "Rows": 1,
    "Progress": 1,
    "DateImportStarted": "2024-12-23T06:11:05.8176384+00:00",
    "DateImportFinished": "2024-12-23T06:11:05.8176384+00:00",
    "Disabled": true,
    "ImportFormatVersion": "2024-12-23T06:11:05.8176384+00:00",
    "IsPartial": true,
    "Guid": "0959ea9b-a892-4ac6-997b-699c4fda0693",
    "FileData": "QEA=",
    "DocumentId": "6ac73178-eb44-499a-8b7e-598081973034",
    "PayrollId": "d7d6de16-6e44-4ae3-a979-00ff5cbc71c8",
    "SheetIds": [
      "5f4317ed-b5e8-403b-975d-e989b141e65a",
      "4f3912ff-ec84-4aca-9c2e-c56fc9a8dbb3"
    ]
  },
  {
    "FileName": "sample string 1",
    "ImportFormat": "sample string 2",
    "DateCreated": "2024-12-23T06:11:05.8176384+00:00",
    "ImportStatus": 3,
    "DateImported": "2024-12-23T06:11:05.8176384+00:00",
    "Detail": "sample string 4",
    "Rows": 1,
    "Progress": 1,
    "DateImportStarted": "2024-12-23T06:11:05.8176384+00:00",
    "DateImportFinished": "2024-12-23T06:11:05.8176384+00:00",
    "Disabled": true,
    "ImportFormatVersion": "2024-12-23T06:11:05.8176384+00:00",
    "IsPartial": true,
    "Guid": "0959ea9b-a892-4ac6-997b-699c4fda0693",
    "FileData": "QEA=",
    "DocumentId": "6ac73178-eb44-499a-8b7e-598081973034",
    "PayrollId": "d7d6de16-6e44-4ae3-a979-00ff5cbc71c8",
    "SheetIds": [
      "5f4317ed-b5e8-403b-975d-e989b141e65a",
      "4f3912ff-ec84-4aca-9c2e-c56fc9a8dbb3"
    ]
  }
]

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>2024-12-23T06:11:05.8176384+00:00</DateCreated>
    <DateImportFinished>2024-12-23T06:11:05.8176384+00:00</DateImportFinished>
    <DateImportStarted>2024-12-23T06:11:05.8176384+00:00</DateImportStarted>
    <DateImported>2024-12-23T06:11:05.8176384+00:00</DateImported>
    <Detail>sample string 4</Detail>
    <Disabled>true</Disabled>
    <DocumentId>6ac73178-eb44-499a-8b7e-598081973034</DocumentId>
    <FileData>QEA=</FileData>
    <FileName>sample string 1</FileName>
    <Guid>0959ea9b-a892-4ac6-997b-699c4fda0693</Guid>
    <ImportFormat>sample string 2</ImportFormat>
    <ImportFormatVersion>2024-12-23T06:11:05.8176384+00:00</ImportFormatVersion>
    <ImportStatus>3</ImportStatus>
    <IsPartial>true</IsPartial>
    <PayrollId>d7d6de16-6e44-4ae3-a979-00ff5cbc71c8</PayrollId>
    <Progress>1</Progress>
    <Rows>1</Rows>
    <SheetIds xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:guid>5f4317ed-b5e8-403b-975d-e989b141e65a</d3p1:guid>
      <d3p1:guid>4f3912ff-ec84-4aca-9c2e-c56fc9a8dbb3</d3p1:guid>
    </SheetIds>
  </ImportDetail>
  <ImportDetail>
    <DateCreated>2024-12-23T06:11:05.8176384+00:00</DateCreated>
    <DateImportFinished>2024-12-23T06:11:05.8176384+00:00</DateImportFinished>
    <DateImportStarted>2024-12-23T06:11:05.8176384+00:00</DateImportStarted>
    <DateImported>2024-12-23T06:11:05.8176384+00:00</DateImported>
    <Detail>sample string 4</Detail>
    <Disabled>true</Disabled>
    <DocumentId>6ac73178-eb44-499a-8b7e-598081973034</DocumentId>
    <FileData>QEA=</FileData>
    <FileName>sample string 1</FileName>
    <Guid>0959ea9b-a892-4ac6-997b-699c4fda0693</Guid>
    <ImportFormat>sample string 2</ImportFormat>
    <ImportFormatVersion>2024-12-23T06:11:05.8176384+00:00</ImportFormatVersion>
    <ImportStatus>3</ImportStatus>
    <IsPartial>true</IsPartial>
    <PayrollId>d7d6de16-6e44-4ae3-a979-00ff5cbc71c8</PayrollId>
    <Progress>1</Progress>
    <Rows>1</Rows>
    <SheetIds xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:guid>5f4317ed-b5e8-403b-975d-e989b141e65a</d3p1:guid>
      <d3p1:guid>4f3912ff-ec84-4aca-9c2e-c56fc9a8dbb3</d3p1:guid>
    </SheetIds>
  </ImportDetail>
</ArrayOfImportDetail>