Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Receivables

Cancel a Receivable

Cancel an Receivable. For full details on when you can cancel Receivables, see our help docs.

post/v1/receivables/{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

Example response

{
  "created_at": "2021-05-15T03:49:53.299680+00:00",
  "deposit_into_account": {
    "type_details": {
      "primary_color": "#0075a3"
    }
  },
  "send_on": "2022-11-26"
}