---
title: "Emissão de boleto com faixas de desconto"
method: POST
path: "/pj/forintegration/cobranca/v3/boletos/simplificado"
tags: ["Emissão de boleto"]
---

# Emissão de boleto com faixas de desconto

`POST /pj/forintegration/cobranca/v3/boletos/simplificado`

## Request

- The document declares no server URL.
- Auth: none declared

## Request body

- Bs2PjCobrancaBoletosCriarBoletoSimplificadoCriarBoletoSimplificadoV3: CriarBoletoSimplificadoDto
  - `seuNumero` string, nullable: Campo para definição de número para o boleto à escolha do cliente, aceita apenas números e letras. Não é obrigatório! Em caso de não enviar, geramos uma numeração automática para este campo em nossa camada do BS2
  - `cliente` Bs2PjCobrancaBoletosCriarBoletoSimplificadoCliente, required: ClienteDto
    - `clienteId` string, uuid: Campo para informar o id de um cliente previamente cadastrado na criação de outro boleto, no response deste endpoint será devolvido um ClienteID. Caso não deseje informar todos os dados novamente neste objeto "Cliente", informe apenas o ClienteId. Se for for o primeiro boleto deste cliente, será obrigatório o envio dos dados, e este campo não deve ser informado!
    - `telefone` string, nullable: Telefone do cliente. Exemplo: “11950505050” ou “1147810100”
    - `email` string, nullable: E-mail do cliente. Exemplo: joao@bs2.com.br
    - `tipo` 1 | 2: 1 - Fisica, 2 - Juridica
    - `documento` string, nullable: Cpf ou Cnpj. Exemplo: Cnpj: 24401281000152 ou Cpf: 75956344075
    - `nome` string, nullable: Nome Pessoa Física ou Razão Social/Nome Fantasia
    - `endereco` Bs2PjCompartilhadosEndereco: EnderecoDto
      - `cep` string, nullable: Exemplo: 04543011
      - `estado` string, nullable: Apenas Siglas SP, MG, RJ
      - `cidade` string, nullable: Exemplo: São Paulo
      - `bairro` string, nullable: Exemplo: Vila Olímpia
      - `logradouro` string, nullable: Exemplo: Av. Pres. Juscelino Kubitschek
      - `numero` string, nullable: Exemplo: KM 10 - Aceita apenas letras e números (sem caracteres especiais)
      - `complemento` string, nullable: Caso o número contenha caracteres especiais, informar neste campo complemento.
  - `sacadorAvalista` Bs2PjCobrancaBoletosCompartilhadosSacadorAvalista: Sacador/Avalista não são obrigatórios, mas uma vez que se informe o CPF/CNPJ do mesmo, é preciso que informe os demais dados do Avalista.
    - `tipo` 1 | 2: 1 - Fisica, 2 - Juridica
    - `documento` string, nullable: Cpf ou Cnpj. Exemplo: Cnpj: 24401281000152 ou Cpf: 75956344075
    - `nome` string, nullable: Nome Pessoa Física ou Razão Social/Nome Fantasia
    - `endereco` Bs2PjCompartilhadosEndereco: EnderecoDto
      - `cep` string, nullable: Exemplo: 04543011
      - `estado` string, nullable: Apenas Siglas SP, MG, RJ
      - `cidade` string, nullable: Exemplo: São Paulo
      - `bairro` string, nullable: Exemplo: Vila Olímpia
      - `logradouro` string, nullable: Exemplo: Av. Pres. Juscelino Kubitschek
      - `numero` string, nullable: Exemplo: KM 10 - Aceita apenas letras e números (sem caracteres especiais)
      - `complemento` string, nullable: Caso o número contenha caracteres especiais, informar neste campo complemento.
  - `vencimento` string, date-time, required: Data de vencimento do boleto, deverá ser maior ou igual que a data atual. Exemplo: 2019-03-28
  - `valor` number, double, required: Valor da cobrança original
  - `canal` string, nullable: Caso o boleto possua beneficiário final, informar neste campo.
  - `multa` Bs2PjCobrancaBoletosCompartilhadosMulta: Multas e juros do boleto
    - `valor` number, double, nullable: Valor percentual que será cobrado uma vez após o vencimento do boleto.
    - `data` string, date-time, nullable: Data a partir da qual será cobrado os valores de multa correspondentes.
    - `juros` number, double, nullable: Juros da multa (Percentual) a partir de qual valor diário (percentual) que será cobrado de juros caso o boleto não tenha sido pago até o vencimento. Exemplo: 15
  - `desconto` Bs2PjCobrancaBoletosCriarBoletoSimplificadoDescontoFaixas: Faixas de desconto
    - `tipo` 0 | 1 | 2: 0-Isento, 1-ValorFixoAteDataInformada, 2-ValorPercentualAteDataInformada
    - `faixas` Bs2PjCobrancaBoletosCriarBoletoSimplificadoDescontoFaixa[], nullable: Lista de faixas de desconto usadas para conceder diferentes descontos de acordo com a data de pagamento do boleto. Só é possível informar até 3 faixas.
      - `limite` string, date-time: Data limite para aplicação do desconto. Se houver um desconto subsequente informado, ele será ativado no dia seguinte.
      - `valor` number, double: Valor do desconto para essa faixa específica. Se o tipo for fixo informar decimal em R$. Se for percentual informar o valor entre 0 e 100.
  - `mensagem` Bs2PjCobrancaBoletosCompartilhadosMensagem: MensagemDto
    - `linha1` string, nullable: Mensagem 1 de instrução do boleto.
    - `linha2` string, nullable: Mensagem 2 de instrução do boleto.
    - `linha3` string, nullable: Mensagem 3 de instrução do boleto.
    - `linha4` string, nullable: Mensagem 4 de instrução do boleto.
  - `aceite` boolean, nullable: Campo para definição de aceite do boleto para casos de protesto do título
  - `especie` string, nullable: Código para identificar o tipo de boleto de pagamento de cobrança. Valores válidos: - "0" = Duplicata Mercantil - "6" = Duplicata de Serviço - "9" = Outros
  - `dataLimitePagamento` string, date-time, nullable: Data limite para pagamento
  - `carteira` 11 | 21 | 31 | 41: 11-Desconto, 21-CobrancaSimples, 31-CobrancaCaucionada, 41-CobrancaVinculada

## Response `201`

Success

- Bs2PjCobrancaBoletosCompartilhadosBoletoCriadoV3: BoletoCriadoDto v3
  - `seuNumero` string, required: Seu número (identificador do boleto). Exemplo: 25962
  - `clienteId` string, uuid, required: Código do cliente. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  - `sacadorAvalista` Bs2PjCobrancaBoletosCompartilhadosSacadorAvalista: Sacador/Avalista não são obrigatórios, mas uma vez que se informe o CPF/CNPJ do mesmo, é preciso que informe os demais dados do Avalista.
    - `tipo` 1 | 2: 1 - Fisica, 2 - Juridica
    - `documento` string, nullable: Cpf ou Cnpj. Exemplo: Cnpj: 24401281000152 ou Cpf: 75956344075
    - `nome` string, nullable: Nome Pessoa Física ou Razão Social/Nome Fantasia
    - `endereco` Bs2PjCompartilhadosEndereco: EnderecoDto
      - `cep` string, nullable: Exemplo: 04543011
      - `estado` string, nullable: Apenas Siglas SP, MG, RJ
      - `cidade` string, nullable: Exemplo: São Paulo
      - `bairro` string, nullable: Exemplo: Vila Olímpia
      - `logradouro` string, nullable: Exemplo: Av. Pres. Juscelino Kubitschek
      - `numero` string, nullable: Exemplo: KM 10 - Aceita apenas letras e números (sem caracteres especiais)
      - `complemento` string, nullable: Caso o número contenha caracteres especiais, informar neste campo complemento.
  - `vencimento` string, date-time, required: Data de vencimento do boleto, deverá ser maior ou igual que a data atual. Exemplo: 2019-03-28
  - `valor` number, double, required: Valor o boleto, deverá ser maior que ZERO. Exemplo: 99.25
  - `canal` string, nullable: Apelido para identificação do Beneficiário. Exemplo: Bs2 Hub
  - `multa` Bs2PjCobrancaBoletosCompartilhadosMulta: Multas e juros do boleto
    - `valor` number, double, nullable: Valor percentual que será cobrado uma vez após o vencimento do boleto.
    - `data` string, date-time, nullable: Data a partir da qual será cobrado os valores de multa correspondentes.
    - `juros` number, double, nullable: Juros da multa (Percentual) a partir de qual valor diário (percentual) que será cobrado de juros caso o boleto não tenha sido pago até o vencimento. Exemplo: 15
  - `desconto` Bs2PjCobrancaBoletosCriarBoletoSimplificadoDescontoFaixas: Faixas de desconto
    - `tipo` 0 | 1 | 2: 0-Isento, 1-ValorFixoAteDataInformada, 2-ValorPercentualAteDataInformada
    - `faixas` Bs2PjCobrancaBoletosCriarBoletoSimplificadoDescontoFaixa[], nullable: Lista de faixas de desconto usadas para conceder diferentes descontos de acordo com a data de pagamento do boleto. Só é possível informar até 3 faixas.
      - `limite` string, date-time: Data limite para aplicação do desconto. Se houver um desconto subsequente informado, ele será ativado no dia seguinte.
      - `valor` number, double: Valor do desconto para essa faixa específica. Se o tipo for fixo informar decimal em R$. Se for percentual informar o valor entre 0 e 100.
  - `mensagem` Bs2PjCobrancaBoletosCompartilhadosMensagem: MensagemDto
    - `linha1` string, nullable: Mensagem 1 de instrução do boleto.
    - `linha2` string, nullable: Mensagem 2 de instrução do boleto.
    - `linha3` string, nullable: Mensagem 3 de instrução do boleto.
    - `linha4` string, nullable: Mensagem 4 de instrução do boleto.
  - `aceite` boolean, nullable: Aceite
  - `especie` string, nullable: Código para identificar o tipo de boleto de pagamento de cobrança. Valores válidos: - "0" = Duplicata Mercantil - "6" = Duplicata de Serviço - "9" = Outros
  - `id` string, uuid: Código do boleto. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  - `sacado` Bs2PjCobrancaBoletosCompartilhadosSacado: Sacado é aquele que paga o boleto, normalmente é um cliente.
    - `email` string, nullable: E-mail do sacado. Exemplo: joao@bs2.com.br
    - `telefone` string, nullable: Telefone do sacado. Exemplo: 11944440000
    - `tipo` 1 | 2: 1 - Fisica, 2 - Juridica
    - `documento` string, nullable: Cpf ou Cnpj. Exemplo: Cnpj: 24401281000152 ou Cpf: 75956344075
    - `nome` string, nullable: Nome Pessoa Física ou Razão Social/Nome Fantasia
    - `endereco` Bs2PjCompartilhadosEndereco: EnderecoDto
      - `cep` string, nullable: Exemplo: 04543011
      - `estado` string, nullable: Apenas Siglas SP, MG, RJ
      - `cidade` string, nullable: Exemplo: São Paulo
      - `bairro` string, nullable: Exemplo: Vila Olímpia
      - `logradouro` string, nullable: Exemplo: Av. Pres. Juscelino Kubitschek
      - `numero` string, nullable: Exemplo: KM 10 - Aceita apenas letras e números (sem caracteres especiais)
      - `complemento` string, nullable: Caso o número contenha caracteres especiais, informar neste campo complemento.
  - `status` 1 | 2 | 3 | 4: 1-Aberto, 2-Vencido, 3-Cancelado, 4-Pago
  - `nossoNumero` integer, nullable: Nosso Número. Exemplo: 10008600128
  - `codigoDeBarra` string, nullable: Código de barra do boleto. Exemplo: 21095787100000000000010000000000000000000000
  - `linhaDigitavel` string, nullable: Linha Digitavel do boleto. Exemplo: 21090010070000000000000860000000000000000000000
  - `beneficiarioFinal` Bs2PJDomainCobrancaModelsBoletosAvulsoBoletoAggregateBeneficiarioFinal
    - `razaoSocial` string, nullable
    - `nomeFantasia` string, nullable
    - `documento` string, nullable

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/bs2/apis/api-emiss-o-de-boleto-com-faixas-de-desconto.md) - [All operations](https://skmtc.dev/bs2/apis/api-emiss-o-de-boleto-com-faixas-de-desconto/llms.txt) - [OpenAPI document](https://skmtc.dev/bs2/apis/api-emiss-o-de-boleto-com-faixas-de-desconto/revisions/413026885b22?raw)