GetAccountSummary
GetAccountSummary
API Method = GetAccountSummary
The "GetAccountSummary" endpoint is a feature we provide to our customers for efficiently accessing their financial history in a consolidated manner. With this service, it's possible to get a summarization of transactions within a specified period, encompassing both inflows and outflows.
Important: For successful utilization of this endpoint, it is necessary to first complete the parameterization process with our customer service team.
{
"method": "GetAccountSummary",
"partnerId": 420,
"businessUnitId": 10935,
"taxNumber": "77758516009",
"startDate": "2023-10-02",
"endDate": "2023-10-02",
"bank": "",
"bankBranch": "",
"bankAccount": "",
"bankAccountDigit": "",
"pageIndex": 0,
"pageSize": 3,
"operationtype": 58
}
{
"success": true,
"entry": [
{
"date": "2023-10-02T00:00:00",
"description": "Devolução de pagamento Pix",
"quantity": 209,
"value": 173.13
},
{
"date": "2023-10-02T00:00:00",
"description": "Transferência",
"quantity": 186,
"value": 74.59
}
],
"balance": 20368.00,
"TotalRows": 100
}
Definition of request fields
| Parameter | Type | Description |
|---|---|---|
| Method | String | Method name |
| PartnerId | Integer | Information provided by FitBank |
| BusinessUnitId | Integer | Information provided by FitBank |
| TaxNumber | String | Taxnumber account holder. |
| 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. |
| 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”) |
| PageIndex | Integer | This field is responsible for specifying which page will be returned |
| PageSize | Integer | This field is responsible for specifying the number of entries per page to be returned. |
| OperationType | String | Type of Operation |
Definition of response fields
| Parameter | Type | Description |
|---|---|---|
| Date | String | Date of summarization. (Ex. 2023-10-02T00:00:00) |
| Description | String | Description of the summarized transaction type |
| Quantity | String | Number of summarized transactions |
| Value | String | Value of summarized transactions |
| Balance | String | Account Balance |
| TotalRows | String | Number of records resulting from the search |
Updated 9 months ago
