POST
/
v0
/
ledgers
/
{ledger_id}
/
opening-balance
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/opening-balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '{
  "balance": 123
}'
{
  "id": "C4ocnUQze8kDwQ3EczkZXn",
  "description": "Payroll#230215",
  "datetime": "2023-02-15T06:42:18Z",
  "files": null,
  "line_entry_ids": [
    "XMDsKVuW4Wmi3LTW31Qw6E",
    "NULcvXTkLczde32qs1rqgB"
  ],
  "linked_entity": {
    "type": "receivable",
    "id": "<string>"
  },
  "line_entries": [
    {
      "amount": 31282.28,
      "datetime": "2023-02-15T06:42:18Z",
      "debit_credit": "debit",
      "description": "Payroll#230215",
      "editable": false,
      "id": "XMDsKVuW4Wmi3LTW31Qw6E",
      "journal_entry_description": "Payroll#230215",
      "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
      "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
      "ledger_name": "Pluto Checking 4242",
      "tags": [],
      "transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
    },
    {
      "amount": 31282.28,
      "datetime": "2023-02-15T06:42:18Z",
      "debit_credit": "credit",
      "description": "Payroll#230215",
      "editable": false,
      "id": "NULcvXTkLczde32qs1rqgB",
      "journal_entry_description": "Payroll#230215",
      "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
      "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
      "ledger_name": "Payroll Expense",
      "tags": []
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
teal-instance-id
string
required

The Teal instance ID

​
modified-by
string | null

An optional identifier for audit logging.

Path Parameters

​
ledger_id
string
required

The ledger ID

Query Parameters

​
expand
enum<string>[] | null

Comma-separated list of Journal Entry expand paths.

Body

application/json

Response

201
application/json

Successful Response

The response is of type object.