2.3 - Boleto query

Consult by ID

The GetBoletoInById and GetBoletoById methods allow you to query a specific boleto, returning all the boleto's information.

GetBoletoInById

Parameter	Type	Description	Mandatory
Method	String	GetBoletoById	YES
PartnerId	Long	FitBank provided ID	YES
BusinessUnitId	Long	FitBank provided ID	YES
DocumentNumber	String	Internal transaction identifier	YES

{
  "Method": "GetBoletoInById",
  "PartnerId": 93234,
  "BusinessUnitId": 40380,
  "DocumentNumber": 135518
}

{
  "Success": "true",
  "Boleto": {
    "BoletoInId": 0,
    "OperationId": 0,
    "DueDate": "2024-02-06T12:44:19.844Z",
    "PaymentDate": "2024-02-06T12:44:19.844Z",
    "CreditDate": "2024-02-06T12:44:19.844Z",
    "CreationDate": "2024-02-06T12:44:19.844Z",
    "PrincipalValue": 0,
    "InterestDate": "2024-02-06T12:44:19.844Z",
    "InterestValue": 0,
    "InterestPercent": 0,
    "FineDate": "2024-02-06T12:44:19.844Z",
    "FineValue": 0,
    "FinePercent": 0,
    "TotalValue": 0,
    "RebateValue": 0,
    "PaidValue": 0,
    "Status": 0,
    "MailToSend": "string",
    "PhoneToSend": "string",
    "OurNumber": "string",
    "Identifier": "string",
    "Barcode": "string",
    "DigitableLine": "string",
    "Url": "string",
    "CustomerName": "string",
    "CustomerTaxNumber": "string",
    "DivergentPaymentType": 0,
    "MinPaymentValue": 0,
    "MaxPaymentValue": 0,
    "Products": [
      {
        "SellerPersonType": 0,
        "Reference": "string",
        "SellerName": "string",
        "SellerTaxNumber": "string",
        "ReceiverPersonType": 0,
        "ReceiverName": "string",
        "ReceiverTaxNumber": "string",
        "ProductCode": "string",
        "ProductName": "string",
        "ProductQty": 0,
        "ProductValue": 0,
        "ProductRateValue": 0,
        "AutomaticType": 0,
        "AccountType": 0,
        "Bank": "string",
        "BankBranch": "string",
        "BankAccount": "string",
        "BankAccountDigit": "string",
        "ReceiverBank": "string",
        "ReceiverBankBranch": "string",
        "ReceiverBankAccount": "string",
        "ReceiverBankAccountDigit": "string",
        "ProductRateValueToTransfer": 0,
        "FineSplitPercent": 0,
        "InterestSplitPercent": 0
      }
    ]
  }
}

GetBoletoById

Parameter	Type	Description	Mandatory
Method	String	GetBoletoById	YES
PartnerId	Long	FitBank provided ID	YES
BusinessUnitId	Long	FitBank provided ID	YES
DocumentNumber	String	Internal transaction identifier	YES

❗️
The GetBoletoById method will be discontinued.

Consult by Date

The GetBoletoByDate and GetListBoletoByDate methods allow you to see all the boletos issued within a certain period of time.

GetListBoletoByDate

Parameter	Type	Description	Mandatory
Method	String	GetListBoletoByDate	YES
PartnerId	Long	FitBank provided ID	YES
BusinessUnitId	Long	FitBank provided ID	YES
InicialDate	DateTime	(yyyy/mm/dd)	YES
FinalDate	DateTime	(yyyy/mm/dd)	YES
PageIndex	Number	Reference of which page will be accessed	YES
PageSize	Number	Number of results that will be displayed on the same page	YES
Status	Short	Created - 0 Registered - 3 Settlement - 5 Canceled - 7	NO
CustomerTaxNumber	String	CPF/CNPJ of the payer	NO
SupplierTaxNumber	String	CPF/CNPJ of the Boleto issuing account	NO
SupplierBank	String	Internal account identification Bank	NO
SupplierBankBranch	String	Internal account identification Bank Branch	NO
SupplierBankAccount	String	Internal account identification Bank Account	NO
SupplierBankAccountDigit	String	Internal account identification Bank Account Digit	NO

{
  "Method": "GetListBoletoByDate",
  "PartnerId": 93234,
  "BusinessUnitId": 40380,
  "InitialDate": "2024-02-01",
  "FinalDate": "2024-02-05",
  "PageIndex": 0,
  "PageSize": 10,
  "Status": null,
  "CustomerTaxNumber": null,
  "SupplierTaxNumber": null,
  "SupplierBank": null,
  "SupplierBankBranch": null,
  "SupplierBankAccount": null,
  "SupplierBankAccountDigit": null
}

{
  "Success": "true",
  "Boletos": [
    {
      "BoletoInId": 0,
      "DueDate": "2024-02-06T13:39:06.143Z",
      "PaymentDate": "2024-02-06T13:39:06.143Z",
      "CreationDate": "2024-02-06T13:39:06.143Z",
      "PrincipalValue": 0,
      "InterestDate": "2024-02-06T13:39:06.143Z",
      "InterestValue": 0,
      "InterestPercent": 0,
      "FineDate": "2024-02-06T13:39:06.143Z",
      "FineValue": 0,
      "RebateValue": 0,
      "TotalValue": 0,
      "PaidValue": 0,
      "Status": 0,
      "OurNumber": "string",
      "Identifier": "string",
      "Barcode": "string",
      "DigitableLine": "string",
      "FileName": "string",
      "CustomerName": "string",
      "CustomerTaxNumber": "string",
      "SupplierName": "string",
      "SupplierTaxNumber": "string"
    }
  ]
}

GetBoletoByDate

Parameter	Type	Description	Mandatory
Method	String	GetBoletoByDate	YES
PartnerId	Long	FitBank provided ID	YES
BusinessUnitId	Long	FitBank provided ID	YES
InicialDate	DateTime	(yyyy/mm/dd)	YES
FinalDate	DateTime	(yyyy/mm/dd)	YES
CustomerName	String	Payer name	NO
CustomerTaxNumber	String	CPF/CNPJ of the payer	NO
CustomerBank	String	Payer's bank code	NO
CustomerBankBranch	String	Payer's bank branch	NO
CustomerBankAccount	String	Payer's bank account	NO
CustomerBankAccountDigit	String	Payer's bank account digit	NO
InicialDueDate	String	(yyyy/mm/dd)	NO
FinalDueDate	String	(yyyy/mm/dd)	NO
InicialPaymentDate	String	(yyyy/mm/dd)	NO
FinalPaymentDate	String	(yyyy/mm/dd)	NO
Status	Short	Created - 0 CanBeRegister - 1 Registered - 3 Settlement - 5 Canceled - 7 Error - 8	NO
RecieverTaxNumber	String	CPF/CNPJ of the Boleto receiver	NO
RecieverBank	Varchar	Internal account receiver identification Bank	NO
RecieverBankBranch	Varchar	Internal account receiver identification Bank Branch	NO
RecieverBankAccount	Varchar	Internal account receiver identification Bank Account	NO
RecieverBankAccountDigit	Varchar	Internal account receiver identification Bank Account Digit	NO
SellerTaxNumber	String	CPF/CNPJ of the Boleto issuing account	NO
SellerBank	String	Seller Bank	NO
SellerBankBranch	String	Seller Bank Branch	NO
SellerBankAccount	String	Seller Bank Account	NO
SupplierTaxNumber	String	CPF/CNPJ of the Boleto issuing account	NO
SupplierBank	Varchar	Internal account identification Bank	NO
SupplierBankBranch	Varchar	Internal account identification Bank Branch	NO
SupplierBankAccount	Varchar	Internal account identification Bank Account	NO
SupplierBankAccountDigit	Varchar	Internal account identification Bank Account Digit	NO
PageIndex	String	Reference of which page will be accessed	NO
PageSize	String	Number of results that will be displayed on the same page	NO

❗️
The GetBoletoByDate method will be discontinued.\

````

2.3 - Boleto query

Consult by ID

GetBoletoInById

GetBoletoById

❗️
`The GetBoletoById method will be discontinued.`

Consult by Date

GetListBoletoByDate

GetBoletoByDate

❗️
`The GetBoletoByDate method will be discontinued.\`

Consult by ID

GetBoletoInById

GetBoletoById

❗️The GetBoletoById method will be discontinued.

Consult by Date

GetListBoletoByDate

GetBoletoByDate

❗️The GetBoletoByDate method will be discontinued.\

❗️
`The GetBoletoById method will be discontinued.`

❗️
`The GetBoletoByDate method will be discontinued.\`