Reporting

Schedule a settlement report

post/reporting

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/reporting
  • Auth: HTTP basic

Request body

from_datestring date required

Starting date (inclusive) of transactions included in the settlement report

statement_subject_idstring nullable

The subject of the statement

to_datestring date required

Ending date (inclusive) of transactions included in the settlement report

typestring required

Settlement report type. Can be bank_account_summary, bank_account_transaction, loan_daily_summary.

Response

Successful response

bai2_document_idstring required

The ID of the BAI2 document

columnsstring[] required

List of columns in the settlement report. Refer to Reporting Guidance for more details.

completed_atstring date-time nullable required

The timestamp the settlement report was generated successfully

created_atstring date-time required

The timestamp the settlement report was scheduled

csv_document_idstring required

Document ID to download the CSV format of the settlement report

from_datestring date required

Starting date (inclusive, from the beginning of from_date in time_zone) of transactions included in the settlement report

idstring required

Unique identifier for the object

initiated_atstring date-time nullable required

The timestamp the settlement report was initiated to be processed

json_document_idstring required

Document ID to download the JSON format of the settlement report

parquet_document_idstring required

Document ID to download the Parquet format of the settlement report

pdf_document_idstring required

The ID of the PDF document

row_countinteger nullable required

Total number of records in the settlement report

statement_subjectstring nullable required

The subject of the statement

statement_subject_descriptionstring

Description of the statement subject

statusstring required

The current status of the report. Either scheduled or completed. Reports remain scheduled until generation succeeds, at which point they transition to completed.

time_zonestring required

Time zone of the settlement report to decide day boundaries. It is a value defined in the IANA TZ database (e.g., America/Los_Angeles, UTC, etc.).

to_datestring date required

Ending date (inclusive, up to the end of to_date in time_zone) of transactions included in the settlement report

typestring required

Settlement report type. Can be bank_account_summary, bank_account_transaction, bank_account_daily_statement, loan_daily_summary.

updated_atstring date-time required

The timestamp the settlement report was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.