Cancel Receivables

Description

Cancels a list of receivables previously registered in the system. The endpoint allows you to provide the IDs of the receivables that should be canceled, and accounts for the operation by branch when informed.

The cancellation behavior varies according to the status and payment method of the receivable in EVO:

If the receivable has already been received, it will be marked as “Canceled” and an outstanding balance will be generated.

If the receivable is open and has a payment method other than outstanding balance, it will be marked as “Canceled” and an outstanding balance will be generated.

If the receivable has the payment method “outstanding balance”, it will only be marked as “Canceled”, without generating a new outstanding balance.

🔑 Query Parameters

Parameter	Type	Required	Description
`idBranch`	`int32`	No	Filter by branch for cancellation accounting. Applicable only for multi-branch token.

📨 Request Body

Field	Type	Required	Description
`idsReceivables`	`array<int32>`	Required	List of IDs of the receivables to be canceled.
`reason`	`string`	Required	List of IDs of the receivables to be canceled.

📤 Response Structure

The response presents the status of the receivables cancellation request.

Field	Type	Description
`success`	`boolean`	Indicates whether the cancellation was completed successfully.
`messageError`	`string`	Error message in case `success`=`false`. Otherwise, it will have the value `null`.
`canceledReceivables`	`array<int32>`	List of IDs of the canceled receivables.
`ignoredReceivables`	`array<int32>`	List of IDs of the receivables ignored and not canceled in the flow.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

Body Params

application/json-patch+json

Example

{
    "idsReceivables": [
        0
    ],
    "reason": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Cancels a list of receivables

Cancel Receivables#

Description#

🔑 Query Parameters#

📨 Request Body#

📤 Response Structure#