GenerateStatementAsync
API Method = GenerateStatementAsync
This endpoint aims to provide a view of the statement and financial transactions, which are essential elements for controlling and monitoring personal and business finances. It allows a clear and detailed view of the transactions made over a period of up to two days, facilitating the analysis of balances, revenues, expenses, and fees.
For better performance, this feature sends the file compiling the requested information via email.
The files, to facilitate reconciliation in different external systems, can be created in the following formats:
- OFX
- CSV
- CNAB
{
"Method": "GenerateStatementAsync",
"PartnerId": 1136,
"BusinessUnitId": 494,
"TaxNumber": "39391365817",
"Bank": "",
"BankBranch": "",
"BankAccount": "",
"BankAccountDigit": "",
"Email": "[email protected]",
"Type": 1,
"InitialDate": "2024/08/05",
"FinalDate": "2024/08/06",
"Url": "https://storage.googleapis.com/osb-files/fitbank/logo-primary.png"
}
{
"Success": "true",
"Message": "Método executado com sucesso"
}
Definition of request fields
Field | Description | Type |
---|---|---|
Method | Method name | string |
PartnerId | Information provided by Fitbank | long |
BusinessUnitId | Information provided by Fitbank | long |
TaxNumber | TaxNumber | string |
Bank | Provided for differentiation at the time of account opening | string |
BankBranch | Provided for differentiation at the time of account opening | string |
BankAccount | Provided for differentiation at the time of account opening | string |
BankAccountDigit | Provided for differentiation at the time of account opening | string |
string | ||
Type | "The 'Type' field is used to describe the category of the bank transaction, providing additional text to complement the 'subtype' field." 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. 2 - The provided email must have the domain @fitbank.com.br. null - The notification will be sent to the email registered on the account. | int |
InitialDate | Initial Date (scheduling) of the period searched - The date range must be less than or equal to 7 days. | Datetime |
FinalDate | Final Date (scheduling) of the period searched - The date range must be less than or equal to 7 days. | Datetime |
Updated 18 days ago