Get a period by ID

GET/ledger/periods/{period}

A closed period's record

Path parameters

periodstringRequired

Returns

200 OK

The Period object.

Errors

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

400401403404409412413422424429500503

Request

curl -X GET 'https://api.dev.bank.corgi.com/ledger/periods/{period}' \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "already_closed": false,
  "checksum": "string",
  "closed_by": "string",
  "interest_journals": 0,
  "interest_posted_amount": 10000,
  "journal_count": 0,
  "period": "string",
  "ties": false,
  "total_credits": 0,
  "total_debits": 0
}