Destroy one

Deletes a draft bank payroll together with all its attached bank
transactions.

The teardown runs asynchronously: eligibility is checked synchronously
(so an ineligible payroll still gets an immediate 422) and the deletion
itself is handed to a background job. A successful call therefore answers
202 Accepted with the payroll as it was before the teardown — it is
not yet deleted in that body. Poll
GET /v1/banking/bank_payrolls/{bank_payroll_id} to observe the final state.

Only a clean draft can be deleted: status: draft, no transition in flight,
and no already-processed (terminal) transfers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the payroll

Headers
uuid
required

UUID of the company on whose behalf the request is made. Send it on banking
requests to identify the acting company. Note that user-scoped list endpoints
(e.g. the recipients/transactions indexes) resolve results across all companies
the authenticated user is a member of, rather than strictly from this header.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json