ServiceImportJobDto

Represents the current status and progress of a service import job.
Returned when starting an import or polling for status.

Properties

Name	Type	Description
code	string	Unique code identifying this import job. Use this code to poll for status via GET /{code}.
Unique code identifying this import job. Use this code to poll for status via GET /{code}.
status	enum	Queued InProgress Completed Failed Cancelled
Queued InProgress Completed Failed Cancelled
fileName	string	Original filename of the uploaded CSV file
Original filename of the uploaded CSV file
totalItems	integer	Total number of data rows to process (excluding header row). May be null if the job hasn't started processing yet.
Total number of data rows to process (excluding header row). May be null if the job hasn't started processing yet.
processedItems	integer	Number of rows that have been processed so far
Number of rows that have been processed so far
createdCount	integer	Number of client billable service records created
Number of client billable service records created
skippedCount	integer	Number of rows skipped (client not found, service already assigned, etc.)
Number of rows skipped (client not found, service already assigned, etc.)
errorCount	integer	Number of rows with errors
Number of rows with errors
startedDate	string	When the job started processing (UTC)
When the job started processing (UTC)
completedDate	string	When the job completed processing (UTC)
When the job completed processing (UTC)
createdDate	string	When the import job was created (UTC)
When the import job was created (UTC)
notImportedDownloadUrl	string	URL to download a CSV containing rows that were not imported. Only available when status is Completed and there were errors or skipped rows. This is a time-limited SAS URL that expires after 60 minutes.
URL to download a CSV containing rows that were not imported. Only available when status is Completed and there were errors or skipped rows. This is a time-limited SAS URL that expires after 60 minutes.

JSON Example

{
  "code": "string",
  "status": "Queued",
  "fileName": "string",
  "totalItems": 0,
  "processedItems": 0
}

ServiceImportJobDto

Properties

JSON Example

Used By Operations