curl --request POST \
--url https://api.sandbox.teal.dev/v0/ledgers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'teal-instance-id: <teal-instance-id>' \
--data '
{
"editable": true,
"name": "Pluto Checking 4242",
"debit_credit": "debit",
"financial_account_type": null,
"parent_id": null,
"report_cash_flow": false,
"sort_code": "1400",
"sub_type": "current_assets",
"opening_balance": "450.25",
"type": "asset"
}
'import requests
url = "https://api.sandbox.teal.dev/v0/ledgers"
payload = {
"editable": True,
"name": "Pluto Checking 4242",
"debit_credit": "debit",
"financial_account_type": None,
"parent_id": None,
"report_cash_flow": False,
"sort_code": "1400",
"sub_type": "current_assets",
"opening_balance": "450.25",
"type": "asset"
}
headers = {
"teal-instance-id": "<teal-instance-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'teal-instance-id': '<teal-instance-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
editable: true,
name: 'Pluto Checking 4242',
debit_credit: 'debit',
financial_account_type: null,
parent_id: null,
report_cash_flow: false,
sort_code: '1400',
sub_type: 'current_assets',
opening_balance: '450.25',
type: 'asset'
})
};
fetch('https://api.sandbox.teal.dev/v0/ledgers', 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/ledgers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'editable' => true,
'name' => 'Pluto Checking 4242',
'debit_credit' => 'debit',
'financial_account_type' => null,
'parent_id' => null,
'report_cash_flow' => false,
'sort_code' => '1400',
'sub_type' => 'current_assets',
'opening_balance' => '450.25',
'type' => 'asset'
]),
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/ledgers"
payload := strings.NewReader("{\n \"editable\": true,\n \"name\": \"Pluto Checking 4242\",\n \"debit_credit\": \"debit\",\n \"financial_account_type\": null,\n \"parent_id\": null,\n \"report_cash_flow\": false,\n \"sort_code\": \"1400\",\n \"sub_type\": \"current_assets\",\n \"opening_balance\": \"450.25\",\n \"type\": \"asset\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.sandbox.teal.dev/v0/ledgers")
.header("teal-instance-id", "<teal-instance-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"editable\": true,\n \"name\": \"Pluto Checking 4242\",\n \"debit_credit\": \"debit\",\n \"financial_account_type\": null,\n \"parent_id\": null,\n \"report_cash_flow\": false,\n \"sort_code\": \"1400\",\n \"sub_type\": \"current_assets\",\n \"opening_balance\": \"450.25\",\n \"type\": \"asset\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.teal.dev/v0/ledgers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["teal-instance-id"] = '<teal-instance-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"editable\": true,\n \"name\": \"Pluto Checking 4242\",\n \"debit_credit\": \"debit\",\n \"financial_account_type\": null,\n \"parent_id\": null,\n \"report_cash_flow\": false,\n \"sort_code\": \"1400\",\n \"sub_type\": \"current_assets\",\n \"opening_balance\": \"450.25\",\n \"type\": \"asset\"\n}"
response = http.request(request)
puts response.read_body{
"id": "7JRNsKwy2Lw66caxVU7WGC",
"name": "Pluto Checking 4242",
"debit_credit": "debit",
"editable": false,
"is_required": false,
"parent_id": null,
"report_cash_flow": false,
"sort_code": "1400",
"sub_type": "current_assets",
"type": "asset",
"created_at": "2024-01-01T00:00:00Z",
"actions": {
"delete": {
"allowed": true,
"reason": "required_ledger",
"message": "<string>"
}
},
"financial_account_type": "bank_account",
"required_ledger_purpose": "account_transfers",
"parent": "<unknown>"
}{
"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"
}Create a Ledger
Creates a Ledger.
curl --request POST \
--url https://api.sandbox.teal.dev/v0/ledgers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'teal-instance-id: <teal-instance-id>' \
--data '
{
"editable": true,
"name": "Pluto Checking 4242",
"debit_credit": "debit",
"financial_account_type": null,
"parent_id": null,
"report_cash_flow": false,
"sort_code": "1400",
"sub_type": "current_assets",
"opening_balance": "450.25",
"type": "asset"
}
'import requests
url = "https://api.sandbox.teal.dev/v0/ledgers"
payload = {
"editable": True,
"name": "Pluto Checking 4242",
"debit_credit": "debit",
"financial_account_type": None,
"parent_id": None,
"report_cash_flow": False,
"sort_code": "1400",
"sub_type": "current_assets",
"opening_balance": "450.25",
"type": "asset"
}
headers = {
"teal-instance-id": "<teal-instance-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'teal-instance-id': '<teal-instance-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
editable: true,
name: 'Pluto Checking 4242',
debit_credit: 'debit',
financial_account_type: null,
parent_id: null,
report_cash_flow: false,
sort_code: '1400',
sub_type: 'current_assets',
opening_balance: '450.25',
type: 'asset'
})
};
fetch('https://api.sandbox.teal.dev/v0/ledgers', 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/ledgers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'editable' => true,
'name' => 'Pluto Checking 4242',
'debit_credit' => 'debit',
'financial_account_type' => null,
'parent_id' => null,
'report_cash_flow' => false,
'sort_code' => '1400',
'sub_type' => 'current_assets',
'opening_balance' => '450.25',
'type' => 'asset'
]),
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/ledgers"
payload := strings.NewReader("{\n \"editable\": true,\n \"name\": \"Pluto Checking 4242\",\n \"debit_credit\": \"debit\",\n \"financial_account_type\": null,\n \"parent_id\": null,\n \"report_cash_flow\": false,\n \"sort_code\": \"1400\",\n \"sub_type\": \"current_assets\",\n \"opening_balance\": \"450.25\",\n \"type\": \"asset\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.sandbox.teal.dev/v0/ledgers")
.header("teal-instance-id", "<teal-instance-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"editable\": true,\n \"name\": \"Pluto Checking 4242\",\n \"debit_credit\": \"debit\",\n \"financial_account_type\": null,\n \"parent_id\": null,\n \"report_cash_flow\": false,\n \"sort_code\": \"1400\",\n \"sub_type\": \"current_assets\",\n \"opening_balance\": \"450.25\",\n \"type\": \"asset\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.teal.dev/v0/ledgers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["teal-instance-id"] = '<teal-instance-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"editable\": true,\n \"name\": \"Pluto Checking 4242\",\n \"debit_credit\": \"debit\",\n \"financial_account_type\": null,\n \"parent_id\": null,\n \"report_cash_flow\": false,\n \"sort_code\": \"1400\",\n \"sub_type\": \"current_assets\",\n \"opening_balance\": \"450.25\",\n \"type\": \"asset\"\n}"
response = http.request(request)
puts response.read_body{
"id": "7JRNsKwy2Lw66caxVU7WGC",
"name": "Pluto Checking 4242",
"debit_credit": "debit",
"editable": false,
"is_required": false,
"parent_id": null,
"report_cash_flow": false,
"sort_code": "1400",
"sub_type": "current_assets",
"type": "asset",
"created_at": "2024-01-01T00:00:00Z",
"actions": {
"delete": {
"allowed": true,
"reason": "required_ledger",
"message": "<string>"
}
},
"financial_account_type": "bank_account",
"required_ledger_purpose": "account_transfers",
"parent": "<unknown>"
}{
"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.
Query Parameters
Comma-separated list of Ledger expand paths.
parent, parent.parent, details Body
Whether line entries can be manually added or removed from the ledger.
Set to false if you control the source of truth for the ledger and want to restrict user changes, for example, if the ledger is for a bank account or a payments account you control (i.e. you are a neobank or using a Banking as a Service platform
true
The name of the ledger.
Teal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.
255"Pluto Checking 4242"
Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit "debit"
Indicates that the ledger represents a real-world financial account.
If provided when creating a new ledger object, you do not need to provide debit_credit, type, sub_type, or report_cash_flow values as we will provide default values.
See the default parameters for financial account types.
bank_account, credit_card, payments, payroll, loan, prepaid_card, accounts_receivable, accounts_payable, treasury, investment null
If the ledger is a child Ledger, the ID of the parent ledger object.
null
Whether to include this ledger in the cash flow report. Note: This field can only be updated for ledgers without a financial_account_type. For financial account ledgers, this value is automatically determined based on the account type. We recommend following these defaults: operating accounts (checking, credit card, etc.) should be included (true), while non-operating accounts (loans, investments, etc.) should be excluded (false). Required if financial_account_type is not specified.
false
Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.
Teal does not enforce any other conventions or patterns on sort codes. However, it is recommended to adopt a common convention such as starting all ledgers of the same type with the same number (assets start with 1, liabilities start with 2, etc.). The default CoA templates provided by Teal follow best practices for sort code numbering.
Required if financial_account_type is not specified.
20^[0-9]+$"1400"
Indicates similar characteristics and accounting treatment for a group of ledgers within a type.
Required if financial_account_type is not specified.
current_assets, non-current_assets, transfers_between_accounts, uncategorized_assets, current_liabilities, non-current_liabilities, equity, operating_revenues, other_income, cost_of_goods_sold, operating_expenses, other_expenses, retained_earnings "current_assets"
Sets the opening balance of the ledger.
"450.25"
Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
Required if financial_account_type is not specified.
asset, liability, equity, revenue, expense "asset"
Response
Successful Response
The unique ID of the object.
"7JRNsKwy2Lw66caxVU7WGC"
The name of the ledger.
255"Pluto Checking 4242"
Indicates if the ledger is a credit or debit ledger.
debit, credit "debit"
Whether line entries can be manually added or removed from the ledger.
false
Indicates that the ledger is a system ledger required for Teal to work. These ledgers can be renamed to fit your needs but cannot be deleted. Their behaviour is identified by required_ledger_purpose; see that field's enum for the full set of purposes (e.g. account_transfers, opening_balances, uncat_inflow, uncat_outflow, retained_earnings, current_year_earnings, accounts_receivable, accounts_payable, and the payroll system ledgers).
false
If the ledger is a child Ledger, the ID of the parent ledger object.
null
Whether or not this ledger is included in the cash flow report. For ledgers with a financial_account_type, this value is automatically determined and cannot be modified.
false
Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.
20"1400"
Indicates similar characteristics and accounting treatment for a group of ledgers within a type.
current_assets, non-current_assets, transfers_between_accounts, uncategorized_assets, current_liabilities, non-current_liabilities, equity, operating_revenues, other_income, cost_of_goods_sold, operating_expenses, other_expenses, retained_earnings "current_assets"
Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
asset, liability, equity, revenue, expense "asset"
The datetime when the ledger was created.
"2024-01-01T00:00:00Z"
Available actions under Teal's ordinary deletion policy. Computed for top-level ledgers in direct ledger responses; null for expanded parents and ledgers embedded in other resources. Delete reasons are stable codes; messages are human-readable explanations. Child ledgers must be deleted first, even when delete.allowed is true. Deletion rechecks eligibility because it can change after this response.
Show child attributes
Show child attributes
Indicates that the ledger represents a real-world financial account.
bank_account, credit_card, payments, payroll, loan, prepaid_card, accounts_receivable, accounts_payable, treasury, investment "bank_account"
Required ledgers fulfill specific system functions and are necessary for the accounting system to operate.
uncat_inflow, uncat_outflow, account_transfers, opening_balances, retained_earnings, current_year_earnings, accounts_receivable, accounts_payable, wages_expense, bonus_expense, commissions_expense, contractor_expense, employee_reimbursements, severance_expense, payroll_tax_expense, employer_benefits_expense, health_insurance_expense, benefits_expense, donations_expense, wages_payable, payroll_tax_payable, employee_benefit_liabilities, payroll_liabilities, payroll_adjustments_clearing, benefits_payable, payroll_tax_accruals, stock_exercise_clearing, payroll_clearing "account_transfers"
Expandable. If the ledger is a child ledger, the parent ledger object.