GetIncomeReport

API Method = GetIncomeReport

This method makes it possible to consult information from the Account Income Report.

{
  "Method": "GetIncomeReport",
  "PartnerId": 93234,
  "BusinessUnitId": 40380,
  "TaxNumber": "30934646000107",
  "Bank": "621",
  "BankBranch": "3212",
  "BankAccount": "51351",
  "BankAccountDigit": "5",
  "ReferenceYear": "2023"
}

{
  "Success": "true",
  "Entry": [
    {
      "Date": "2022-12-31T00:00;00",
      "Balance": 5
    },
    {
      "Date": "2023-12-31T00:00;00",
      "Balance": 10
    }
  ]
}

Definition of request fields

Field	Type	Description
Method	String	Method name
PartnerId	Integer	Information provided by FitBank
BusinessUnitId	Integer	Information provided by FitBank
TaxNumber	String	Taxnumber account holder.
Bank	String	Bank Code (Ex.: “450”)
BankBranch	String	Bank Agency Code (Ex.: “0001”)
BankAccount	String	Bank Account (Ex.: “146492”)
BankAccountDigit	String	Account Digit (Ex.: “1”)
ReferenceYear	Integer	Reference year for the consultation

Error scenarios responses

It will only be possible to consult the reference year prior to the current year.

{
"Success": "false",
"Message": "ISE0004 - O ano de referência não pode ser maior ou igual ao ano atual",
"Validation": null
}

Important: When using the GetIncomeReport method to consult the income report, an Income Report in PDF format will be automatically sent to the email provided in the account.