Delete

Delete a payroll. Cannot delete payrolls in Processing or Completed status.

DELETE /v1/payrolls/{payrollId}

Delete

cURL

curl --request DELETE \
  --url https://api.cadanapay.com/v1/payrolls/{payrollId} \
  --header 'Authorization: Bearer <token>'

400

{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey · string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

payrollId · string<uuid> · required

The unique identifier for the payroll

Response

204

Successful operation