POST api/v5/Boleto

Emite um novo boleto.

Request Information

URI Parameters

None.

Body Parameters

Dados para a emissão do boleto.

EmissaoBoletoDto
NameDescriptionTypeAdditional information
Sacado

string

Required

String length: inclusive between 0 and 250

CPFCNPJSacado

string

Required

Max length: 20

Vencimento

date

Required

Valor

decimal number

Required

SeuNumero

string

String length: inclusive between 0 and 30

Parcela

string

String length: inclusive between 0 and 7

Linha1

string

Max length: 250

Linha2

string

Max length: 250

Email

string

None.

DataEnvioEmail

date

None.

Pdf

boolean

None.

Desconto

DescontoDto

None.

Split

Collection of SplitDoBoletoDto

None.

Request Formats

application/json, text/json

Sample:
{
  "Sacado": "sample string 1",
  "CPFCNPJSacado": "sample string 2",
  "Vencimento": "27/06/2019",
  "Valor": 4.0,
  "SeuNumero": "sample string 5",
  "Parcela": "sample string 6",
  "Linha1": "sample string 7",
  "Linha2": "sample string 8",
  "Email": "sample string 9",
  "DataEnvioEmail": "27/06/2019",
  "Pdf": true,
  "Desconto": {
    "Tipo": "Isento",
    "Valor": 1.0,
    "DataLimite": "27/06/2019"
  },
  "Split": [
    {
      "CpfCnpjCliente": "sample string 1",
      "ValorFixo": 2.0,
      "ValorPercentual": 3.0,
      "ValorTarifaFixo": 4.0,
      "ValorTarifaPercentual": 5.0
    },
    {
      "CpfCnpjCliente": "sample string 1",
      "ValorFixo": 2.0,
      "ValorPercentual": 3.0,
      "ValorTarifaFixo": 4.0,
      "ValorTarifaPercentual": 5.0
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Dados do boleto emitido.

RetornoEmissaoBoleto
NameDescriptionTypeAdditional information
Id

string

None.

Url

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Url": "sample string 2"
}