OpenAPI

Month-end close for a period

POST/ledger/periods/{period}/close

Path parameters

periodstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

operatorstringRequired

Returns

200 OK

The Period object.

Errors

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

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/ledger/periods/{period}/close' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "operator": "string"
  }'

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
}