Cancelar Recebíveis

Descrição

Cancela uma lista de recebíveis previamente cadastrados no sistema. O endpoint permite informar os IDs dos recebíveis que devem ser cancelados, e contabiliza a operação por filial quando informado.

O comportamento do cancelamento varia conforme o status e a forma de pagamento do recebível no EVO:

Caso o recebível já tenha sido recebido, ele será marcado como “Cancelado” e será gerado um saldo devedor.

Caso o recebível esteja em aberto e possua forma de pagamento diferente de saldo devedor, ele será marcado como “Cancelado” e será gerado um saldo devedor.

Caso o recebível possua forma de pagamento “saldo devedor”, ele será apenas marcado como “Cancelado”, sem geração de um novo saldo devedor.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idBranch`	`int32`	Não	Filtrar pela filial para contabilização do cancelamento. Aplicável apenas para token multifilial.

📨 Corpo da Requisição (Request Body)

Campo	Tipo	Obrigatoriedade	Descrição
`idsReceivables`	array<int32>	Obrigatório	Lista de IDs dos recebíveis a serem cancelados.
`reason`	string	Obrigatório	Lista de IDs dos recebíveis a serem cancelados.

📤 Estrutura da Resposta

A resposta apresenta o status da solicitação de cancelamento dos recebíveis.

Campo	Tipo	Descrição
`success`	`boolean`	Indica se o cancelamento foi realizado com sucesso.
`messageError`	`string`	Mensagem de erro no caso de `success`=`false`. Caso contrário, terá valor `null`.
`canceledReceivables`	`array\<int32>`	Lista dos IDs dos recebíveis cancelados.
`ignoredReceivables`	`array\<int32>`	Lista dos IDs dos recebíveis ignorados e não cancelados no fluxo.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

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

Parâmetros de Consulta

Parâmetros Body

application/json-patch+json

Exemplo

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

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Cancels a list of receivables

Cancelar Recebíveis

Descrição

🔑 Parâmetros de Consulta (Query Params)

📨 Corpo da Requisição (Request Body)

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Cancels a list of receivables

Cancelar Recebíveis#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📨 Corpo da Requisição (Request Body)#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Cancelar Recebíveis

Descrição

🔑 Parâmetros de Consulta (Query Params)

📨 Corpo da Requisição (Request Body)

📤 Estrutura da Resposta