Corgi BankDocumentation
OpenAPI

The Report object

SettlementReport is one scheduled report: what was asked for, where it got to, and the documents it produced.

Attributes

completed_atstring · date-time or nullOptional
created_atstring · date-timeRequired
customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

documentsarray of objectsRequired
4 child attributes
built_atstring · date-timeRequired
formatstringRequired
report_idstringRequired

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

sha256stringRequired
failure_reasonstringOptional
from_datestring · dateRequired

A business date, YYYY-MM-DD

idstringRequired

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

railstringOptional
requested_bystringRequired
scheduled_atstring · date-time or nullOptional
scopestringRequired
statusstringRequired
to_datestring · dateRequired

A business date, YYYY-MM-DD

typestringRequired

to move to open esc to close