API reference
Engagements
Committed work per client: one-off or recurring periods, a delivery log, and invoice drafts per period.
- GET
/api/v1/engagementsList engagements - POST
/api/v1/engagementsCreate an engagement - GET
/api/v1/engagements/{id}Get an engagement - DELETE
/api/v1/engagements/{id}Delete an engagement - PATCH
/api/v1/engagements/{id}Update an engagement - GET
/api/v1/engagements/exportExport engagements as CSV - GET
/api/v1/engagements/summarySummarise engagements needing attention - POST
/api/v1/engagements/{id}/cancelCancel an engagement - GET
/api/v1/engagements/{id}/entriesList the entries of an engagement - POST
/api/v1/engagements/{id}/entriesLog work on an engagement - GET
/api/v1/engagements/{id}/entries/exportExport an engagement's entries as CSV - DELETE
/api/v1/engagements/{id}/entries/{entry_id}Delete an entry - PATCH
/api/v1/engagements/{id}/entries/{entry_id}Update an entry - GET
/api/v1/engagements/{id}/periodsList the periods of an engagement - PATCH
/api/v1/engagements/{id}/periods/{period_id}Set a period's quantity - POST
/api/v1/engagements/{id}/periods/{period_id}/invoiceCreate an invoice draft for a period - GET
/api/v1/engagements/{id}/periods/{period_id}/reportDownload a period's service report - POST
/api/v1/engagements/{id}/periods/{period_id}/report/sendEmail a period's service report - POST
/api/v1/engagements/{id}/renewRenew a one-off engagement - POST
/api/v1/engagements/{id}/resumeResume a cancelled engagement