Update a Journal Entry
curl --request PUT \
--url https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'teal-instance-id: <teal-instance-id>' \
--data '
{
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"line_entry_changes": {
"create": [
{
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"description": "Payroll#230215",
"tag_ids": [
"<string>"
],
"sort_order": 1
}
],
"update": [
{
"id": "XMDsKVuW4Wmi3LTW31Qw6E",
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"description": "<string>",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"tag_ids": [
"<string>"
],
"sort_order": 1
}
],
"delete": [
"<string>"
]
},
"review_status": "reviewed"
}
'import requests
url = "https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}"
payload = {
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"line_entry_changes": {
"create": [
{
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"description": "Payroll#230215",
"tag_ids": ["<string>"],
"sort_order": 1
}
],
"update": [
{
"id": "XMDsKVuW4Wmi3LTW31Qw6E",
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"description": "<string>",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"tag_ids": ["<string>"],
"sort_order": 1
}
],
"delete": ["<string>"]
},
"review_status": "reviewed"
}
headers = {
"teal-instance-id": "<teal-instance-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'teal-instance-id': '<teal-instance-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
datetime: '2023-02-15T06:42:18Z',
description: 'Payroll#230215',
line_entry_changes: {
create: [
{
amount: '31282.27999999999883584678173065185546875',
debit_credit: 'credit',
ledger_id: '7JRNsKwy2Lw66caxVU7WGC',
description: 'Payroll#230215',
tag_ids: ['<string>'],
sort_order: 1
}
],
update: [
{
id: 'XMDsKVuW4Wmi3LTW31Qw6E',
amount: '31282.27999999999883584678173065185546875',
debit_credit: 'credit',
description: '<string>',
ledger_id: '7JRNsKwy2Lw66caxVU7WGC',
tag_ids: ['<string>'],
sort_order: 1
}
],
delete: ['<string>']
},
review_status: 'reviewed'
})
};
fetch('https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'datetime' => '2023-02-15T06:42:18Z',
'description' => 'Payroll#230215',
'line_entry_changes' => [
'create' => [
[
'amount' => '31282.27999999999883584678173065185546875',
'debit_credit' => 'credit',
'ledger_id' => '7JRNsKwy2Lw66caxVU7WGC',
'description' => 'Payroll#230215',
'tag_ids' => [
'<string>'
],
'sort_order' => 1
]
],
'update' => [
[
'id' => 'XMDsKVuW4Wmi3LTW31Qw6E',
'amount' => '31282.27999999999883584678173065185546875',
'debit_credit' => 'credit',
'description' => '<string>',
'ledger_id' => '7JRNsKwy2Lw66caxVU7WGC',
'tag_ids' => [
'<string>'
],
'sort_order' => 1
]
],
'delete' => [
'<string>'
]
],
'review_status' => 'reviewed'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"teal-instance-id: <teal-instance-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}"
payload := strings.NewReader("{\n \"datetime\": \"2023-02-15T06:42:18Z\",\n \"description\": \"Payroll#230215\",\n \"line_entry_changes\": {\n \"create\": [\n {\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"description\": \"Payroll#230215\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"update\": [\n {\n \"id\": \"XMDsKVuW4Wmi3LTW31Qw6E\",\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"description\": \"<string>\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n },\n \"review_status\": \"reviewed\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("teal-instance-id", "<teal-instance-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}")
.header("teal-instance-id", "<teal-instance-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"datetime\": \"2023-02-15T06:42:18Z\",\n \"description\": \"Payroll#230215\",\n \"line_entry_changes\": {\n \"create\": [\n {\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"description\": \"Payroll#230215\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"update\": [\n {\n \"id\": \"XMDsKVuW4Wmi3LTW31Qw6E\",\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"description\": \"<string>\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n },\n \"review_status\": \"reviewed\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["teal-instance-id"] = '<teal-instance-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"datetime\": \"2023-02-15T06:42:18Z\",\n \"description\": \"Payroll#230215\",\n \"line_entry_changes\": {\n \"create\": [\n {\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"description\": \"Payroll#230215\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"update\": [\n {\n \"id\": \"XMDsKVuW4Wmi3LTW31Qw6E\",\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"description\": \"<string>\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n },\n \"review_status\": \"reviewed\"\n}"
response = http.request(request)
puts response.read_body{
"id": "C4ocnUQze8kDwQ3EczkZXn",
"description": "Payroll#230215",
"datetime": "2023-02-15T06:42:18Z",
"creation_date": "2023-02-15T06:42:18Z",
"is_opening_balance": false,
"creation_source": "manual",
"categorization_status": "pending",
"review_status": "unreviewed",
"line_entry_ids": [
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
],
"linked_entity": null,
"review_status_set_at": "2023-02-15T06:42:18Z",
"line_entries": [
{
"amount": 31282.28,
"categorization_status": "completed",
"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",
"sort_order": 1,
"tags": [],
"transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
},
{
"amount": 31282.28,
"categorization_status": "completed",
"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",
"sort_order": 2,
"tags": []
}
],
"accrual_source": {
"id": "<string>",
"instance_id": "<string>",
"type": "invoice",
"status": "paid",
"display_status": "paid",
"effective_date": "2023-12-25",
"gross_amount": 123,
"amount_paid": 123,
"amount_adjusted": 123,
"amount_outstanding": 123,
"external_id": "<string>",
"reference_number": "",
"external_party_id": "<string>",
"due_date": "2023-12-25",
"notes": "<string>",
"service_period_start": "2023-12-25",
"service_period_end": "2023-12-25",
"lines": [
{
"id": "<string>",
"accrual_source_id": "<string>",
"account_id": "<string>",
"line_number": 123,
"description": "<string>",
"amount": 123,
"external_id": "<string>"
}
],
"journal_entry_ids": [],
"files": [
{
"id": "<string>",
"file_name": "<string>"
}
],
"payment_applications": [
{
"payment_application_id": "<string>",
"matched_amount": 123,
"line_entry": {
"line_entry_id": "<string>",
"line_entry_description": "<string>",
"line_entry_amount": 123,
"journal_entry_id": "<string>",
"journal_entry_description": "<string>"
},
"source_type": "bank_transaction",
"status": "proposed",
"adjustments": [
{
"accrual_adjustment_id": "<string>",
"debit_account_id": "<string>",
"credit_account_id": "<string>",
"amount": 123
}
]
}
]
},
"transfer": {
"id": "<string>",
"from_entry": {
"journal_entry_id": "<string>",
"description": "<string>",
"datetime": "2023-11-07T05:31:56Z",
"line_entries": [
{
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"id": "XMDsKVuW4Wmi3LTW31Qw6E",
"datetime": "2023-02-15T06:42:18Z",
"editable": true,
"journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
"journal_entry_description": "Payroll#230215",
"categorization_status": "completed",
"ledger_name": "Payroll Expense",
"description": "Payroll#230215",
"related_line_entry_id": "<string>",
"transaction_id": "<string>",
"sort_order": 1,
"journal_entry": null,
"ledger": null,
"opposing_ledger_ids": [
"<string>"
],
"tags": [
{
"id": "UjL3BQnEaJtecuC7CUeDk",
"name": "Sprinter - 1ab-c23",
"tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
}
],
"transaction": null,
"payment_applications": [
{
"payment_application_id": "<string>",
"matched_amount": 123,
"accrual_source": {
"accrual_source_id": "<string>",
"type": "invoice",
"external_id": "<string>",
"external_party_id": "<string>",
"effective_date": "2023-12-25",
"gross_amount": 123,
"reference_number": ""
},
"source_type": "bank_transaction",
"status": "proposed",
"adjustments": [
{
"accrual_adjustment_id": "<string>",
"debit_account_id": "<string>",
"credit_account_id": "<string>",
"amount": 123
}
]
}
],
"line_payment_applications": [
{
"line_payment_application_id": "<string>",
"matched_amount": 123,
"accrual_source": {
"accrual_source_id": "<string>",
"type": "payroll",
"start_date": "2023-12-25",
"end_date": "2023-12-25"
},
"source_type": "bank_transaction",
"status": "proposed"
}
],
"accrual_source": {
"id": "<string>",
"instance_id": "<string>",
"type": "invoice",
"status": "paid",
"display_status": "paid",
"effective_date": "2023-12-25",
"gross_amount": 123,
"amount_paid": 123,
"amount_adjusted": 123,
"amount_outstanding": 123,
"external_id": "<string>",
"reference_number": "",
"external_party_id": "<string>",
"due_date": "2023-12-25",
"notes": "<string>",
"service_period_start": "2023-12-25",
"service_period_end": "2023-12-25",
"lines": [
{
"id": "<string>",
"accrual_source_id": "<string>",
"account_id": "<string>",
"line_number": 123,
"description": "<string>",
"amount": 123,
"external_id": "<string>"
}
]
}
}
]
},
"to_entry": {
"journal_entry_id": "<string>",
"description": "<string>",
"datetime": "2023-11-07T05:31:56Z",
"line_entries": [
{
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"id": "XMDsKVuW4Wmi3LTW31Qw6E",
"datetime": "2023-02-15T06:42:18Z",
"editable": true,
"journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
"journal_entry_description": "Payroll#230215",
"categorization_status": "completed",
"ledger_name": "Payroll Expense",
"description": "Payroll#230215",
"related_line_entry_id": "<string>",
"transaction_id": "<string>",
"sort_order": 1,
"journal_entry": null,
"ledger": null,
"opposing_ledger_ids": [
"<string>"
],
"tags": [
{
"id": "UjL3BQnEaJtecuC7CUeDk",
"name": "Sprinter - 1ab-c23",
"tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
}
],
"transaction": null,
"payment_applications": [
{
"payment_application_id": "<string>",
"matched_amount": 123,
"accrual_source": {
"accrual_source_id": "<string>",
"type": "invoice",
"external_id": "<string>",
"external_party_id": "<string>",
"effective_date": "2023-12-25",
"gross_amount": 123,
"reference_number": ""
},
"source_type": "bank_transaction",
"status": "proposed",
"adjustments": [
{
"accrual_adjustment_id": "<string>",
"debit_account_id": "<string>",
"credit_account_id": "<string>",
"amount": 123
}
]
}
],
"line_payment_applications": [
{
"line_payment_application_id": "<string>",
"matched_amount": 123,
"accrual_source": {
"accrual_source_id": "<string>",
"type": "payroll",
"start_date": "2023-12-25",
"end_date": "2023-12-25"
},
"source_type": "bank_transaction",
"status": "proposed"
}
],
"accrual_source": {
"id": "<string>",
"instance_id": "<string>",
"type": "invoice",
"status": "paid",
"display_status": "paid",
"effective_date": "2023-12-25",
"gross_amount": 123,
"amount_paid": 123,
"amount_adjusted": 123,
"amount_outstanding": 123,
"external_id": "<string>",
"reference_number": "",
"external_party_id": "<string>",
"due_date": "2023-12-25",
"notes": "<string>",
"service_period_start": "2023-12-25",
"service_period_end": "2023-12-25",
"lines": [
{
"id": "<string>",
"accrual_source_id": "<string>",
"account_id": "<string>",
"line_number": 123,
"description": "<string>",
"amount": 123,
"external_id": "<string>"
}
]
}
}
]
}
},
"autocat_result": {
"id": "ac_9kSx1s5F8kQ2s6c9m2Zt3W",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"method": "rule",
"confidence": 0.95,
"created_at": "2023-02-15T06:42:18Z",
"rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}Journal Entries
Update a Journal Entry
Updates an existing Journal Entry’s details or Line Entries. When updating Line Entries in the Journal Entry, debit and credit amounts must equal.
PUT
/
v0
/
journal-entries
/
{journal_entry_id}
Update a Journal Entry
curl --request PUT \
--url https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'teal-instance-id: <teal-instance-id>' \
--data '
{
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"line_entry_changes": {
"create": [
{
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"description": "Payroll#230215",
"tag_ids": [
"<string>"
],
"sort_order": 1
}
],
"update": [
{
"id": "XMDsKVuW4Wmi3LTW31Qw6E",
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"description": "<string>",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"tag_ids": [
"<string>"
],
"sort_order": 1
}
],
"delete": [
"<string>"
]
},
"review_status": "reviewed"
}
'import requests
url = "https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}"
payload = {
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"line_entry_changes": {
"create": [
{
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"description": "Payroll#230215",
"tag_ids": ["<string>"],
"sort_order": 1
}
],
"update": [
{
"id": "XMDsKVuW4Wmi3LTW31Qw6E",
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"description": "<string>",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"tag_ids": ["<string>"],
"sort_order": 1
}
],
"delete": ["<string>"]
},
"review_status": "reviewed"
}
headers = {
"teal-instance-id": "<teal-instance-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'teal-instance-id': '<teal-instance-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
datetime: '2023-02-15T06:42:18Z',
description: 'Payroll#230215',
line_entry_changes: {
create: [
{
amount: '31282.27999999999883584678173065185546875',
debit_credit: 'credit',
ledger_id: '7JRNsKwy2Lw66caxVU7WGC',
description: 'Payroll#230215',
tag_ids: ['<string>'],
sort_order: 1
}
],
update: [
{
id: 'XMDsKVuW4Wmi3LTW31Qw6E',
amount: '31282.27999999999883584678173065185546875',
debit_credit: 'credit',
description: '<string>',
ledger_id: '7JRNsKwy2Lw66caxVU7WGC',
tag_ids: ['<string>'],
sort_order: 1
}
],
delete: ['<string>']
},
review_status: 'reviewed'
})
};
fetch('https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'datetime' => '2023-02-15T06:42:18Z',
'description' => 'Payroll#230215',
'line_entry_changes' => [
'create' => [
[
'amount' => '31282.27999999999883584678173065185546875',
'debit_credit' => 'credit',
'ledger_id' => '7JRNsKwy2Lw66caxVU7WGC',
'description' => 'Payroll#230215',
'tag_ids' => [
'<string>'
],
'sort_order' => 1
]
],
'update' => [
[
'id' => 'XMDsKVuW4Wmi3LTW31Qw6E',
'amount' => '31282.27999999999883584678173065185546875',
'debit_credit' => 'credit',
'description' => '<string>',
'ledger_id' => '7JRNsKwy2Lw66caxVU7WGC',
'tag_ids' => [
'<string>'
],
'sort_order' => 1
]
],
'delete' => [
'<string>'
]
],
'review_status' => 'reviewed'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"teal-instance-id: <teal-instance-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}"
payload := strings.NewReader("{\n \"datetime\": \"2023-02-15T06:42:18Z\",\n \"description\": \"Payroll#230215\",\n \"line_entry_changes\": {\n \"create\": [\n {\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"description\": \"Payroll#230215\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"update\": [\n {\n \"id\": \"XMDsKVuW4Wmi3LTW31Qw6E\",\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"description\": \"<string>\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n },\n \"review_status\": \"reviewed\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("teal-instance-id", "<teal-instance-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}")
.header("teal-instance-id", "<teal-instance-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"datetime\": \"2023-02-15T06:42:18Z\",\n \"description\": \"Payroll#230215\",\n \"line_entry_changes\": {\n \"create\": [\n {\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"description\": \"Payroll#230215\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"update\": [\n {\n \"id\": \"XMDsKVuW4Wmi3LTW31Qw6E\",\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"description\": \"<string>\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n },\n \"review_status\": \"reviewed\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.teal.dev/v0/journal-entries/{journal_entry_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["teal-instance-id"] = '<teal-instance-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"datetime\": \"2023-02-15T06:42:18Z\",\n \"description\": \"Payroll#230215\",\n \"line_entry_changes\": {\n \"create\": [\n {\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"description\": \"Payroll#230215\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"update\": [\n {\n \"id\": \"XMDsKVuW4Wmi3LTW31Qw6E\",\n \"amount\": \"31282.27999999999883584678173065185546875\",\n \"debit_credit\": \"credit\",\n \"description\": \"<string>\",\n \"ledger_id\": \"7JRNsKwy2Lw66caxVU7WGC\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n },\n \"review_status\": \"reviewed\"\n}"
response = http.request(request)
puts response.read_body{
"id": "C4ocnUQze8kDwQ3EczkZXn",
"description": "Payroll#230215",
"datetime": "2023-02-15T06:42:18Z",
"creation_date": "2023-02-15T06:42:18Z",
"is_opening_balance": false,
"creation_source": "manual",
"categorization_status": "pending",
"review_status": "unreviewed",
"line_entry_ids": [
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
],
"linked_entity": null,
"review_status_set_at": "2023-02-15T06:42:18Z",
"line_entries": [
{
"amount": 31282.28,
"categorization_status": "completed",
"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",
"sort_order": 1,
"tags": [],
"transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
},
{
"amount": 31282.28,
"categorization_status": "completed",
"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",
"sort_order": 2,
"tags": []
}
],
"accrual_source": {
"id": "<string>",
"instance_id": "<string>",
"type": "invoice",
"status": "paid",
"display_status": "paid",
"effective_date": "2023-12-25",
"gross_amount": 123,
"amount_paid": 123,
"amount_adjusted": 123,
"amount_outstanding": 123,
"external_id": "<string>",
"reference_number": "",
"external_party_id": "<string>",
"due_date": "2023-12-25",
"notes": "<string>",
"service_period_start": "2023-12-25",
"service_period_end": "2023-12-25",
"lines": [
{
"id": "<string>",
"accrual_source_id": "<string>",
"account_id": "<string>",
"line_number": 123,
"description": "<string>",
"amount": 123,
"external_id": "<string>"
}
],
"journal_entry_ids": [],
"files": [
{
"id": "<string>",
"file_name": "<string>"
}
],
"payment_applications": [
{
"payment_application_id": "<string>",
"matched_amount": 123,
"line_entry": {
"line_entry_id": "<string>",
"line_entry_description": "<string>",
"line_entry_amount": 123,
"journal_entry_id": "<string>",
"journal_entry_description": "<string>"
},
"source_type": "bank_transaction",
"status": "proposed",
"adjustments": [
{
"accrual_adjustment_id": "<string>",
"debit_account_id": "<string>",
"credit_account_id": "<string>",
"amount": 123
}
]
}
]
},
"transfer": {
"id": "<string>",
"from_entry": {
"journal_entry_id": "<string>",
"description": "<string>",
"datetime": "2023-11-07T05:31:56Z",
"line_entries": [
{
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"id": "XMDsKVuW4Wmi3LTW31Qw6E",
"datetime": "2023-02-15T06:42:18Z",
"editable": true,
"journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
"journal_entry_description": "Payroll#230215",
"categorization_status": "completed",
"ledger_name": "Payroll Expense",
"description": "Payroll#230215",
"related_line_entry_id": "<string>",
"transaction_id": "<string>",
"sort_order": 1,
"journal_entry": null,
"ledger": null,
"opposing_ledger_ids": [
"<string>"
],
"tags": [
{
"id": "UjL3BQnEaJtecuC7CUeDk",
"name": "Sprinter - 1ab-c23",
"tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
}
],
"transaction": null,
"payment_applications": [
{
"payment_application_id": "<string>",
"matched_amount": 123,
"accrual_source": {
"accrual_source_id": "<string>",
"type": "invoice",
"external_id": "<string>",
"external_party_id": "<string>",
"effective_date": "2023-12-25",
"gross_amount": 123,
"reference_number": ""
},
"source_type": "bank_transaction",
"status": "proposed",
"adjustments": [
{
"accrual_adjustment_id": "<string>",
"debit_account_id": "<string>",
"credit_account_id": "<string>",
"amount": 123
}
]
}
],
"line_payment_applications": [
{
"line_payment_application_id": "<string>",
"matched_amount": 123,
"accrual_source": {
"accrual_source_id": "<string>",
"type": "payroll",
"start_date": "2023-12-25",
"end_date": "2023-12-25"
},
"source_type": "bank_transaction",
"status": "proposed"
}
],
"accrual_source": {
"id": "<string>",
"instance_id": "<string>",
"type": "invoice",
"status": "paid",
"display_status": "paid",
"effective_date": "2023-12-25",
"gross_amount": 123,
"amount_paid": 123,
"amount_adjusted": 123,
"amount_outstanding": 123,
"external_id": "<string>",
"reference_number": "",
"external_party_id": "<string>",
"due_date": "2023-12-25",
"notes": "<string>",
"service_period_start": "2023-12-25",
"service_period_end": "2023-12-25",
"lines": [
{
"id": "<string>",
"accrual_source_id": "<string>",
"account_id": "<string>",
"line_number": 123,
"description": "<string>",
"amount": 123,
"external_id": "<string>"
}
]
}
}
]
},
"to_entry": {
"journal_entry_id": "<string>",
"description": "<string>",
"datetime": "2023-11-07T05:31:56Z",
"line_entries": [
{
"amount": "31282.27999999999883584678173065185546875",
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"id": "XMDsKVuW4Wmi3LTW31Qw6E",
"datetime": "2023-02-15T06:42:18Z",
"editable": true,
"journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
"journal_entry_description": "Payroll#230215",
"categorization_status": "completed",
"ledger_name": "Payroll Expense",
"description": "Payroll#230215",
"related_line_entry_id": "<string>",
"transaction_id": "<string>",
"sort_order": 1,
"journal_entry": null,
"ledger": null,
"opposing_ledger_ids": [
"<string>"
],
"tags": [
{
"id": "UjL3BQnEaJtecuC7CUeDk",
"name": "Sprinter - 1ab-c23",
"tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
}
],
"transaction": null,
"payment_applications": [
{
"payment_application_id": "<string>",
"matched_amount": 123,
"accrual_source": {
"accrual_source_id": "<string>",
"type": "invoice",
"external_id": "<string>",
"external_party_id": "<string>",
"effective_date": "2023-12-25",
"gross_amount": 123,
"reference_number": ""
},
"source_type": "bank_transaction",
"status": "proposed",
"adjustments": [
{
"accrual_adjustment_id": "<string>",
"debit_account_id": "<string>",
"credit_account_id": "<string>",
"amount": 123
}
]
}
],
"line_payment_applications": [
{
"line_payment_application_id": "<string>",
"matched_amount": 123,
"accrual_source": {
"accrual_source_id": "<string>",
"type": "payroll",
"start_date": "2023-12-25",
"end_date": "2023-12-25"
},
"source_type": "bank_transaction",
"status": "proposed"
}
],
"accrual_source": {
"id": "<string>",
"instance_id": "<string>",
"type": "invoice",
"status": "paid",
"display_status": "paid",
"effective_date": "2023-12-25",
"gross_amount": 123,
"amount_paid": 123,
"amount_adjusted": 123,
"amount_outstanding": 123,
"external_id": "<string>",
"reference_number": "",
"external_party_id": "<string>",
"due_date": "2023-12-25",
"notes": "<string>",
"service_period_start": "2023-12-25",
"service_period_end": "2023-12-25",
"lines": [
{
"id": "<string>",
"accrual_source_id": "<string>",
"account_id": "<string>",
"line_number": 123,
"description": "<string>",
"amount": 123,
"external_id": "<string>"
}
]
}
}
]
}
},
"autocat_result": {
"id": "ac_9kSx1s5F8kQ2s6c9m2Zt3W",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"method": "rule",
"confidence": 0.95,
"created_at": "2023-02-15T06:42:18Z",
"rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}Authorizations
Bearer authentication header of the form Bearer , where is your auth token.
Headers
The Teal instance ID
An optional identifier for audit logging.
Path Parameters
Journal entry ID
Query Parameters
Comma-separated list of expand paths.
Available options:
accrual_source, autocat_result, line_entries, line_entries.transaction, line_entries.ledger, line_entries.opposing_ledger_ids, line_entries.payment_applications, line_entries.line_payment_applications, transfer Body
application/json
The datetime the Journal Entry was created in UTC time.
Example:
"2023-02-15T06:42:18Z"
An arbitrary string on the object, useful for displaying to the user.
Maximum string length:
512Example:
"Payroll#230215"
An object with optional create, update,
and delete parameters to modify the Line Entries associated with
the Journal Entry. The create and update parameters accept lists of
Line Entry objects, while the delete parameter accepts a list of
existing Line Entry IDs.
Show child attributes
Show child attributes
Set the review status of the Journal Entry.
Available options:
unreviewed, reviewed Example:
"reviewed"
Response
Successful Response
The unique ID of the object.
Example:
"C4ocnUQze8kDwQ3EczkZXn"
An arbitrary string on the object, useful for displaying to the user.
Maximum string length:
512Example:
"Payroll#230215"
The datetime the Journal Entry was created in UTC time.
Example:
"2023-02-15T06:42:18Z"
The timestamp when this journal entry record was created in the database.
Example:
"2023-02-15T06:42:18Z"
Whether the Journal Entry represents an opening balance.
Example:
false
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, payment_application, legacy, scheduled_accrual Whether the journal entry is still awaiting an auto-categorization result: 'pending' (awaiting), 'delayed' (timed out, a late result may still resolve it), 'completed' (resolved, or not auto-categorized), or 'not_attempted' (categorization is disabled for the instance, so no result was ever requested and none will arrive).
Available options:
pending, delayed, completed, not_attempted Whether the user has reviewed the Journal Entry. New Journal Entries default to 'unreviewed'.
Available options:
unreviewed, reviewed The ids of the Line Entries detailing the Journal Entry's movement of value.
Example:
[
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]
Deprecated - always null
When the review status was last set. Null if the Journal Entry has never been reviewed.
Example:
"2023-02-15T06:42:18Z"
List of Line Entries. Included in expanded responses.
Show child attributes
Show child attributes
Example:
[
{
"amount": 31282.28,
"categorization_status": "completed",
"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",
"sort_order": 1,
"tags": [],
"transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
},
{
"amount": 31282.28,
"categorization_status": "completed",
"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",
"sort_order": 2,
"tags": []
}
]
The accrual source associated with this journal entry, if any. Included in expanded responses.
Show child attributes
Show child attributes
The transfer linking this journal entry to the journal entry on the other side of the transfer, if any. Included in expanded responses.
Show child attributes
Show child attributes
The auto-categorization result for the transaction underlying this journal entry, if any: how the category ledger was assigned (method, confidence, and rule). Null for manual journal entries, entries not categorized by the autocat pipeline, and entries a user has since manually recategorized (a manual categorization overrides the autocat result). Included in expanded responses.
Show child attributes
Show child attributes