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 a year, facilitating the analysis of balances, revenues, expenses, and fees.

For better performance, this feature sends the file compiling the requested information via email or webhook (if enabled).

The files, to facilitate reconciliation in different external systems, can be created in the following formats:

PDF
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",
  "SendWebhook": true
}

{
    "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
Email	Email	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. null - The notification will be sent to the email registered on the account.	int
InitialDate	Initial Date (scheduling) of the period searched	Datetime
FinalDate	Final Date (scheduling) of the period searched	Datetime
URL	Url for Statement template	string
SendWebhook	Optional field. If set to true, the file will be sent via webhook.	boolean

Webhook Notification

If the SendWebhook field is set to true, the file will be sent via a webhook with the following structure:

{
  "BusinessUnitId": 480,
  "GenerateStatementAsync": {
    "DocumentNumber": 10655,
    "Url": "https://exportstatementasymc/api/ExportStatementAsync/Csv/Extrato_05778101031_05-11-2025_10-43.zip",
    "Status": 1
  }
}

Webhook Status Definitions:

Created (1): The file was successfully created and is available for download.
Error (2): An error occurred during file generation.
Expired (3): The file is no longer available as it has expired.

Additional Notes on Webhook:

The file expires after 7 days.
The Url field in the webhook payload is only provided when the file is successfully created (Status = 1). Otherwise, it will be returned as null.