Skip to main content
POST
/
v0
/
journal-entries
Create a Journal Entry
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '
{
  "datetime": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "line_entries": [
    {
      "amount": "31282.27999999999883584678173065185546875",
      "debit_credit": "debit",
      "ledger_id": "<string>",
      "description": "Payroll#230215",
      "tag_ids": [
        "<string>"
      ]
    }
  ]
}
'
{
  "id": "<string>",
  "description": "<string>",
  "datetime": "2023-11-07T05:31:56Z",
  "creation_date": "2023-11-07T05:31:56Z",
  "is_opening_balance": true,
  "creation_source": "manual",
  "files": null,
  "line_entry_ids": [
    "XMDsKVuW4Wmi3LTW31Qw6E",
    "NULcvXTkLczde32qs1rqgB"
  ],
  "linked_entity": "<unknown>",
  "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

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.

Query Parameters

​
expand
enum<string>[] | null

Comma-separated list of expandable paths.

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

Body

application/json
​
datetime
string<date-time>
required

The datetime the Journal Entry was created in UTC time.

​
description
string
required

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

​
line_entries
LineEntryWithTags · object[]
required

The Line Entry objects to be associated with the Journal Entry. Must include at least two Line Entries, one debit and one credit, and the sum of the amounts of all debit entries must equal the sum of the amounts of the credit entries.

Response

Successful Response

​
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<date-time>
required

The datetime the Journal Entry was created in UTC time.

​
creation_date
string<date-time>
required

The timestamp when this journal entry record was created in the database.

​
is_opening_balance
boolean
required

Whether the Journal Entry represents an opening balance.

​
creation_source
enum<string>
required

The source of the journal entry creation: 'manual' if created manually by the user, 'transaction' if auto-generated from transaction categorization (e.g., Plaid sync), or 'legacy' if auto-generated from the old AR/AP system.

Available options:
manual,
transaction,
accrual,
legacy
​
files
JournalEntryFile · object[] | null

A list of files attached to the Journal Entry.

Example:

null

​
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.

Example:
[
  "XMDsKVuW4Wmi3LTW31Qw6E",
  "NULcvXTkLczde32qs1rqgB"
]
​
linked_entity
null

Deprecated - always null

​
line_entries
ExpandableDetailedLineEntry · object[] | null

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

Example:
[
  {
    "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": []
  }
]