Sign in

v1

latestOpenAPI 3.0.12026-07-2428103163.2 KB
Organisations
Pay Runs

Cancel pay run

Cancels a pay run which has not yet been started. A pay run may only be cancelled if the following conditions are met:

  • The pay run exists within the system
  • The pay run is in a state that is valid for cancellation

We are unable to cancel pay runs which have been processed or are in progress. See the Statuses documentation for details on which statuses are valid for cancellation.

post/organisations/{organisationId}/pay-runs/{payRunId}/cancel

Path parameters

organisationIdstring uuid required

The unique Crezco ID for an organisation

payRunIdstring uuid required

The unique pay run ID for the pay run

Headers

Crezco-Versionstring

The requested API version

Response

OK

statusstring required
<p> Current status of this pay run. See the <a href="https://crezco.readme.io/reference/statuses">Statuses reference</a> in our documentation for a full description of all possible statuses. </p>

Example response

{
  "status": "Created"
}