Retrieve the General Ledger Report

GET

reports

general-ledger

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

Query Parameters

start_date

string

required

Only include data after the start date (inclusive).

end_date

string

required

Only include data before the end date (inclusive).

time_zone

enum<string>

default: UTC

Time Zone Identifier

Available options:

Africa/Abidjan,

Africa/Accra,

Africa/Addis_Ababa,

Africa/Algiers,

Africa/Asmara,

Africa/Asmera,

Africa/Bamako,

Africa/Bangui,

Africa/Banjul,

Africa/Bissau,

Africa/Blantyre,

Africa/Brazzaville,

Africa/Bujumbura,

Africa/Cairo,

Africa/Casablanca,

Africa/Ceuta,

Africa/Conakry,

Africa/Dakar,

Africa/Dar_es_Salaam,

Africa/Djibouti,

Africa/Douala,

Africa/El_Aaiun,

Africa/Freetown,

Africa/Gaborone,

Africa/Harare,

Africa/Johannesburg,

Africa/Juba,

Africa/Kampala,

Africa/Khartoum,

Africa/Kigali,

Africa/Kinshasa,

Africa/Lagos,

Africa/Libreville,

Africa/Lome,

Africa/Luanda,

Africa/Lubumbashi,

Africa/Lusaka,

Africa/Malabo,

Africa/Maputo,

Africa/Maseru,

Africa/Mbabane,

Africa/Mogadishu,

Africa/Monrovia,

Africa/Nairobi,

Africa/Ndjamena,

Africa/Niamey,

Africa/Nouakchott,

Africa/Ouagadougou,

Africa/Porto-Novo,

Africa/Sao_Tome,

Africa/Timbuktu,

Africa/Tripoli,

Africa/Tunis,

Africa/Windhoek,

America/Adak,

America/Anchorage,

America/Anguilla,

America/Antigua,

America/Araguaina,

America/Argentina/Buenos_Aires,

America/Argentina/Catamarca,

America/Argentina/ComodRivadavia,

America/Argentina/Cordoba,

America/Argentina/Jujuy,

America/Argentina/La_Rioja,

America/Argentina/Mendoza,

America/Argentina/Rio_Gallegos,

America/Argentina/Salta,

America/Argentina/San_Juan,

America/Argentina/San_Luis,

America/Argentina/Tucuman,

America/Argentina/Ushuaia,

America/Aruba,

America/Asuncion,

America/Atikokan,

America/Atka,

America/Bahia,

America/Bahia_Banderas,

America/Barbados,

America/Belem,

America/Belize,

America/Blanc-Sablon,

America/Boa_Vista,

America/Bogota,

America/Boise,

America/Buenos_Aires,

America/Cambridge_Bay,

America/Campo_Grande,

America/Cancun,

America/Caracas,

America/Catamarca,

America/Cayenne,

America/Cayman,

America/Chicago,

America/Chihuahua,

America/Ciudad_Juarez,

America/Coral_Harbour,

America/Cordoba,

America/Costa_Rica,

America/Creston,

America/Cuiaba,

America/Curacao,

America/Danmarkshavn,

America/Dawson,

America/Dawson_Creek,

America/Denver,

America/Detroit,

America/Dominica,

America/Edmonton,

America/Eirunepe,

America/El_Salvador,

America/Ensenada,

America/Fort_Nelson,

America/Fort_Wayne,

America/Fortaleza,

America/Glace_Bay,

America/Godthab,

America/Goose_Bay,

America/Grand_Turk,

America/Grenada,

America/Guadeloupe,

America/Guatemala,

America/Guayaquil,

America/Guyana,

America/Halifax,

America/Havana,

America/Hermosillo,

America/Indiana/Indianapolis,

America/Indiana/Knox,

America/Indiana/Marengo,

America/Indiana/Petersburg,

America/Indiana/Tell_City,

America/Indiana/Vevay,

America/Indiana/Vincennes,

America/Indiana/Winamac,

America/Indianapolis,

America/Inuvik,

America/Iqaluit,

America/Jamaica,

America/Jujuy,

America/Juneau,

America/Kentucky/Louisville,

America/Kentucky/Monticello,

America/Knox_IN,

America/Kralendijk,

America/La_Paz,

America/Lima,

America/Los_Angeles,

America/Louisville,

America/Lower_Princes,

America/Maceio,

America/Managua,

America/Manaus,

America/Marigot,

America/Martinique,

America/Matamoros,

America/Mazatlan,

America/Mendoza,

America/Menominee,

America/Merida,

America/Metlakatla,

America/Mexico_City,

America/Miquelon,

America/Moncton,

America/Monterrey,

America/Montevideo,

America/Montreal,

America/Montserrat,

America/Nassau,

America/New_York,

America/Nipigon,

America/Nome,

America/Noronha,

America/North_Dakota/Beulah,

America/North_Dakota/Center,

America/North_Dakota/New_Salem,

America/Nuuk,

America/Ojinaga,

America/Panama,

America/Pangnirtung,

America/Paramaribo,

America/Phoenix,

America/Port-au-Prince,

America/Port_of_Spain,

America/Porto_Acre,

America/Porto_Velho,

America/Puerto_Rico,

America/Punta_Arenas,

America/Rainy_River,

America/Rankin_Inlet,

America/Recife,

America/Regina,

America/Resolute,

America/Rio_Branco,

America/Rosario,

America/Santa_Isabel,

America/Santarem,

America/Santiago,

America/Santo_Domingo,

America/Sao_Paulo,

America/Scoresbysund,

America/Shiprock,

America/Sitka,

America/St_Barthelemy,

America/St_Johns,

America/St_Kitts,

America/St_Lucia,

America/St_Thomas,

America/St_Vincent,

America/Swift_Current,

America/Tegucigalpa,

America/Thule,

America/Thunder_Bay,

America/Tijuana,

America/Toronto,

America/Tortola,

America/Vancouver,

America/Virgin,

America/Whitehorse,

America/Winnipeg,

America/Yakutat,

America/Yellowknife,

Antarctica/Casey,

Antarctica/Davis,

Antarctica/DumontDUrville,

Antarctica/Macquarie,

Antarctica/Mawson,

Antarctica/McMurdo,

Antarctica/Palmer,

Antarctica/Rothera,

Antarctica/South_Pole,

Antarctica/Syowa,

Antarctica/Troll,

Antarctica/Vostok,

Arctic/Longyearbyen,

Asia/Aden,

Asia/Almaty,

Asia/Amman,

Asia/Anadyr,

Asia/Aqtau,

Asia/Aqtobe,

Asia/Ashgabat,

Asia/Ashkhabad,

Asia/Atyrau,

Asia/Baghdad,

Asia/Bahrain,

Asia/Baku,

Asia/Bangkok,

Asia/Barnaul,

Asia/Beirut,

Asia/Bishkek,

Asia/Brunei,

Asia/Calcutta,

Asia/Chita,

Asia/Choibalsan,

Asia/Chongqing,

Asia/Chungking,

Asia/Colombo,

Asia/Dacca,

Asia/Damascus,

Asia/Dhaka,

Asia/Dili,

Asia/Dubai,

Asia/Dushanbe,

Asia/Famagusta,

Asia/Gaza,

Asia/Harbin,

Asia/Hebron,

Asia/Ho_Chi_Minh,

Asia/Hong_Kong,

Asia/Hovd,

Asia/Irkutsk,

Asia/Istanbul,

Asia/Jakarta,

Asia/Jayapura,

Asia/Jerusalem,

Asia/Kabul,

Asia/Kamchatka,

Asia/Karachi,

Asia/Kashgar,

Asia/Kathmandu,

Asia/Katmandu,

Asia/Khandyga,

Asia/Kolkata,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuching,

Asia/Kuwait,

Asia/Macao,

Asia/Macau,

Asia/Magadan,

Asia/Makassar,

Asia/Manila,

Asia/Muscat,

Asia/Nicosia,

Asia/Novokuznetsk,

Asia/Novosibirsk,

Asia/Omsk,

Asia/Oral,

Asia/Phnom_Penh,

Asia/Pontianak,

Asia/Pyongyang,

Asia/Qatar,

Asia/Qostanay,

Asia/Qyzylorda,

Asia/Rangoon,

Asia/Riyadh,

Asia/Saigon,

Asia/Sakhalin,

Asia/Samarkand,

Asia/Seoul,

Asia/Shanghai,

Asia/Singapore,

Asia/Srednekolymsk,

Asia/Taipei,

Asia/Tashkent,

Asia/Tbilisi,

Asia/Tehran,

Asia/Tel_Aviv,

Asia/Thimbu,

Asia/Thimphu,

Asia/Tokyo,

Asia/Tomsk,

Asia/Ujung_Pandang,

Asia/Ulaanbaatar,

Asia/Ulan_Bator,

Asia/Urumqi,

Asia/Ust-Nera,

Asia/Vientiane,

Asia/Vladivostok,

Asia/Yakutsk,

Asia/Yangon,

Asia/Yekaterinburg,

Asia/Yerevan,

Atlantic/Azores,

Atlantic/Bermuda,

Atlantic/Canary,

Atlantic/Cape_Verde,

Atlantic/Faeroe,

Atlantic/Faroe,

Atlantic/Jan_Mayen,

Atlantic/Madeira,

Atlantic/Reykjavik,

Atlantic/South_Georgia,

Atlantic/St_Helena,

Atlantic/Stanley,

Australia/ACT,

Australia/Adelaide,

Australia/Brisbane,

Australia/Broken_Hill,

Australia/Canberra,

Australia/Currie,

Australia/Darwin,

Australia/Eucla,

Australia/Hobart,

Australia/LHI,

Australia/Lindeman,

Australia/Lord_Howe,

Australia/Melbourne,

Australia/NSW,

Australia/North,

Australia/Perth,

Australia/Queensland,

Australia/South,

Australia/Sydney,

Australia/Tasmania,

Australia/Victoria,

Australia/West,

Australia/Yancowinna,

Brazil/Acre,

Brazil/DeNoronha,

Brazil/East,

Brazil/West,

CET,

CST6CDT,

Canada/Atlantic,

Canada/Central,

Canada/Eastern,

Canada/Mountain,

Canada/Newfoundland,

Canada/Pacific,

Canada/Saskatchewan,

Canada/Yukon,

Chile/Continental,

Chile/EasterIsland,

Cuba,

EET,

EST,

EST5EDT,

Egypt,

Eire,

Etc/GMT,

Etc/GMT+0,

Etc/GMT+1,

Etc/GMT+10,

Etc/GMT+11,

Etc/GMT+12,

Etc/GMT+2,

Etc/GMT+3,

Etc/GMT+4,

Etc/GMT+5,

Etc/GMT+6,

Etc/GMT+7,

Etc/GMT+8,

Etc/GMT+9,

Etc/GMT-0,

Etc/GMT-1,

Etc/GMT-10,

Etc/GMT-11,

Etc/GMT-12,

Etc/GMT-13,

Etc/GMT-14,

Etc/GMT-2,

Etc/GMT-3,

Etc/GMT-4,

Etc/GMT-5,

Etc/GMT-6,

Etc/GMT-7,

Etc/GMT-8,

Etc/GMT-9,

Etc/GMT0,

Etc/Greenwich,

Etc/UCT,

Etc/UTC,

Etc/Universal,

Etc/Zulu,

Europe/Amsterdam,

Europe/Andorra,

Europe/Astrakhan,

Europe/Athens,

Europe/Belfast,

Europe/Belgrade,

Europe/Berlin,

Europe/Bratislava,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

Europe/Busingen,

Europe/Chisinau,

Europe/Copenhagen,

Europe/Dublin,

Europe/Gibraltar,

Europe/Guernsey,

Europe/Helsinki,

Europe/Isle_of_Man,

Europe/Istanbul,

Europe/Jersey,

Europe/Kaliningrad,

Europe/Kiev,

Europe/Kirov,

Europe/Kyiv,

Europe/Lisbon,

Europe/Ljubljana,

Europe/London,

Europe/Luxembourg,

Europe/Madrid,

Europe/Malta,

Europe/Mariehamn,

Europe/Minsk,

Europe/Monaco,

Europe/Moscow,

Europe/Nicosia,

Europe/Oslo,

Europe/Paris,

Europe/Podgorica,

Europe/Prague,

Europe/Riga,

Europe/Rome,

Europe/Samara,

Europe/San_Marino,

Europe/Sarajevo,

Europe/Saratov,

Europe/Simferopol,

Europe/Skopje,

Europe/Sofia,

Europe/Stockholm,

Europe/Tallinn,

Europe/Tirane,

Europe/Tiraspol,

Europe/Ulyanovsk,

Europe/Uzhgorod,

Europe/Vaduz,

Europe/Vatican,

Europe/Vienna,

Europe/Vilnius,

Europe/Volgograd,

Europe/Warsaw,

Europe/Zagreb,

Europe/Zaporozhye,

Europe/Zurich,

Factory,

GB,

GB-Eire,

GMT,

GMT+0,

GMT-0,

GMT0,

Greenwich,

HST,

Hongkong,

Iceland,

Indian/Antananarivo,

Indian/Chagos,

Indian/Christmas,

Indian/Cocos,

Indian/Comoro,

Indian/Kerguelen,

Indian/Mahe,

Indian/Maldives,

Indian/Mauritius,

Indian/Mayotte,

Indian/Reunion,

Iran,

Israel,

Jamaica,

Japan,

Kwajalein,

Libya,

MET,

MST,

MST7MDT,

Mexico/BajaNorte,

Mexico/BajaSur,

Mexico/General,

NZ,

NZ-CHAT,

Navajo,

PRC,

PST8PDT,

Pacific/Apia,

Pacific/Auckland,

Pacific/Bougainville,

Pacific/Chatham,

Pacific/Chuuk,

Pacific/Easter,

Pacific/Efate,

Pacific/Enderbury,

Pacific/Fakaofo,

Pacific/Fiji,

Pacific/Funafuti,

Pacific/Galapagos,

Pacific/Gambier,

Pacific/Guadalcanal,

Pacific/Guam,

Pacific/Honolulu,

Pacific/Johnston,

Pacific/Kanton,

Pacific/Kiritimati,

Pacific/Kosrae,

Pacific/Kwajalein,

Pacific/Majuro,

Pacific/Marquesas,

Pacific/Midway,

Pacific/Nauru,

Pacific/Niue,

Pacific/Norfolk,

Pacific/Noumea,

Pacific/Pago_Pago,

Pacific/Palau,

Pacific/Pitcairn,

Pacific/Pohnpei,

Pacific/Ponape,

Pacific/Port_Moresby,

Pacific/Rarotonga,

Pacific/Saipan,

Pacific/Samoa,

Pacific/Tahiti,

Pacific/Tarawa,

Pacific/Tongatapu,

Pacific/Truk,

Pacific/Wake,

Pacific/Wallis,

Pacific/Yap,

Poland,

Portugal,

ROC,

ROK,

Singapore,

Turkey,

UCT,

US/Alaska,

US/Aleutian,

US/Arizona,

US/Central,

US/East-Indiana,

US/Eastern,

US/Hawaii,

US/Indiana-Starke,

US/Michigan,

US/Mountain,

US/Pacific,

US/Samoa,

UTC,

Universal,

W-SU,

WET,

Zulu

Response

200 - application/json

start_date

string

required

The start date of the report (inclusive). Must be in YYYY-MM-DD format.

end_date

string

required

The end date of the report (inclusive). Must be in YYYY-MM-DD format.

records

object[]

required

A list of all Ledger Statement objects.

records.ledger_id

string

required

The unique ID of the object.

records.name

string

required

The name of the ledger.

records.type

enum<string>

required

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.

Available options:

asset,

liability,

equity,

revenue,

expense

records.sub_type

enum<string>

required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

Required if financial_account_type is not specified.

Available options:

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

records.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

records.amount

number

required

The sum, in decimal dollar cents, of all line entries in the ledger.

records.opening_balance

number

required

The balance, in decimal dollar cents, of the ledger at the start date.

records.closing_balance

number

required

The balance, in decimal dollar cents, of the ledger at the end date.

records.lines

object[]

required

A list all Line Entries in the Ledger.

records.lines.amount

number

required

The value of the line entry in decimal dollar cents.

records.lines.debit_credit

enum<string>

required

Indicates if the amount is a credit or debit.

Available options:

debit,

credit

records.lines.description

string | null

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

records.lines.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.

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

records.lines.transaction_id

string | null

The ID of the associated Transaction, if one exists.

records.lines.id

string | null

required

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

records.lines.datetime

string

required

The datetime the Line Entry was created in UTC time.

records.lines.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.

records.lines.journal_entry

null

Expandable. The associated Journal Entry object.

records.lines.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.

records.lines.journal_entry_description

string

required

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

records.lines.ledger

null

Expandable. The associated Ledger object.

records.lines.ledger_name

string

required

The name of the Line Entry's Ledger.

records.lines.tags

object[] | null

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

records.lines.transaction

null

Expandable. The associated Transaction object, if one exists.

records.total_amount

number

required

The sum, in decimal dollar cents, of the ledger amount and the amount of all child ledgers, if any.

records.children

object[]

required

If the Ledger has any children, a list of the Ledger objects.

records.children.ledger_id

string

required

The unique ID of the object.

records.children.name

string

required

The name of the ledger.

records.children.type

enum<string>

required

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

records.children.sub_type

enum<string>

required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

Required if financial_account_type is not specified.

Available options:

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

records.children.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

records.children.amount

number

required

The sum, in decimal dollar cents, of all line entries in the ledger.

records.children.opening_balance

number

required

The balance, in decimal dollar cents, of the ledger at the start date.

records.children.closing_balance

number

required

The balance, in decimal dollar cents, of the ledger at the end date.

records.children.lines

object[]

required

A list all Line Entries in the Ledger.

records.children.lines.amount

number

required

The value of the line entry in decimal dollar cents.

records.children.lines.debit_credit

enum<string>

required

Indicates if the amount is a credit or debit.

Available options:

debit,

credit

records.children.lines.description

string | null

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

records.children.lines.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.

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

records.children.lines.transaction_id

string | null

The ID of the associated Transaction, if one exists.

records.children.lines.id

string | null

required

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

records.children.lines.datetime

string

required

The datetime the Line Entry was created in UTC time.

records.children.lines.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.

records.children.lines.journal_entry

null

Expandable. The associated Journal Entry object.

records.children.lines.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.

records.children.lines.journal_entry_description

string

required

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

records.children.lines.ledger

null

Expandable. The associated Ledger object.

records.children.lines.ledger_name

string

required

The name of the Line Entry's Ledger.

records.children.lines.tags

object[] | null

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

records.children.lines.transaction

null

Expandable. The associated Transaction object, if one exists.

records.children.total_amount

number

required

The sum, in decimal dollar cents, of the ledger amount and the amount of all child ledgers, if any.

records.children.children

object[]

required

If the Ledger has any children, a list of the Ledger objects.

records.children.children.ledger_id

string

required

The unique ID of the object.

records.children.children.name

string

required

The name of the ledger.

records.children.children.type

enum<string>

required

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

records.children.children.sub_type

enum<string>

required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

Required if financial_account_type is not specified.

Available options:

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

records.children.children.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

records.children.children.amount

number

required

The sum, in decimal dollar cents, of all line entries in the ledger.

records.children.children.opening_balance

number

required

The balance, in decimal dollar cents, of the ledger at the start date.

records.children.children.closing_balance

number

required

The balance, in decimal dollar cents, of the ledger at the end date.

records.children.children.lines

object[]

required

A list all Line Entries in the Ledger.

records.children.children.lines.amount

number

required

The value of the line entry in decimal dollar cents.

records.children.children.lines.debit_credit

enum<string>

required

Indicates if the amount is a credit or debit.

Available options:

debit,

credit

records.children.children.lines.description

string | null

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

records.children.children.lines.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.

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

records.children.children.lines.transaction_id

string | null

The ID of the associated Transaction, if one exists.

records.children.children.lines.id

string | null

required

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

records.children.children.lines.datetime

string

required

The datetime the Line Entry was created in UTC time.

records.children.children.lines.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.

records.children.children.lines.journal_entry

null

Expandable. The associated Journal Entry object.

records.children.children.lines.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.

records.children.children.lines.journal_entry_description

string

required

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

records.children.children.lines.ledger

null

Expandable. The associated Ledger object.

records.children.children.lines.ledger_name

string

required

The name of the Line Entry's Ledger.

records.children.children.lines.tags

object[] | null

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

records.children.children.lines.transaction

null

Expandable. The associated Transaction object, if one exists.

records.children.children.total_amount

number

required

The sum, in decimal dollar cents, of the ledger amount and the amount of all child ledgers, if any.

records.children.children.children

object[]

required

If the Ledger has any children, a list of the Ledger objects.

records.children.children.children.ledger_id

string

required

The unique ID of the object.

records.children.children.children.name

string

required

The name of the ledger.

records.children.children.children.type

enum<string>

required

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

records.children.children.children.sub_type

enum<string>

required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

Required if financial_account_type is not specified.

Available options:

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

records.children.children.children.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

records.children.children.children.amount

number

required

The sum, in decimal dollar cents, of all line entries in the ledger.

records.children.children.children.opening_balance

number

required

The balance, in decimal dollar cents, of the ledger at the start date.

records.children.children.children.closing_balance

number

required

The balance, in decimal dollar cents, of the ledger at the end date.

records.children.children.children.lines

object[]

required

A list all Line Entries in the Ledger.

records.children.children.children.total_amount

number

required

The sum, in decimal dollar cents, of the ledger amount and the amount of all child ledgers, if any.

records.children.children.children.children

object[]

required

If the Ledger has any children, a list of the Ledger objects.

List financial summaries by period Retrieve a tag group

API overview

Teal API Endpoints

API Migration

Retrieve the General Ledger Report

Authorizations

Headers

Query Parameters

Response