--- title: "Emitir um novo boleto." method: POST path: "/pj/forintegration/cobranca/v2/boletos/simplificado" tags: ["Emitir boleto"] --- # Emitir um novo boleto. `POST /pj/forintegration/cobranca/v2/boletos/simplificado` ## Request - The document declares no server URL. - Auth: none declared ## Request body - SwaggerCobrancaBs2PjCobrancaBoletosV2CriarBoletoSimplificadoV2CriarBoletoSimplificado: Payload de emissão de boleto. - `seuNumero` string, nullable: Identificador do boleto definido pelo próprio emissor, usado para reconhecimento no seu sistema (ex.: número da venda ou nota fiscal). Aceita apenas letras e números. - `beneficiarioFinal` SwaggerCobrancaBs2PjCobrancaBoletosV2CriarBoletoSimplificadoV2BeneficiarioFinal: Beneficiário final informado na emissão de boleto, quem receberá o valor pago. - `razaoSocial` string, nullable: Razão social do beneficiário final. - `nomeFantasia` string, nullable: Nome fantasia do beneficiário final. - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. - `cliente` SwaggerCobrancaBs2PjCobrancaBoletosV2CriarBoletoSimplificadoV2Cliente, required: Dados do cliente (pagador/sacado) para emissão de boleto simplificado. - `tipo` integer: Tipo de pessoa: física (identificada por CPF) ou jurídica (identificada por CNPJ). - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. - `nome` string, nullable: Nome da pessoa física ou razão social da pessoa jurídica. - `endereco` SwaggerCobrancaBs2PjCompartilhadosEndereco: Endereço completo do pagador, contendo logradouro, número, complemento, bairro, cidade, UF e CEP. - `cep` string, nullable: CEP do endereço do pagador, somente os 8 dígitos numéricos sem máscara. Exemplo: 04543011. - `estado` string, nullable: Sigla do estado do endereço. Apenas iniciais. Exemplo: SP, MG, RJ. - `cidade` string, nullable: Cidade do endereço do pagador. Exemplo: São Paulo. - `bairro` string, nullable: Bairro do endereço do pagador. Exemplo: Vila Olímpia. - `logradouro` string, nullable: Logradouro do endereço do pagador. Exemplo: Av. Pres. Juscelino Kubitschek. - `numero` string, nullable: Número do logradouro no endereço. Aceita apenas letras e números, sem caracteres especiais. Exemplo: KM 10. - `complemento` string, nullable: Complemento do endereço do pagador. Utilizado para informações adicionais ou quando o número contém caracteres especiais. - `telefone` string, nullable: Telefone do pagador. Informar apenas dígitos numéricos, sem máscara (máximo 13 dígitos). Exemplo: 11944440000. - `email` string, nullable: E-mail do pagador. Exemplo: joao@bs2.com.br. - `clienteId` string, uuid: Identificador único do cliente (pagador/sacado) previamente cadastrado, no formato GUID. Informar apenas este campo para reutilizar um cliente já cadastrado. Para o primeiro boleto do cliente, omitir este campo e informar todos os dados completos. - `sacadorAvalista` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosSacadorAvalista: Sacador avalista do boleto. - `tipo` integer: Tipo de pessoa: física (identificada por CPF) ou jurídica (identificada por CNPJ). - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. - `nome` string, nullable: Nome da pessoa física ou razão social da pessoa jurídica. - `endereco` SwaggerCobrancaBs2PjCompartilhadosEndereco: Endereço completo do pagador, contendo logradouro, número, complemento, bairro, cidade, UF e CEP. - `cep` string, nullable: CEP do endereço do pagador, somente os 8 dígitos numéricos sem máscara. Exemplo: 04543011. - `estado` string, nullable: Sigla do estado do endereço. Apenas iniciais. Exemplo: SP, MG, RJ. - `cidade` string, nullable: Cidade do endereço do pagador. Exemplo: São Paulo. - `bairro` string, nullable: Bairro do endereço do pagador. Exemplo: Vila Olímpia. - `logradouro` string, nullable: Logradouro do endereço do pagador. Exemplo: Av. Pres. Juscelino Kubitschek. - `numero` string, nullable: Número do logradouro no endereço. Aceita apenas letras e números, sem caracteres especiais. Exemplo: KM 10. - `complemento` string, nullable: Complemento do endereço do pagador. Utilizado para informações adicionais ou quando o número contém caracteres especiais. - `vencimento` string, date-time, required: Data de vencimento do boleto. - `valor` number, double, required: Valor monetário em reais. - `canal` string, nullable: Apelido para identificação do beneficiário. - `multa` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosMulta: Configuração de multa e juros aplicados após o vencimento do boleto. Multa máxima: 20%. Juros máximos: 20% ao mês. - `valor` number, double, nullable: Valor percentual de multa aplicado a partir da data de multa/juros. - `data` string, date-time, nullable: Data a partir da qual a multa e os juros passam a ser cobrados sobre o boleto. - `juros` number, double, nullable: Taxa de juros aplicada a partir da data de multa/juros, em percentual ao mês. Máximo: 20% ao mês. Exemplo: 15. - `desconto` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosDesconto: Configuração do desconto por pagamento antecipado. - `percentual` number, double, nullable: Valor percentual do desconto. - `valorFixo` number, double, nullable: Valor fixo a ser descontado quando o pagamento ocorrer dentro da data limite de desconto. - `valorDiario` number, double, nullable: Valor de desconto concedido por dia até a data limite de desconto. - `limite` string, date-time, nullable: Data limite para aplicação do desconto. - `mensagem` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosMensagem: Mensagem personalizada impressa no boleto, dividida em até 4 linhas de até 80 caracteres cada. Utilizada para orientar o caixa ou o pagador sobre a cobrança. - `linha1` string, nullable: Primeira linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha2` string, nullable: Segunda linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha3` string, nullable: Terceira linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha4` string, nullable: Quarta linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `aceite` boolean, nullable: Indicador de reconhecimento da obrigação de pagamento pelo pagador. - `especie` string, nullable: Classificação do documento que origina o boleto. Valores válidos: 0 = Duplicata Mercantil, 6 = Duplicata de Serviço, 9 = Outros. Padrão: Outros. - `dataLimitePagamento` string, date-time, nullable: Data limite até a qual o boleto pode ser pago após o vencimento. O prazo configurável é de 1 a 90 dias após o vencimento. - `carteira` integer: Código da carteira de cobrança. Valores: 21 (Carteira simples) ou 41 (Carteira vinculada). ## Response `201` Created - SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosBoletoCriado: Dados do boleto retornados após a emissão bem-sucedida, incluindo identificadores, linha digitável, código de barras e nosso número. - `seuNumero` string, required: Identificador do boleto definido pelo próprio emissor, usado para reconhecimento no seu sistema (ex.: número da venda ou nota fiscal). Aceita apenas letras e números. - `clienteId` string, uuid, required: Código do cliente. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - `sacadorAvalista` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosSacadorAvalista: Sacador avalista do boleto. - `tipo` integer: Tipo de pessoa: física (identificada por CPF) ou jurídica (identificada por CNPJ). - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. - `nome` string, nullable: Nome da pessoa física ou razão social da pessoa jurídica. - `endereco` SwaggerCobrancaBs2PjCompartilhadosEndereco: Endereço completo do pagador, contendo logradouro, número, complemento, bairro, cidade, UF e CEP. - `cep` string, nullable: CEP do endereço do pagador, somente os 8 dígitos numéricos sem máscara. Exemplo: 04543011. - `estado` string, nullable: Sigla do estado do endereço. Apenas iniciais. Exemplo: SP, MG, RJ. - `cidade` string, nullable: Cidade do endereço do pagador. Exemplo: São Paulo. - `bairro` string, nullable: Bairro do endereço do pagador. Exemplo: Vila Olímpia. - `logradouro` string, nullable: Logradouro do endereço do pagador. Exemplo: Av. Pres. Juscelino Kubitschek. - `numero` string, nullable: Número do logradouro no endereço. Aceita apenas letras e números, sem caracteres especiais. Exemplo: KM 10. - `complemento` string, nullable: Complemento do endereço do pagador. Utilizado para informações adicionais ou quando o número contém caracteres especiais. - `vencimento` string, date-time, required: Data de vencimento do boleto. - `valor` number, double, required: Valor monetário em reais. - `canal` string, nullable: Apelido para identificação do beneficiário. - `multa` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosMulta: Configuração de multa e juros aplicados após o vencimento do boleto. Multa máxima: 20%. Juros máximos: 20% ao mês. - `valor` number, double, nullable: Valor percentual de multa aplicado a partir da data de multa/juros. - `data` string, date-time, nullable: Data a partir da qual a multa e os juros passam a ser cobrados sobre o boleto. - `juros` number, double, nullable: Taxa de juros aplicada a partir da data de multa/juros, em percentual ao mês. Máximo: 20% ao mês. Exemplo: 15. - `desconto` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosDesconto: Configuração do desconto por pagamento antecipado. - `percentual` number, double, nullable: Valor percentual do desconto. - `valorFixo` number, double, nullable: Valor fixo a ser descontado quando o pagamento ocorrer dentro da data limite de desconto. - `valorDiario` number, double, nullable: Valor de desconto concedido por dia até a data limite de desconto. - `limite` string, date-time, nullable: Data limite para aplicação do desconto. - `mensagem` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosMensagem: Mensagem personalizada impressa no boleto, dividida em até 4 linhas de até 80 caracteres cada. Utilizada para orientar o caixa ou o pagador sobre a cobrança. - `linha1` string, nullable: Primeira linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha2` string, nullable: Segunda linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha3` string, nullable: Terceira linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha4` string, nullable: Quarta linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `aceite` boolean, nullable: Indicador de reconhecimento da obrigação de pagamento pelo pagador. - `especie` string, nullable: Classificação do documento que origina o boleto. Valores válidos: 0 = Duplicata Mercantil, 6 = Duplicata de Serviço, 9 = Outros. Padrão: Outros. - `id` string, uuid: Identificador único no formato GUID. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. - `sacado` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosSacado: Pagador do boleto (sacado) — pessoa física ou jurídica responsável pela quitação. - `tipo` integer: Tipo de pessoa: física (identificada por CPF) ou jurídica (identificada por CNPJ). - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. - `nome` string, nullable: Nome da pessoa física ou razão social da pessoa jurídica. - `endereco` SwaggerCobrancaBs2PjCompartilhadosEndereco: Endereço completo do pagador, contendo logradouro, número, complemento, bairro, cidade, UF e CEP. - `cep` string, nullable: CEP do endereço do pagador, somente os 8 dígitos numéricos sem máscara. Exemplo: 04543011. - `estado` string, nullable: Sigla do estado do endereço. Apenas iniciais. Exemplo: SP, MG, RJ. - `cidade` string, nullable: Cidade do endereço do pagador. Exemplo: São Paulo. - `bairro` string, nullable: Bairro do endereço do pagador. Exemplo: Vila Olímpia. - `logradouro` string, nullable: Logradouro do endereço do pagador. Exemplo: Av. Pres. Juscelino Kubitschek. - `numero` string, nullable: Número do logradouro no endereço. Aceita apenas letras e números, sem caracteres especiais. Exemplo: KM 10. - `complemento` string, nullable: Complemento do endereço do pagador. Utilizado para informações adicionais ou quando o número contém caracteres especiais. - `email` string, nullable: E-mail do pagador. Exemplo: joao@bs2.com.br. - `telefone` string, nullable: Telefone do pagador. Informar apenas dígitos numéricos, sem máscara (máximo 13 dígitos). Exemplo: 11944440000. - `status` integer: Status atual do boleto no ciclo de vida. - `nossoNumero` integer, nullable: Identificador do boleto gerado pelo banco. - `codigoDeBarra` string, nullable: Código de barras do boleto. Exemplo: 21895787100000000000010000000000000000000000. - `linhaDigitavel` string, nullable: Linha digitável do boleto. Exemplo: 21090010070000000000000860000000000000000000000. - `beneficiarioFinal` SwaggerCobrancaBs2PJDomainCobrancaModelsBoletosAvulsoBoletoAggregateBeneficiarioFinal: Beneficiário final do boleto — quem de fato recebe o valor(quando difere do cedente). - `razaoSocial` string, nullable: Razão social do beneficiário final. - `nomeFantasia` string, nullable: Nome fantasia do beneficiário final. - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. ## Other responses - `400`: Bad Request --- [API](https://skmtc.dev/bs2/apis/api-boletos.md) - [All operations](https://skmtc.dev/bs2/apis/api-boletos/llms.txt) - [OpenAPI document](https://skmtc.dev/bs2/apis/api-boletos/revisions/5d82dc00a3f9?raw)