# Delete receivable

Delete receivable.

 If deletion fails, a <a href="https://developers.pismo.io/events/docs/depositary-credit-rights-status-change-failure-1" target="_blank">credit_rights_status_change_failure-1</a> event is generated. If deletion succeeds, a <a href="https://developers.pismo.io/events/docs/depositary-credit-rights-status-change-success-1" target="_blank">credit_rights_status_change_success-1</a> event is generated.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Banking - Credit receivables",
    "contact": {
      "email": "support@pismo.com.br",
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "description": "Endpoints to handle contract operations",
    "license": {
      "name": "Copyright Pismo",
      "url": "https://developers.pismo.io/licenses/"
    },
    "termsOfService": "https://developers.pismo.io/terms/",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api-sandbox.pismolabs.io/credit-rights-receivable",
      "description": "Production server"
    }
  ],
  "tags": [
    {
      "name": "Receivable",
      "description": "Endpoints to manage receivables"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "parameters": {
      "InternalNumberPath": {
        "in": "path",
        "name": "internalNumber",
        "description": "Client-assigned internal number.",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "CorrelationID": {
        "type": "string",
        "description": "Correlation ID (CID). This field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If one isn't passed, one is automatically generated. You can find the CID in a response header. \n",
        "example": "88474990237-94940"
      },
      "DeleteReceivableResponse": {
        "type": "object",
        "properties": {
          "internal_number": {
            "type": "string",
            "description": "Client-assigned internal number"
          },
          "message": {
            "type": "string",
            "description": "Deletion message"
          }
        }
      },
      "Errors": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "GlobalErrorResponse": {
        "type": "object",
        "properties": {
          "correlationId": {
            "$ref": "#/components/schemas/CorrelationID"
          },
          "errors": {
            "$ref": "#/components/schemas/Errors"
          }
        }
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GlobalErrorResponse"
            }
          }
        }
      },
      "401Unauthorized": {
        "description": "Missing or invalid access token",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GlobalErrorResponse"
            }
          }
        }
      },
      "500InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GlobalErrorResponse"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "JWT",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "paths": {
    "/v1/credit-rights/{internalNumber}": {
      "delete": {
        "summary": "Delete receivable",
        "description": "Delete receivable.\n\n If deletion fails, a <a href=\"https://developers.pismo.io/events/docs/depositary-credit-rights-status-change-failure-1\" target=\"_blank\">credit_rights_status_change_failure-1</a> event is generated. If deletion succeeds, a <a href=\"https://developers.pismo.io/events/docs/depositary-credit-rights-status-change-success-1\" target=\"_blank\">credit_rights_status_change_success-1</a> event is generated.\n",
        "operationId": "delete-receivable",
        "tags": [
          "Receivable"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/InternalNumberPath"
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json:": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteReceivableResponse"
                }
              }
            },
            "description": "Success message is sent to the client while delete is processed asynchronously"
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```