GET
/
v0
/
journal-entries
/
{journal_entry_id}
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "id": "C4ocnUQze8kDwQ3EczkZXn",
  "description": "Payroll#230215",
  "datetime": "2023-02-15T06:42:18Z",
  "files": [
    {
      "id": "CNmWM3X6AcvRdEwZKxq4bL",
      "file_name": "invoice.pdf"
    }
  ],
  "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
headerrequired

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

Headers

teal-instance-id
string
required

The Teal instance ID

Path Parameters

journal_entry_id
string
required

Journal entry ID

Query Parameters

expand
enum<string>[] | null

Comma-separated list of expandable paths.

Available options:
line_entries,
line_entries.transaction,
line_entries.ledger

Response

200 - application/json
id
string
required

The unique ID of the object.

description
string
required

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

datetime
string
required

The datetime the Journal Entry was created in UTC time.

files
object[] | null

A list of files attached to the Journal Entry. Only available to Instances using Platform GL as their accounting package.

line_entry_ids
string[] | null

The ids of the Line Entries detailing the Journal Entry's movement of value. Only null if the Instance is using QuickBooks as their accounting package.

linked_entity
object | null

The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.

line_entries
object[] | null

List of Line Entries. platformGL instances only. Included in expanded responses.