WorkItems

Create work item

post/api/v1/workitems

Request

  • Base URL: /sandbox (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /sandbox/api/v1/workitems
  • Auth: OAuth 2 (authorization code, authorization URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/authorize, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token; client credentials, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token, scopes: policy.write)

Query parameters

idstring

e.g. workitem_c0645dc026a74ae99ec436df63d77d2c

If not specified, a new one is generated

finalisedboolean

Immediately attempt to finalise the work item

Request body

titlestring nullable

Title as it will appear by default on invoice

itemType0 | 1 | 2
fileNotestring nullable

File note taken against this work item, not visible to the client of the firm

taskTypeIdstring nullable

e.g. tasktype_c0645dc026a74ae99ec436df63d77d2c

employeeIdstring nullable

e.g. employee_c0645dc026a74ae99ec436df63d77d2c

employeeTeamIdstring nullable

e.g. team_c0645dc026a74ae99ec436df63d77d2c

matterIdstring nullable

e.g. matter_c0645dc026a74ae99ec436df63d77d2c

billingStageIdstring nullable

e.g. matterbillingstage_c0645dc026a74ae99ec436df63d77d2c

invoiceIdstring nullable

e.g. invoice_c0645dc026a74ae99ec436df63d77d2c

entryDatestring date-time

When was the work done

durationTicksinteger nullable

Duration of this work item. Actual value billed is rounded up to the nearest Unit. There are 10 million ticks in a second.

unitsnumber double nullable

Quantity of work. Each unit translates to a number of minutes depending on the firm's policy and agreement with the client.

Response

OK

successboolean
reasonstring nullable
resultCode0 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110

Represents the outcome of a command execution. Used to indicate success or the reason for failure when a command does not succeed.

sourceIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.