Create a new task.
Tasks are created on entries or transactions based on their transaction type, and row ID or transaction ID fields.
The analysis type determines which transaction types are permitted to create new tasks:
For general ledger (for-profit), general ledger (not-for-profit), and general ledger (not-for-profit with funds) analyses:
ENTRYTRANSACTIONFor accounts payable analyses:
AP_ENTRYAP_OUTSTANDING_ENTRYFor accounts receivable analyses:
AR_ENTRYAR_OUTSTANDING_ENTRYThe task type determines which of rowId and transactionId are required when creating a new task. The following table outlines which
fields must be set for a given task type:
| Type | rowId | transactionId |
|---|---|---|
ENTRY | ✅ | ✅ |
TRANSACTION | ❌ | ✅ |
AP_ENTRY | ✅ | ❌ |
AR_ENTRY | ✅ | ❌ |
AP_OUTSTANDING_ENTRY | ✅ | ❌ |
AR_OUTSTANDING_ENTRY | ✅ | ❌ |
All tasks created by this endpoint will have sampleType set to MANUAL.
api.tasks.writeBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Identifies the associated engagement.
The current state of the task.
OPEN, NORMAL, COMPLETED, DISMISSED, RESOLVED The type of entry this task is associated with.
ENTRY, TRANSACTION, AP_ENTRY, AR_ENTRY, AP_OUTSTANDING_ENTRY, AR_OUTSTANDING_ENTRY, TRA_ENTRY Identifies the associated entry.
Identifies the associated transaction.
Identifies the user assigned to this task.
A description of the task.
Which sample this task is a part of.
Which audit areas this task is associated with.
Which assertions this task is associated with.
PENDING, REJECTED, APPROVED Created
Indicates the data integrity version to ensure data consistency.
Identifies the associated engagement.
The current state of the task.
OPEN, NORMAL, COMPLETED, DISMISSED, RESOLVED The type of entry this task is associated with.
ENTRY, TRANSACTION, AP_ENTRY, AR_ENTRY, AP_OUTSTANDING_ENTRY, AR_OUTSTANDING_ENTRY, TRA_ENTRY The unique object identifier.
The date that the object was originally created.
The date that the object was last updated or modified.
Details about the user who created the object.
Details about the user who last modified or updated the object.
Identifies the associated analysis.
Identifies the associated analysis type.
The name of the associated transaction.
The task's name. Generated based on on the related entry or transaction.
Identifies the associated entry.
Identifies the associated transaction.
Identifies the user assigned to this task.
A description of the task.
A list of all the comments that have been made on this task.
Which sample this task is a part of.
Which audit areas this task is associated with.
Which assertions this task is associated with.
The sampling method used to create this task.
RISK_BASED, RANDOM, MANUAL, MONETARY_UNIT_SAMPLING For AP and AR analyses this is the entry type for the associated entry.
For AP analyses this is the vendor name for the associated entry.
For AR analyses this is the customer name for the associated entry.
For AP and AR analyses this is the Invoice ref value for the associated entry.
The credit value of the associated transaction or entry, formatted as MONEY_100.
The debit value of the associated transaction or entry, formatted as MONEY_100.
A map of ensemble names or IDs mapped to their risk score value. The value is a PERCENTAGE_FIXED_POINT type.
The filter statement that was applied when creating this task via a bulk task creation.
PENDING, REJECTED, APPROVED