API Documentation

[Mobile] Table of Contents:

Trial Balance File

A listing of all accounts in CorePro for a given bank with these qualities (as of the effective date of the file):

  • All customer accounts in an Open status
  • All customer accounts which have a non-zero balance
  • All program accounts

Trial Balance File Definition

This file is created by CorePro on a daily basis. It has the following properties:

  1. Exactly one tab-delimited header line.
  2. Zero or more tab-delimited content lines.
  3. A tab character (\t, or 0x09) embedded in actual text content will be replaced with a space character (" ", or 0x20) during file generation
  4. Although most other files created and consumed by CorePro are fixed-length in nature, this file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contains large sections of empty columns.
  5. ANSI encoded
  6. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  7. File will be available in the relative directory of /TrialBalanceFiles/Daily. The file created for the last day of a given month will also be copied /TrialBalanceFiles/Monthly. (i.e. two copies of same file will exist in each of Daily and Monthly subfolders)
  8. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_{BANKNAME}_TrialBalanceExport_{PRODUCTCATEGORY}.TXT, where {BANKNAME} is the name of the bank, and {PRODUCTCATEGORY} is either CHECKING or SAVINGS.
    • The date in the file name is the creation date of the file. The data it contains will typically be from the end of the previous day.
    • For example, if the file name is 201501080015_EXAMPLEBANK_TrialBalanceExport_CHECKING.TXT, the data it contains will usually -- but not necessarily -- apply to Jan 7 2015.
    • Root-relative path on sftp.corepro.io for that file would be: /TrialBalanceFiles/Daily/201501080015_EXAMPLEBANK_TrialBalanceExport_CHECKING.TXT

Format Disclaimer
Q2 Open reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.

Implementation Note
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as being 872 bytes per line, receiving a file with 984 bytes per line should not disrupt your processing. This applies to both Header and Content lines.

 File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on the FileCreatedDate or FileEffectiveDate contained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.

Header Row

Property Data Type (Max Length) Tab Offset Description
FileName string (50) 0 The name of this request file excluding path. Will be named following this pattern:
  1. yyyyMMddhhmm_EXAMPLEBANK_TrialBalance_CHECKING.TXT
  2. Example: 201410210148_EXAMPLEBANK_TrialBalance_CHECKING.TXT
RecordCount integer (10) 1 The number of records represented within the file.
NOTE: This field is zero-padded on the left side. e.g.: 0000000872
FileCreatedDate datetime (34) 2 The date the file was created.
Follows same format as API e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
FileEffectiveDate datetime (34) 3 The date to which the data in the file pertains.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.

Content Row

Property Data Type (Max Length) Tab Offset Description
Program Name string (50) 4 The name of the program with which the line item is associated.
Client Name string (50) 5 The name of the client with which the line item is associated.
CustomerId integer (10) 0 The customerId property of the customer object.
FirstName string (64) 1 The firstName property of the customer object.
MiddleName string (64) 2 The middleName property of the customer object.
LastName string (128) 3 The lastName property of the customer object.
FullName string (256) 4 A nicely formatted concatenation of the firstName, middleName, and lastName properties of the customer object.
AccountCreatedDate datetime 5 The createdDate property of the account object.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
AccountName string (50) 6 The name property of the account object.
AccountNumber string (17) 7 The accountNumber property of the account object.
EffectiveDateEndingBalance decimal 8 The accountBalance property of the account object as of the FileEffectiveDate in the file header.
Always contains two digits of precision to the right of the decimal. Follows same format as API for monetary values. e.g.: 13.00. See decimal format details.
EffectiveDateInterestAccrued decimal 9 The interest accrued for the account on the day of the FileEffectiveDate in the file header.
Always contains four digits of precision to the right of the decimal. Follows same format as API for Interest values. e.g.: 0.0020. See decimal format details.
PeriodAverageDailyBalance decimal 10 The average daily balance for the account from the beginning of the period through the FileEffectiveDate in the file header.
Always contains two digits of precision to the right of the decimal. Follows same format as API for monetary values. e.g.: 13.00. See decimal format details.
PeriodInterestAccrued decimal 11 The interest accrued for the account from the beginning of the period through the FileEffectiveDate in the file header.
Always contains four digits of precision to the right of the decimal. Follows same format as API for Interest values. e.g.: 0.0020. See decimal format details.
PeriodRoundedInterestAccrued decimal 12 The rounded interest accrued for the account from the beginning of the period through the FileEffectiveDate in the file header.
Always contains two digits of precision to the right of the decimal. Follows same format as API for Interest values. e.g.: 0.01. See decimal format details.
PeriodInterestPaid decimal 13 The total amount of interest paid on the account from the beginning of the period through the FileEffectiveDate in the file header.
Always contains two digits of precision to the right of the decimal. Follows same format as API for monetary values. e.g.: 13.00. See decimal format details.
YearToDateInterestPaid decimal 14 The total amount of interest paid on the account from the beginning of the year through the FileEffectiveDate in the file header.
Always contains two digits of precision to the right of the decimal. Follows same format as API for monetary values. e.g.: 13.00. See decimal format details.
InterestRate decimal 15 The Annual Percentage Rate (configured in CorePro Admin) used during interest calculations on the account that was effective on the FileEffectiveDate in the file header.
Always contains eleven digits of precision to the right of the decimal. Follows same format as API for monetary values. e.g.: 0.00957389763. See decimal format details.
BeneficiaryCount integer (10) 16 The number of active beneficiaries the customer had effective on the FileEffectiveDate in the file header.
ProductName string (100) 17 The name property of the customer object.
TaxId string (30) 18 The taxId property of the customer object.
AccountId integer (10) 19 The accountId property of the account object.

Example Trial Balance File

Content: See 201504180415_SAMPLEBANK_TRIALBALANCEEXPORT_DDA.TXT


NOTE: Your browser or text editor may wrap the text to fit the window or silently convert the delimiter tab characters to spaces. Actual source file does not wrap and has delimiter tab characters.

Ready to start a conversation?

Email Us