---
title: "GetBoletoInById"
method: POST
path: "/GetBoletoInById"
tags: ["Consult Boleto"]
---

# GetBoletoInById

`POST /GetBoletoInById`

More performant version than GetBoletoById. Use to get a boleto by DocumentNumber.

## Request body

- object
  - `Method` string, required
  - `PartnerId` number, required
  - `BusinessUnitId` number, required
  - `DocumentNumber` number, required

## Response `200`

Ok

- object
  - `Success` string
  - `Boleto` object
    - `boletoInId` integer
    - `operationId` integer
    - `status` integer, nullable
    - `ourNumber` string, nullable
    - `externalNumber` string, nullable
    - `identifier` string, nullable
    - `barcode` string, nullable
    - `digitableLine` string, nullable
    - `url` string, nullable
    - `date` object
      - `creation` string, date-time, nullable
      - `dueDate` string, date-time, nullable
      - `deadline` string, date-time, nullable
      - `cancel` string, date-time, nullable
    - `values` object
      - `principalValue` number, double, nullable
      - `interest` object
        - `value` number, double, nullable
        - `percent` number, double, nullable
        - `type` integer, nullable
        - `date` string, date-time, nullable
      - `fine` object
        - `value` number, double, nullable
        - `percent` number, double, nullable
        - `date` string, date-time, nullable
      - `discount` object[]
        - `value` number, double, nullable
        - `date` string, date-time, nullable
      - `rebateValue` number, double, nullable
      - `divergentPayment` object
        - `type` integer, nullable
        - `minValue` number, double, nullable
        - `maxValue` number, double, nullable
    - `toSend` object
      - `mail` string, nullable
      - `phone` string, nullable
    - `supplier` object
      - `name` string, nullable
      - `taxNumber` string, nullable
      - `banks` object
        - `code` integer, nullable
        - `branch` string, nullable
        - `account` string, nullable
        - `accountDigit` string, nullable
    - `customer` object
      - `name` string, nullable
      - `taxNumber` string, nullable
      - `mail` string, nullable
      - `phone` string, nullable
      - `address` object
        - `addressLine1` string, nullable
        - `addressLine2` string, nullable
        - `city` string, nullable
        - `state` string, nullable
        - `neighborhood` string, nullable
        - `zipCode` string, nullable
    - `split` object[]
      - `product` object
        - `reference` string, nullable
        - `name` string, nullable
        - `quantity` integer, nullable
        - `value` number, double, nullable
        - `receiver` object
          - `name` string, nullable
          - `taxNumber` string, nullable
          - `banks` object
            - `code` integer, nullable
            - `branch` string, nullable
            - `account` string, nullable
            - `accountDigit` string, nullable
        - `seller` object
          - `name` string, nullable
          - `taxNumber` string, nullable
    - `paymentInfo` object, nullable
      - `paymentChannel` integer, nullable
      - `paidValue` number, double, nullable
      - `rebate` number, double, nullable
      - `discount` number, double, nullable
      - `fine` number, double, nullable
      - `interest` number, double, nullable
      - `paymentDate` string, date-time, nullable
      - `creditDate` string, date-time, nullable
      - `payerBankCode` string, nullable
      - `payerBankBranchCode` string, nullable

---

[API](https://skmtc.net/fitbank/apis/onboarding.md) · [All operations](https://skmtc.net/fitbank/apis/onboarding/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fitbank/onboarding/versions/f94d262a8f58/schema)