Kickoff

Request Information
URL POST {{basepath}}/api/:project/payable/:payable-id/kickoff
CategoryPayable

Description

Starts the process of generating the steps for the payable.

Makes a payable.

Requires body of {}

Returns a PayableKickoffResponse

Url variables
:project{{project}}
:payable-id{{payable_id}}
Header
Content-Typeapplication/json
JSON
{}

Example responses

Kickoff - but the payable is already open
Request Method & URL
POST {{basepath}}/api/:project/payable/:payable-id/kickoff
Request Body:
{}
Url variables
:project{{project}}
:payable-id{{payable_id}}
Response Code:
408 Request Timeout
Response Body:
{
    "responseId": "2_a8291b2b30d624084910782caa0dd5655bdb3f80",
    "status": "error",
    "errorCode": "invalid_status",
    "errorMessage": "You cannot kick off a payable in status open"
}
Kickoff payable
Request Method & URL
POST {{basepath}}/api/:project/payable/:payable-id/kickoff
Request Body:
{}
Url variables
:project{{project}}
:payable-id{{payable_id}}
Response Code:
200 OK
Response Body:
{
    "responseId": "2_1d99129405ba8d97ed73993eec4315ccc24e8378",
    "message": "Payable has been queued for kickoff",
    "identifier": "3_2_88b60c63650c8a274d535206c6781cf5577f722b1637853158"
}