GET /api/v3/task/{taskGuid}

Retrieves a task by its GUID. The output property could potentially contain a large amount of data. If response time or size becomes an issue, use field reduction to eliminate the output field.

GetTaskV3

Request Headers

Header	Value	Required	Description
ECI-ApiKey	string	Yes	Your API key. See Authentication.
Content-Type	application/json	Yes	All requests must specify JSON content type.

Path Parameters

Name	Description	Type	Required
taskGuid	The GUID of the task	string (uuid)	Required

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

TaskResponse

Property

Description

Type

analyzingCount

Count of bills that are in the analyzing state, used by bill import tasks only

integer (int32)

batch

BatchChild

BatchChild properties

Property	Description	Type
batchCode	The batch code.	string
batchId	The batch id.	integer (int32)

beginDate

The date and time the task began

string (date-time)

currentSuccessCount

The count of successful bills that still exist (i.e. have not been deleted), used by bill import tasks only

integer (int32)

endDate

The date and time the task finished. If the task is not finished, endDate will have no value

string (date-time)

hasAttachments

Deprecated property - HasAttachments always returns true

boolean

message

The task’s message

string

output

The task’s output. For certain task types, this field could be sizable

object

settings

The task’s settings

object

status

The task’s status

string

taskGUId

The task guid

string (uuid)

taskId

integer (int32)

taskNote

User provided note/comment for this Task

string

taskType

TaskType

TaskType properties

Property	Description	Type
taskTypeCode	The code for task type	string
taskTypeId	The task type identifier	integer (int32)
taskTypeInfo	The task type information	string

unresolvedFlagCount

The count of bills with unresolved flags on this task, used by bill import tasks only

integer (int32)

user

UserChild

UserChild properties

Property	Description	Type
fullName	The user’s full name	string
userCode	The user code	string
userId	The user identifier	integer (int32)

Example Response application/json

{  "analyzingCount": 1,  "batch": {    "batchCode": "string",    "batchId": 1
  },  "beginDate": "2026-03-30",  "currentSuccessCount": 1,  "endDate": "2026-03-30",  "hasAttachments": false,  "message": "string",  "output": {},  "settings": {},  "status": "string",  "taskGUId": "string",  "taskId": 1,  "taskNote": "string",  "taskType": {    "taskTypeCode": "string",    "taskTypeId": 1,    "taskTypeInfo": "string"
  },  "unresolvedFlagCount": 1,  "user": {    "fullName": "string",    "userCode": "string",    "userId": 1
  }
}