/api/conversations/{conversationId}/bankTransactions/statsRetrieving statistics of downloaded banking transactions related to the conversation
Returns statistics related to downloaded transactions. These statistics are returned for each account that has been shared as part of the conversation. This information only occurs when the bankTransactions section is defined when creating a conversation. and are available when the appropriate callback is received, or when the bankTransactions status reaches FINISHED.
Query Parameter Description
The method supports the following query parameters:
| Parameter | Example | Description |
|---|---|---|
| dateFrom | 2020-09-17T11: 18: 21.999Z | The starting date for the scope of analyzed transactions in the format https://tools.ietf.org/html/rfc3339(opens in new tab). The default value is the oldest available transaction. You can enter an earlier date, but only transactions that the user has shared will be included. |
| dateTo | 2020-09-17T11: 18: 21.999Z | The end date for the range of analyzed transactions in the format https://tools.ietf.org/html/rfc3339(opens in new tab). The default value is the latest available transaction. You can enter a later date, but only transactions that the user has shared will be included. |
Response Content Description
Detailed description of returned fields:
| Parameter | Example | Description |
|---|---|---|
| dateFrom | 2020-09-16T10: 44: 51.544Z | The starting date of the search criteria, or the date of the first transaction for all bank accounts, if the criteria was empty. The field will not be presented if the starting date criterion is not specified and there are no transactions in the given search criteria. |
| dateTo | 2020-09-16T10: 44: 51.544Z | End date of the search criteria, or the date of the last transaction for all bank accounts, if the criteria was empty. The field will not be presented if the end date criterion is not specified and there are no transactions in the given search criteria. |
| items | - | A structure containing information about transaction statistics. Each element of this structure represents statistics from a separate bank account. |
| items.dateFirst | 2020-06-16T00: 00: 00.000Z | Date of the first transaction in the range. |
| items.dateLast | 2020-09-16T00: 00: 00.000Z | Date of the last transaction in the range. |
| items.numberOfCreditTransactions | 12 | Number of bank account discretionary transactions. |
| items.numberOfDebitTransactions | 12 | Number of debit transactions on the bank account. |
| items.avgCreditPerMonth | 300,000 | Average value of credit transactions per month, presented in basic units - e.g. in grosze. The value will be available if the analyzed period is greater than 60 days. |
| items.avgDebitPerMonth | 258000 | Average value of debit transactions per month, presented in basic units - e.g. in grosze. The value will be available if the analyzed period is greater than 60 days. |
| items.avgCredit | 30,000 | Average value of bank account discretionary transactions, presented in basic units - e.g. in grosze. |
| items.avgDebit | 40,000 | Average value of bank account debit transactions, presented in basic units - e.g. in grosze. |
| items.maxCredit | 110000 | Maximum value of a bank account discretionary transaction, presented in basic units - e.g. in grosze. |
| items.maxDebit | 132000 | The maximum value of the debit transaction from the bank account, presented in basic units - e.g. in grosze. |
| items.accountId | PL68249000050000400075212326 | Account number. |
| items.currency | PLN | Currency code for a given bank account. |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversationId | path | string | Required | Conversation ID |
dateFrom | query | string · date-time | Optional | Starting date |
dateTo | query | string · date-time | Optional | End date |
Responses
Information available
application/vnd.authologic.v1.1+jsondateFromstring · date-time optional The starting date of the search criteria or the date of the first transaction for all accounts if the criteria was empty
dateTostring · date-time optional End date of the search criteria or the last transaction date for all accounts if the criteria was empty
itemsarray<object> required List of transaction statistics for each account separately
List of transaction statistics for each account separately
dateFirststring · date-time required Date of the first transaction in the range
dateLaststring · date-time required Date of the last transaction in the range
numberOfCreditTransactionsinteger · int32 optional The number of credit transactions of the account. The value will be available if you selected all transactions or credit transactions.
numberOfDebitTransactionsinteger · int32 optional Number of account debit transactions. The value will be available if you selected all transactions or debit transactions.
avgCreditPerMonthinteger · int32 optional Average value of credit transactions per month, presented in basic units - e.g. in cents. The value will be available if the analyzed period is greater than 60 days and if credit transactions or all of them were selected when creating the conversation.
avgDebitPerMonthinteger · int32 optional Average value of credit transactions per month, presented in basic units - e.g. in cents. The value will be available if the analyzed period is greater than 60 days and if credit transactions or all of them were selected when creating the conversation.
avgCreditinteger · int32 optional Average value of the account's credit transactions, presented in basic units - e.g. in cents. The value will be available if you selected all transactions or credit transactions.
avgDebitinteger · int32 optional Average value of the account's debit transactions, presented in basic units - e.g. in cents. The value will be available if you selected all transactions or debit transactions.
maxCreditinteger · int32 optional Maximum value of the account credit transaction, presented in basic units - e.g. in cents. The value will be available if you selected or all credit transactions when creating the conversation.
maxDebitinteger · int32 optional Maximum value of the account debit transaction, presented in basic units - e.g. in cents. The value will be available if you selected all transactions or debit transactions.
accountIdstring required Account number.
currencystring required Currency code for the account
Bad Request
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Exhaustion of the plan or limitations related to non-payment
Forbidden
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Conversation not found
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Conversation is unavailable
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Server side error