LinX Batch Detail Object

The LinX Batch Detail object represents detailed information for a LinX batch.

Attributes

string (UUID)

ID of the LinX batch.

status

string enum, values: NEW, QUEUED, COMPLETED, INVALID, CANCELLING, FAILED

Status of the LinX batch. The following values are supported:

NEW New batch has been created.
QUEUED Batch entries (requests) have been queued for creation.
COMPLETED All requests have been executed.
INVALID JSON schema validation failed.
CANCELLING Batch has been cancelled.
FAILED Batch was not processed.

templateId

string (UUID)

ID of the LinX template used for the batch. This ID is the same for all versions of the template.

templateVersionId

string (UUID)

ID of the version of the LinX template used for the batch.

templateVersion

integer

Version number of the LinX template used for the batch.

templateDisplayName

string

Short readable name for the LinX template used for the batch.

activeRequestsCount

integer

Number of LinX requests created by the batch with a current status of ACTIVE.

cancelledRequestsCount

integer

Number of LinX requests created by the batch with a current status of CANCELLED.

completedRequestsCount

integer

Number of LinX requests created by the batch with a current status of COMPLETED.

declinedRequestsCount

integer

Number of LinX requests created by the batch with a current status of DECLINED.

expiredRequestsCount

integer

Number of LinX requests created by the batch with a current status of EXPIRED.

failedRequestsCount

integer

Number of LinX requests created by the batch with a current status of FAILED.

rejectedRequestsCount

integer

Number of LinX requests for the batch that were rejected during creation.

totalRequestsCount

integer

Total number of requests for the batch.

createdBy

object

Entity that created the LinX batch.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the LinX batch was created in the RocketKOR system.

updatedBy

object

Entity that last updated the LinX batch.

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the LinX batch was last updated.

LinX Batch Detail Object

				
					{
  "id": "string(UUID)",
  "status": "NEW | QUEUED | COMPLETED | INVALID | CANCELLING | FAILED",
  "templateId": "string(UUID)",
  "templateVersionId": "string(UUID)",
  "templateVersion": integer,
  "templateDisplayName": "string",
  "activeRequestsCount": integer,
  "cancelledRequestsCount": integer,
  "completedRequestsCount": integer,
  "declinedRequestsCount": integer,
  "expiredRequestsCount": integer,
  "failedRequestsCount": integer,
  "rejectedRequestsCount": integer,
  "totalRequestsCount": integer,
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "createdAt": "string(date-time)",
  "updatedBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "updatedAt": "string(date-time)"
}