Skip to content

Corgi BankDocumentation

OpenAPI

Read a completed report's document as json or csv

GET/reports/{id}/documents/{format}

Path parameters

idstringRequired

formatstringRequired

Returns

200 OK

accountsarray of objectsRequired

9 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

closing_minorintegerRequired

ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ledger_movement_minorintegerRequired

ledger_readbooleanRequired

net_movement_minorintegerRequired

net_settlement_minorintegerRequired

opening_minorintegerRequired

other_postings_minorintegerRequired

currencystringRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

daysarray of objectsRequired

4 child attributes

business_datestring · dateRequired

A business date, YYYY-MM-DD

net_movement_minorintegerRequired

net_settlement_minorintegerRequired

railsarray of objectsRequired

7 child attributes

linesarray of objectsRequired

10 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired

categorystringRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

directionstringRequired

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

settlement_minorintegerRequired

signed_minorintegerRequired

transfer_idstringRequired

Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

net_movement_minorintegerRequired

net_settlement_minorintegerRequired

railstringRequired

returned_minorintegerRequired

settled_minorintegerRequired

windowstringRequired

from_datestring · dateRequired

A business date, YYYY-MM-DD

line_countintegerRequired

net_movement_minorintegerRequired

net_settlement_minorintegerRequired

notesarray of stringsRequired

railstringOptional

report_idstringRequired

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

scopestringRequired

tiesbooleanRequired

to_datestring · dateRequired

A business date, YYYY-MM-DD

typestringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X GET 'https://api.dev.bank.corgi.com/reports/{id}/documents/{format}' \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "accounts": [
    {
      "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "closing_minor": 0,
      "ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "ledger_movement_minor": 0,
      "ledger_read": false,
      "net_movement_minor": 0,
      "net_settlement_minor": 0,
      "opening_minor": 0,
      "other_postings_minor": 0
    }
  ],
  "currency": "USD",
  "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "days": [
    {
      "business_date": "2026-09-17",
      "net_movement_minor": 0,
      "net_settlement_minor": 0,
      "rails": [
        {}
      ]
    }
  ],
  "from_date": "2026-09-17",
  "line_count": 0,
  "net_movement_minor": 0,
  "net_settlement_minor": 0,
  "notes": [
    "string"
  ],
  "rail": "string",
  "report_id": "strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "scope": "string",
  "ties": false,
  "to_date": "2026-09-17",
  "type": "string"
}