Bank statements
Get categorized bank statement
Categorization engine
The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.
The Get categorized bank statement endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources.
get/companies/{companyId}/reports/enhancedCashFlow/transactions
Query parameters
pageinteger
Example:1
Page number. Read more.
pageSizeinteger
Example:100
Number of records to return in a page. Read more.
querystring
Codat query string. Read more.
Response
OK
Example response
{
"reportInfo": {
"pageNumber": 1,
"pageSize": 100,
"totalResults": 2401,
"reportName": "Cash Flow transactions report",
"companyName": "Example Company",
"generatedDate": "2023-01-25T22:36:05.125Z"
},
"dataSources": [
{
"accounts": [
{
"sourceRef": {
"sourceType": "Banking"
},
"id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
"platformName": "Plaid",
"accountProvider": "Bank of Sandbox",
"accountName": "Business Current Account",
"accountType": "Debit",
"currency": "USD",
"currentBalance": 1000,
"identifiers": [
{
"type": "Debit",
"subType": "Current",
"number": 12345678,
"bankCode": 123456,
"iban": "US123456789",
"bic": "US123456789",
"maskedAccountNumber": 1234
}
]
},
{
"sourceRef": {
"sourceType": "Banking"
},
"id": "12345678-1234-1234-1234-123456789012",
"platformName": "Plaid",
"accountProvider": "Bank of Sandbox",
"accountName": "Business Saving Account",
"accountType": "Debit",
"currency": "USD",
"currentBalance": 5321,
"identifiers": [
{
"type": "Debit",
"subType": "Saving",
"number": 87654321,
"bankCode": 654321,
"iban": "US987654321",
"bic": "US987654321",
"maskedAccountNumber": 4321
}
]
}
]
}
],
"reportItems": [
{
"transactions": [
{
"sourceRef": {
"sourceType": "Banking"
}
},
{
"accountRef": {
"id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
"name": "Business Current Account"
},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"date": "2023-01-25",
"description": "Payment to supplier",
"amount": 100,
"currency": "USD",
"transactionCategory": {
"confidence": 92.7,
"levels": [
"Asset",
"Current",
"Bank"
],
"confidences": [
92.7,
95,
96
]
},
"platformName": "Plaid",
"counterpartyNames": [
"Counterparty"
],
"modifiedDate": "2023-01-25T22:36:05.125Z"
},
{
"sourceRef": {
"sourceType": "Banking"
}
},
{
"accountRef": {
"id": "12345678-1234-1234-1234-123456789012",
"name": "Business Saving Account"
},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"date": "2023-01-25",
"description": "Payment to supplier",
"amount": 100,
"currency": "USD",
"transactionCategory": null,
"confidence": 92.7,
"levels": [
"Expense",
"Operating"
],
"confidences": [
92.7,
95
],
"platformName": "Plaid",
"counterpartyNames": [],
"modifiedDate": "2023-01-25T22:36:05.125Z"
}
]
}
]
}