GenerateBalanceReportAsync

The GenerateBalanceReportAsync endpoint is used to generate an account balance report for accounting purposes. When invoked, the endpoint generates a CSV file containing a summary of financial data and sends it by email to the specified address.

This report provides a consolidated view of financial movements, including:

Opening and closing balances
Total credits and debits for the selected period

The request allows:

Providing a list of specific accounts (AccountKeyList) to generate individual or grouped reports
Requesting the report for the entire Business Unit (BU) using the SendType parameter
Customizing the time range (StartDate and EndDate) for analysis

This feature is especially useful for auditing and accounting reconciliation, enabling greater control over the financial status of multiple accounts or the entire BU in a single operation.

{
    "Method": "GenerateBalanceReportAsync",
    "PartnerId": 1136,
    "BusinessUnitId": 1165,
    "AccountKeyList": [
        "2324214321-21312421-213213-3",
        "2398744321-21312421-213213-3"
    ],
    "BankingDatas": [
        {
            "TaxNumber": "",
            "Bank": "",
            "BankBranch": "",
            "BankAccount": "",
            "BankAccountDigit": ""
        }
    ],
    "Email": "[email protected]",
    "Type": 1, //0 -CSV
    "SendType": 2, // 0- BU, 1- Account, 2 -Interno
    "StartDate": "2024/05/01",
    "EndDate": "2024/05/02"
}

{
"Success": "true",
"DocumentNumber": "383hhd8",
  "Message": "Solicitação de Relatório de Saldo realizada com sucesso."
}

Definition of request fields

Parameter	Type	Description
Method	String	Method name.
PartnerId	Int64	Information Provied by Fitbank
AccountKeyList	String	Field used to specify one or more accounts by their AccountKey or to define a range of accounts to be included in the report.
BankingDatas	Object	Field responsible for returning bank details details
Email	String	Email
Type	String	Field used to define the format of the generated file. Currently, only 0 is supported, which corresponds to the CSV format.
SendType	String	0 - The provided email must be associated with the domain specified in the BusinessUnit. 1 - The notification will be sent to the email registered on the account. null - The notification will be sent to the email registered on the account.
StartDate	String	Field used to perform the start date filter to delimit the statement.
EndDate	String	Field used to perform the end date filter to delimit the statement.