Cancelar receita parcelada

POST

/simplificav2/receita_parcelada/:id/cancelar

Cancela uma receita parcelada e interrompe as parcelas ainda em aberto.

Authentication

AuthorizationBearer

Token privado usado para consultar dados da plataforma.

Como usar:

obtenha o token privado da sua empresa;
envie Authorization: Bearer SEU_TOKEN_PRIVADO;
não use x-api-key neste módulo.

Token privado usado para consultar dados da plataforma. Como usar: - obtenha o token privado da sua empresa; - envie `Authorization: Bearer SEU_TOKEN_PRIVADO`; - não use `x-api-key` neste módulo.

Path parameters

idintegerRequired

Identificador da receita parcelada.

Request

This endpoint expects an object.

motivostringRequired<=4000 characters

Response

Receita parcelada cancelada com sucesso.

statusstring

mensagemstring

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/receita_parcelada/1/cancelar \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"motivo": "Cancelamento solicitado pela integração."
>	}'

1	{
2	"status": "sucesso",
3	"mensagem": "Receita parcelada cancelada com sucesso.",
4	"data": {
5	"id": 118
6	}
7	}