Skip to main content
PUT
/
v1
/
ledgers
/
{id}
/
status
Update ledger status
curl --request PUT \
  --url https://api.example.com/v1/ledgers/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "closing_date": "2023-11-07T05:31:56Z",
  "closing_reason": "<string>"
}
'
{
  "ledger": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "code": "<string>",
    "description": "<string>",
    "type": "asset",
    "currency_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency_code": "<string>",
    "balance_current": 123,
    "balance_available": 123,
    "overdraft_enabled": true,
    "overdraft_limit": 123,
    "last_activity_date": "2023-11-07T05:31:56Z",
    "opening_date": "2023-11-07T05:31:56Z",
    "closing_date": "2023-11-07T05:31:56Z",
    "parent_ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "child_ledger_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_at": "2023-11-07T05:31:56Z",
    "modified_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "active": true,
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Ledger UUID

Body

application/json
​
active
boolean
required

Set ledger active status

​
closing_date
string<date-time>

Date when ledger should be closed

​
closing_reason
string

Reason for closing the ledger

Response

200 - application/json

Status updated successfully

​
ledger
object