Banking data file upload
Upload your banking data to Codat and take advantage of our bank statement enrichment features and reports
Overview
If you already have a banking data provider, you can still benefit from our bank statement categorization functionality by manually uploading that banking data to Codat.
You can do this in two ways:
- Upload banking data files and download the resulting categorized bank statement in our Portal.
- Write the banking data records and get the resulting categorized bank statement via our API.
To use the data upload functionality, you need to create a Codat company first. We walk you through this in Get started with Lending API.
Upload in Portal
In the Codat Portal, navigate to Companies, choose the company you want to upload the banking data for, then select Lending > Upload banking data. Here, you can manually upload CSV files that contain bank account details and bank transaction details from your banking provider.
Download CSV templates with example data from this page and check the allowed values for each data type in our API reference to make sure your data is in the right format. We summarized the data requirements in the table below.
| Data type | Template | Required fields | Allowed values |
|---|---|---|---|
| Accounts | CSV template | id, name, type, currentBalance, currency, accountIdentifierType, institutionId, institutionNameAn account identifier: iban, bic, or number | See the Banking: Bank account schema |
| Transactions | CSV template | id, accountId, currency, description, amount, postedDate, code | See the Banking: Transaction schema |
You can check the progress of the upload by navigating to Data history > Read history of the company. Once the upload is complete, download the Enhanced cash flow report to view the resulting categorized bank statement in Lending > Reports.
To add, amend or remove records, upload a CSV file that contains the updated dataset you want recorded in Codat, and it will replace the existing dataset. For example, if you perform a monthly statement upload, each new CSV file must contain the data for all previously uploaded months as well as the new month.
To delete the dataset in its entirety, delete the existing data connection first, then upload the correct file. This will automatically create a new data connection.
Upload via API
To upload your customer's banking data using our API, follow these steps:
- Create data connection
First, use the Create a data connection endpoint to establish a new data connection for the company. Use zpqy as the platform key in the request body.
- Set upload configuration
Before creating the data, you must define its source type and account. This tells us what format to expect the data in. Use the Set upload configuration endpoint to create the configuration.
To upload records that align with our Banking: Bank account and Banking: Transaction schemas, set codat as your source.
Each data connection can only have one configuration. To view existing configuration, use the Get upload configuration endpoint.
To change it, delete the connection, set the configuration for the new connectionId, and reupload the data.
- Start the upload session
Use the Start upload session endpoint to initiate a bank statement upload session for a given company. A session is a one-time process that lets accounts and transactions to be uploaded to Codat.
You can only have one active session per data type at a time. Additionally, the session will time out if no data is uploaded after 90 minutes. You can complete or cancel a session using the End upload session endpoint.
- Upload the data
During an active session, use the Upload data endpoint to upload an object that matches the Banking: Bank account schema or an array of objects that match the Banking: Transaction schema.
If you need to add, amend or remove the banking transaction records, upload the whole dataset again and include the changed records in it. To delete the records, delete the data connection first, create a new one, and upload the data for the new connectionId.
- End the upload session
Use the End upload session to indicate that you want to finalize the bank statement upload process. Include Cancel in the request body to cancel the processing of the dataset or Process to trigger the ingestion and enrichment of the data.
You can check the progress by calling the Get read operation endpoint. Once complete, read the resulting categorized bank statement using the Get categorized bank statement endpoint.
We have covered the options to upload banking data from your existing provider using our Portal and our API. Next, you may want to learn more about our categorized bank statements.