Skip to main content
PUT
/
v0
/
line-entries
/
{line_entry_id}
Update a Line Entry
curl --request PUT \
  --url https://api.sandbox.teal.dev/v0/line-entries/{line_entry_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '
{
  "description": "<string>",
  "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
  "tag_ids": [
    "<string>"
  ]
}
'
{
  "amount": 123,
  "debit_credit": "debit",
  "ledger_id": "<string>",
  "id": "XMDsKVuW4Wmi3LTW31Qw6E",
  "datetime": "2023-11-07T05:31:56Z",
  "editable": true,
  "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
  "journal_entry_description": "<string>",
  "ledger_name": "<string>",
  "description": "Payroll#230215",
  "related_line_entry_id": "<string>",
  "transaction_id": "<string>",
  "journal_entry": {
    "creation_date": "2023-02-15T06:42:18Z",
    "creation_source": "manual",
    "datetime": "2023-02-15T06:42:18Z",
    "description": "Payroll#230215",
    "id": "C4ocnUQze8kDwQ3EczkZXn",
    "is_opening_balance": false,
    "line_entry_ids": [
      "XMDsKVuW4Wmi3LTW31Qw6E",
      "NULcvXTkLczde32qs1rqgB"
    ]
  },
  "ledger": {
    "created_at": "2024-01-01T00:00:00",
    "debit_credit": "debit",
    "editable": false,
    "financial_account_type": "bank_account",
    "id": "7JRNsKwy2Lw66caxVU7WGC",
    "is_required": false,
    "name": "Pluto Checking 4242",
    "report_cash_flow": true,
    "sort_code": "2240",
    "sub_type": "current_assets",
    "type": "asset"
  },
  "opposing_ledger_ids": [
    "<string>"
  ],
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "tag_group_id": "<string>"
    }
  ],
  "transaction": {
    "amount": 31282.28,
    "datetime": "2023-02-15T06:42:18Z",
    "description": "Payroll#230215",
    "id": "txn_UjL3BQnEaJtecuC7CUeDk",
    "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
    "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
    "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E",
    "personal": false,
    "posted_status": "posted",
    "review_status": "reviewed",
    "source_account_id": "L7RR1Yz85FJoASPvPLs441"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
teal-instance-id
string
required

The Teal instance ID

​
modified-by
string | null

An optional identifier for audit logging.

Path Parameters

​
line_entry_id
string
required

The line entry ID

Query Parameters

​
expand
enum<string>[] | null

Comma-separated list of Line Entry expand paths.

Available options:
transaction,
ledger,
journal_entry,
opposing_ledger_ids

Body

application/json
​
description
string | null

An arbitrary string on the object, useful for displaying to the user or for categorization.

​
ledger_id
string | null

The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

​
tag_ids
string[] | null

A list of IDs of the Tag objects associated with the Line Entry.

Response

Successful Response

​
amount
number
required

The value of the line entry in decimal dollar cents.

Example:

"31282.27999999999883584678173065185546875"

​
debit_credit
enum<string>
required

Indicates if the amount is a credit or debit.

Available options:
debit,
credit
Example:

"credit"

​
ledger_id
string
required

The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

​
id
string | null
required

The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.

Example:

"XMDsKVuW4Wmi3LTW31Qw6E"

​
datetime
string<date-time>
required

The datetime the Line Entry was created in UTC time.

Example:

"2023-02-15T06:42:18Z"

​
editable
boolean
required

Indicates if the Line Entry can be manually added or removed from a Ledger, as dictated by the editable property on the Ledger.

Example:

true

​
journal_entry_id
string | null
required

The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.

Example:

"C4ocnUQze8kDwQ3EczkZXn"

​
journal_entry_description
string
required

An arbitrary string on the object, useful for displaying to users.

Example:

"Payroll#230215"

​
ledger_name
string
required

The name of the Line Entry's Ledger.

Example:

"Payroll Expense"

​
description
string | null

An arbitrary string on the object, useful for displaying to the user or for categorization.

Example:

"Payroll#230215"

​
related_line_entry_id
string | null

If the Line Entry is identified as a transfer between accounts, the ID of the Line Entry in the opposing Ledger. Related guide: Auto-categorization

​
transaction_id
string | null

The ID of the associated Transaction, if one exists.

​
journal_entry
JournalEntry · object

Expandable. The associated Journal Entry object.

Example:
{
  "creation_date": "2023-02-15T06:42:18Z",
  "creation_source": "manual",
  "datetime": "2023-02-15T06:42:18Z",
  "description": "Payroll#230215",
  "id": "C4ocnUQze8kDwQ3EczkZXn",
  "is_opening_balance": false,
  "line_entry_ids": [
    "XMDsKVuW4Wmi3LTW31Qw6E",
    "NULcvXTkLczde32qs1rqgB"
  ]
}
​
ledger
Ledger · object

Expandable. The associated Ledger object.

Example:
{
  "created_at": "2024-01-01T00:00:00",
  "debit_credit": "debit",
  "editable": false,
  "financial_account_type": "bank_account",
  "id": "7JRNsKwy2Lw66caxVU7WGC",
  "is_required": false,
  "name": "Pluto Checking 4242",
  "report_cash_flow": true,
  "sort_code": "2240",
  "sub_type": "current_assets",
  "type": "asset"
}
​
opposing_ledger_ids
string[] | null

Expandable. IDs of the ledgers on the other side(s) of the line entry with opposite debit/credit.

​
tags
Tag · object[] | null

A list of all the Tags associated with the Line Entry, if any.

​
transaction
Transaction · object

Expandable. The associated Transaction object, if one exists.

Example:
{
  "amount": 31282.28,
  "datetime": "2023-02-15T06:42:18Z",
  "description": "Payroll#230215",
  "id": "txn_UjL3BQnEaJtecuC7CUeDk",
  "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
  "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
  "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E",
  "personal": false,
  "posted_status": "posted",
  "review_status": "reviewed",
  "source_account_id": "L7RR1Yz85FJoASPvPLs441"
}