# Get receivable (deprecated)

Get unique receivable. This endpoint is **DEPRECATED**, use the <a href="https://developers.pismo.io/pismo-docs/reference/validateunicity">Validate receivable</a> endpoint instead.


# 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": {
      "DebtorDocNumberQuery": {
        "in": "query",
        "name": "debtor_document_number",
        "description": "Debtor document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Fisicas number (Brazil). Must not be the same as the lender document number.\n",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "FaceValueQuery": {
        "in": "query",
        "name": "face_value",
        "description": "Face value refers to the nominal or stated value of a financial instrument or asset, typically printed or stated on the instrument itself. It represents the initial value assigned to the instrument at the time of issuance or purchase. Can be up to 16 digits and two decimal places.\n",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "InterOpHoldingNumQuery": {
        "in": "query",
        "name": "interop_holding_number",
        "description": "Client-assigned interop holding number. Same as `holding_number` passed in the Register receivable endpoint.",
        "required": true,
        "schema": {
          "maxLength": 10,
          "minLength": 1,
          "type": "string"
        }
      },
      "LenderDocNumberQuery": {
        "in": "query",
        "name": "lender_document_number",
        "description": "Lender document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Fisicas number (Brazil). Must not be the same as the debtor document number.\n",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "MaturityDateQuery": {
        "in": "query",
        "name": "maturity_date",
        "description": "Maturity date. Format = yyyy-mm-dd.",
        "required": false,
        "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"
      },
      "DebtorDocumentNumber": {
        "type": "string",
        "description": "Debtor document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Fisicas number (Brazil). Must not be the same as the lender document number. \n",
        "maxLength": 14
      },
      "Errors": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "FaceValue": {
        "type": "number",
        "description": "Face value refers to the nominal or stated value of a financial instrument or asset, typically printed or stated on the instrument itself. It represents the initial value assigned to the instrument at the time of issuance or purchase.\n",
        "example": 499.23
      },
      "GetUniqueReceivableResponse": {
        "type": "object",
        "properties": {
          "debtor_document_number": {
            "$ref": "#/components/schemas/DebtorDocumentNumber"
          },
          "face_value": {
            "$ref": "#/components/schemas/FaceValue"
          },
          "interop_holding_number": {
            "$ref": "#/components/schemas/InteropHoldingNumber"
          },
          "lender_document_number": {
            "$ref": "#/components/schemas/LenderDocumentNumber"
          },
          "maturity_date": {
            "$ref": "#/components/schemas/MaturityDate"
          },
          "message": {
            "$ref": "#/components/schemas/Message"
          }
        }
      },
      "GlobalErrorResponse": {
        "type": "object",
        "properties": {
          "correlationId": {
            "$ref": "#/components/schemas/CorrelationID"
          },
          "errors": {
            "$ref": "#/components/schemas/Errors"
          }
        }
      },
      "InteropHoldingNumber": {
        "type": "string",
        "description": "Client-assigned interoperation holding number. Called `holding_number` when passed in the Register receivable endpoint.\n",
        "example": "017917411A"
      },
      "LenderDocumentNumber": {
        "type": "string",
        "description": "Lender document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Fisicas number (Brazil). Should not be the same as the debtor document number. \n",
        "example": "51407165000113"
      },
      "MaturityDate": {
        "type": "string",
        "description": "Maturity date. Format = yyyy-mm-dd. Must be equal to today or later.",
        "example": "2023-06=22"
      },
      "Message": {
        "type": "string",
        "description": "Message",
        "maxLength": 500,
        "example": "Credit rights update request is being processed"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad Request",
        "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": {
      "get": {
        "summary": "Get receivable (deprecated)",
        "description": "Get unique receivable. This endpoint is **DEPRECATED**, use the <a href=\"https://developers.pismo.io/pismo-docs/reference/validateunicity\">Validate receivable</a> endpoint instead.\n",
        "operationId": "get-receivable",
        "deprecated": true,
        "tags": [
          "Receivable"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/InterOpHoldingNumQuery"
          },
          {
            "$ref": "#/components/parameters/LenderDocNumberQuery"
          },
          {
            "$ref": "#/components/parameters/DebtorDocNumberQuery"
          },
          {
            "$ref": "#/components/parameters/MaturityDateQuery"
          },
          {
            "$ref": "#/components/parameters/FaceValueQuery"
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json:": {
                "schema": {
                  "$ref": "#/components/schemas/GetUniqueReceivableResponse"
                }
              }
            },
            "description": "Success message is sent to the client while an unicity validation is processed asynchronously"
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```