Statement
CorePro creates monthly bank statements and yearly tax (1099) statements for customers who have accounts that are active during the period.
1099 Statements are only created and filed with the IRS if the minimum thresholds are met (currently $10 per year in interest income).
statement Object
Represents a single statement in CorePro.
details
Property | Data Type (length) |
Description |
---|---|---|
statementId |
integer | |
customerId |
integer | Customer who owns the Bank Account |
type |
string | Accepted values are:
|
month |
integer | |
year |
integer |
get
Get a statement for a customer
Note: When you provide an invalid identifier (id,tag, or emailAddress), all routes ending with /get
returns 400 (Bad Request).
GET /statement/get/{customerId}/{statementId}
Request Parameters
customerId |
Required | Customer ID (returned when customer originally created) |
statementId |
Required | Statement ID (returned from /statement/list) |
Response Data
A statement Object |
Error Codes
Code | Message (en-US) | Notes |
1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
Example
Request
GET /statement/get/456/55354 Authorization: Basic PutBase64TokenHere
Response
200
{ "data": { "statements": [ { "createdDate":"2012-04-03T18:28:20.620-05:00", "customerId":"456", "month":"3", "statementId":"55354", "type":"Monthly", "year":"2012", } ] }, "status":200, "errors":[] }
list
Get a list of all statements for a customer
GET /statement/list/{customerId}
Request Parameters
customerId |
Required | Customer ID (returned when customer was created) |
Response Data
A list of statement Objects |
Error Codes
Code | Message (en-US) | Notes |
1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
Example
Request
GET /statement/list/456 Authorization: Basic PutBase64TokenHere
Response
200
{ "data": { "statements": [ { "createdDate":"2012-09-03T18:28:20.620-05:00", "customerId":"456", "month":"8", "statementId":"55434", "type":"Monthly", "year":"2012", }, { "createdDate":"2012-02-03T18:28:20.620-05:00", "customerId":"456", "month":"1", "statementId":"55223", "type":"Tax1099INT", "year":"2012", } ] }, "status":200, "errors":[] }
search
Get a monthly or tax statement for a customer
GET /statement/search/{customerId}/{type}/{year}/{month}
Request Parameters
customerId |
Required | Customer ID (returned when customer originally created) |
type |
Required | Accepted values are:
|
year |
Required | 4-digit year of statement to return. E.g.: "2014" |
month |
Required | 2-digit month of statement to return. E.g.: "01" |
Response Data
A statement Object |
Error Codes
Code | Message (en-US) | Notes |
1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
67001 | Invalid Statement Type. Valid values are: 'Monthly', 'Tax1099INT'. | |
67002 | Year must be a valid 4 digit value. | |
67003 | Month must be between 1 and 12 inclusive. | |
67004 | Quarter must be between 1 and 4 inclusive. | |
Example
Request
GET /statement/search/456/monthly/2012/3 Authorization: Basic PutBase64TokenHere
Response
200
{ "data": { "statements": [ { "createdDate":"2012-04-03T18:28:20.620-05:00", "customerId":"456", "month":"3", "statementId":"55354", "type":"Monthly", "year":"2012", } ] }, "status":200, "errors":[] }
download
Download the PDF content of a monthly or tax statement for a customer
GET /statement/download/{customerId}/{statementId}
Request Parameters
customerId |
Required | Customer ID (returned when customer originally created) |
statementId |
Required | Statement ID (returned as part of the /statement/list results) |
Response Data
A fileContent object. |
Error Codes
Code | Message (en-US) | Notes |
1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
67101 | A statementId is required. | |
67102 | The requested statementId = {0} is invalid. | |
67103 | The requested statementId = {0} is configured improperly. Please contact support. | |
67104 | The requested statementId = {0} could not be located. |
Example
Request
GET /statement/download/ Authorization: Basic PutBase64TokenHere
Response
200
{ "data": { "contentType":"application/pdf", "contentLength":44, "content":"dGhpcyBpcyB3aGVyZSB0aGUgYWN0dWFsIHBkZiBieXRlcyB3b3VsZCBiZSE=", }, "status":200, "errors":[] }