---
title: "Busca do boleto."
method: GET
path: "/bill/{id}"
tags: ["Bill"]
---

# Busca do boleto.

`GET /bill/{id}`

## Path parameters

- `id` string, required

## Response `200`

Success

- Bill — Classe `Bill` Modelo de boleto.
  - `id` string — Propriedade `Id` Identificador único gerado automaticamente.
  - `walletCode` integer — Propriedade `WalletCode` Código da carteira.
  - `requestId` string, nullable — Propriedade `RequestId` Identificador único da requisição.
  - `bankNumber` integer — Propriedade `BankNumber` Identificador nosso número.
  - `billNumber` integer, nullable — Propriedade `BillNumber` Número de identificação do boleto.
  - `billReferenceNumber` integer, nullable — Propriedade `BillReferenceNumber` Número Referência Atual Cadastro Título.
  - `beneficiary` BillBeneficiary — Classe `BillBeneficiary` Modelo de beneficiário do boleto.
    - `name` string, nullable — Propriedade `Name` Nome ou Razão Social do beneficiário.
    - `documentType` 'CNPJ' | 'CPF' | 'ESTRANGEIRO' — Tipo de Documento.<p>Values:</p><ul><li><i>CNPJ</i> - CNPJ.</li><li><i>CPF</i> - CPF.</li><li><i>ESTRANGEIRO</i> - Estrangeiro.</li></ul>
    - `document` string, nullable — Propriedade `Document` CPF ou CNPJ do beneficiário.
  - `beneficiaryFinal` BillBeneficiary — Classe `BillBeneficiary` Modelo de beneficiário do boleto.
    - `name` string, nullable — Propriedade `Name` Nome ou Razão Social do beneficiário.
    - `documentType` 'CNPJ' | 'CPF' | 'ESTRANGEIRO' — Tipo de Documento.<p>Values:</p><ul><li><i>CNPJ</i> - CNPJ.</li><li><i>CPF</i> - CPF.</li><li><i>ESTRANGEIRO</i> - Estrangeiro.</li></ul>
    - `document` string, nullable — Propriedade `Document` CPF ou CNPJ do beneficiário.
  - `payer` Payer — Classe `Payer` Modelo do pagador.
    - `name` string, nullable — Propriedade `Name` Nome ou Razão Social do pagador.
    - `documentType` 'CNPJ' | 'CPF' | 'ESTRANGEIRO' — Tipo de Documento.<p>Values:</p><ul><li><i>CNPJ</i> - CNPJ.</li><li><i>CPF</i> - CPF.</li><li><i>ESTRANGEIRO</i> - Estrangeiro.</li></ul>
    - `document` string, nullable — Propriedade `Document` CPF ou CNPJ do pagador.
    - `address` string, nullable — Propriedade `Address` Rua, Número e Complemento do pagador.
    - `city` string, nullable — Propriedade `City` Cidade do pagador.
    - `state` string, nullable — Propriedade `State` Sigla da Unidade da Federação do pagador.
    - `zipCode` string, nullable — Propriedade `ZipCode` CEP do pagador.
  - `barcode` string, nullable — Propriedade `Barcode` Número código de barras.
  - `digitableLine` string, nullable — Propriedade `DigitableLine` Número Linha Digitável.
  - `nominalValue` number, double — Propriedade `NominalValue` Valor nominal do boleto.
  - `paidValue` number, double — Propriedade `PaidValue` Valor pago do boleto.
  - `issueDate` string, nullable — Propriedade `IssueDate` Data de emissão do boleto.
  - `dueDate` string, nullable — Propriedade `DueDate` Data de Vencimento do boleto.
  - `documentKind` 'DUPLICATA_MERCANTIL' | 'DUPLICATA_SERVICO' | 'OUTROS' | 'DEPOSITO_APORTE' — Valores `DocumentKind` Código Espécie da cobrança.<p>Values:</p><ul><li><i>DUPLICATA_MERCANTIL</i> - Duplicata Mercantil.</li><li><i>DUPLICATA_SERVICO</i> - Duplicata de Serviço.</li><li><i>OUTROS</i> - Outros.</li><li><i>DEPOSITO_APORTE</i> - Boleto de Depósito e Aporte.</li></ul>
  - `paymentType` 'TOTAL' | 'DIVERGENTE' | 'PARCIAL' — Valores `PaymentType` Tipo de Pagamento do boleto.<p>Values:</p><ul><li><i>TOTAL</i> - Aceita apenas um único pagamento no valor total do boleto, incluindo juros, multas e descontos.</li><li><i>DIVERGENTE</i> - Aceita apenas um único pagamento no valor definido entre o intervalo dos campos maxValue e minValue.</li><li><i>PARCIAL</i> - Aceite a quantidade de pagamentos estipulada no campo partials no valor definido entre o intervalo dos campos maxValue e minValue.</li></ul>
  - `status` 'PROCESSAMENTO' | 'REJEITADO' | 'REGISTRADO' | 'BAIXADO' | 'LIQUIDADO_PARCIAL' | 'LIQUIDADO_INTEGRAL' | 'CANCELADO' | 'EXPIRADO' — Valores `BillStatus` Situação do boleto.<p>Values:</p><ul><li><i>PROCESSAMENTO</i> - Processamento.</li><li><i>REJEITADO</i> - Rejeitado.</li><li><i>REGISTRADO</i> - Registrado.</li><li><i>BAIXADO</i> - Baixado.</li><li><i>LIQUIDADO_PARCIAL</i> - Liquidado parcial.</li><li><i>LIQUIDADO_INTEGRAL</i> - Liquidado integral.</li><li><i>CANCELADO</i> - Cancelado.</li><li><i>EXPIRADO</i> - Expirado.</li></ul>
  - `maxValue` number, double, nullable — Propriedade `MaxValue` Valor Máximo aceito para pagamento.
  - `minValue` number, double, nullable — Propriedade `MinValue` Valor Mínimo aceito para pagamento.
  - `partials` integer, nullable — Propriedade `Partials` Quantidade de pagamento parcial.
  - `discount` Discount — Classe `Discount` Modelo de desconto do pagamento.
    - `discountType` 'DATA_FIXA' | 'DIA_CORRIDO' | 'DIA_UTIL' — Valores `DiscountType` Código de Desconto do pagamento.<p>Values:</p><ul><li><i>DATA_FIXA</i> - Valor Fixo até a data informada. Permite até 3 registros de desconto, sendo obrigatório especificar o valor e a data limite.</li><li><i>DIA_CORRIDO</i> - Valor por antecipação dia corrido. Permite apenas um único registro de desconto (discountOne) e só o atributo value deve ser preenchido</li><li><i>DIA_UTIL</i> - Valor por antecipação dia útil. Permite apenas um único registro de desconto (discountOne) e só o atributo value deve ser preenchido</li></ul>
    - `discountOne` DiscountInfo — Classe `DiscountInfo` Modelo de informação de desconto do pagamento.
      - `value` number, double — Propriedade `Value` Valor de Desconto do pagamento.
      - `limitDate` string, nullable — Propriedade `LimitDate` Data de Desconto do pagamento.
    - `discountTwo` DiscountInfo — Classe `DiscountInfo` Modelo de informação de desconto do pagamento.
      - `value` number, double — Propriedade `Value` Valor de Desconto do pagamento.
      - `limitDate` string, nullable — Propriedade `LimitDate` Data de Desconto do pagamento.
    - `discountThree` DiscountInfo — Classe `DiscountInfo` Modelo de informação de desconto do pagamento.
      - `value` number, double — Propriedade `Value` Valor de Desconto do pagamento.
      - `limitDate` string, nullable — Propriedade `LimitDate` Data de Desconto do pagamento.
  - `deductionValue` number, double — Propriedade `DeductionValue` Valor de Abatimento do valor nominal por antecipação do pagamento.
  - `fine` Fine — Classe `Fine` Modelo de multa do pagamento.
    - `percentage` number, double — Propriedade `Percentage` Percentual de Multa do pagamento.
    - `daysAmount` integer — Propriedade `DaysAmount` Quantidade de Dias de Multa após vencimento do pagamento.
  - `interestPercentage` number, double, nullable — Propriedade `InterestPercentage` Percentual de Juros do pagamento.
  - `settleDaysAmount` integer — Propriedade `SettleDaysAmount` Quantidade de Dias de Baixa após vencimento.
  - `receivableScheduleDelay` integer — Propriedade `ReceivableScheduleDelay` Atraso do agendamento do recebimento.
  - `tags` Tag[], nullable
    - `key` string, nullable — Propriedade `Name` Chave da tag.
    - `value` string, nullable — Propriedade `Name` Valor da tag.
  - `created` string, date-time — Propriedade `Created` Data de inclusão.
  - `updated` string, date-time, nullable — Propriedade `Updated` Data de alteração.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Server Error

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)