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": 896,
    "BusinessUnitId": 1261,
    "ElectronicPayerTaxNumber": "93693236000131",
    "PageSize": 100,
    "PageIndex": 1,
    "InitialDueDate": "01/08/2024",
    "FinalDueDate": "25/12/2024",
    "BeneficiaryName": null,
    "BeneficiaryTaxNumber": null
}

{
    "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"
        }
    ]
}

Description

Parameter	Type	Description	Mandatory
Method	string	GetBoletosDDA	Yes
PartnerId	integer	FitBank provided ID	Yes
BusinessUnitId	integer	FitBank provided ID	Yes
ElectronicPayerTaxNumber	string	Electronic Payer's CPF/CNPJ	Yes
PageSize	integer	Number of results that will be displayed on the same page	Yes
PageIndex	integer	Reference of which page will be accessed	Yes
InitialDueDate	String	Start due date	No
FinalDueDate	String	Final due date	No
BeneficiaryName	String	Payee Name	No
BeneficiaryTaxNumber	String	Payee TaxNumber	No

GetInfosBoletoDDA

The GetInfosBoletoDDA method allows detailed consultation of an individual boleto, using the barcode for identification.

{
    "Method": "GetInfosBoletoDDA",
    "PartnerId": 896,
    "BusinessUnitId": 1261,
    "ElectronicPayerTaxNumber": "52796756793",
    "Barcode": "45099962200000100000010000013200630210005070"
}

{
    "Success": true,
    "Beneficiary": {
        "Name": "Sousa Saldanha",
        "TradeName": null,
        "TaxNumber": "52796756793"
    },
    "Payer": {
        "Name": "Teste",
        "TaxNumber": "25975096057"
    },
    "Boleto": {
        "Barcode": "45099962200000100000010000013200630210005070",
        "DigitableLine": "45090010060001320063902100050703996220000010000",
        "DueDate": "20240210",
        "Situation": "12 - Boleto apto para pagamento",
        "PrincipalValue": 100.00,
        "CalculatedValues": {
            "InterestValue": 2200,
            "FineValue": 10,
            "DiscontValue": 0,
            "RebateValue": 0,
            "FinalValue": 2310
        }
    }
}

Description

Parameter	Type	Description	Mandatory
Method	string	GetInfosBoletoDDA	Yes
PartnerId	integer	FitBank provided ID	Yes
BusinessUnitId	integer	FitBank provided ID	Yes
ElectronicPayerTaxNumber	string	Electronic Payer's CPF/CNPJ	Yes
Barcode	string	boleto barcode	Yes