v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Payables

Cancel a Payable

Cancel an existing Payable. For full details on when you can cancel payables, see our help docs.

post/v1/payables/{id}/cancel

Path parameters

idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The ID for the resource being accessed.

Request body

acting_team_memberstring uuid required

The TeamMember ID performing this action. This will be displayed in the Routable Dashboard and also used in any emails sent as a result of this cancellation.

cancel_in_accounting_softwareboolean

Determines whether to post this action in your accounting software (true) or Routable only (false).

Response

OK

OR
OR
OR
OR
OR

Example response

{
  "created_at": "2021-05-15T03:49:53.299680+00:00",
  "pay_to_payment_method": {
    "type_details": {
      "primary_color": "#0075a3"
    }
  },
  "send_on": "2022-11-26",
  "withdraw_from_account": {
    "type_details": {
      "primary_color": "#0075a3"
    }
  },
  "type_details": {
    "receiver": {
      "transaction_id": "IK746XVY",
      "trace_id": "1d5a5516babb4bfb9d2c091bd5ffc15c"
    },
    "sender": {
      "transaction_id": "IK746XVY",
      "trace_id": "1d5a5516babb4bfb9d2c091bd5ffc15c"
    },
    "transaction_id": "IK746XVY"
  }
}