> ## Documentation Index
> Fetch the complete documentation index at: https://bmpmoneyplus-sandbox.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 19 - Contract Cancellation

Through this endpoint, the partner can cancel a previously established proposal. To use this functionality, consider the following requirements:

* The proposal cannot have a paid status or be linked to a payment batch;
* The proposal cannot be ceded or linked to a cession batch;
* The maximum cancellation period for the proposal is up to seven days.

<Expandable title="Messaging - Proposta Cancelar">
  | Category | Operation        | Action   | Code  | Detailed Code | Message                                                                                                      |
  | -------- | ---------------- | -------- | ----- | ------------- | ------------------------------------------------------------------------------------------------------------ |
  | Proposta | PropostaCancelar | Cancelar | C0067 | V0001         | Não é permitido o cancelamento da proposta por este parceiro                                                 |
  | Proposta | PropostaCancelar | Cancelar | C0067 | V0002         | Situação da Proposta não permite Cancelamento                                                                |
  | Proposta | PropostaCancelar | Cancelar | C0067 | V0003         | Situação da Proposta não permite Cancelamento                                                                |
  | Proposta | PropostaCancelar | Cancelar | C0067 | V0004         | Prazo para cancelamento de `{nroDiasCancelamento}` dias foi ultrapassado                                     |
  | Proposta | PropostaCancelar | Cancelar | C0067 | V0005         | Situação da Proposta não permite Cancelamento                                                                |
  | Proposta | PropostaCancelar | Cancelar | C0067 | V0006         | Situação da Proposta não permite Cancelamento                                                                |
  | Proposta | PropostaCancelar | Cancelar | C0067 | V0007         | Situação da Proposta não permite Cancelamento                                                                |
  | Proposta | PropostaCancelar | Cancelar | C0067 | V0008         | Proposta não pode ser aprovada, pois sua situação é `{SituacaoPropostaEnum.GetDescricao(proposta.Situacao)}` |
  | Proposta | PropostaCancelar | Cancelar | C0112 | V0001         | Proposta não encontrada                                                                                      |
  | Proposta | PropostaCancelar | Cancelar | C0112 | V0002         | A Proposta não pertence à esta Integração                                                                    |
  | Proposta | PropostaCancelar | Cancelar | C0194 | V0001         | Proposta não localizada                                                                                      |
  | Proposta | PropostaCancelar | Cancelar | C0194 | V0002         | Proposta já foi cancelada                                                                                    |
  | Proposta | PropostaCancelar | Cancelar | C0194 | V0003         | Proposta está em uma Cessão, não é possível cancelar                                                         |
  | Proposta | PropostaCancelar | Cancelar | C0194 | V0004         | Informe o motivo de cancelamento                                                                             |
  | Proposta | PropostaCancelar | Cancelar | C0194 | V0005         | Proposta foi enviada na remessa de pagamento                                                                 |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0001         | Informe o valor aprovado e a quantidade de parcelas                                                          |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0002         | Valor aprovado não pode ser superior ao valor solicitado                                                     |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0003         | Valor/Prazo aprovado não pode ser diferente do Valor/Prazo solicitado                                        |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0004         | A Proposta deve ter pelo menos 1(um) Assinante cadastrado                                                    |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0005         | É necessário informar o E-mail e Celular de todos os Assinantes                                              |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0006         | Proposta não deve ter boletos.                                                                               |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0007         | Motivo de Rejeição deve ser informado                                                                        |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0008         | Valor e Prazo não podem ser alterados quando o cálculo da parcela é sem juros                                |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0009         | Percentual de Juros deve ser informado                                                                       |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0010         | Valor da Parcela deve ser informado                                                                          |
  | Proposta | PropostaCancelar | Cancelar | C0185 | V0011         | Proposta deve ter parcelas geradas antes de ser finalizada.                                                  |
</Expandable>


## OpenAPI

````yaml post /Proposta/Cancelar
openapi: 3.0.1
info:
  title: BMPDigitalCore.ApiExterna.Proposta.API
  version: '1.0'
servers:
  - url: https://api.bmpdigital.moneyp.dev.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /Proposta/Cancelar:
    post:
      tags:
        - Proposta
      parameters:
        - name: IdempotencyKey
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropostaCancelarCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/PropostaCancelarCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PropostaCancelarCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            text/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
components:
  schemas:
    PropostaCancelarCommand:
      type: object
      properties:
        dto:
          $ref: '#/components/schemas/FindPropostaDTO'
        textoMotivoCancelamento:
          type: string
          description: Campo para inserção do motivo do cancelamento
          nullable: true
        parametros:
          type: array
          items:
            $ref: '#/components/schemas/ParametroDTO'
          nullable: true
      additionalProperties: false
    ActionResponse:
      type: object
      properties:
        msg:
          type: string
          nullable: true
        result:
          type: boolean
          writeOnly: true
        hasError:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
        parametros:
          type: array
          items:
            $ref: '#/components/schemas/ParametroDTO'
          nullable: true
      additionalProperties: false
    ResponseBase:
      type: object
      properties:
        msg:
          type: string
          nullable: true
        result:
          type: boolean
          writeOnly: true
        hasError:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
      additionalProperties: false
    FindPropostaDTO:
      type: object
      properties:
        codigoProposta:
          type: string
          description: Código identificador da proposta
          format: uuid
          nullable: true
        codigoOperacao:
          type: string
          description: Código da operação do parceiro
          nullable: true
        numeroProposta:
          type: integer
          description: Número sequencial da proposta
          format: int64
          nullable: true
      additionalProperties: false
    ParametroDTO:
      type: object
      properties:
        nome:
          type: string
          description: Refere-se ao nome do parâmetro.
          nullable: true
        valor:
          type: string
          description: Refere-se ao valor do parâmetro.
          nullable: true
      additionalProperties: false
    Message:
      type: object
      properties:
        messageType:
          $ref: '#/components/schemas/ErrorType'
        code:
          type: string
          nullable: true
        context:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        field:
          type: string
          nullable: true
      additionalProperties: false
    ErrorType:
      enum:
        - 1
        - 2
        - 3
      type: integer
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Informe o token
      name: Authorization
      in: header

````