3 - Queries

GetBoletosDDA

The GetBoletosDDA method makes it possible to consult all the boletos registered for the electronic payer. The payer can filter the list of boletos issued in their name using the start and end due date, limiting the display to only boletos due within the defined period. In addition, it is possible to consult the boletos issued to a specific payee, either by name or CPF/CNPJ.

{
  "Method": "GetBoletosDDA",
  "PartnerId": 12345,
  "BusinessUnitId": 12345,
  "ElectronicPayerTaxNumber": "12345678910",
  "PageSize": 10,
  "PageIndex": 1,
  "InitialDueDate": "01/01/2026",
  "FinalDueDate": "31/12/2026",
  "BeneficiaryName": "Company Name",
  "BeneficiaryTaxNumber": "98765432100"
}

{
    "Success": true,
    "Payer": {
        "Name": "Technologies",
        "TaxNumber": "93693236000131"
    },
    "Boletos": [
        {
            "Beneficiary": {
                "Name": "Josh",
                "TradingName": null,
                "TaxNumber": "25975096057"
            },
            "Barcode": "45095956100000010000010000000900621350037120",
            "DigitableLine": "45090010060000090062113500371201595610000001000",
            "DueDate": "10/12/2023",
            "PrincipalValue": 11.00,
            "CalculatedValues": {
                "InterestValue": 0,
                "FineValue": 0,
                "DiscountValue": 0,
                "RebateValue": 0.00,
                "FinalValue": 11.00
            },
            "Situation": "12 - Boleto apto para pagamento"
        },
        {
            "Beneficiary": {
                "Name": "Josh",
                "TradingName": null,
                "TaxNumber": "25975096057"
            },
            "Barcode": "45091956100000010000010000001100621530037150",
            "DigitableLine": "45090010060000110062715300371505195610000001000",
            "DueDate": "11/12/2023",
            "PrincipalValue": 12.00,
            "CalculatedValues": {
                "InterestValue": 0,
                "FineValue": 2,
                "DiscountValue": 0,
                "RebateValue": 0.00,
                "FinalValue": 14.00
            },
            "Situation": "12 - Boleto apto para pagamento"
        },
        {
            "Beneficiary": {
                "Name": "Josh",
                "TradingName": null,
                "TaxNumber": "25975096057"
            },
            "Barcode": "45098956100000010000010000001300621550037190",
            "DigitableLine": "45090010060000130062315500371909895610000001000",
            "DueDate": "12/12/2023",
            "PrincipalValue": 13.00,
            "CalculatedValues": {
                "InterestValue": 0,
                "FineValue": 2,
                "DiscountValue": 0,
                "RebateValue": 10.00,
                "FinalValue": 3.00
            },
            "Situation": "12 - Boleto apto para pagamento"
        }
    ]
}

Request Parameters

Field	Type	Required	Description
`Method`	string	Yes	Must be `GetBoletosDDA`
`PartnerId`	integer	Yes	Partner identifier
`BusinessUnitId`	integer	Yes	Business unit identifier
`ElectronicPayerTaxNumber`	string	Yes	CPF or CNPJ of the electronic payer
`PageSize`	integer	Yes	Number of records per page (recommended: 10-100)
`PageIndex`	integer	Yes	Page number (starts at 1)
`InitialDueDate`	string	No	Initial due date filter (DD/MM/YYYY)
`FinalDueDate`	string	No	Final due date filter (DD/MM/YYYY)
`BeneficiaryName`	string	No	Beneficiary name filter
`BeneficiaryTaxNumber`	string	No	Beneficiary CPF/CNPJ filter

Success Response

{
  "Success": true,
  "Payer": {
    "Name": "John Doe",
    "TaxNumber": "12345678910"
  },
  "Boletos": [
    {
      "Beneficiary": {
        "Name": "Energy Company Ltd",
        "TradeName": "Energy Co",
        "TaxNumber": "98765432100123"
      },
      "Barcode": "45091900200000040000016612345678900000000086",
      "DigitableLine": "450916671234567890300000000869190020000004000",
      "DueDate": "31/12/2026",
      "PrincipalValue": 150.00,
      "CalculatedValues": {
        "InterestValue": 3.00,
        "FineValue": 7.50,
        "DiscountValue": 0.00,
        "RebateValue": 0.00,
        "FinalValue": 160.50
      }
    }
  ]
}

Response Fields

Field	Type	Description
`Success`	boolean	Operation result
`Payer.Name`	string	Name of the electronic payer
`Payer.TaxNumber`	string	CPF/CNPJ of the payer
`Boletos`	array	List of boletos
`Beneficiary`	object	Beneficiary information
`Barcode`	string	44-digit barcode
`DigitableLine`	string	47-digit digitable line
`DueDate`	string	Due date (DD/MM/YYYY)
`PrincipalValue`	decimal	Original boleto value
`InterestValue`	decimal	Calculated interest
`FineValue`	decimal	Calculated fine
`DiscountValue`	decimal	Calculated discount
`RebateValue`	decimal	Rebate value
`FinalValue`	decimal	Final amount to pay

Error Response

No boletos found:

{
  "Success": false,
  "Message": "Não foram encontrados boletos para o Pagador Eletrônico informado"
}

Updated 8 days ago