{ "openapi": "3.1.0", "info": { "title": "Teal API", "version": "0.1" }, "servers": [ { "url": "https://api.sandbox.teal.dev", "description": "Sandbox" }, { "url": "https://api.teal.dev", "description": "Production" } ], "paths": { "/v0/instance": { "post": { "tags": ["Instances"], "summary": "Create an Instance", "description": "Creates a new Instance based on the given parameters.", "operationId": "create_instance_v0_instance_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "x-teal-agent-id", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "uuid" }, { "type": "null" }], "description": "The agent id", "title": "X-Teal-Agent-Id" }, "description": "The agent id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Instances"], "summary": "Retrieve the current Instance", "description": "Retrieves the details of the Instance identified by the teal-instance-id header.", "operationId": "get_current_instance_v0_instance_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetailedInstance" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Instances"], "summary": "Update the current Instance", "description": "Updates the `entries_start` or `name` of the Instance identified by the teal-instance-id header.", "operationId": "update_current_instance_v0_instance_put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string", "maxLength": 255 }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/bulk/journal-entries": { "get": { "tags": ["Journal Entries"], "summary": "Get bulk journal entries with line entries", "description": "Retrieve journal entries in bulk within a date range. **Note:** This endpoint always includes line entries in the response (unlike the paginated /journal-entries endpoint). Line entries are required for the Manual Journal Entries UI table display. This is an internal-only endpoint designed for the Books frontend.", "operationId": "get_bulk_journal_entries_v0_bulk_journal_entries_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "The start date of the period, inclusive", "title": "Start Date" }, "description": "The start date of the period, inclusive" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "The end date of the period, inclusive", "title": "End Date" }, "description": "The end date of the period, inclusive" }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "creation_source", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/JournalEntryCreationSource" }, { "type": "null" } ], "description": "Only return Journal Entries with the specified creation source.", "deprecated": true, "title": "Creation Source" }, "description": "Only return Journal Entries with the specified creation source.", "deprecated": true }, { "name": "creation_sources", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryCreationSource" } }, { "type": "null" } ], "description": "Only return Journal Entries with the specified creation sources.", "teal_explode": false, "title": "Creation Sources" }, "description": "Only return Journal Entries with the specified creation sources." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntrySort" } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 1, "description": "Maximum number of journal entries to return.", "default": 10000, "title": "Limit" }, "description": "Maximum number of journal entries to return." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJournalEntries" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Journal Entries"], "summary": "Create multiple Journal Entries", "description": "Creates multiple new Journal Entries.", "operationId": "bulk_create_journal_entry_v0_bulk_journal_entries_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expandable paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expandable paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryCreate" }, "title": "Journal Entries" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpandableJournalEntry" }, "title": "Response Bulk Create Journal Entry V0 Bulk Journal Entries Post" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/journal-entries/metrics": { "get": { "tags": ["Journal Entries"], "summary": "Get Journal Entry metrics", "description": "Returns the instance-wide count of journal entries awaiting review,\nfor the review filter menu.\n\nThe count equals the number of entries the review_status=unreviewed\nfilter would return on the list endpoint under the same creation_sources.", "operationId": "get_journal_entry_metrics_v0_journal_entries_metrics_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "creation_sources", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryCreationSource" } }, { "type": "null" } ], "description": "Only count Journal Entries with the specified creation sources.", "teal_explode": false, "title": "Creation Sources" }, "description": "Only count Journal Entries with the specified creation sources." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryMetrics" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/journal-entries/{journal_entry_id}": { "get": { "tags": ["Journal Entries"], "summary": "Retrieve a Journal Entry", "description": "Retrieves information about an existing Journal Entry.", "operationId": "get_journal_entry_v0_journal_entries__journal_entry_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "journal_entry_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Journal entry ID", "title": "Journal Entry Id" }, "description": "Journal entry ID" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expandable paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expandable paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpandableJournalEntry" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Journal Entries"], "summary": "Update a Journal Entry", "description": "Updates an existing Journal Entry's details or Line Entries. When updating Line\nEntries in the Journal Entry, debit and credit amounts must equal.", "operationId": "update_journal_entry_v0_journal_entries__journal_entry_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "journal_entry_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Journal entry ID", "title": "Journal Entry Id" }, "description": "Journal entry ID" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expand paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpandableJournalEntry" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Journal Entries"], "summary": "Delete a Journal Entry", "description": "Deletes an existing Journal Entry.", "operationId": "delete_journal_entry_v0_journal_entries__journal_entry_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "journal_entry_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Journal entry ID", "title": "Journal Entry Id" }, "description": "Journal entry ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/journal-entries": { "put": { "tags": ["Journal Entries"], "summary": "Update multiple Journal Entries", "description": "Updates multiple existing Journal Entry's details.", "operationId": "update_multiple_journal_entries_v0_journal_entries_put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryUpdateWithId" }, "title": "Journal Entry Updates" } } } }, "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Journal Entries"], "summary": "List all Journal Entries", "description": "List all the Journal Entries an Instance.", "operationId": "get_journal_entries_v0_journal_entries_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only return Journal Entries after the start date (inclusive).\n Must be in `YYYY-MM-DD` format.", "title": "Start Date" }, "description": "Only return Journal Entries after the start date (inclusive).\n Must be in `YYYY-MM-DD` format." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only return Journal Entries before the end date (inclusive).\n Must be in `YYYY-MM-DD` format.", "title": "End Date" }, "description": "Only return Journal Entries before the end date (inclusive).\n Must be in `YYYY-MM-DD` format." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "ledger_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Only return Journal Entries where at least one Line Entry belongs\n to the specified Ledger.", "title": "Ledger Id" }, "description": "Only return Journal Entries where at least one Line Entry belongs\n to the specified Ledger." }, { "name": "strict_ledger_id_groups", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When true, reject missing or inaccessible ledger IDs in\n ledger_id_groups. When false, ignore those IDs while preserving each\n group's matching requirement.", "default": true, "title": "Strict Ledger Id Groups" }, "description": "When true, reject missing or inaccessible ledger IDs in\n ledger_id_groups. When false, ignore those IDs while preserving each\n group's matching requirement." }, { "name": "creation_source", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/JournalEntryCreationSource" }, { "type": "null" } ], "description": "Only return Journal Entries with the specified creation source.", "deprecated": true, "title": "Creation Source" }, "description": "Only return Journal Entries with the specified creation source.", "deprecated": true }, { "name": "creation_sources", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryCreationSource" } }, { "type": "null" } ], "description": "Only return Journal Entries with the specified creation sources.", "teal_explode": false, "title": "Creation Sources" }, "description": "Only return Journal Entries with the specified creation sources." }, { "name": "keywords", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "minLength": 3, "maxLength": 100 }, { "type": "null" }], "description": "Only return Journal Entries where the description matches the specified keyword(s).", "title": "Keywords" }, "description": "Only return Journal Entries where the description matches the specified keyword(s)." }, { "name": "amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Only return journal entries with the specified monetary amount.\n\n If specified, `min_amount` and `max_amount` parameters are ignored.\n\n If no decimal place provided, rounded values will be matched.\n E.g. an input of `100` will match 100.13 and 100.45, but an input of `100.13` will only match that value.", "title": "Amount" }, "description": "Only return journal entries with the specified monetary amount.\n\n If specified, `min_amount` and `max_amount` parameters are ignored.\n\n If no decimal place provided, rounded values will be matched.\n E.g. an input of `100` will match 100.13 and 100.45, but an input of `100.13` will only match that value." }, { "name": "min_amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Only return journal entries with a monetary amount of at least the specified amount.\n\n Ignored if `amount` is set.", "title": "Min Amount" }, "description": "Only return journal entries with a monetary amount of at least the specified amount.\n\n Ignored if `amount` is set." }, { "name": "max_amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Only return journal entries with a monetary amount less than or equal to the specified amount.\n\n Ignored if `amount` is set.", "title": "Max Amount" }, "description": "Only return journal entries with a monetary amount less than or equal to the specified amount.\n\n Ignored if `amount` is set." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/JournalEntrySort" }, { "$ref": "#/components/schemas/JournalEntrySortAmount" } ] } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expandable paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expandable paths." }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Only return Journal Entries whose line entries collectively include all given Tags.", "teal_explode": false, "title": "Tag Ids" }, "description": "Only return Journal Entries whose line entries collectively include all given Tags." }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Journal Entry IDs. Only return Journal Entries with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "A comma separated list of Journal Entry IDs. Only return Journal Entries with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "categorization_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryCategorizationStatus" } }, { "type": "null" } ], "description": "A comma separated list of categorization statuses ('pending', 'delayed', 'completed'). Only return Journal Entries whose categorization status matches one of the specified values.", "teal_explode": false, "title": "Categorization Status" }, "description": "A comma separated list of categorization statuses ('pending', 'delayed', 'completed'). Only return Journal Entries whose categorization status matches one of the specified values." }, { "name": "review_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryReviewStatus" } }, { "type": "null" } ], "description": "A comma separated list of review statuses ('unreviewed', 'reviewed'). Only return Journal Entries whose review status matches one of the specified values.", "teal_explode": false, "title": "Review Status" }, "description": "A comma separated list of review statuses ('unreviewed', 'reviewed'). Only return Journal Entries whose review status matches one of the specified values." }, { "name": "categorization_method", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CategorizationMethodFilter" } }, { "type": "null" } ], "description": "A comma separated list of categorization methods ('ai', 'rule', 'user', 'matched', 'uncategorized'). Only return Journal Entries whose autocat result (the same one the autocat_result expand path returns) was decided by one of the specified methods. 'ai' matches every automatic method except 'rule'. 'user' returns Journal Entries with no live autocat result — the case where the expand path returns null — whether a user recategorized the Transaction or another flow rewrote the entry's lines. 'matched' returns payment-application Journal Entries and 'uncategorized' returns Journal Entries with a line on an uncategorized system ledger; the other values never return those. Combine with creation_source to scope to transaction-backed entries. 'auto' and 'manual' are accepted synonyms for 'ai' and 'user'.", "teal_explode": false, "title": "Categorization Method" }, "description": "A comma separated list of categorization methods ('ai', 'rule', 'user', 'matched', 'uncategorized'). Only return Journal Entries whose autocat result (the same one the autocat_result expand path returns) was decided by one of the specified methods. 'ai' matches every automatic method except 'rule'. 'user' returns Journal Entries with no live autocat result — the case where the expand path returns null — whether a user recategorized the Transaction or another flow rewrote the entry's lines. 'matched' returns payment-application Journal Entries and 'uncategorized' returns Journal Entries with a line on an uncategorized system ledger; the other values never return those. Combine with creation_source to scope to transaction-backed entries. 'auto' and 'manual' are accepted synonyms for 'ai' and 'user'." }, { "name": "include_total_count", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When true, populate total_count: the number of Journal Entries matching the provided filters across all pages. Adds a count query, so request it only when needed.", "default": false, "title": "Include Total Count" }, "description": "When true, populate total_count: the number of Journal Entries matching the provided filters across all pages. Adds a count query, so request it only when needed." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "ledger_id_groups", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "One or more comma-separated lists of ledger IDs.\n Only return Journal Entries where at least one Line Entry belongs to one of the specified ledgers in a group.\n Specifying multiple groups will return an intersection of the matches.", "title": "Ledger Id Groups" }, "description": "One or more comma-separated lists of ledger IDs.\n Only return Journal Entries where at least one Line Entry belongs to one of the specified ledgers in a group.\n Specifying multiple groups will return an intersection of the matches." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Journal Entries"], "summary": "Create a Journal Entry", "description": "Creates a new Journal Entry object. The debit and credit amounts of the\nLine Entries must match.", "operationId": "create_journal_entry_v0_journal_entries_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expandable paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expandable paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpandableJournalEntry" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Journal Entries"], "summary": "Delete multiple Journal Entries", "description": "Delete multiple Journal Entries.", "operationId": "delete_journal_entries_v0_journal_entries_delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryBulkDelete" } } } }, "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform": { "get": { "tags": ["Platform"], "summary": "Retrieve Platform", "description": "Retrieves details about an existing Platform.", "operationId": "get_platform_v0_platform_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Platform" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/v0/platform/instances": { "post": { "tags": ["Platform"], "summary": "Create an Instance", "description": "Creates a new Instance based on the given parameters.", "operationId": "create_instance_v0_platform_instances_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "x-teal-agent-id", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "uuid" }, { "type": "null" }], "description": "The agent id", "title": "X-Teal-Agent-Id" }, "description": "The agent id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Platform"], "summary": "List all Instances", "description": "Lists all Instances belonging to a Platform.", "operationId": "get_instances_v0_platform_instances_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Only return Instances containing a specific string in\n their `name`.", "title": "Name" }, "description": "Only return Instances containing a specific string in\n their `name`." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/InstanceSort" }, { "type": "null" }], "description": "Sort results", "title": "Sort" }, "description": "Sort results" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstancePage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform/instances/{instance_id}": { "get": { "tags": ["Platform"], "summary": "Retrieve an Instance", "description": "Retrieves the details of an existing Instance.", "operationId": "get_instance_details_v0_platform_instances__instance_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "instance_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The instance ID", "title": "Instance Id" }, "description": "The instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetailedInstance" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Platform"], "summary": "Delete an Instance", "description": "Deletes an Instance in the sandbox environment. To deactivate an Instance in a\nproduction environment, use the [Update Subscription](https://docs.teal.dev/api-reference/platform/update-an-instance's-subscription)\nendpoint.", "operationId": "delete_instance_v0_platform_instances__instance_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "instance_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The instance ID", "title": "Instance Id" }, "description": "The instance ID" } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Platform"], "summary": "Update an Instance", "description": "Updates the `entries_start` or `name` of an Instance.", "operationId": "update_instance_v0_platform_instances__instance_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "instance_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The instance ID", "title": "Instance Id" }, "description": "The instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string", "maxLength": 255 }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform/instances/{instance_id}/subscription": { "put": { "tags": ["Platform"], "summary": "Update an Instance's subscription", "description": "Updates an Instance's `subscription`. Set to `tier0` to deactivate\nthe Instance.", "operationId": "update_subscription_v0_platform_instances__instance_id__subscription_put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "instance_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The instance ID", "title": "Instance Id" }, "description": "The instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string", "maxLength": 255 }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceSubscriptionUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/line-entries/{line_entry_id}": { "put": { "tags": ["Line Entries"], "summary": "Update a Line Entry", "description": "Updates a Line Entry.", "operationId": "update_line_entry_v0_line_entries__line_entry_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "line_entry_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The line entry ID", "title": "Line Entry Id" }, "description": "The line entry ID" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LineEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Line Entry expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Line Entry expand paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleLineEntryUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/journal-entries/{journal_entry_id}/line-entries": { "get": { "tags": ["Line Entries"], "summary": "List all Line Entries in a Journal Entry", "description": "Lists all the Line Entries in a Journal Entry.", "operationId": "get_journal_entry_line_entries_v0_journal_entries__journal_entry_id__line_entries_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "journal_entry_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Journal entry ID", "title": "Journal Entry Id" }, "description": "Journal entry ID" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LineEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Line Entry expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Line Entry expand paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" }, "title": "Response Get Journal Entry Line Entries V0 Journal Entries Journal Entry Id Line Entries Get" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/ledgers/{ledger_id}/line-entries": { "get": { "tags": ["Line Entries"], "summary": "List all Line Entries in a Ledger", "description": "Lists all Line Entries in a Ledger.", "operationId": "get_ledger_line_entries_v0_ledgers__ledger_id__line_entries_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ledger ID", "title": "Ledger Id" }, "description": "The ledger ID" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "The start date of the period, inclusive", "title": "Start Date" }, "description": "The start date of the period, inclusive" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "The end date of the period, inclusive", "title": "End Date" }, "description": "The end date of the period, inclusive" }, { "name": "is_cashflow", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "description": "If provided, returned line entries will filter based on whether the line affects the balance of a cashflow ledger.", "title": "Is Cashflow" }, "description": "If provided, returned line entries will filter based on whether the line affects the balance of a cashflow ledger." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LineEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Line Entry expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Line Entry expand paths." }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Tag IDs. Only return lines with all of the given Tags.", "teal_explode": false, "title": "Tag Ids" }, "description": "A comma separated list of Tag IDs. Only return lines with all of the given Tags." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetailedLinePage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/sources/ledgers/{ledger_id}": { "delete": { "tags": ["Transaction Sources"], "summary": "Delete Ledger Transaction Source", "description": "Delete Ledger Transaction Source", "operationId": "delete_transaction_source_by_ledger_v0_sources_ledgers__ledger_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ledger ID", "title": "Ledger Id" }, "description": "The ledger ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Transaction Sources"], "summary": "Update Ledger Transaction Source", "description": "Update an existing Plaid source account with a new Plaid processor token.", "operationId": "update_source_v0_sources_ledgers__ledger_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ledger ID belonging to an existing Plaid transaction source account", "title": "Ledger Id" }, "description": "The ledger ID belonging to an existing Plaid transaction source account" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionSourceUpdate" } } } }, "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/sources/plaid": { "post": { "tags": ["Transaction Sources"], "summary": "Link Plaid Account", "description": "Link an external financial account via a Plaid processor token to a new or existing manual source account.", "operationId": "create_plaid_link_v0_sources_plaid_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaidLinkCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TxnProcessingTask" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/sources/plaid/links/status": { "get": { "tags": ["Transaction Sources"], "summary": "Get Plaid Link Statuses", "description": "Returns the status of all Plaid connected financial account ledgers on the\nplatform.", "operationId": "get_plaid_link_statuses_v0_sources_plaid_links_status_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "instance_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The Instance ID", "title": "Instance Id" }, "description": "The Instance ID" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerLinkStatusPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/source-accounts": { "get": { "tags": ["Transaction Sources"], "summary": "Get Transaction Source Accounts", "description": "Gets all the transaction source accounts for an instance.", "operationId": "get_source_accounts_v0_source_accounts_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Source Account IDs. Only return Source Accounts with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "A comma separated list of Source Account IDs. Only return Source Accounts with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceAccount" }, "title": "Response Get Source Accounts V0 Source Accounts Get" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Transaction Sources"], "summary": "Create a Transaction Source Account", "description": "Create a transaction source account to manually write transactions.", "operationId": "create_source_account_v0_source_accounts_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceAccountCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceAccount" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/source-accounts/{source_account_id}": { "delete": { "tags": ["Transaction Sources"], "summary": "Delete a Transaction Source Account", "description": "Delete a transaction source account. Accounts that contain\ntransactions may not be deleted.", "operationId": "delete_source_account_v0_source_accounts__source_account_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID", "title": "Source Account Id" }, "description": "The Source Account ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Transaction Sources"], "summary": "Update a Transaction Source Account", "description": "Update a transaction source account.", "operationId": "update_source_account_v0_source_accounts__source_account_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID", "title": "Source Account Id" }, "description": "The Source Account ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceAccountUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceAccount" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform-gl/coa-templates": { "post": { "tags": ["Chart of Accounts Templates"], "summary": "Create a Chart of Accounts Template", "description": "Creates a Chart of Accounts Template.", "operationId": "create_coa_template_v0_platform_gl_coa_templates_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CoaTemplateExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expandable paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expandable paths." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplateCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplate" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Chart of Accounts Templates"], "summary": "List all Chart of Accounts Templates", "description": "Lists all Chart of Accounts Templates for the Platform.", "operationId": "get_coa_templates_v0_platform_gl_coa_templates_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CoaTemplateExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expandable paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expandable paths." }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CoaTemplateStatus" } }, { "type": "null" } ], "description": "Comma-separated list of template statuses.", "teal_explode": false, "title": "Status" }, "description": "Comma-separated list of template statuses." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplatePage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform-gl/coa-templates/{coa_template_id}": { "put": { "tags": ["Chart of Accounts Templates"], "summary": "Update a Chart of Accounts Template", "operationId": "update_coa_template_v0_platform_gl_coa_templates__coa_template_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "coa_template_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Chart of Accounts Template", "title": "Coa Template Id" }, "description": "The ID of the Chart of Accounts Template" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplateUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplate" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Chart of Accounts Templates"], "summary": "Retrieve a Chart of Accounts Template", "description": "Retrieves details of an existing Chart of Accounts Template.", "operationId": "get_coa_template_v0_platform_gl_coa_templates__coa_template_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "coa_template_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Chart of Accounts Template", "title": "Coa Template Id" }, "description": "The ID of the Chart of Accounts Template" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CoaTemplateExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expandable paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expandable paths." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplate" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Chart of Accounts Templates"], "summary": "Delete a Chart of Accounts Template", "description": "Deletes a Chart of Accounts Template. Instances already using the Chart of\nAccounts Template will not be affected.", "operationId": "delete_coa_template_v0_platform_gl_coa_templates__coa_template_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "coa_template_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Chart of Accounts Template", "title": "Coa Template Id" }, "description": "The ID of the Chart of Accounts Template" } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform-gl/coa-templates/{coa_template_id}/clone": { "post": { "tags": ["Chart of Accounts Templates"], "summary": "Clone a Chart of Accounts Template", "description": "Clones a Chart of Accounts Template and all its Ledger Templates.", "operationId": "clone_coa_template_v0_platform_gl_coa_templates__coa_template_id__clone_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "coa_template_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Chart of Accounts Template to be cloned", "title": "Coa Template Id" }, "description": "The ID of the Chart of Accounts Template to be cloned" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CoaTemplateExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of expandable paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of expandable paths." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplateClone" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplate" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform-gl/coa-templates/{coa_template_id}/ledgers": { "post": { "tags": ["Chart of Accounts Templates"], "summary": "Create a Ledger Template", "description": "Creates a new Ledger Template within a Chart of Accounts Template.", "operationId": "create_ledger_template_v0_platform_gl_coa_templates__coa_template_id__ledgers_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "coa_template_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Chart of Accounts Template.", "title": "Coa Template Id" }, "description": "The ID of the Chart of Accounts Template." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerTemplateCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerTemplate" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/bulk/coa-templates/{coa_template_id}/ledgers": { "post": { "tags": ["Chart of Accounts Templates"], "summary": "Bulk Create Ledger Templates", "description": "Creates multiple Ledger Templates atomically.", "operationId": "bulk_create_ledger_templates_v0_bulk_coa_templates__coa_template_id__ledgers_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "coa_template_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Chart of Accounts Template.", "title": "Coa Template Id" }, "description": "The ID of the Chart of Accounts Template." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerTemplateBulkCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerTemplate" }, "title": "Response Bulk Create Ledger Templates V0 Bulk Coa Templates Coa Template Id Ledgers Post" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform-gl/coa-templates/ledgers/{ledger_template_id}": { "put": { "tags": ["Chart of Accounts Templates"], "summary": "Update a Ledger Template", "description": "Updates an existing Ledger Template.", "operationId": "update_ledger_template_v0_platform_gl_coa_templates_ledgers__ledger_template_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_template_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Ledger Template.", "title": "Ledger Template Id" }, "description": "The ID of the Ledger Template." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerTemplateUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerTemplate" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Chart of Accounts Templates"], "summary": "Delete a Ledger Template", "description": "Deletes an existing Ledger Template.", "operationId": "delete_ledger_template_v0_platform_gl_coa_templates_ledgers__ledger_template_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_template_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Ledger Template.", "title": "Ledger Template Id" }, "description": "The ID of the Ledger Template." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform/categorization/rules": { "get": { "tags": ["Categorization"], "summary": "List all Platform rules", "description": "Lists all the Platform categorization rules.", "operationId": "get_platform_rules_v0_platform_categorization_rules_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The name of the rule for filtering.", "title": "Name" }, "description": "The name of the rule for filtering." }, { "name": "ledger_name", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The ledger name for filtering.", "title": "Ledger Name" }, "description": "The ledger name for filtering." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CategorizationRuleSort" } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Categorization Rule IDs. Only return Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "A comma separated list of Categorization Rule IDs. Only return Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorizationRulePage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Categorization"], "summary": "Create a Platform rule", "description": "Creates a new Platform categorization rule.", "operationId": "create_platform_rule_v0_platform_categorization_rules_post", "security": [{ "OAuth2PasswordBearer": [] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformRuleCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorizationRule" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform/categorization/rules/{rule_id}": { "delete": { "tags": ["Categorization"], "summary": "Delete a Platform rule", "description": "Deletes a categorization rule.", "operationId": "delete_platform_rule_v0_platform_categorization_rules__rule_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The categorization rule ID", "title": "Rule Id" }, "description": "The categorization rule ID" } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/categorization/rules": { "get": { "tags": ["Categorization"], "summary": "List all Instance rules", "description": "Lists all the Instance categorization rules.", "operationId": "get_instance_rules_v0_categorization_rules_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The name of the rule for filtering.", "title": "Name" }, "description": "The name of the rule for filtering." }, { "name": "ledger_name", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The ledger name for filtering.", "title": "Ledger Name" }, "description": "The ledger name for filtering." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CategorizationRuleSort" } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Categorization Rule IDs. Only return Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "A comma separated list of Categorization Rule IDs. Only return Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorizationRulePage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Categorization"], "summary": "Create an Instance rule", "description": "Creates a new Instance categorization rule.", "operationId": "create_instance_rule_v0_categorization_rules_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformRuleCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorizationRule" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/categorization/rules/{rule_id}": { "delete": { "tags": ["Categorization"], "summary": "Delete an Instance rule", "description": "Deletes an instance categorization rule.", "operationId": "delete_instance_rule_v0_categorization_rules__rule_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The categorization rule ID", "title": "Rule Id" }, "description": "The categorization rule ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/categorization/metrics": { "get": { "tags": ["Categorization"], "summary": "Get categorization status metrics", "description": "Returns categorization-status counts (pending / delayed / completed) for an\ninstance.\n\n``instance`` holds instance-wide totals across every journal entry. When\n``ledger_ids`` is supplied, ``ledgers`` holds the same metrics computed for the\njournal entries that touch each requested ledger (via a line entry), keyed by\nledger ID.", "operationId": "get_categorization_metrics_v0_categorization_metrics_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of opposing ledger IDs. When provided, the response includes per-ledger categorization metrics for each ID alongside the instance-wide totals. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ledger Ids" }, "description": "A comma separated list of opposing ledger IDs. When provided, the response includes per-ledger categorization metrics for each ID alongside the instance-wide totals. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorizationMetrics" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/ledgers": { "get": { "tags": ["Ledgers"], "summary": "List all Ledgers", "description": "Lists all of an Instance's Ledgers.", "operationId": "get_ledgers_v0_ledgers_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/LedgerType" }, { "type": "null" }], "description": "Optional ledger type used for filtering.", "title": "Type" }, "description": "Optional ledger type used for filtering." }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of ledger names used for filtering. Each name must be an exact match.", "teal_explode": false, "title": "Name" }, "description": "A comma separated list of ledger names used for filtering. Each name must be an exact match." }, { "name": "sub_type", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/LedgerSubType" }, { "type": "null" }], "description": "Optional ledger sub type used for filtering.", "title": "Sub Type" }, "description": "Optional ledger sub type used for filtering." }, { "name": "financial_account_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FinancialAccountType" }, { "type": "null" } ], "description": "Optional financial account type used for filtering.", "title": "Financial Account Type" }, "description": "Optional financial account type used for filtering." }, { "name": "debit_credit", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/DebitCredit" }, { "type": "null" }], "description": "Optional ledger debit/credit used for filtering.", "title": "Debit Credit" }, "description": "Optional ledger debit/credit used for filtering." }, { "name": "special_type", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/SpecialLedgerType" }, { "type": "null" }], "description": "Optional special ledger type used for filtering.", "title": "Special Type" }, "description": "Optional special ledger type used for filtering." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LedgerSort" } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LedgerExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Ledger expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Ledger expand paths." }, { "name": "ledger_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Deprecated: use `ids` instead. Comma-separated list of ledger IDs.", "deprecated": true, "teal_explode": false, "title": "Ledger Ids" }, "description": "Deprecated: use `ids` instead. Comma-separated list of ledger IDs.", "deprecated": true }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Alias for `ledger_ids`. Comma-separated list of ledger IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "Alias for `ledger_ids`. Comma-separated list of ledger IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Ledgers"], "summary": "Create a Ledger", "description": "Creates a Ledger.", "operationId": "create_ledger_v0_ledgers_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LedgerExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Ledger expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Ledger expand paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/ledgers/{ledger_id}": { "put": { "tags": ["Ledgers"], "summary": "Update a Ledger", "description": "Updates a Ledger.", "operationId": "update_ledger_v0_ledgers__ledger_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ledger ID", "title": "Ledger Id" }, "description": "The ledger ID" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LedgerExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Ledger expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Ledger expand paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Ledgers"], "summary": "Delete a Ledger", "description": "Deletes a Ledger and optionally its associated journal entries.\n\nBy default, ledgers with line entries cannot be deleted. Set delete_journal_entries=true\nto delete the ledger along with:\n- All journal entries that have line entries on this ledger\n- All line entries in those journal entries\n- All reconciliations for this ledger\n- The source account (if not linked to Plaid)\n- Historical ledger balances\n\nNote: This operation is irreversible. Special ledgers (e.g., uncategorized inflow/outflow)\ncannot be deleted.", "operationId": "delete_ledger_v0_ledgers__ledger_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ledger ID", "title": "Ledger Id" }, "description": "The ledger ID" }, { "name": "delete_journal_entries", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to delete journal entries associated with this ledger. When true, deletes all journal entries containing line entries on this ledger, along with reconciliations and the source account. This operation is irreversible.", "default": false, "title": "Delete Journal Entries" }, "description": "Whether to delete journal entries associated with this ledger. When true, deletes all journal entries containing line entries on this ledger, along with reconciliations and the source account. This operation is irreversible." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Ledgers"], "summary": "Get a Ledger", "description": "Get a Ledger.", "operationId": "get_ledger_v0_ledgers__ledger_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ledger ID", "title": "Ledger Id" }, "description": "The ledger ID" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LedgerExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Ledger expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Ledger expand paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/ledgers/{ledger_id}/opening-balance": { "post": { "tags": ["Ledgers"], "summary": "Set a Ledger's opening balance", "description": "Sets the opening balance for a Ledger on the entries start date for the\nInstance, replacing any opening balance the Ledger already has. Each Ledger's\nopening balance is recorded on its own journal entry, which is returned.\n\nA $0 balance clears the opening balance (removing the ledger's opening\nbalance journal entry) when one exists, instead of writing a zero-dollar\nline.", "operationId": "set_ledger_opening_balance_v0_ledgers__ledger_id__opening_balance_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ledger ID", "title": "Ledger Id" }, "description": "The ledger ID" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Journal Entry expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Journal Entry expand paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerUpdateOpeningBalance" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpandableJournalEntry" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/ledgers/opening-balances": { "get": { "tags": ["Ledgers"], "summary": "Get all ledgers opening balances", "description": "Returns the opening balance journal entries as a paginated list.", "operationId": "get_ledgers_opening_balances_list_v0_ledgers_opening_balances_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/bulk/ledgers": { "delete": { "tags": ["Ledgers"], "summary": "Delete multiple ledgers in bulk", "description": "Deletes multiple Ledgers in bulk and optionally their associated journal entries.\n\nBy default, ledgers with line entries cannot be deleted. Set delete_journal_entries=true\nto delete each ledger along with:\n- All journal entries that have line entries on that ledger\n- All line entries in those journal entries\n- All reconciliations for that ledger\n- The source account for that ledger (if not linked to Plaid)\n- Historical ledger balances\n\nReturns a list of results for each ledger in the request, indicating success or failure\nfor each individual deletion. Special ledgers cannot be deleted.\n\nNote: This operation is irreversible.", "operationId": "delete_ledgers_bulk_v0_bulk_ledgers_delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "description": "A comma separated list of ledger IDs.", "teal_explode": false, "title": "Ledger Ids" }, "description": "A comma separated list of ledger IDs." }, { "name": "delete_journal_entries", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to delete journal entries associated with these ledgers. When true, deletes all journal entries containing line entries on these ledgers, along with reconciliations and source accounts (if not linked to Plaid)This operation is irreversible.", "default": false, "title": "Delete Journal Entries" }, "description": "Whether to delete journal entries associated with these ledgers. When true, deletes all journal entries containing line entries on these ledgers, along with reconciliations and source accounts (if not linked to Plaid)This operation is irreversible." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "207": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerDeleteResult" }, "title": "Response Delete Ledgers Bulk V0 Bulk Ledgers Delete" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/income-statement": { "get": { "tags": ["Reports"], "summary": "Retrieve the Income Statement", "description": "Retrieves the income statement for the business. Returns a list of ledger\n summaries grouped by ledger `sub_type` and profit calculations.\n\n\nRelated\n guide: [Income statement](https://docs.teal.dev/guides/reports/income_statement)", "operationId": "get_income_statement_v0_reports_income_statement_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "include_empty", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Controls which ledgers appear in the report based on activity: \n\n- `true`: Includes all ledgers, whether they have line entries or not.\n\n- `false`: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned.", "default": true, "title": "Include Empty" }, "description": "Controls which ledgers appear in the report based on activity: \n\n- `true`: Includes all ledgers, whether they have line entries or not.\n\n- `false`: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomeStatement" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/balance-sheet": { "get": { "tags": ["Reports"], "summary": "Retrieve the Balance Sheet", "description": "Retrieves the balance sheet for the business. Returns a list of ledger\nsummaries grouped by ledger `type`.\n\nNote: Ledgers with zero balances will be returned if they have underlying\ntransaction activity (transactions that net to zero). Use the `include_empty`\nparameter to control whether completely unused ledgers are included.\n\nRequires a Tier 2 subscription.", "operationId": "get_balance_sheet_v0_reports_balance_sheet_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "The balance sheet as of the end date (inclusive). The start date\n for a balance sheet is always the `entries_start` date of the Instance.", "title": "End Date" }, "description": "The balance sheet as of the end date (inclusive). The start date\n for a balance sheet is always the `entries_start` date of the Instance." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "include_empty", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Controls which ledgers appear in the report based on activity: \n\n- `true`: Includes all ledgers, whether they have line entries or not.\n\n- `false`: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned.", "default": true, "title": "Include Empty" }, "description": "Controls which ledgers appear in the report based on activity: \n\n- `true`: Includes all ledgers, whether they have line entries or not.\n\n- `false`: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceSheet" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/balance-sheet/range": { "get": { "tags": ["Reports"], "summary": "Retrieve the balance sheets for a given range", "description": "Retrieves the balance sheets for all periods in the range.\nRequires a Tier 2 subscription.", "operationId": "get_balance_sheet_range_v0_reports_balance_sheet_range_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "range_start", "in": "query", "required": true, "schema": { "type": "string", "description": "The start of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error.", "title": "Range Start" }, "description": "The start of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error." }, { "name": "range_end", "in": "query", "required": true, "schema": { "type": "string", "description": "The end of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error.", "title": "Range End" }, "description": "The end of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error." }, { "name": "period", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Period", "description": "The interval of the periods." }, "description": "The interval of the periods." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "include_empty", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Controls which ledgers appear in the report based on activity: \n\n- `true`: Includes all ledgers, whether they have line entries or not.\n\n- `false`: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned.", "default": true, "title": "Include Empty" }, "description": "Controls which ledgers appear in the report based on activity: \n\n- `true`: Includes all ledgers, whether they have line entries or not.\n\n- `false`: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned." }, { "name": "include_only_closed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include only the changes to the balance sheet for transactions that have been closed.", "default": false, "title": "Include Only Closed" }, "description": "Include only the changes to the balance sheet for transactions that have been closed." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceSheetPeriods" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/income-statement/range": { "get": { "tags": ["Reports"], "summary": "Retrieve the income statements periods for a given range", "description": "Retrieves an income statement for all periods in a given range.", "operationId": "get_income_statement_range_v0_reports_income_statement_range_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "range_start", "in": "query", "required": true, "schema": { "type": "string", "description": "The start of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error.", "title": "Range Start" }, "description": "The start of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error." }, { "name": "range_end", "in": "query", "required": true, "schema": { "type": "string", "description": "The end of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error.", "title": "Range End" }, "description": "The end of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error." }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/Period" }, { "type": "null" }], "description": "The interval of the periods. If no period is provided the entire range will be returned as a single period.", "title": "Period" }, "description": "The interval of the periods. If no period is provided the entire range will be returned as a single period." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "include_empty", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Controls which ledgers appear in the report based on activity: \n\n- `true`: Includes all ledgers, whether they have line entries or not.\n\n- `false`: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned.", "default": true, "title": "Include Empty" }, "description": "Controls which ledgers appear in the report based on activity: \n\n- `true`: Includes all ledgers, whether they have line entries or not.\n\n- `false`: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned." }, { "name": "include_only_closed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include only changes to the income statement for transactions that have been closed.", "default": false, "title": "Include Only Closed" }, "description": "Include only changes to the income statement for transactions that have been closed." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomeStatementPeriods" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/ledger-statement": { "get": { "tags": ["Reports"], "summary": "Retrieve a ledger statement", "description": "Retrieves a ledger statement for an existing ledger containing the opening\nand closing balances with all the line entries within the period.", "operationId": "get_ledger_statement_v0_reports_ledger_statement_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "query", "required": true, "schema": { "type": "string", "description": "The ledger ID", "title": "Ledger Id" }, "description": "The ledger ID" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LineEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Line Entry expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Line Entry expand paths." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerStatementPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/cash-flow": { "get": { "tags": ["Reports"], "summary": "Retrieve the Cash Flow Report", "description": "Retrieves the cash flow report for the business. Returns an object with all\nledgers whose balanced changed during the period and the starting and ending\nbalances for each cash flow ledger.", "operationId": "get_cash_flow_report_v0_reports_cash_flow_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashFlowReport" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/cash-flow/range": { "get": { "tags": ["Reports"], "summary": "Retrieve multiple cash flow reports for a given range", "description": "Retrieves the cash flow report for each period within the range.", "operationId": "get_cash_flow_range_v0_reports_cash_flow_range_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "range_start", "in": "query", "required": true, "schema": { "type": "string", "description": "The start of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error.", "title": "Range Start" }, "description": "The start of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error." }, { "name": "range_end", "in": "query", "required": true, "schema": { "type": "string", "description": "The end of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error.", "title": "Range End" }, "description": "The end of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error." }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/Period" }, { "type": "null" }], "description": "The interval of the periods. If no period is provided the entire range will be returned as a single period.", "title": "Period" }, "description": "The interval of the periods. If no period is provided the entire range will be returned as a single period." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "include_only_closed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include only changes to the cash flow report for transactions that have been closed.", "default": false, "title": "Include Only Closed" }, "description": "Include only changes to the cash flow report for transactions that have been closed." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashFlowReportPeriods" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/cash-flow-totals": { "get": { "tags": ["Reports"], "summary": "List cash flow totals by period", "description": "Retrieves a list of the cash flow data across all cash flow ledgers\nsegmented by period.", "operationId": "get_cash_flow_totals_by_period_v0_reports_cash_flow_totals_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "period", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Period", "description": "Determines how the data is segmented." }, "description": "Determines how the data is segmented." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashFlowTotals" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/ledger-cash-flow-totals": { "get": { "tags": ["Reports"], "summary": "List cash flow totals by ledger", "description": "Retrieves a list of cash flow data segmented by ledger.", "operationId": "get_cash_flow_totals_by_ledger_v0_reports_ledger_cash_flow_totals_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashFlowTotals" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/top-expenses": { "get": { "tags": ["Reports"], "summary": "List top expenses", "description": "Lists the top expenses for the business within the period.", "operationId": "get_top_expenses_v0_reports_top_expenses_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "exclusiveMinimum": 0, "description": "The number of results to return", "title": "Limit" }, "description": "The number of results to return" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopExpenses" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/revenue": { "get": { "tags": ["Reports"], "summary": "Retrieve the revenue report", "description": "Retrieves revenue totals for the period (with an optional derived\ncomparison period), the per-ledger revenue split, and a bucketed trend\ntime series.", "operationId": "get_revenue_v0_reports_revenue_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "granularity", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/TrendGranularity", "description": "Determines how the trend time series is segmented. The range/granularity combination may produce at most 400 trend buckets.", "default": "monthly" }, "description": "Determines how the trend time series is segmented. The range/granularity combination may produce at most 400 trend buckets." }, { "name": "include_prior", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to derive and include totals for the comparison period immediately preceding the requested period.", "default": true, "title": "Include Prior" }, "description": "Whether to derive and include totals for the comparison period immediately preceding the requested period." }, { "name": "include_only_closed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include only revenue from transactions that have been closed.", "default": false, "title": "Include Only Closed" }, "description": "Include only revenue from transactions that have been closed." }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReport" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/expenses": { "get": { "tags": ["Reports"], "summary": "Retrieve the expenses report", "description": "Retrieves the total expenses for the period (with an optional derived\ncomparison period) and the per-ledger expenses split.", "operationId": "get_expenses_v0_reports_expenses_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "include_prior", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to derive and include totals for the comparison period immediately preceding the requested period.", "default": true, "title": "Include Prior" }, "description": "Whether to derive and include totals for the comparison period immediately preceding the requested period." }, { "name": "include_only_closed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include only expenses from transactions that have been closed.", "default": false, "title": "Include Only Closed" }, "description": "Include only expenses from transactions that have been closed." }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpensesReport" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/cash": { "get": { "tags": ["Reports"], "summary": "Retrieve the cash report", "description": "Retrieves period cash flow (net and gross in/out, with an optional\nderived comparison period and two independently bucketed trend series),\nthe trailing burn or build rate with runway, and per-account cash\nbalances as of the period end.", "operationId": "get_cash_v0_reports_cash_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "net_cash_flow_granularity", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/TrendGranularity", "description": "Determines how the net cash flow time series is segmented. The range/granularity combination may produce at most 400 trend buckets.", "default": "monthly" }, "description": "Determines how the net cash flow time series is segmented. The range/granularity combination may produce at most 400 trend buckets." }, { "name": "cash_in_out_granularity", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/TrendGranularity", "description": "Determines how the cash in/out time series is segmented. The range/granularity combination may produce at most 400 trend buckets.", "default": "monthly" }, "description": "Determines how the cash in/out time series is segmented. The range/granularity combination may produce at most 400 trend buckets." }, { "name": "include_prior", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to derive and include the net cash flow for the comparison period immediately preceding the requested period.", "default": true, "title": "Include Prior" }, "description": "Whether to derive and include the net cash flow for the comparison period immediately preceding the requested period." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashReport" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/net-profit-by-period": { "get": { "tags": ["Reports"], "summary": "List net profit by period", "description": "Lists net profit calculations by period.", "operationId": "get_net_profit_by_period_v0_reports_net_profit_by_period_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "period", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Period", "description": "Determines how the data is segmented." }, "description": "Determines how the data is segmented." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag ids for filtering. Requires Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag ids for filtering. Requires Tier 3 subscription" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetProfit" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/gross-profit-by-period": { "get": { "tags": ["Reports"], "summary": "List gross profit by period", "description": "Lists gross profit calculations by period.", "operationId": "get_gross_profit_by_period_v0_reports_gross_profit_by_period_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "period", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Period", "description": "Determines how the data is segmented." }, "description": "Determines how the data is segmented." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag ids for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag ids for filtering. Requires a Tier 3 subscription" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrossProfit" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/financial-summaries-by-period": { "get": { "tags": ["Reports"], "summary": "List financial summaries by period", "description": "Lists financial summaries by period.", "operationId": "get_financial_summaries_by_period_v0_reports_financial_summaries_by_period_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "period", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Period", "description": "Determines how the data is segmented." }, "description": "Determines how the data is segmented." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Comma-separated list of tag ids for filtering. Requires a Tier 3 subscription", "teal_explode": false, "title": "Tag Ids" }, "description": "Comma-separated list of tag ids for filtering. Requires a Tier 3 subscription" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialSummary" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reports/general-ledger": { "get": { "tags": ["Reports"], "summary": "Retrieve the General Ledger Report", "description": "Retrieves a list of ledger statements for all ledgers and sub-ledgers in the\nchart of accounts within the period. Instances with a large chart of accounts\nor many transactions may encounter slower processing times.", "operationId": "get_general_ledger_report_v0_reports_general_ledger_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data after the start date (inclusive).", "title": "Start Date" }, "description": "Only include data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "description": "Only include data before the end date (inclusive).", "title": "End Date" }, "description": "Only include data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralLedgerReport" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/source-accounts/{source_account_id}/transactions": { "post": { "tags": ["Transactions"], "summary": "Create Transactions", "description": "Creates Transactions into a Transaction Source Account. Returns a\nTransaction Processing Task.", "operationId": "create_transactions_v0_source_accounts__source_account_id__transactions_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID", "title": "Source Account Id" }, "description": "The Source Account ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateTransaction" }, "description": "A list of Transactions to be created", "title": "Transactions" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TxnProcessingTask" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Transactions"], "summary": "Delete all Transactions in a Source Account", "description": "Deletes all Transactions in a Transaction Source Account.", "operationId": "delete_source_account_transactions_v0_source_accounts__source_account_id__transactions_delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID.", "title": "Source Account Id" }, "description": "The Source Account ID." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only delete data after the start date (inclusive).", "title": "Start Date" }, "description": "Only delete data after the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only delete data before the end date (inclusive).", "title": "End Date" }, "description": "Only delete data before the end date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TxnProcessingTask" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Transactions"], "summary": "List a Source Account's Transactions", "description": "Returns a list of Transactions in a Transaction Source Account.", "operationId": "get_source_account_transactions_v0_source_accounts__source_account_id__transactions_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID.", "title": "Source Account Id" }, "description": "The Source Account ID." }, { "name": "review_status", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/ReviewStatus" }, { "type": "null" }], "description": "Only return Transactions with a specific review status.", "title": "Review Status" }, "description": "Only return Transactions with a specific review status." }, { "name": "posted_status", "in": "query", "required": false, "schema": { "anyOf": [{ "$ref": "#/components/schemas/PostedStatus" }, { "type": "null" }], "description": "Only return Transactions with a specific posted status.", "title": "Posted Status" }, "description": "Only return Transactions with a specific posted status." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only return Transactions created after \n the start date (inclusive).", "title": "Start Date" }, "description": "Only return Transactions created after \n the start date (inclusive)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only return Transactions before the \n end start date (inclusive).", "title": "End Date" }, "description": "Only return Transactions before the \n end start date (inclusive)." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Tag IDs. Only return Transactions with all of the given Tags.", "teal_explode": false, "title": "Tag Ids" }, "description": "A comma separated list of Tag IDs. Only return Transactions with all of the given Tags." }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TransactionExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Transaction expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Transaction expand paths." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSort" } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Transactions"], "summary": "Bulk Update Multiple Transactions", "description": "Update multiple transactions. The maximum number of transactions\nthat can be updated at once is 100.", "operationId": "update_multiple_transactions_v0_source_accounts__source_account_id__transactions_put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID.", "title": "Source Account Id" }, "description": "The Source Account ID." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionUpdateMultiple" } } } }, "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/transactions/tasks": { "get": { "tags": ["Transactions"], "summary": "List Transaction Processing Tasks", "description": "List Transaction Processing Tasks.", "operationId": "list_txn_processing_tasks_v0_transactions_tasks_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The source account id", "title": "Source Account Id" }, "description": "The source account id" }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TransactionProcessingStatus" }, { "type": "null" } ], "description": "The Transaction Processing Task status", "title": "Status" }, "description": "The Transaction Processing Task status" }, { "name": "task_types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TxnProcessingTaskType" } }, { "type": "null" } ], "description": "A comma separated list of task types. Only return Tasks whose type matches one of the specified values. If omitted, all types are returned.", "teal_explode": false, "title": "Task Types" }, "description": "A comma separated list of task types. Only return Tasks whose type matches one of the specified values. If omitted, all types are returned." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TxnProcessingTaskSort" } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Transaction Processing Task IDs. Only return Tasks with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "A comma separated list of Transaction Processing Task IDs. Only return Tasks with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "include_transaction_ids", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to include the created/removed/modified/skipped/failed transaction id arrays on each Task. Set false when only the Task's status is needed: the arrays dominate the response size and are stored out of line, so omitting them avoids reading them at all. Note they are already omitted for any Task that is not complete.", "default": true, "title": "Include Transaction Ids" }, "description": "Whether to include the created/removed/modified/skipped/failed transaction id arrays on each Task. Set false when only the Task's status is needed: the arrays dominate the response size and are stored out of line, so omitting them avoids reading them at all. Note they are already omitted for any Task that is not complete." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TxnProcessingTaskPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/transactions/tasks/{task_id}": { "get": { "tags": ["Transactions"], "summary": "Retrieve a Transaction Processing Task", "description": "Retrieves an existing Transaction Processing Task.", "operationId": "get_transaction_processing_status_v0_transactions_tasks__task_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Transaction Processing Task ID.", "title": "Task Id" }, "description": "The Transaction Processing Task ID." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TxnProcessingTask" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/bulk/source-accounts/{source_account_id}/transactions": { "delete": { "tags": ["Transactions"], "summary": "Delete Multiple Transactions by IDs", "description": "Delete multiple transactions by their IDs from a source account and their associated Journal Entries.\nReturns individual success/failure status for each transaction.", "operationId": "delete_transactions_bulk_v0_bulk_source_accounts__source_account_id__transactions_delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID.", "title": "Source Account Id" }, "description": "The Source Account ID." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteTransactionsRequest" } } } }, "responses": { "207": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDeleteResult" }, "title": "Response Delete Transactions Bulk V0 Bulk Source Accounts Source Account Id Transactions Delete" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/source-accounts/{source_account_id}/transactions/{transaction_id}": { "delete": { "tags": ["Transactions"], "summary": "Delete a Transaction", "description": "Deletes an existing Transaction.", "operationId": "delete_transaction_v0_source_accounts__source_account_id__transactions__transaction_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID.", "title": "Source Account Id" }, "description": "The Source Account ID." }, { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the Transaction to be deleted.", "title": "Transaction Id" }, "description": "The ID of the Transaction to be deleted." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Transactions"], "summary": "Update a Transaction", "description": "Updates a specific Transaction. Any parameters not specified will\nnot be changed.", "operationId": "update_transaction_v0_source_accounts__source_account_id__transactions__transaction_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Transaction ID.", "title": "Transaction Id" }, "description": "The Transaction ID." }, { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID.", "title": "Source Account Id" }, "description": "The Source Account ID." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionUpdate" } } } }, "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Transactions"], "summary": "Retrieve a Transaction", "description": "Returns a single Transaction.", "operationId": "get_transaction_v0_source_accounts__source_account_id__transactions__transaction_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID.", "title": "Source Account Id" }, "description": "The Source Account ID." }, { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Transaction ID.", "title": "Transaction Id" }, "description": "The Transaction ID." }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TransactionExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Transaction expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Transaction expand paths." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExpandableTransaction" }, { "type": "null" } ], "title": "Response Get Transaction V0 Source Accounts Source Account Id Transactions Transaction Id Get" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform/tag-groups/{tag_group_id}": { "get": { "tags": ["Tags"], "summary": "Retrieve a tag group", "description": "Retrieves an existing tag group.", "operationId": "get_tag_group_v0_platform_tag_groups__tag_group_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_group_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag group ID", "title": "Tag Group Id" }, "description": "The tag group ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagGroup" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Tags"], "summary": "Delete a tag group", "description": "Deletes an existing tag group from the platform. This will also remove\nall tags this tag group from all line entries and transactions.", "operationId": "delete_tag_group_v0_platform_tag_groups__tag_group_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_group_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag group ID", "title": "Tag Group Id" }, "description": "The tag group ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Tags"], "summary": "Update a tag group", "description": "Updates an existing tag group. Unspecified fields will not be updated.", "operationId": "update_tag_group_v0_platform_tag_groups__tag_group_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_group_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag group ID", "title": "Tag Group Id" }, "description": "The tag group ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagGroupUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/platform/tag-groups": { "get": { "tags": ["Tags"], "summary": "List all tag groups", "description": "List all tag groups.", "operationId": "get_tag_groups_v0_platform_tag_groups_get", "security": [{ "OAuth2PasswordBearer": [] }], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagGroup" }, "title": "Response Get Tag Groups V0 Platform Tag Groups Get" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Tags"], "summary": "Create a tag group", "description": "Creates a tag group for the platform.", "operationId": "create_tag_group_v0_platform_tag_groups_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagGroupCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagGroup" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/tags/rules": { "get": { "tags": ["Tags"], "summary": "List all tag rules", "description": "Lists all tag rules.", "operationId": "get_tag_rules_v0_tags_rules_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Tag Rule IDs. Only return Tag Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "A comma separated list of Tag Rule IDs. Only return Tag Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRulePage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Tags"], "summary": "Create a tag rule", "description": "Creates a new tag rule for an existing instance.", "operationId": "add_tag_rule_v0_tags_rules_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRuleCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRule" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/tags/rules/{tag_rule_id}": { "get": { "tags": ["Tags"], "summary": "Retrieve a tag rule", "description": "Retrieves an existing tag rule.", "operationId": "get_tag_rule_v0_tags_rules__tag_rule_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_rule_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag ID", "title": "Tag Rule Id" }, "description": "The tag ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRule" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Tags"], "summary": "Delete a tag rule", "description": "Deletes an existing tag rule.", "operationId": "delete_tag_rule_v0_tags_rules__tag_rule_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_rule_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag ID", "title": "Tag Rule Id" }, "description": "The tag ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Tags"], "summary": "Update a tag rule", "description": "Updates a tag rule. Unspecified fields will not be updated.", "operationId": "update_tag_rule_v0_tags_rules__tag_rule_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_rule_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag ID", "title": "Tag Rule Id" }, "description": "The tag ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRuleUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/tags/{tag_id}": { "get": { "tags": ["Tags"], "summary": "Retrieve a tag", "description": "Retrieves an existing tag.", "operationId": "get_tag_v0_tags__tag_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag ID", "title": "Tag Id" }, "description": "The tag ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedTag" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Tags"], "summary": "Delete a tag", "description": "Deletes an existing tag for an instance. Associated line entry tags,\ntransaction tags, and tag rules will also be deleted.", "operationId": "delete_tag_v0_tags__tag_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag ID", "title": "Tag Id" }, "description": "The tag ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Tags"], "summary": "Update a tag", "description": "Updates an existing tag. Unspecified fields will not be updated.", "operationId": "update_tag_v0_tags__tag_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag ID", "title": "Tag Id" }, "description": "The tag ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/tags": { "get": { "tags": ["Tags"], "summary": "List all tags", "description": "List of tags belonging to an instance.", "operationId": "get_instance_tags_v0_tags_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Optional name of tag for filtering.", "title": "Name" }, "description": "Optional name of tag for filtering." }, { "name": "tag_group_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Optional tag group ID for filtering.", "title": "Tag Group Id" }, "description": "Optional tag group ID for filtering." }, { "name": "include_disabled", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include disabled tags.", "default": false, "title": "Include Disabled" }, "description": "Include disabled tags." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/InstanceTagSort" } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Tag IDs. Only return Tags with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "A comma separated list of Tag IDs. Only return Tags with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedTagPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "post": { "tags": ["Tags"], "summary": "Create a tag", "description": "Creates a new tag for an existing instance and tag group.", "operationId": "add_instance_tag_v0_tags_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The teal instance ID", "title": "Teal-Instance-Id" }, "description": "The teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reconciliations": { "post": { "tags": ["Reconciliation"], "summary": "Create a Reconciliation", "description": "Creates a new Reconciliation based on the given parameters.", "operationId": "create_reconciliation_v0_reconciliations_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconciliationCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reconciliation" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "get": { "tags": ["Reconciliation"], "summary": "List Reconciliations", "description": "List an instance's reconciliations.", "operationId": "list_reconciliations_v0_reconciliations_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationSort" } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "progress_status", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReconciliationProgressStatus" }, { "type": "null" } ], "description": "Only return Reconciliations with a specific progress status.", "title": "Progress Status" }, "description": "Only return Reconciliations with a specific progress status." }, { "name": "ledger_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The ledger ID.", "title": "Ledger Id" }, "description": "The ledger ID." }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "A comma separated list of Reconciliation IDs. Only return Reconciliations with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.", "teal_explode": false, "title": "Ids" }, "description": "A comma separated list of Reconciliation IDs. Only return Reconciliations with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconciliationPage" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/bulk/reconciliations": { "post": { "tags": ["Reconciliation"], "summary": "Bulk Create Reconciliations", "description": "Bulk-create completed reconciliations for a ledger from a list of periods.\nAll journal entries are reconciled in their natural periods. Unlike the single\ncreate endpoint, balances are not verified. New periods are appended after\nany existing reconciliations.\n\nReturns HTTP 207 with per-period results. If any period fails validation the\noperation is aborted and affected periods are returned with success: false.", "operationId": "bulk_create_reconciliations_v0_bulk_reconciliations_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkReconciliationCreate" } } } }, "responses": { "207": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkReconciliationResult" }, "title": "Response Bulk Create Reconciliations V0 Bulk Reconciliations Post" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reconciliations/last-completed": { "get": { "tags": ["Reconciliation"], "summary": "Get the last completed reconciliation for each ledger", "description": "Get the last completed reconciliation for each ledger.", "operationId": "get_last_completed_reconciliation_v0_reconciliations_last_completed_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "The ledger IDs.", "teal_explode": false, "title": "Ledger Ids" }, "description": "The ledger IDs." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Reconciliation" }, "title": "Response Get Last Completed Reconciliation V0 Reconciliations Last Completed Get" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reconciliations/{reconciliation_id}/journal-entries": { "get": { "tags": ["Reconciliation"], "summary": "Fetch Journal Entries for a given reconciliation", "description": "Fetch Journal Entries for reconciliation.", "operationId": "get_reconciliation_journal_entries_v0_reconciliations__reconciliation_id__journal_entries_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "reconciliation_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The reconciliation ID", "title": "Reconciliation Id" }, "description": "The reconciliation ID" }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/JournalEntrySort" }, { "$ref": "#/components/schemas/JournalEntrySortAmount" } ] } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationJournalEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Reconciliation Journal Entry expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Reconciliation Journal Entry expand paths." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only return Journal Entries after the start date (inclusive). Must be in `YYYY-MM-DD` format.", "title": "Start Date" }, "description": "Only return Journal Entries after the start date (inclusive). Must be in `YYYY-MM-DD` format." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only return Journal Entries before the end date (inclusive). Must be in `YYYY-MM-DD` format.", "title": "End Date" }, "description": "Only return Journal Entries before the end date (inclusive). Must be in `YYYY-MM-DD` format." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "ledger_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Only return Journal Entries where at least one Line Entry belongs to one of the specified Ledgers.", "teal_explode": false, "title": "Ledger Ids" }, "description": "Only return Journal Entries where at least one Line Entry belongs to one of the specified Ledgers." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "description", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Filter by description. Returns records containing the provided text (case-insensitive). If provided, description_starts_with and description_ends_with are not accepted.", "title": "Description" }, "description": "Filter by description. Returns records containing the provided text (case-insensitive). If provided, description_starts_with and description_ends_with are not accepted." }, { "name": "description_starts_with", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Filter by description prefix. Returns records where description starts with the provided text (case-insensitive). If provided, description is not accepted.", "title": "Description Starts With" }, "description": "Filter by description prefix. Returns records where description starts with the provided text (case-insensitive). If provided, description is not accepted." }, { "name": "description_ends_with", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Filter by description suffix. Returns records where description ends with the provided text (case-insensitive). If provided, description is not accepted.", "title": "Description Ends With" }, "description": "Filter by description suffix. Returns records where description ends with the provided text (case-insensitive). If provided, description is not accepted." }, { "name": "amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Filter by exact amount in decimal dollar cents. If provided, min_amount and max_amount are not accepted.", "title": "Amount" }, "description": "Filter by exact amount in decimal dollar cents. If provided, min_amount and max_amount are not accepted." }, { "name": "min_amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Only return records with a monetary amount of at least the specified amount. If provided, amount is not accepted.", "title": "Min Amount" }, "description": "Only return records with a monetary amount of at least the specified amount. If provided, amount is not accepted." }, { "name": "max_amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Only return records with a monetary amount less than or equal to the specified amount. If provided, amount is not accepted.", "title": "Max Amount" }, "description": "Only return records with a monetary amount less than or equal to the specified amount. If provided, amount is not accepted." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconciliationJournalEntries" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/ledgers/{ledger_id}/reconciliations/unreconciled/journal-entries": { "get": { "tags": ["Reconciliation"], "summary": "Fetch Journal Entries for the next reconciliation in a given ledger", "description": "Fetch Journal Entries for the next reconciliation in a given ledger.", "operationId": "get_next_reconciliation_journal_entries_v0_ledgers__ledger_id__reconciliations_unreconciled_journal_entries_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ledger_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ledger ID", "title": "Ledger Id" }, "description": "The ledger ID" }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/JournalEntrySort" }, { "$ref": "#/components/schemas/JournalEntrySortAmount" } ] } }, { "type": "null" } ], "description": "A comma separated list of sort orders for the results.", "teal_explode": false, "title": "Sort" }, "description": "A comma separated list of sort orders for the results." }, { "name": "expand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationJournalEntryExpandPath" } }, { "type": "null" } ], "description": "Comma-separated list of Reconciliation Journal Entry expand paths.", "teal_explode": false, "title": "Expand" }, "description": "Comma-separated list of Reconciliation Journal Entry expand paths." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only return Journal Entries after the start date (inclusive). Must be in `YYYY-MM-DD` format.", "title": "Start Date" }, "description": "Only return Journal Entries after the start date (inclusive). Must be in `YYYY-MM-DD` format." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "description": "Only return Journal Entries before the end date (inclusive). Must be in `YYYY-MM-DD` format.", "title": "End Date" }, "description": "Only return Journal Entries before the end date (inclusive). Must be in `YYYY-MM-DD` format." }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Time Zone Identifier", "enum": [ "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/Coyhaique", "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", "localtime" ], "default": "UTC", "title": "Time Zone" }, "description": "Time Zone Identifier" }, { "name": "ledger_ids", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Only return Journal Entries where at least one Line Entry belongs to one of the specified Ledgers.", "teal_explode": false, "title": "Ledger Ids" }, "description": "Only return Journal Entries where at least one Line Entry belongs to one of the specified Ledgers." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "exclusiveMaximum": 1001, "description": "The number of records to return. Max limit is 1000.", "default": 50, "title": "Limit" }, "description": "The number of records to return. Max limit is 1000." }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Opaque page token", "title": "Page Token" }, "description": "Opaque page token" }, { "name": "description", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Filter by description. Returns records containing the provided text (case-insensitive). If provided, description_starts_with and description_ends_with are not accepted.", "title": "Description" }, "description": "Filter by description. Returns records containing the provided text (case-insensitive). If provided, description_starts_with and description_ends_with are not accepted." }, { "name": "description_starts_with", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Filter by description prefix. Returns records where description starts with the provided text (case-insensitive). If provided, description is not accepted.", "title": "Description Starts With" }, "description": "Filter by description prefix. Returns records where description starts with the provided text (case-insensitive). If provided, description is not accepted." }, { "name": "description_ends_with", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Filter by description suffix. Returns records where description ends with the provided text (case-insensitive). If provided, description is not accepted.", "title": "Description Ends With" }, "description": "Filter by description suffix. Returns records where description ends with the provided text (case-insensitive). If provided, description is not accepted." }, { "name": "amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Filter by exact amount in decimal dollar cents. If provided, min_amount and max_amount are not accepted.", "title": "Amount" }, "description": "Filter by exact amount in decimal dollar cents. If provided, min_amount and max_amount are not accepted." }, { "name": "min_amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Only return records with a monetary amount of at least the specified amount. If provided, amount is not accepted.", "title": "Min Amount" }, "description": "Only return records with a monetary amount of at least the specified amount. If provided, amount is not accepted." }, { "name": "max_amount", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Only return records with a monetary amount less than or equal to the specified amount. If provided, amount is not accepted.", "title": "Max Amount" }, "description": "Only return records with a monetary amount less than or equal to the specified amount. If provided, amount is not accepted." }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconciliationJournalEntries" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/reconciliations/{reconciliation_id}": { "get": { "tags": ["Reconciliation"], "summary": "Fetch a Reconciliation", "description": "Get a reconciliation.", "operationId": "get_reconciliation_v0_reconciliations__reconciliation_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "reconciliation_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The reconciliation ID", "title": "Reconciliation Id" }, "description": "The reconciliation ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reconciliation" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "put": { "tags": ["Reconciliation"], "summary": "Update a Reconciliation", "description": "Update a reconciliation.", "operationId": "update_reconciliation_v0_reconciliations__reconciliation_id__put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "reconciliation_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The reconciliation ID", "title": "Reconciliation Id" }, "description": "The reconciliation ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconciliationUpdate" } } } }, "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } }, "delete": { "tags": ["Reconciliation"], "summary": "Delete a Reconciliation and all later reconciliations on the same ledger", "description": "Delete a Reconciliation and all later reconciliations on the same ledger.", "operationId": "delete_reconciliation_v0_reconciliations__reconciliation_id__delete", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "reconciliation_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The reconciliation ID", "title": "Reconciliation Id" }, "description": "The reconciliation ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "204": { "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/bulk/reconciliations/{reconciliation_id}/journal-entries": { "put": { "tags": ["Reconciliation"], "summary": "Bulk update reconciliation journal entry status", "description": "Bulk update reconciliation journal entry status.", "operationId": "update_reconciliation_journal_entries_v0_bulk_reconciliations__reconciliation_id__journal_entries_put", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "reconciliation_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The reconciliation ID", "title": "Reconciliation Id" }, "description": "The reconciliation ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationJournalEntryUpdate" }, "title": "Reconciliation Journal Entry Updates" } } } }, "responses": { "207": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationJournalEntryUpdateResult" }, "title": "Response Update Reconciliation Journal Entries V0 Bulk Reconciliations Reconciliation Id Journal Entries Put" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/source-accounts/{source_account_id}/statement-files": { "post": { "tags": ["Statement Reconciliation"], "summary": "Upload a Statement File", "description": "Upload a bank statement PDF for a source account.", "operationId": "create_statement_file_v0_source_accounts__source_account_id__statement_files_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "source_account_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Source Account ID", "title": "Source Account Id" }, "description": "The Source Account ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_statement_file_v0_source_accounts__source_account_id__statement_files_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFile" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/statement-files/{statement_file_id}": { "get": { "tags": ["Statement Reconciliation"], "summary": "Fetch a Statement File", "description": "Get a statement file and its processing status.", "operationId": "get_statement_file_v0_statement_files__statement_file_id__get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "statement_file_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Statement File ID", "title": "Statement File Id" }, "description": "The Statement File ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFile" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/statement-files/{statement_file_id}/content": { "get": { "tags": ["Statement Reconciliation"], "summary": "Download a Statement File", "description": "Download the stored statement PDF.", "operationId": "get_statement_file_content_v0_statement_files__statement_file_id__content_get", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "statement_file_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Statement File ID", "title": "Statement File Id" }, "description": "The Statement File ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/octet-stream": {} } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/statement-files/{statement_file_id}/parsed-statement": { "post": { "tags": ["Statement Reconciliation"], "summary": "Create a Parsed Statement for a Statement File", "description": "Store the parsed contents of a statement file. Rejects payloads whose\nlines do not reproduce ending_balance from opening_balance — net change\nis direction-aware by account type (error code\n`parsed_statement_balance_mismatch`) — and returns 409 if the statement\nfile already has a parsed statement.", "operationId": "create_parsed_statement_v0_statement_files__statement_file_id__parsed_statement_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "statement_file_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Statement File ID", "title": "Statement File Id" }, "description": "The Statement File ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParsedStatementCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParsedStatement" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } }, "/v0/statement-files/{statement_file_id}/parse-failure": { "post": { "tags": ["Statement Reconciliation"], "summary": "Mark a Statement File as Failed to Parse", "description": "Mark a statement file as failed to parse.", "operationId": "mark_statement_file_parse_failed_v0_statement_files__statement_file_id__parse_failure_post", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "statement_file_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Statement File ID", "title": "Statement File Id" }, "description": "The Statement File ID" }, { "name": "teal-instance-id", "in": "header", "required": true, "schema": { "type": "string", "description": "The Teal instance ID", "title": "Teal-Instance-Id" }, "description": "The Teal instance ID" }, { "name": "modified-by", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "An optional identifier for audit logging.", "title": "Modified-By" }, "description": "An optional identifier for audit logging." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFile" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Unprocessable Content" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TealErrorResponse" } } }, "description": "Service Unavailable" } } } } }, "webhooks": { "/v0transaction.source.processing.error": { "post": { "tags": ["Webhooks"], "summary": "Transaction Source Processing Error", "description": "If an error is encountered while syncing transactions with a source (ex. Plaid),\nan HTTP POST request with a body following this schema will be sent to your\nregistered webhook URL.", "operationId": "transaction_source_processing_error_v0transaction_source_processing_error_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionSourceProcessingError" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v0transaction.source.processing.completed": { "post": { "tags": ["Webhooks"], "summary": "Transaction Source Processing Complete", "description": "Upon successful completion of a transaction sync with a source (ex. Plaid),\nan HTTP POST request with a body following this schema will be sent to your\nregistered webhook URL.", "operationId": "transaction_source_processing_complete_v0transaction_source_processing_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionSourceProcessingComplete" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v0transaction.source.initialized": { "post": { "tags": ["Webhooks"], "summary": "Transaction Source Initialized", "description": "Indicates the successful initialization of a transaction source.\nAn HTTP POST request with a body following this schema will be sent to your\nregistered webhook URL.", "operationId": "transaction_source_initialized_v0transaction_source_initialized_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionSourceInitialized" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AccountingBasis": { "type": "string", "enum": ["cash", "accrual"], "title": "AccountingBasis" }, "AccrualSource": { "properties": { "id": { "type": "string", "title": "Id" }, "instance_id": { "type": "string", "title": "Instance Id" }, "external_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id" }, "reference_number": { "type": "string", "title": "Reference Number", "default": "" }, "external_party_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Party Id" }, "type": { "$ref": "#/components/schemas/AccrualSourceType" }, "status": { "$ref": "#/components/schemas/AccrualSourceStatus" }, "display_status": { "$ref": "#/components/schemas/AccrualSourceDisplayStatus" }, "effective_date": { "type": "string", "format": "date", "title": "Effective Date" }, "due_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Due Date" }, "gross_amount": { "type": "number", "title": "Gross Amount" }, "amount_paid": { "type": "number", "title": "Amount Paid" }, "amount_adjusted": { "type": "number", "title": "Amount Adjusted" }, "amount_outstanding": { "type": "number", "title": "Amount Outstanding" }, "notes": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Notes" }, "service_period_start": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Service Period Start" }, "service_period_end": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Service Period End" }, "lines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AccrualSourceLine" }, "type": "array" }, { "type": "null" } ], "title": "Lines" } }, "type": "object", "required": [ "id", "instance_id", "type", "status", "display_status", "effective_date", "gross_amount", "amount_paid", "amount_adjusted", "amount_outstanding" ], "title": "AccrualSource" }, "AccrualSourceDetails": { "properties": { "id": { "type": "string", "title": "Id" }, "instance_id": { "type": "string", "title": "Instance Id" }, "external_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id" }, "reference_number": { "type": "string", "title": "Reference Number", "default": "" }, "external_party_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Party Id" }, "type": { "$ref": "#/components/schemas/AccrualSourceType" }, "status": { "$ref": "#/components/schemas/AccrualSourceStatus" }, "display_status": { "$ref": "#/components/schemas/AccrualSourceDisplayStatus" }, "effective_date": { "type": "string", "format": "date", "title": "Effective Date" }, "due_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Due Date" }, "gross_amount": { "type": "number", "title": "Gross Amount" }, "amount_paid": { "type": "number", "title": "Amount Paid" }, "amount_adjusted": { "type": "number", "title": "Amount Adjusted" }, "amount_outstanding": { "type": "number", "title": "Amount Outstanding" }, "notes": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Notes" }, "service_period_start": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Service Period Start" }, "service_period_end": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Service Period End" }, "lines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AccrualSourceLine" }, "type": "array" }, { "type": "null" } ], "title": "Lines" }, "journal_entry_ids": { "items": { "type": "string" }, "type": "array", "title": "Journal Entry Ids", "default": [] }, "files": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AccrualSourceFile" }, "type": "array" }, { "type": "null" } ], "title": "Files" }, "payment_applications": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AccrualSourcePaymentApplication" }, "type": "array" }, { "type": "null" } ], "title": "Payment Applications" } }, "type": "object", "required": [ "id", "instance_id", "type", "status", "display_status", "effective_date", "gross_amount", "amount_paid", "amount_adjusted", "amount_outstanding" ], "title": "AccrualSourceDetails" }, "AccrualSourceDisplayStatus": { "type": "string", "enum": ["paid", "open", "draft", "cancelled", "processing", "overdue", "partially_paid"], "title": "AccrualSourceDisplayStatus" }, "AccrualSourceFile": { "properties": { "id": { "type": "string", "title": "Id" }, "file_name": { "type": "string", "title": "File Name" } }, "type": "object", "required": ["id", "file_name"], "title": "AccrualSourceFile" }, "AccrualSourceLine": { "properties": { "id": { "type": "string", "title": "Id" }, "accrual_source_id": { "type": "string", "title": "Accrual Source Id" }, "external_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id" }, "account_id": { "type": "string", "title": "Account Id" }, "line_number": { "type": "integer", "title": "Line Number" }, "description": { "type": "string", "title": "Description" }, "amount": { "type": "number", "title": "Amount" } }, "type": "object", "required": [ "id", "accrual_source_id", "account_id", "line_number", "description", "amount" ], "title": "AccrualSourceLine" }, "AccrualSourcePaymentApplication": { "properties": { "payment_application_id": { "type": "string", "title": "Payment Application Id" }, "matched_amount": { "type": "number", "title": "Matched Amount" }, "line_entry": { "$ref": "#/components/schemas/PaymentApplicationLineEntry" }, "source_type": { "$ref": "#/components/schemas/PaymentApplicationSourceType" }, "status": { "$ref": "#/components/schemas/PaymentApplicationStatus" }, "adjustments": { "items": { "$ref": "#/components/schemas/PaymentApplicationAccrualAdjustment" }, "type": "array", "title": "Adjustments" } }, "type": "object", "required": [ "payment_application_id", "matched_amount", "line_entry", "source_type", "status", "adjustments" ], "title": "AccrualSourcePaymentApplication" }, "AccrualSourceStatus": { "type": "string", "enum": ["paid", "open", "draft", "cancelled", "processing"], "title": "AccrualSourceStatus" }, "AccrualSourceType": { "type": "string", "enum": ["invoice", "bill", "payroll"], "title": "AccrualSourceType" }, "AutocatMethod": { "type": "string", "enum": [ "rule", "similarity", "embedding", "llm_classifier", "user", "transfers_between_accounts" ], "title": "AutocatMethod" }, "AutocatResult": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["ac_9kSx1s5F8kQ2s6c9m2Zt3W"] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The category ledger autocat assigned to the transaction.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "method": { "$ref": "#/components/schemas/AutocatMethod", "description": "How the category was assigned. Although 'user' is a declared value, it is never returned in practice: a user categorization is recorded separately and suppresses the autocat result, so autocat_result is null for user-categorized transactions.", "examples": ["rule"] }, "confidence": { "type": "number", "title": "Confidence", "description": "The autocat model's confidence in the assignment, 0.0 to 1.0.", "examples": [0.95] }, "rule_id": { "anyOf": [{ "type": "string", "format": "uuid" }, { "type": "null" }], "title": "Rule Id", "description": "If method is 'rule', the ID of the rule that matched; otherwise null. This is an opaque identifier supplied by the external categorizer." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the autocat result was recorded, in UTC.", "examples": ["2023-02-15T06:42:18Z"] } }, "type": "object", "required": ["id", "ledger_id", "method", "confidence", "created_at"], "title": "AutocatResult", "description": "The auto-categorization decision recorded for a transaction: how its\ncategory ledger was assigned. Present only for transaction-sourced journal\nentries that were categorized by the external autocat pipeline." }, "BalanceSheet": { "properties": { "records": { "items": { "$ref": "#/components/schemas/ReportRecord" }, "type": "array", "title": "Records", "description": "A list of Records that represents either a ledger or a groups of ledgers.\n\nRecords that are groups of ledgers are grouped by balance sheet `type`: `asset`, `liability`, and `equity`, in that order, and then by `sub_type`. Within each `sub_type` group, Ledger objects are ordered by `sort_code`.", "examples": [ [ { "amount": 0, "children": [ { "amount": 0, "children": [ { "amount": 95582.71, "debit_credit": "debit", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "name": "Pluto Checking 4242", "sort_code": "1011", "sub_type": "current_assets", "total_amount": 95582.71, "type": "asset" } ], "debit_credit": "debit", "name": "Current Assets", "total_amount": 95582.71, "type": "asset" } ], "debit_credit": "debit", "name": "Asset", "total_amount": 95582.71, "type": "asset" }, { "amount": 0, "children": [ { "amount": 0, "children": [ { "amount": 8067, "debit_credit": "credit", "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco", "name": "Pluto Credit Card 2424", "sort_code": "2010", "sub_type": "current_liabilities", "total_amount": 8067, "type": "liability" } ], "debit_credit": "credit", "name": "Current Liabilities", "total_amount": 8067, "type": "liability" } ], "debit_credit": "credit", "name": "Liability", "total_amount": 8067, "type": "liability" }, { "amount": 0, "children": [ { "amount": 0, "children": [ { "amount": 87515.71, "debit_credit": "credit", "ledger_id": "WhvrC7XAES1fDrpWWgmPtg", "name": "Opening Balance Retained Earnings", "sort_code": "8010", "sub_type": "equity", "total_amount": 87515.71, "type": "equity" } ], "debit_credit": "credit", "name": "Equity", "total_amount": 87515.71, "type": "equity" } ], "debit_credit": "credit", "name": "Equity", "total_amount": 87515.71, "type": "equity" } ] ] }, "retained_earnings_metadata": { "$ref": "#/components/schemas/RetainedEarningsMetadata", "description": "System-computed Retained Earnings and Current Year Earnings for the period. Useful for showing the calculated portion separately from any user-posted journal entries against the writable Retained Earnings / Current Year Earnings system ledgers." } }, "type": "object", "required": ["records", "retained_earnings_metadata"], "title": "BalanceSheet" }, "BalanceSheetPeriods": { "properties": { "periods": { "items": { "type": "string" }, "type": "array", "title": "Periods", "description": "A list of periods in the range.", "examples": [["Q1-2020", "Q2-2020"]] }, "records": { "items": { "$ref": "#/components/schemas/ReportPeriodsRecord" }, "type": "array", "title": "Records", "description": "A list of Records that represents either a ledger or a groups of ledgers.\n\nRecords that are groups of ledgers are grouped by balance sheet `type`: `asset`, `liability`, and `equity`, in that order, and then by `sub_type`. Within each `sub_type` group, Ledger objects are ordered by `sort_code`.", "examples": [ [ { "amounts": [0, 0], "children": [ { "amounts": [0, 0], "children": [ { "amounts": [82636.12, 95582.71], "debit_credit": "debit", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "name": "Pluto Checking 4242", "sort_code": "1011", "sub_type": "current_assets", "total_amounts": [82636.12, 95582.71], "type": "asset" } ], "debit_credit": "debit", "name": "Current Assets", "total_amounts": [82636.12, 95582.71], "type": "asset" } ], "debit_credit": "debit", "name": "Asset", "total_amounts": [82636.12, 95582.71], "type": "asset" }, { "amounts": [0, 0], "children": [ { "amounts": [0, 0], "children": [ { "amounts": [2713.28, 8067], "debit_credit": "credit", "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco", "name": "Pluto Credit Card 2424", "sort_code": "2010", "sub_type": "current_liabilities", "total_amounts": [2713.28, 8067], "type": "liability" } ], "debit_credit": "credit", "name": "Current Liabilities", "total_amounts": [2713.28, 8067], "type": "liability" } ], "debit_credit": "credit", "name": "Liability", "total_amounts": [2713.28, 8067], "type": "liability" }, { "amounts": [0, 0], "children": [ { "amounts": [0, 0], "children": [ { "amounts": [47213.23, 87515.71], "debit_credit": "credit", "ledger_id": "WhvrC7XAES1fDrpWWgmPtg", "name": "Opening Balance Retained Earnings", "sort_code": "8010", "sub_type": "equity", "total_amounts": [47213.23, 87515.71], "type": "equity" } ], "debit_credit": "credit", "name": "Equity", "total_amounts": [47213.23, 87515.71], "type": "equity" } ], "debit_credit": "credit", "name": "Equity", "total_amounts": [47213.23, 87515.71], "type": "equity" } ] ] }, "retained_earnings_metadata": { "$ref": "#/components/schemas/RetainedEarningsMetadataPeriods", "description": "Per-period system-computed Retained Earnings and Current Year Earnings. Useful for showing the calculated portion separately from any user-posted journal entries against the writable Retained Earnings / Current Year Earnings system ledgers." } }, "type": "object", "required": ["periods", "records", "retained_earnings_metadata"], "title": "BalanceSheetPeriods" }, "Body_create_statement_file_v0_source_accounts__source_account_id__statement_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File", "description": "The statement PDF to upload." } }, "type": "object", "required": ["file"], "title": "Body_create_statement_file_v0_source_accounts__source_account_id__statement_files_post" }, "BulkDeleteTransactionsRequest": { "properties": { "transaction_ids": { "items": { "type": "string" }, "type": "array", "title": "Transaction Ids", "description": "List of transaction IDs to delete" } }, "type": "object", "required": ["transaction_ids"], "title": "BulkDeleteTransactionsRequest" }, "BulkJournalEntries": { "properties": { "records": { "items": { "$ref": "#/components/schemas/BulkJournalEntry" }, "type": "array", "title": "Records", "description": "List of journal entries with minimal fields" }, "is_truncated": { "type": "boolean", "title": "Is Truncated", "description": "Indicates the results were truncated and there are more entries available than the limit." } }, "type": "object", "required": ["records", "is_truncated"], "title": "BulkJournalEntries", "description": "Response schema for bulk journal entry queries." }, "BulkJournalEntry": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "description": { "type": "string", "title": "Description", "description": "Journal entry description", "examples": ["Payroll#230215"] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The datetime the Journal Entry was created in UTC time", "examples": ["2023-02-15T06:42:18Z"] }, "creation_date": { "type": "string", "format": "date-time", "title": "Creation Date", "description": "The timestamp when this journal entry record was created in the database", "examples": ["2023-02-15T06:42:18Z"] }, "line_entries": { "items": { "$ref": "#/components/schemas/BulkJournalEntryLineEntry" }, "type": "array", "title": "Line Entries", "description": "Line entries associated with this journal entry", "examples": [ [ { "amount": "31282.27999999999883584678173065185546875", "debit_credit": "debit", "editable": true, "id": "XMDsKVuW4Wmi3LTW31Qw6E", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC" }, { "amount": "31282.27999999999883584678173065185546875", "debit_credit": "credit", "editable": true, "id": "NULcvXTkLczde32qs1rqgB", "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco" } ] ] } }, "type": "object", "required": ["id", "description", "datetime", "creation_date", "line_entries"], "title": "BulkJournalEntry", "description": "Minimal journal entry schema optimized for bulk queries.\n\nContains only the fields required by the Manual Journal Entries UI." }, "BulkJournalEntryLineEntry": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["XMDsKVuW4Wmi3LTW31Qw6E"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Whether this is a debit or credit line entry", "examples": ["debit"] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the ledger this line entry belongs to", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "amount": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Amount", "description": "The amount of this line entry", "examples": ["31282.27999999999883584678173065185546875"] }, "editable": { "type": "boolean", "title": "Editable", "description": "Whether this line entry can be edited", "examples": [true] } }, "type": "object", "required": ["id", "debit_credit", "ledger_id", "amount", "editable"], "title": "BulkJournalEntryLineEntry", "description": "Minimal line entry schema for bulk journal entry responses." }, "BulkReconciliationCreate": { "properties": { "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The Ledger ID", "examples": ["WTjdK47SHxokWUdypL8zyB"] }, "time_zone": { "type": "string", "enum": [ "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/Coyhaique", "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", "localtime" ], "minLength": 1, "title": "Time Zone", "description": "Time Zone Identifier", "default": "UTC" }, "periods": { "items": { "$ref": "#/components/schemas/BulkReconciliationPeriod" }, "type": "array", "maxItems": 120, "minItems": 1, "title": "Periods", "description": "List of statement periods with their ending balances, in chronological order." } }, "type": "object", "required": ["ledger_id", "periods"], "title": "BulkReconciliationCreate" }, "BulkReconciliationPeriod": { "properties": { "ref": { "type": "string", "maxLength": 36, "minLength": 1, "title": "Ref", "description": "Client-supplied identifier echoed back in the response to identify this period.", "examples": ["row_1"] }, "statement_ending_date": { "type": "string", "format": "date", "title": "Statement Ending Date", "description": "The end date of the statement period.", "examples": ["2024-01-31"] }, "statement_ending_balance": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Statement Ending Balance", "description": "The ending balance of the statement for this period.", "examples": [132629.38] } }, "type": "object", "required": ["ref", "statement_ending_date", "statement_ending_balance"], "title": "BulkReconciliationPeriod" }, "BulkReconciliationResult": { "properties": { "ref": { "type": "string", "title": "Ref", "description": "Echoed from the request item." }, "validated": { "type": "boolean", "title": "Validated", "description": "Whether this item passed validation. True does not imply creation — if the batch was aborted due to other errors, data will be null even when validated is true." }, "error_code": { "anyOf": [{ "$ref": "#/components/schemas/TealErrorCode" }, { "type": "null" }], "description": "Machine-readable error code; null when validated." }, "error": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Error", "description": "Error message when validation failed; null when validated." }, "data": { "anyOf": [{ "$ref": "#/components/schemas/Reconciliation" }, { "type": "null" }], "description": "Created reconciliation on success; null if validation failed or the batch was aborted." } }, "type": "object", "required": ["ref", "validated"], "title": "BulkReconciliationResult" }, "BurnBuildRate": { "properties": { "type": { "$ref": "#/components/schemas/BurnBuildRateType", "description": "`burn_rate` when the average net cash flow over the measured window is negative; `build_rate` otherwise (including exactly zero). Discriminates how `runway_months` was derived.", "examples": ["burn_rate"] }, "avg_net_cash_flow": { "type": "number", "title": "Avg Net Cash Flow", "description": "Average monthly net cash flow across cash accounts over the measured window, in decimal dollar cents. Signed: negative indicates burn.", "examples": ["-12500"] }, "runway_months": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Runway Months", "description": "Whole months, floored, clamped at zero (zero means less than one month). Derived from the cash balance as of the request time. For `burn_rate`: months of cash remaining at the average burn. For `build_rate`: months of expenses covered by the cash balance. Null only for `build_rate` when the average monthly expense rate is zero or negative.", "examples": [10] }, "monthly_expense_rate": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Monthly Expense Rate", "description": "Average monthly expenses over the measured window, in decimal dollar cents. Present only for `build_rate`; null for `burn_rate` or negative expense window total.", "examples": [null] }, "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The first day of the measured trailing window: the three most recent whole calendar months completed as of the request time, in the requested time zone. Independent of the requested `start_date`/`end_date`; the in-progress month is never included.", "examples": ["2024-02-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The last day of the measured trailing window (inclusive).", "examples": ["2024-04-30"] } }, "type": "object", "required": ["type", "avg_net_cash_flow", "start_date", "end_date"], "title": "BurnBuildRate" }, "BurnBuildRateType": { "type": "string", "enum": ["burn_rate", "build_rate"], "title": "BurnBuildRateType" }, "BusinessOrPersonal": { "type": "string", "enum": ["business", "personal"], "title": "BusinessOrPersonal" }, "CashFlowLedger": { "properties": { "children": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CashFlowLedger" }, "type": "array" }, { "type": "null" } ], "title": "Children", "description": "If the Ledger has any children, a list of the Ledger objects.", "examples": [null] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "lines": { "items": { "$ref": "#/components/schemas/CashFlowLineEntry" }, "type": "array", "title": "Lines", "description": "A list all Line Entries in the Ledger.", "examples": [ [ { "amount": 13451.49, "cash_flow_ledger_name": "Pluto Checking 4242", "datetime": "2023-01-05T00:00:00Z", "journal_entry_description": "Stripe Deposit - xPOLDZXC4334", "journal_entry_id": "344AYLxqH6Q8W7RyHNhfjb", "line_id": "FiiRY2pnADdxwnpajFdhSs" }, { "amount": 17801.8, "cash_flow_ledger_name": "Pluto Checking 4242", "datetime": "2023-02-05T00:00:00Z", "journal_entry_description": "Stripe Deposit - aJFGJLKO2345", "journal_entry_id": "Msb2JMaa7MwG1XHSih35vv", "line_id": "921rijhvBPHDQPSmys14dc" } ] ] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "net_cash_flow": { "type": "number", "title": "Net Cash Flow", "description": "The sum, in decimal dollar cents, of all line entries in the Ledger.", "examples": ["-10837.22999999999956344254314899444580078125"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the Ledger is a child Ledger, the ID of the parent Ledger.", "examples": [null] }, "total_net_cash_flow": { "type": "number", "title": "Total Net Cash Flow", "description": "The sum, in decimal dollar cents, of all line entries in this ledger and all its child ledgers.", "examples": ["-10837.22999999999956344254314899444580078125"] } }, "type": "object", "required": ["ledger_id", "lines", "name", "net_cash_flow", "total_net_cash_flow"], "title": "CashFlowLedger" }, "CashFlowLedgerPeriods": { "properties": { "children": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CashFlowLedgerPeriods" }, "type": "array" }, { "type": "null" } ], "title": "Children", "description": "If the Ledger has any children, a list of the Ledger objects.", "examples": [null] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "net_cash_flows": { "items": { "type": "number" }, "type": "array", "title": "Net Cash Flows", "description": "The sum, in decimal dollar cents, of all line entries in the Ledger.", "examples": [["-10837.22999999999956344254314899444580078125"]] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the Ledger is a child Ledger, the ID of the parent Ledger.", "examples": [null] }, "total_net_cash_flows": { "items": { "type": "number" }, "type": "array", "title": "Total Net Cash Flows", "description": "The sum, in decimal dollar cents, of all line entries in this ledger and all its child ledgers.", "examples": [["-10837.22999999999956344254314899444580078125"]] } }, "type": "object", "required": ["ledger_id", "name", "net_cash_flows", "total_net_cash_flows"], "title": "CashFlowLedgerPeriods" }, "CashFlowLineEntry": { "properties": { "amount": { "type": "number", "title": "Amount", "description": "The value in decimal dollar cents.", "examples": ["-2938.28000000000020008883439004421234130859375"] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "When the object was created in UTC time.", "examples": ["2023-02-15T06:42:18Z"] }, "cash_flow_ledger_name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Cash Flow Ledger Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "journal_entry_description": { "type": "string", "title": "Journal Entry Description", "description": "An arbitrary string on the object, useful for displaying to users.", "examples": ["Payroll#230215"] }, "journal_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Journal Entry Id", "description": "The unique ID of the object.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "line_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Line Id", "description": "The unique ID of the object.", "examples": ["XMDsKVuW4Wmi3LTW31Qw6E"] } }, "type": "object", "required": [ "amount", "datetime", "cash_flow_ledger_name", "journal_entry_description", "journal_entry_id", "line_id" ], "title": "CashFlowLineEntry" }, "CashFlowReport": { "properties": { "cash_flow_ledgers": { "items": { "$ref": "#/components/schemas/CashFlowLedger" }, "type": "array", "title": "Cash Flow Ledgers", "description": "A list of Cash Flow Ledger objects indicating which ledgers were impacted by cash movements in the given period.", "examples": [ [ { "ledger_id": "KhxYFDUi8XZBA94uoHhzs8", "lines": [ { "amount": -6682.7, "cash_flow_ledger_name": "Pluto Checking 4242", "datetime": "2024-01-08T00:00:00Z", "journal_entry_description": "Hill's*Order#1460", "journal_entry_id": "Sd5i3iDEUPwaZks5Eqz767", "line_id": "MtcXSgvyVHdm44AamH3A7p" } ], "name": "Supplies", "net_cash_flow": -6682.7, "total_net_cash_flow": -6682.7 }, { "ledger_id": "WhvrC7XAES1fDrpWWgmPtg", "lines": [ { "amount": 13451.49, "cash_flow_ledger_name": "Pluto Checking 4242", "datetime": "2024-01-05T00:00:00Z", "journal_entry_description": "Stripe Deposit - xPOLDZXC4334", "journal_entry_id": "344AYLxqH6Q8W7RyHNhfjb", "line_id": "FiiRY2pnADdxwnpajFdhSs" }, { "amount": 17801.8, "cash_flow_ledger_name": "Pluto Checking 4242", "datetime": "2024-02-05T00:00:00Z", "journal_entry_description": "Stripe Deposit - aJFGJLKO2345", "journal_entry_id": "Msb2JMaa7MwG1XHSih35vv", "line_id": "921rijhvBPHDQPSmys14dc" } ], "name": "Sales Revenue", "net_cash_flow": 31253.29, "total_net_cash_flow": 31253.29 } ] ] }, "ending_balances": { "items": { "$ref": "#/components/schemas/CashLedgerBalance" }, "type": "array", "title": "Ending Balances", "description": "A list of Cash Balance objects at the end of the period for ledgers reporting cash flow.", "examples": [ [ { "cash_balance": 38743.77, "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "ledger_name": "Pluto Checking 4242", "sort_code": "1400", "total_cash_balance": 38743.77 } ] ] }, "ending_cash_balance": { "type": "number", "title": "Ending Cash Balance", "description": "The total debit balance, in decimal dollar cents, of all cash flow ledgers at the end of the period.", "examples": ["38743.7699999999967985786497592926025390625"] }, "starting_balances": { "items": { "$ref": "#/components/schemas/CashLedgerBalance" }, "type": "array", "title": "Starting Balances", "description": "A list of Cash Balance objects at the beginning of the period for ledgers reporting cash flow.", "examples": [ [ { "cash_balance": 14173.18, "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "ledger_name": "Pluto Checking 4242", "sort_code": "1400", "total_cash_balance": 14173.18 } ] ] }, "starting_cash_balance": { "type": "number", "title": "Starting Cash Balance", "description": "The total debit balance, in decimal dollar cents, of all cash flow ledgers at the beginning of the period.", "examples": ["14173.1800000000002910383045673370361328125"] } }, "type": "object", "required": [ "cash_flow_ledgers", "ending_balances", "ending_cash_balance", "starting_balances", "starting_cash_balance" ], "title": "CashFlowReport" }, "CashFlowReportPeriods": { "properties": { "periods": { "items": { "type": "string" }, "type": "array", "title": "Periods", "description": "A list of periods in the range.", "examples": [["Q1-2020"]] }, "cash_flow_ledgers": { "items": { "$ref": "#/components/schemas/CashFlowLedgerPeriods" }, "type": "array", "title": "Cash Flow Ledgers", "description": "A list of Cash Flow Ledger objects indicating which ledgers were impacted by cash movements in the given period.", "examples": [ [ { "ledger_id": "KhxYFDUi8XZBA94uoHhzs8", "name": "Supplies", "net_cash_flows": [-6682.7], "total_net_cash_flows": [-6682.7] }, { "ledger_id": "WhvrC7XAES1fDrpWWgmPtg", "name": "Sales Revenue", "net_cash_flows": [31253.29], "total_net_cash_flows": [31253.29] } ] ] }, "ending_balances": { "items": { "$ref": "#/components/schemas/CashLedgerBalancePeriods" }, "type": "array", "title": "Ending Balances", "description": "A list of Cash Balance objects at the end of the period for ledgers reporting cash flow.", "examples": [ [ { "cash_balances": [38743.77], "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "ledger_name": "Pluto Checking 4242", "sort_code": "1400", "total_cash_balances": [38743.77] } ] ] }, "ending_cash_balances": { "items": { "type": "number" }, "type": "array", "title": "Ending Cash Balances", "description": "The total debit balance, in decimal dollar cents, of all cash flow ledgers at the end of the period.", "examples": [["38743.7699999999967985786497592926025390625"]] }, "starting_balances": { "items": { "$ref": "#/components/schemas/CashLedgerBalancePeriods" }, "type": "array", "title": "Starting Balances", "description": "A list of Cash Balance objects at the beginning of the period for ledgers reporting cash flow.", "examples": [ [ { "cash_balances": [14173.18], "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "ledger_name": "Pluto Checking 4242", "sort_code": "1400", "total_cash_balances": [14173.18] } ] ] }, "starting_cash_balances": { "items": { "type": "number" }, "type": "array", "title": "Starting Cash Balances", "description": "The total debit balance, in decimal dollar cents, of all cash flow ledgers at the beginning of the period.", "examples": [["14173.1800000000002910383045673370361328125"]] } }, "type": "object", "required": [ "periods", "cash_flow_ledgers", "ending_balances", "ending_cash_balances", "starting_balances", "starting_cash_balances" ], "title": "CashFlowReportPeriods" }, "CashFlowTotalEntry": { "properties": { "balance": { "type": "number", "title": "Balance", "description": "The debit balance, in decimal dollar cents, of all ledgers.", "examples": ["48644.91000000000349245965480804443359375"] }, "name": { "type": "string", "title": "Name", "description": "The month and year of the period in `mm YYYY` format.", "examples": ["Jan 2024"] }, "net_cash_flow": { "type": "number", "title": "Net Cash Flow", "description": "The sum, in decimal dollar cents, of the cash flow of all ledgers.", "examples": ["26469.88000000000101863406598567962646484375"] }, "outflow": { "type": "number", "title": "Outflow", "description": "The sum, in decimal dollar cents, of the cash flow of all ledgers.", "examples": ["26469.88000000000101863406598567962646484375"] }, "inflow": { "type": "number", "title": "Inflow", "description": "The sum, in decimal dollar cents, of the cash flow of all ledgers.", "examples": ["26469.88000000000101863406598567962646484375"] } }, "type": "object", "required": ["balance", "name", "net_cash_flow", "outflow", "inflow"], "title": "CashFlowTotalEntry" }, "CashFlowTotals": { "properties": { "ending_balance": { "type": "number", "title": "Ending Balance", "description": "The total ending balance, in decimal dollar cents, of all cash flow ledgers for the period.", "examples": ["22175.02999999999883584678173065185546875"] }, "entries": { "items": { "$ref": "#/components/schemas/CashFlowTotalEntry" }, "type": "array", "title": "Entries", "description": "A list of report summary totals broken down by period between the start date and end date.", "examples": [ [ { "balance": 48644.91, "inflow": 29980.1, "name": "Jan 2024", "net_cash_flow": 26469.88, "outflow": 3510.22 }, { "balance": 60808.87, "inflow": 18668.31, "name": "Feb 2024", "net_cash_flow": 12163.96, "outflow": 6504.35 }, { "balance": 62972.11, "inflow": 3163.24, "name": "Mar 2024", "net_cash_flow": 2163.24, "outflow": 1000 } ] ] }, "starting_balance": { "type": "number", "title": "Starting Balance", "description": "The total starting balance, in decimal dollar cents, of all cash flow ledgers for the period.", "examples": ["62972.110000000000582076609134674072265625"] } }, "type": "object", "required": ["ending_balance", "entries", "starting_balance"], "title": "CashFlowTotals" }, "CashInOutTimeSeriesEntry": { "properties": { "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The first day of this bucket (inclusive). Bucket dates are authoritative: edge buckets widen to whole calendar periods and may extend beyond the requested range.", "examples": ["2024-02-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The last day of this bucket (inclusive).", "examples": ["2024-02-29"] }, "cash_in": { "type": "number", "title": "Cash In", "description": "Gross cash inflows to cash accounts within the bucket, in decimal dollar cents. Always non-negative.", "examples": ["9708.0699999999997089616954326629638671875"] }, "cash_out": { "type": "number", "title": "Cash Out", "description": "Gross cash outflows from cash accounts within the bucket, in decimal dollar cents. Always non-negative.", "examples": ["5666.7899999999999636202119290828704833984375"] } }, "type": "object", "required": ["start_date", "end_date", "cash_in", "cash_out"], "title": "CashInOutTimeSeriesEntry" }, "CashLedgerBalance": { "properties": { "children": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CashLedgerBalance" }, "type": "array" }, { "type": "null" } ], "title": "Children", "description": "If the Ledger has any children, a list of the Ledger objects.", "examples": [null] }, "cash_balance": { "type": "number", "title": "Cash Balance", "description": "The debit balance, in decimal dollar cents, of all line entries in the ledger.", "examples": ["3822.829999999999927240423858165740966796875"] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the Ledger is a child Ledger, the ID of the parent Ledger.", "examples": [null] }, "sort_code": { "type": "string", "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.", "examples": ["1400"] }, "total_cash_balance": { "type": "number", "title": "Total Cash Balance", "description": "The debit balance, in decimal dollar cents, of all line entries in the ledger and all its child ledgers, if any.", "examples": ["3822.829999999999927240423858165740966796875"] } }, "type": "object", "required": ["cash_balance", "ledger_id", "ledger_name", "sort_code", "total_cash_balance"], "title": "CashLedgerBalance" }, "CashLedgerBalancePeriods": { "properties": { "children": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CashLedgerBalancePeriods" }, "type": "array" }, { "type": "null" } ], "title": "Children", "description": "If the Ledger has any children, a list of the Ledger objects.", "examples": [null] }, "cash_balances": { "items": { "type": "number" }, "type": "array", "title": "Cash Balances", "description": "The debit balance, in decimal dollar cents, of all line entries in the ledger.", "examples": [["3822.829999999999927240423858165740966796875"]] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the Ledger is a child Ledger, the ID of the parent Ledger.", "examples": [null] }, "sort_code": { "type": "string", "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.", "examples": ["1400"] }, "total_cash_balances": { "items": { "type": "number" }, "type": "array", "title": "Total Cash Balances", "description": "The debit balance, in decimal dollar cents, of all line entries in the ledger and all its child ledgers, if any.", "examples": [["3822.829999999999927240423858165740966796875"]] } }, "type": "object", "required": [ "cash_balances", "ledger_id", "ledger_name", "sort_code", "total_cash_balances" ], "title": "CashLedgerBalancePeriods" }, "CashReport": { "properties": { "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The first day of the requested period (inclusive).", "examples": ["2024-02-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The last day of the requested period (inclusive).", "examples": ["2024-02-29"] }, "prior_start_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Prior Start Date", "description": "The first day of the derived comparison period (inclusive). Null when `include_prior` is false.", "examples": ["2024-01-01"] }, "prior_end_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Prior End Date", "description": "The last day of the derived comparison period (inclusive). Null when `include_prior` is false.", "examples": ["2024-01-31"] }, "net_cash_flow_granularity": { "$ref": "#/components/schemas/TrendGranularity", "description": "The bucket size used for `net_cash_flow_time_series`.", "examples": ["weekly"] }, "cash_in_out_granularity": { "$ref": "#/components/schemas/TrendGranularity", "description": "The bucket size used for `cash_in_out_time_series`.", "examples": ["monthly"] }, "net_cash_flow": { "type": "number", "title": "Net Cash Flow", "description": "Net cash flow across cash accounts within the period, in decimal dollar cents. Signed; always equals `cash_in - cash_out`.", "examples": ["4041.26999999999998181010596454143524169921875"] }, "cash_in": { "type": "number", "title": "Cash In", "description": "Gross cash inflows to cash accounts within the period, in decimal dollar cents. Always non-negative. Matched transfers between two cash accounts are excluded when both legs fall inside the period; transfers to or from accounts outside the cash pool (e.g. credit cards) and unmatched transfers are included.", "examples": ["9708.0699999999997089616954326629638671875"] }, "cash_out": { "type": "number", "title": "Cash Out", "description": "Gross cash outflows from cash accounts within the period, in decimal dollar cents. Always non-negative. Matched transfers between two cash accounts are excluded when both legs fall inside the period; transfers to or from accounts outside the cash pool (e.g. credit cards) and unmatched transfers are included.", "examples": ["5666.7899999999999636202119290828704833984375"] }, "prior_net_cash_flow": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Prior Net Cash Flow", "description": "Net cash flow within the comparison period, in decimal dollar cents. Null when `include_prior` is false.", "examples": ["4495.3000000000001818989403545856475830078125"] }, "total_cash_balance": { "type": "number", "title": "Total Cash Balance", "description": "The total balance across all cash ledgers as of the end of `end_date`, in decimal dollar cents. Matches the cash flow report's ending cash balance for the same period.", "examples": ["33739.8199999999997089616954326629638671875"] }, "other_cash_balance": { "type": "number", "title": "Other Cash Balance", "description": "Deprecated. Always zero: unsourced cash now appears in `by_source_account` with a null `source_account_id`. Kept so consumers that add this to the `by_source_account` sum keep a correct total during rollout; removed once they stop reading it.", "deprecated": true, "examples": ["0"] }, "by_source_account": { "items": { "$ref": "#/components/schemas/SourceAccountCashBalance" }, "type": "array", "title": "By Source Account", "description": "Book balance per cash account as of the end of `end_date`, ordered by ledger sort code. Source-account-linked accounts always appear; cash-flow ledgers with no source account (e.g. manual petty cash) appear with a null `source_account_id` when their balance is nonzero. Balances always sum to `total_cash_balance`." }, "burn_build_rate": { "anyOf": [{ "$ref": "#/components/schemas/BurnBuildRate" }, { "type": "null" }], "description": "The trailing burn or build rate and runway. Null when the organization's entries begin after the first day of the measured trailing window (insufficient history)." }, "net_cash_flow_time_series": { "items": { "$ref": "#/components/schemas/NetCashFlowTimeSeriesEntry" }, "type": "array", "title": "Net Cash Flow Time Series", "description": "Net cash flow bucketed by `net_cash_flow_granularity`. Edge buckets widen to whole calendar periods, so the series may span more than the requested range and is not guaranteed to sum to `net_cash_flow`. Empty when there is nothing to chart: no external cash flow in the requested range and no bucket carries gross flow. A bucket whose inflows and outflows offset serializes as net 0.0 but still counts as activity. Matched transfers between cash accounts are excluded from flows only when both legs fall inside the window being measured, so a period whose transfers each settle within one bucket reads as empty; a transfer whose legs land in different buckets contributes flow to each." }, "cash_in_out_time_series": { "items": { "$ref": "#/components/schemas/CashInOutTimeSeriesEntry" }, "type": "array", "title": "Cash In Out Time Series", "description": "Gross cash inflows and outflows bucketed by `cash_in_out_granularity`. Edge buckets widen to whole calendar periods, so the series may span more than the requested range and is not guaranteed to sum to `cash_in` / `cash_out`. Empty when there is nothing to chart: no external cash flow in the requested range and every bucket is zero. Matched transfers between cash accounts are excluded from flows only when both legs fall inside the window being measured, so a period whose transfers each settle within one bucket reads as empty; a transfer whose legs land in different buckets contributes flow to each." } }, "type": "object", "required": [ "start_date", "end_date", "net_cash_flow_granularity", "cash_in_out_granularity", "net_cash_flow", "cash_in", "cash_out", "total_cash_balance", "other_cash_balance", "by_source_account", "net_cash_flow_time_series", "cash_in_out_time_series" ], "title": "CashReport" }, "CategorizationMethodFilter": { "type": "string", "enum": ["ai", "rule", "user", "matched", "uncategorized"], "title": "CategorizationMethodFilter", "description": "The values the journal-entry categorization_method query parameter\naccepts. 'uncategorized' selects entries with a line on an uncategorized\nsystem ledger and 'matched' selects payment-application entries — the\nother values never return those, so the five values partition an\ninstance's journal entries. For the remaining entries the\nvalues mirror the web badge's kinds\n(getCategorizationKind): 'ai' is a live, still-applied autocat result by\nany automatic method except 'rule' (a method added later lands in 'ai'\nautomatically), 'rule' is such a result decided by a rule, and 'user' —\nlike the badge's 'manual' — is the absence of a live result rather than\na recorded value. Expand a value to the concrete methods it stands for\nwith to_autocat_methods; 'user' and 'uncategorized' are structural cases\nthe repo filter implements directly ('user' expands to the\nAutocatMethod.user sentinel meaning \"resolves to no result\",\n'uncategorized' to no methods at all). 'auto' and 'manual' are accepted\nas synonyms for 'ai' and 'user', matching the badge's labels." }, "CategorizationMetrics": { "properties": { "instance": { "$ref": "#/components/schemas/CategorizationStatusMetrics", "description": "Categorization metrics across every journal entry in the instance." }, "ledgers": { "additionalProperties": { "$ref": "#/components/schemas/CategorizationStatusMetrics" }, "type": "object", "title": "Ledgers", "description": "Per-ledger categorization metrics keyed by ledger ID. Populated only for the ledger IDs supplied via the ledger_ids query parameter." } }, "type": "object", "required": ["instance"], "title": "CategorizationMetrics" }, "CategorizationRule": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["N6ntpvTtiA4L31vVyVat5n"] }, "expression": { "type": "string", "title": "Expression", "description": "A pattern matching expression using the\n match(pattern, field) function. Use `t` to access the Transaction\n object. The pattern supports regular expression syntax.\n \n \n Read more: [Categorization guide](https://docs.teal.dev/guides/platform/categorization/rules#expressions)", "examples": ["match(\".*(?i)SHELL GAS\", t.description)"] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the destination ledger.", "examples": ["Fuel Expenses"] }, "name": { "type": "string", "title": "Name", "description": "An arbitrary string to name the rule.", "examples": ["Shell to Fuel Expenses"] }, "priority": { "type": "integer", "title": "Priority", "description": "The priority of the rule.", "examples": ["100"] } }, "type": "object", "required": ["id", "expression", "ledger_name", "name", "priority"], "title": "CategorizationRule" }, "CategorizationRulePage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/CategorizationRule" }, "type": "array", "title": "Records", "description": "The categorization rule objects" } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "CategorizationRulePage" }, "CategorizationRuleSort": { "type": "string", "enum": ["name", "-name", "ledger_name", "-ledger_name"], "title": "CategorizationRuleSort" }, "CategorizationStatusMetrics": { "properties": { "total": { "type": "integer", "title": "Total", "description": "Total journal entries in scope (pending + delayed + completed + not_attempted)." }, "pending": { "type": "integer", "title": "Pending", "description": "Journal entries whose categorization has not started." }, "delayed": { "type": "integer", "title": "Delayed", "description": "Journal entries whose categorization is delayed." }, "completed": { "type": "integer", "title": "Completed", "description": "Journal entries whose categorization has finished." }, "not_attempted": { "type": "integer", "title": "Not Attempted", "description": "Journal entries that were never sent for categorization because the instance's categorization pipeline is disabled." } }, "type": "object", "required": ["total", "pending", "delayed", "completed", "not_attempted"], "title": "CategorizationStatusMetrics" }, "CategorizerType": { "type": "string", "enum": ["ai", "rules", "similarity", "transfer_between_accounts", "uncategorized", "user"], "title": "CategorizerType" }, "CoaTemplate": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["PpvsmFEv14yGDyT6iV6kXw"] }, "name": { "type": "string", "title": "Name", "description": "An arbitrary string on the object, useful for \n identifying the Chart of Accounts template.", "examples": ["Coffee Shop Sole Prop"] }, "accounting_basis": { "$ref": "#/components/schemas/AccountingBasis", "description": "The accounting basis for this Chart of Accounts \n template.", "examples": ["accrual"] }, "status": { "$ref": "#/components/schemas/CoaTemplateStatus", "examples": ["live"] }, "type": { "$ref": "#/components/schemas/CoaTemplateType", "description": "Whether this template belongs to an agent or a platform.", "examples": ["agent"] }, "ledgers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LedgerTemplate" }, "type": "array" }, { "type": "null" } ], "title": "Ledgers", "description": "Expandable. A list of the Ledger \n Templates associated with the Chart of Accounts Template.", "examples": [null] }, "ledger_ids": { "items": { "type": "string" }, "type": "array", "title": "Ledger Ids", "description": "A list of IDs of the Ledger Template \n objects associated with the Chart of Accounts Template", "examples": [["7JRNsKwy2Lw66caxVU7WGC", "HLn8oy2eqMUCwjp1Cwdgco"]] } }, "type": "object", "required": ["id", "name", "accounting_basis", "status", "type", "ledger_ids"], "title": "CoaTemplate" }, "CoaTemplateClone": { "properties": { "name": { "type": "string", "title": "Name", "description": "An arbitrary string on the object, useful for \n identifying the Chart of Accounts template.", "examples": ["Coffee Shop C-Corp"] } }, "type": "object", "required": ["name"], "title": "CoaTemplateClone" }, "CoaTemplateCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "An arbitrary string on the object, useful for \n identifying the Chart of Accounts template.", "examples": ["Coffee Shop Sole Prop"] }, "accounting_basis": { "$ref": "#/components/schemas/AccountingBasis", "description": "The accounting basis for this Chart of Accounts \n template.", "default": "cash", "examples": ["cash"] }, "status": { "$ref": "#/components/schemas/CoaTemplateStatus", "default": "live", "examples": ["live"] } }, "type": "object", "required": ["name"], "title": "CoaTemplateCreate" }, "CoaTemplateExpandPath": { "type": "string", "enum": ["ledgers"], "title": "CoaTemplateExpandPath" }, "CoaTemplatePage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/CoaTemplate" }, "type": "array", "title": "Records", "description": "List of CoA templates" } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "CoaTemplatePage" }, "CoaTemplateStatus": { "type": "string", "enum": ["draft", "live"], "title": "CoaTemplateStatus" }, "CoaTemplateType": { "type": "string", "enum": ["agent", "platform"], "title": "CoaTemplateType" }, "CoaTemplateUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name" }, "status": { "anyOf": [{ "$ref": "#/components/schemas/CoaTemplateStatus" }, { "type": "null" }] } }, "type": "object", "title": "CoaTemplateUpdate" }, "CreateSourceAccountLedger": { "properties": { "financial_account_type": { "$ref": "#/components/schemas/FinancialAccountType", "description": "The financial account type of the ledger." }, "opening_balance": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Opening Balance", "description": "Opening balance of the ledger in dollars." } }, "type": "object", "required": ["financial_account_type"], "title": "CreateSourceAccountLedger" }, "CreateTransaction": { "properties": { "id": { "type": "string", "minLength": 1, "title": "Id", "description": "The unique ID of the object. This is used as an idempotency \n key to prevent duplicates. This is manually set as part of the create \n transactions request. If the transaction is created via a data integration, \n Plaid for example, it will be set to the `transaction_id` to enforce \n idempotency with the data source.", "examples": ["t_9237232"] }, "amount": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Amount", "description": "The value of the transaction in decimal dollar cents.", "examples": [132629.38] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The UTC datetime that the Transaction was created. This\n will never be before an Instance's `entries_start` date. When importing \n transactions, transactions whose datetime is before the Instance’s \n `entries_start` date will be skipped. Other transactions will be processed \n as normal.", "examples": ["2024-03-15T15:28:53Z"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "An arbitrary string on the object, useful for\n displaying information to the user. \n Descriptions over 512 characters will be truncated.", "examples": ["Payroll March 15 2024"] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "Arbitrary structured information about the transaction.\n This could be location of the transaction to display to the user or vendor \n information to use as part of a Platform or Instance categorization rule. \n Teal does not use metadata for any accounting purposes.", "examples": [null] }, "tag_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Tag Ids", "description": "An array of IDs of the Tag objects associated with \n the Transaction.\n\nTags are transitive — the tags on a Transaction are \n applied to its corresponding Line Entry or Line Entries.", "examples": [null] }, "opposing_ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Opposing Ledger Id", "description": "The ledger id of the opposing ledger.", "examples": [null] }, "lines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TransactionLine" }, "type": "array" }, { "type": "null" } ], "title": "Lines", "description": "Optional list of transaction lines to split the transaction across multiple ledgers.", "examples": [null] } }, "type": "object", "required": ["id", "amount", "datetime", "description"], "title": "CreateTransaction" }, "DebitCredit": { "type": "string", "enum": ["debit", "credit"], "title": "DebitCredit" }, "DetailedInstance": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["RKtPbubK5NcbBsUmU1ktSP"] }, "entries_start": { "type": "string", "format": "date-time", "title": "Entries Start", "description": "The datetime in UTC time from which the API will \n sync an Instance's accounting data. Transactions or journal entries cannot \n be entered before this date. The time component is ignored — the value \n is always stored as start-of-day UTC (00:00:00Z).", "examples": ["2024-01-01T00:00:00Z"] }, "name": { "type": "string", "title": "Name", "description": "The name of the business.", "examples": ["ACME Goods Inc"] }, "subscription": { "$ref": "#/components/schemas/SubscriptionLevel", "description": "The Instance's subscription tier.", "examples": ["tier3"] }, "accounting_basis": { "$ref": "#/components/schemas/AccountingBasis", "description": "The accounting method used: cash basis or accrual basis.", "examples": ["accrual"] }, "coa_template_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Coa Template Id", "description": "The ID of the Chart of Accounts Template used \n to pre-populate the Instance's ledgers.", "examples": ["CNmWM3X6AcvRdEwZKxq4bL"] }, "earliest_journal_entry_datetime": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Earliest Journal Entry Datetime", "description": "The datetime of the earliest journal entry if one exists, otherwise null", "examples": ["2024-01-01T00:00:00Z"] }, "latest_journal_entry_datetime": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Latest Journal Entry Datetime", "description": "The datetime of the latest journal entry if one exists, otherwise null", "examples": ["2024-10-01T00:00:00Z"] }, "latest_close_datetime": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Latest Close Datetime", "description": "The datetime when the books for the instance were last closed by a bookkeeper", "examples": ["2025-10-01T00:00:00Z"] } }, "type": "object", "required": [ "id", "entries_start", "name", "subscription", "accounting_basis", "coa_template_id", "earliest_journal_entry_datetime", "latest_journal_entry_datetime", "latest_close_datetime" ], "title": "DetailedInstance" }, "DetailedLineEntry": { "properties": { "amount": { "type": "number", "title": "Amount", "description": "The value of the line entry in decimal dollar cents.", "examples": ["31282.27999999999883584678173065185546875"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the amount is a credit or debit.", "examples": ["credit"] }, "description": { "anyOf": [{ "type": "string", "maxLength": 4000 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for displaying to the user or for categorization.", "examples": ["Payroll#230215"] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Line Entry's Ledger.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "related_line_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Related Line Entry Id", "description": "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](https://docs.teal.dev/guides/platform/categorization/pipeline#transfers-between-accounts)" }, "transaction_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Transaction Id", "description": "The ID of the associated Transaction, if one exists." }, "sort_order": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Sort Order", "description": "The position of the Line Entry within its Journal Entry, used to determine display order.", "examples": [1] }, "id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Id", "description": "The unique ID of the object.", "examples": ["XMDsKVuW4Wmi3LTW31Qw6E"] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The datetime the Line Entry was created in UTC time.", "examples": ["2023-02-15T06:42:18Z"] }, "editable": { "type": "boolean", "title": "Editable", "description": "Indicates if the Line Entry can be manually added or removed from a Ledger, as dictated by the `editable` property on the Ledger.", "examples": [true] }, "journal_entry": { "type": "null", "title": "Journal Entry", "description": "Expandable. The associated Journal Entry object.", "examples": [null] }, "journal_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Journal Entry Id", "description": "The ID of the associated Journal Entry.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "journal_entry_description": { "type": "string", "maxLength": 512, "title": "Journal Entry Description", "description": "An arbitrary string on the object, useful for displaying to users.", "examples": ["Payroll#230215"] }, "categorization_status": { "$ref": "#/components/schemas/JournalEntryCategorizationStatus", "description": "Whether the associated Journal Entry is still awaiting an auto-categorization result: 'pending' (awaiting), 'delayed' (timed out, a late result may still resolve it), or 'completed' (resolved, or not auto-categorized). Both Line Entries of a Journal Entry share this value.", "examples": ["completed"] }, "ledger": { "type": "null", "title": "Ledger", "description": "Expandable. The associated Ledger object.", "examples": [null] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the Line Entry's Ledger.", "examples": ["Payroll Expense"] }, "opposing_ledger_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Opposing Ledger Ids", "description": "Expandable. IDs of the ledgers on the other side(s) of the line entry with opposite debit/credit." }, "tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "A list of all the Tags associated with the Line Entry, if any." }, "transaction": { "type": "null", "title": "Transaction", "description": "Expandable. The associated Transaction object, if one exists.", "examples": [null] }, "payment_applications": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LineEntryPaymentApplication" }, "type": "array" }, { "type": "null" } ], "title": "Payment Applications" }, "line_payment_applications": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LineEntryLinePaymentApplication" }, "type": "array" }, { "type": "null" } ], "title": "Line Payment Applications" }, "accrual_source": { "anyOf": [{ "$ref": "#/components/schemas/AccrualSource" }, { "type": "null" }] } }, "type": "object", "required": [ "amount", "debit_credit", "ledger_id", "id", "datetime", "editable", "journal_entry_id", "journal_entry_description", "categorization_status", "ledger_name" ], "title": "DetailedLineEntry" }, "DetailedLinePage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" }, "type": "array", "title": "Records" } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "DetailedLinePage" }, "EnhancedTag": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["UjL3BQnEaJtecuC7CUeDk"] }, "name": { "type": "string", "title": "Name", "description": "An arbitrary string, useful for identifying the tag to the user.", "examples": ["Sprinter - 1ab-c23"] }, "tag_group_id": { "type": "string", "title": "Tag Group Id", "description": "The ID of the tag group.", "examples": ["NCB2xo5S1yQbNgyWskXpwG"] }, "tag_group_name": { "type": "string", "title": "Tag Group Name", "description": "An arbitrary string, useful for identifying the tag group to the user.", "examples": ["Delivery vehicles"] }, "enabled": { "type": "boolean", "title": "Enabled", "description": "Whether the tag is able to be assigned to objects.", "examples": [true] } }, "type": "object", "required": ["id", "name", "tag_group_id", "tag_group_name", "enabled"], "title": "EnhancedTag" }, "EnhancedTagPage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/EnhancedTag" }, "type": "array", "title": "Records", "description": "A list of tags.", "examples": [ [ { "enabled": true, "id": "UjL3BQnEaJtecuC7CUeDk", "name": "Sprinter - 1ab-c23", "tag_group_id": "NCB2xo5S1yQbNgyWskXpwG", "tag_group_name": "Delivery vehicles" } ] ] } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "EnhancedTagPage" }, "ExpandableDetailedLineEntry": { "properties": { "amount": { "type": "number", "title": "Amount", "description": "The value of the line entry in decimal dollar cents.", "examples": ["31282.27999999999883584678173065185546875"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the amount is a credit or debit.", "examples": ["credit"] }, "description": { "anyOf": [{ "type": "string", "maxLength": 4000 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for displaying to the user or for categorization.", "examples": ["Payroll#230215"] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Line Entry's Ledger.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "related_line_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Related Line Entry Id", "description": "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](https://docs.teal.dev/guides/platform/categorization/pipeline#transfers-between-accounts)" }, "transaction_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Transaction Id", "description": "The ID of the associated Transaction, if one exists." }, "sort_order": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Sort Order", "description": "The position of the Line Entry within its Journal Entry, used to determine display order.", "examples": [1] }, "id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Id", "description": "The unique ID of the object.", "examples": ["XMDsKVuW4Wmi3LTW31Qw6E"] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The datetime the Line Entry was created in UTC time.", "examples": ["2023-02-15T06:42:18Z"] }, "editable": { "type": "boolean", "title": "Editable", "description": "Indicates if the Line Entry can be manually added or removed from a Ledger, as dictated by the `editable` property on the Ledger.", "examples": [true] }, "journal_entry": { "anyOf": [{ "$ref": "#/components/schemas/JournalEntry" }, { "type": "null" }], "description": "Expandable. The associated Journal Entry object.", "examples": [ { "categorization_status": "completed", "creation_date": "2023-02-15T06:42:18Z", "creation_source": "manual", "datetime": "2023-02-15T06:42:18Z", "description": "Payroll#230215", "id": "C4ocnUQze8kDwQ3EczkZXn", "is_opening_balance": false, "line_entry_ids": ["XMDsKVuW4Wmi3LTW31Qw6E", "NULcvXTkLczde32qs1rqgB"], "review_status": "unreviewed" } ] }, "journal_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Journal Entry Id", "description": "The ID of the associated Journal Entry.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "journal_entry_description": { "type": "string", "maxLength": 512, "title": "Journal Entry Description", "description": "An arbitrary string on the object, useful for displaying to users.", "examples": ["Payroll#230215"] }, "categorization_status": { "$ref": "#/components/schemas/JournalEntryCategorizationStatus", "description": "Whether the associated Journal Entry is still awaiting an auto-categorization result: 'pending' (awaiting), 'delayed' (timed out, a late result may still resolve it), or 'completed' (resolved, or not auto-categorized). Both Line Entries of a Journal Entry share this value.", "examples": ["completed"] }, "ledger": { "anyOf": [{ "$ref": "#/components/schemas/Ledger" }, { "type": "null" }], "description": "Expandable. The associated Ledger object.", "examples": [ { "created_at": "2024-01-01T00:00:00", "debit_credit": "debit", "editable": false, "financial_account_type": "bank_account", "id": "7JRNsKwy2Lw66caxVU7WGC", "is_autocat_category": false, "is_required": false, "name": "Pluto Checking 4242", "report_cash_flow": true, "sort_code": "2240", "sub_type": "current_assets", "type": "asset" } ] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the Line Entry's Ledger.", "examples": ["Payroll Expense"] }, "opposing_ledger_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Opposing Ledger Ids", "description": "Expandable. IDs of the ledgers on the other side(s) of the line entry with opposite debit/credit." }, "tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "A list of all the Tags associated with the Line Entry, if any." }, "transaction": { "anyOf": [{ "$ref": "#/components/schemas/Transaction" }, { "type": "null" }], "description": "Expandable. The associated Transaction object, if one exists.", "examples": [ { "amount": 31282.28, "datetime": "2023-02-15T06:42:18Z", "description": "Payroll#230215", "id": "txn_UjL3BQnEaJtecuC7CUeDk", "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E", "personal": false, "posted_status": "posted", "review_status": "reviewed", "source_account_id": "L7RR1Yz85FJoASPvPLs441" } ] }, "payment_applications": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LineEntryPaymentApplication" }, "type": "array" }, { "type": "null" } ], "title": "Payment Applications", "description": "Payments applied to an accrual source (bill/invoice) using the Line Entry." }, "line_payment_applications": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LineEntryLinePaymentApplication" }, "type": "array" }, { "type": "null" } ], "title": "Line Payment Applications", "description": "Payments applied to specific payroll lines of an accrual source using the Line Entry." }, "accrual_source": { "anyOf": [{ "$ref": "#/components/schemas/AccrualSource" }, { "type": "null" }], "description": "The accrual source linked to a line entry, if one exists." } }, "type": "object", "required": [ "amount", "debit_credit", "ledger_id", "id", "datetime", "editable", "journal_entry_id", "journal_entry_description", "categorization_status", "ledger_name" ], "title": "ExpandableDetailedLineEntry" }, "ExpandableJournalEntry": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "An arbitrary string on the object, useful for \n displaying to the user.", "examples": ["Payroll#230215"] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The datetime the Journal Entry was created in UTC \n time.", "examples": ["2023-02-15T06:42:18Z"] }, "creation_date": { "type": "string", "format": "date-time", "title": "Creation Date", "description": "The timestamp when this journal entry record was created in the database.", "examples": ["2023-02-15T06:42:18Z"] }, "is_opening_balance": { "type": "boolean", "title": "Is Opening Balance", "description": "Whether the Journal Entry represents an\n opening balance.", "examples": [false] }, "line_entry_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Line Entry Ids", "description": "The ids of the Line Entries detailing the Journal\n Entry's movement of value.", "examples": [["XMDsKVuW4Wmi3LTW31Qw6E", "NULcvXTkLczde32qs1rqgB"]] }, "linked_entity": { "type": "null", "title": "Linked Entity", "description": "Deprecated - always null" }, "creation_source": { "$ref": "#/components/schemas/JournalEntryCreationSource", "description": "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." }, "categorization_status": { "$ref": "#/components/schemas/JournalEntryCategorizationStatus", "description": "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)." }, "review_status": { "$ref": "#/components/schemas/JournalEntryReviewStatus", "description": "Whether the user has reviewed the Journal Entry. New Journal Entries default to 'unreviewed'." }, "review_status_set_at": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Review Status Set At", "description": "When the review status was last set. Null if the Journal Entry has never been reviewed.", "examples": ["2023-02-15T06:42:18Z"] }, "line_entries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" }, "type": "array" }, { "type": "null" } ], "title": "Line Entries", "description": "List of Line Entries. Included in expanded responses.", "examples": [ [ { "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": { "anyOf": [{ "$ref": "#/components/schemas/AccrualSourceDetails" }, { "type": "null" }], "description": "The accrual source associated with this journal entry, if any. Included in expanded responses." }, "transfer": { "anyOf": [{ "$ref": "#/components/schemas/Transfer" }, { "type": "null" }], "description": "The transfer linking this journal entry to the journal entry on the other side of the transfer, if any. Included in expanded responses." }, "autocat_result": { "anyOf": [{ "$ref": "#/components/schemas/AutocatResult" }, { "type": "null" }], "description": "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." } }, "type": "object", "required": [ "id", "description", "datetime", "creation_date", "is_opening_balance", "creation_source", "categorization_status", "review_status" ], "title": "ExpandableJournalEntry" }, "ExpandableTransaction": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object. This is used as an idempotency \n key to prevent duplicates. This is manually set as part of the create \n transactions request. If the transaction is created via a data integration, \n Plaid for example, it will be set to the `transaction_id` to enforce \n idempotency with the data source.", "examples": ["t_9237232"] }, "amount": { "type": "number", "title": "Amount", "description": "The value of the transaction in decimal dollar cents.", "examples": [132629.38] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The UTC datetime that the Transaction was created. This\n will never be before an Instance's `entries_start` date. When importing \n transactions, transactions whose datetime is before the Instance’s \n `entries_start` date will be skipped. Other transactions will be processed \n as normal.", "examples": ["2024-03-15T15:28:53Z"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "An arbitrary string on the object, useful for\n displaying information to the user. \n Descriptions over 512 characters will be truncated.", "examples": ["Payroll March 15 2024"] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "Arbitrary structured information about the transaction.\n This could be location of the transaction to display to the user or vendor \n information to use as part of a Platform or Instance categorization rule. \n Teal does not use metadata for any accounting purposes.", "examples": [null] }, "categorization_method": { "anyOf": [{ "$ref": "#/components/schemas/CategorizerType" }, { "type": "null" }], "description": "How the Transaction was assigned its \n category.\n\nSee the [categorization guide](https://docs.teal.dev/guides/platform/categorization/pipeline) \n for more details.", "examples": ["similarity"] }, "posted_status": { "$ref": "#/components/schemas/PostedStatus", "description": "Indicates if the corresponding journal entry and \n line entries for the transaction have been have been created. `deleted` \n indicates that the transaction is `posted` but the corresponding journal entry\n and line entries have been deleted.", "examples": ["posted"] }, "review_status": { "$ref": "#/components/schemas/ReviewStatus", "description": "Indicates if the transaction has been reviewed. \n See the [reviewing transactions](https://docs.teal.dev/guides/transactions/reviewing_transactions) \n for steps on how to use this.", "examples": ["reviewed"] }, "journal_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Journal Entry Id", "description": "The ID of the Journal Entry that the \n Transaction's Line Entry is associated with.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "journal_entry": { "anyOf": [{ "$ref": "#/components/schemas/JournalEntry" }, { "type": "null" }], "description": "The transaction's Journal Entry. Included in expanded responses.", "examples": [ { "categorization_status": "completed", "creation_date": "2023-02-15T06:42:18Z", "creation_source": "transaction", "datetime": "2023-02-15T06:42:18Z", "description": "Payroll#230215", "id": "C4ocnUQze8kDwQ3EczkZXn", "is_opening_balance": false, "line_entry_ids": ["XMDsKVuW4Wmi3LTW31Qw6E", "NULcvXTkLczde32qs1rqgB"], "review_status": "unreviewed" } ] }, "source_account_id": { "type": "string", "title": "Source Account Id", "description": "The ID of the transaction source account\n where the transaction is stored." }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ID of the financial account ledger associated \n with the Transaction.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "ledger": { "anyOf": [{ "$ref": "#/components/schemas/Ledger" }, { "type": "null" }], "description": "The transaction's ledger. Included in expanded responses.", "examples": [ { "created_at": "2024-01-01T00:00:00", "debit_credit": "debit", "editable": false, "financial_account_type": "bank_account", "id": "7JRNsKwy2Lw66caxVU7WGC", "is_autocat_category": false, "is_required": false, "name": "Pluto Checking 4242", "report_cash_flow": true, "sort_code": "1140", "sub_type": "current_assets", "type": "asset" } ] }, "line_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Line Entry Id", "description": "The ID of the financial account ledger associated \n with the Transaction.", "examples": ["XMDsKVuW4Wmi3LTW31Qw6E"] }, "line_entry": { "anyOf": [{ "$ref": "#/components/schemas/DetailedLineEntry" }, { "type": "null" }], "description": "The transaction's Line Entry. Included in expanded responses.", "examples": [ { "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, "transaction_id": "t_9237232" } ] }, "opposing_line_entry_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Opposing Line Entry Ids", "description": "A list of IDs of all the Line Entries \n objects in the journal entry with the opposite `debit_credit` status. For\n example if the Transaction's line entry is a debit this opposing line entries\n will be credit line entries.", "examples": [["NULcvXTkLczde32qs1rqgB"]] }, "opposing_line_entries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" }, "type": "array" }, { "type": "null" } ], "title": "Opposing Line Entries", "description": "The transaction's opposing Line Entry. Included in expanded responses.", "examples": [ [ { "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, "transaction_id": "t_9237232" } ] ] }, "tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "A list of all the Tags associated with the Transaction, \n if any. Tags are transitive — the tags on a Transaction are applied to \n its corresponding Line Entry or Line Entries.", "examples": [null] }, "personal": { "type": "boolean", "title": "Personal", "description": "Deprecated. Always false.", "default": false, "deprecated": true, "examples": [false] }, "autocat_result": { "anyOf": [{ "$ref": "#/components/schemas/AutocatResult" }, { "type": "null" }], "description": "How this transaction's category ledger was assigned by the autocat pipeline (method, confidence, and rule). Null when the transaction was not categorized by autocat or has since been manually recategorized (a manual categorization overrides the autocat result). Included in expanded responses." } }, "type": "object", "required": [ "id", "amount", "datetime", "description", "posted_status", "review_status", "source_account_id" ], "title": "ExpandableTransaction" }, "ExpensesLedgerEntry": { "properties": { "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the ledger.", "examples": ["Rent"] }, "amount": { "type": "number", "title": "Amount", "description": "The expenses attributed to this ledger within the period, in decimal dollar cents. Positive amounts are spend; negative when refunds or reversals exceed spend. May be zero for ledgers whose activity nets out within the period.", "examples": ["20527.79999999999927240423858165740966796875"] } }, "type": "object", "required": ["ledger_id", "ledger_name", "amount"], "title": "ExpensesLedgerEntry" }, "ExpensesReport": { "properties": { "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The first day of the requested period (inclusive).", "examples": ["2024-02-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The last day of the requested period (inclusive).", "examples": ["2024-02-29"] }, "prior_start_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Prior Start Date", "description": "The first day of the derived comparison period (inclusive). Null when `include_prior` is false.", "examples": ["2024-01-01"] }, "prior_end_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Prior End Date", "description": "The last day of the derived comparison period (inclusive). Null when `include_prior` is false.", "examples": ["2024-01-31"] }, "total": { "type": "number", "title": "Total", "description": "The total expenses within the period, in decimal dollar cents.", "examples": ["24216.8499999999985448084771633148193359375"] }, "prior_total": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Prior Total", "description": "The total expenses within the comparison period, in decimal dollar cents. Null when `include_prior` is false.", "examples": ["21876.29999999999927240423858165740966796875"] }, "by_ledger": { "items": { "$ref": "#/components/schemas/ExpensesLedgerEntry" }, "type": "array", "title": "By Ledger", "description": "Expenses within the period split by ledger, ordered by amount descending (ties broken by ledger name). Only ledgers with at least one line entry in the period are included; a ledger whose entries net to zero returns a zero amount, sorting after positive-amount ledgers (contra/negative rows follow).", "examples": [ [ { "amount": 20527.8, "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "ledger_name": "Rent" }, { "amount": 3689.05, "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco", "ledger_name": "Advertising" } ] ] } }, "type": "object", "required": ["start_date", "end_date", "total", "by_ledger"], "title": "ExpensesReport" }, "FinancialAccountType": { "type": "string", "enum": [ "bank_account", "credit_card", "payments", "payroll", "loan", "prepaid_card", "accounts_receivable", "accounts_payable", "treasury", "investment" ], "title": "FinancialAccountType" }, "FinancialSummary": { "properties": { "summary": { "$ref": "#/components/schemas/FinancialSummaryTotalRecord", "description": "The financial summary for the period." }, "entries": { "items": { "$ref": "#/components/schemas/FinancialSummaryPeriodRecord" }, "type": "array", "title": "Entries", "description": "A list of report summary totals broken down by period between the start date and end date." } }, "type": "object", "required": ["summary", "entries"], "title": "FinancialSummary" }, "FinancialSummaryPeriodRecord": { "properties": { "period": { "type": "string", "title": "Period", "description": "The month and year of the period in `mm YYYY` format.", "examples": ["Jan 2024"] }, "totals": { "$ref": "#/components/schemas/FinancialSummaryTotalRecord", "description": "The financial summary for the period." } }, "type": "object", "required": ["period", "totals"], "title": "FinancialSummaryPeriodRecord" }, "FinancialSummaryTotalRecord": { "properties": { "revenue": { "type": "number", "title": "Revenue", "description": "The sum, in decimal dollar cents, of all `revenue` type ledgers during the period.", "examples": ["239544.1799999999930150806903839111328125"] }, "expense": { "type": "number", "title": "Expense", "description": "The sum, in decimal dollar cents, of all `expense` type ledgers during the period.", "examples": ["200203.619999999995343387126922607421875"] }, "operating_revenue": { "type": "number", "title": "Operating Revenue", "description": "The sum, in decimal dollar cents, of debit and credit entries of all `operating_revenue` subtype ledgers.", "examples": ["239544.1799999999930150806903839111328125"] }, "cost_of_goods_sold": { "type": "number", "title": "Cost Of Goods Sold", "description": "The sum, in decimal dollar cents, of all `cost_of_goods_sold` subtype ledgers.", "examples": ["122039.360000000000582076609134674072265625"] }, "gross_profit": { "type": "number", "title": "Gross Profit", "description": "The total of `operating_revenue` subtype ledgers minus `cost_of_goods_sold` subtype ledgers in decimal dollar cents.", "examples": ["117504.8200000000069849193096160888671875"] }, "percent_gross_margin": { "type": "number", "title": "Percent Gross Margin", "description": "Gross profit as a percentage of total operating revenue.", "examples": ["49.0499999999999971578290569595992565155029296875"] }, "net_profit": { "type": "number", "title": "Net Profit", "description": "The sum, in decimal dollar cents, of all `revenue` type ledgers minus the sum of all `expense` type ledgers.", "examples": ["39340.5599999999976716935634613037109375"] }, "percent_profit_margin": { "type": "number", "title": "Percent Profit Margin", "description": "Net profit as a percentage of total revenue.", "examples": ["16.4200000000000017053025658242404460906982421875"] } }, "type": "object", "required": [ "revenue", "expense", "operating_revenue", "cost_of_goods_sold", "gross_profit", "percent_gross_margin", "net_profit", "percent_profit_margin" ], "title": "FinancialSummaryTotalRecord" }, "GeneralError": { "properties": { "error_type": { "type": "string", "title": "Error Type", "description": "The error type.", "examples": ["API_ERROR"] }, "error_message": { "type": "string", "title": "Error Message", "description": "The error message.", "examples": ["An unexpected error occurred."] } }, "type": "object", "required": ["error_type", "error_message"], "title": "GeneralError" }, "GeneralLedgerReport": { "properties": { "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The start date of the report (inclusive). Must be in YYYY-MM-DD format.", "examples": ["2024-01-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The end date of the report (inclusive). Must be in YYYY-MM-DD format.", "examples": ["2024-03-31"] }, "records": { "items": { "$ref": "#/components/schemas/NestedLedgerStatement" }, "type": "array", "title": "Records", "description": "A list of all Ledger Statement objects.", "examples": [ [ { "amount": 17080.11, "children": [], "closing_balance": 31253.29, "debit_credit": "debit", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "lines": [ { "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, "transaction_id": "txn_MtcXSgvy" } ], "name": "Pluto Checking 4242", "opening_balance": 14173.18, "sub_type": "current_assets", "total_amount": 17080.11, "type": "asset" } ] ] } }, "type": "object", "required": ["start_date", "end_date", "records"], "title": "GeneralLedgerReport" }, "GrossProfit": { "properties": { "entries": { "items": { "$ref": "#/components/schemas/GrossProfitRecord" }, "type": "array", "title": "Entries", "description": "A list of report summary totals broken down by period between the start date and end date.", "examples": [ [ { "period": "Jan 2024", "totals": { "cost_of_goods_sold": 148934.41, "gross_profit": 26469.88, "operating_revenue": 175404.29 } }, { "period": "Feb 2024", "totals": { "cost_of_goods_sold": 172624.45, "gross_profit": 12163.96, "operating_revenue": 184788.41 } }, { "period": "Mar 2024", "totals": { "cost_of_goods_sold": 291035.17, "gross_profit": 32163.24, "operating_revenue": 323198.41 } } ] ] } }, "type": "object", "required": ["entries"], "title": "GrossProfit" }, "GrossProfitRecord": { "properties": { "period": { "type": "string", "title": "Period", "description": "The month and year of the period in `mm YYYY` format.", "examples": ["Jan 2024"] }, "totals": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Totals", "description": "The financial summary for the period.", "examples": [ { "cost_of_goods_sold": "300", "gross_profit": "700", "operating_revenue": "1000" } ] } }, "type": "object", "required": ["period", "totals"], "title": "GrossProfitRecord" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "IncomeStatement": { "properties": { "records": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ReportRecord" }, "type": "array" }, { "type": "null" } ], "title": "Records", "description": "A list of Records that represents either a ledger, a groups of ledgers, or a profit metric.\n\nRecords that are groups of ledgers are grouped by income statement `sub_type`: `operating_revenues`, `cost_of_goods_sold`, `operating_expenses`, `other_expenses` and `other_income`. Records that are profit metrics calculate total net sales, gross profit, total operating profit, and net profit.\n\nThe list of Records will always be returned in the following order:\n- Operating revenue ledgers (group)\n- Total net sales (calculation)\n- Cost of goods sold (group)\n- Gross profit (calculation)\n- Operating expenses (group)\n- Total operating profit (calculation)\n- Other expenses (group)\n- Other income (group)\n- Net profit (calculation)\n\nWithin each `sub_type` group, Ledger objects are ordered by `sort_code`.", "examples": [ [ { "amount": 0, "children": [ { "amount": 262469.88, "debit_credit": "credit", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "name": "Sales Revenue", "sort_code": "4100", "sub_type": "operating_revenues", "total_amount": 262469.88, "type": "revenue" } ], "debit_credit": "credit", "name": "Operating Revenues", "total_amount": 262469.88, "type": "revenue" }, { "amount": 262469.88, "debit_credit": "credit", "name": "Total Net Sales", "total_amount": 262469.88 }, { "amount": 0, "children": [ { "amount": 134929.69, "debit_credit": "debit", "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco", "name": "Cost Of Goods Sold", "sort_code": "5100", "sub_type": "cost_of_goods_sold", "total_amount": 134929.69, "type": "expense" } ], "debit_credit": "debit", "name": "Cost Of Goods Sold", "total_amount": 134929.69, "type": "expense" }, { "amount": 127540.19, "debit_credit": "credit", "name": "Gross Profit", "total_amount": 127540.19 }, { "amount": 0, "children": [ { "amount": 86276.92, "debit_credit": "debit", "ledger_id": "WhvrC7XAES1fDrpWWgmPtg", "name": "Salaries And Wages Expense", "sort_code": "5300", "sub_type": "operating_expenses", "total_amount": 86276.92, "type": "expense" } ], "debit_credit": "debit", "name": "Operating Expenses", "total_amount": 86276.92, "type": "expense" }, { "amount": 41263.27, "debit_credit": "credit", "name": "Total Operating Profit", "total_amount": 41263.27 }, { "amount": 0, "debit_credit": "debit", "name": "Other Expenses", "total_amount": 0, "type": "expense" }, { "amount": 0, "debit_credit": "credit", "name": "Other Income", "total_amount": 0, "type": "revenue" }, { "amount": 41263.27, "debit_credit": "credit", "name": "Net Profit", "total_amount": 41263.27 } ] ] } }, "type": "object", "title": "IncomeStatement" }, "IncomeStatementPeriods": { "properties": { "periods": { "items": { "type": "string" }, "type": "array", "title": "Periods", "description": "A list of periods in the range.", "examples": [["Q1-2020", "Q2-2020"]] }, "records": { "items": { "$ref": "#/components/schemas/ReportPeriodsRecord" }, "type": "array", "title": "Records", "description": "A list of Records that represents either a ledger, a groups of ledgers, or a profit metric.\n\nRecords that are groups of ledgers are grouped by income statement `sub_type`: `operating_revenues`, `cost_of_goods_sold`, `operating_expenses`, `other_expenses` and `other_income`. Records that are profit metrics calculate total net sales, gross profit, total operating profit, and net profit.\n\nThe list of Records will always be returned in the following order:\n- Operating revenue ledgers (group)\n- Total net sales (calculation)\n- Cost of goods sold (group)\n- Gross profit (calculation)\n- Operating expenses (group)\n- Total operating profit (calculation)\n- Other expenses (group)\n- Other income (group)\n- Net profit (calculation)\n\nWithin each `sub_type` group, Ledger objects are ordered by `sort_code`.", "examples": [ [ { "amounts": [0, 0], "children": [ { "amounts": [262469.88, 272321.32], "debit_credit": "credit", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "name": "Sales Revenue", "sort_code": "4100", "sub_type": "operating_revenues", "total_amounts": [262469.88, 272321.32], "type": "revenue" } ], "debit_credit": "credit", "name": "Operating Revenues", "total_amounts": [262469.88, 272321.32], "type": "revenue" }, { "amounts": [262469.88, 272321.32], "debit_credit": "credit", "name": "Total Net Sales", "total_amounts": [262469.88, 272321.32] }, { "amounts": [0, 0], "children": [ { "amounts": [134929.69, 144421.61], "debit_credit": "debit", "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco", "name": "Cost Of Goods Sold", "sort_code": "5100", "sub_type": "cost_of_goods_sold", "total_amounts": [134929.69, 144421.61], "type": "expense" } ], "debit_credit": "debit", "name": "Cost Of Goods Sold", "total_amounts": [134929.69, 144421.61], "type": "expense" }, { "amounts": [127540.19, 127899.71], "debit_credit": "credit", "name": "Gross Profit", "total_amounts": [127540.19, 127899.71] }, { "amounts": [0, 0], "children": [ { "amounts": [86276.92, 87271.31], "debit_credit": "debit", "ledger_id": "WhvrC7XAES1fDrpWWgmPtg", "name": "Salaries And Wages Expense", "sort_code": "5300", "sub_type": "operating_expenses", "total_amounts": [86276.92, 87271.31], "type": "expense" } ], "debit_credit": "debit", "name": "Operating Expenses", "total_amounts": [86276.92, 87271.31], "type": "expense" }, { "amounts": [41263.27, 40628.4], "debit_credit": "credit", "name": "Total Operating Profit", "total_amounts": [41263.27, 40628.4] }, { "amounts": [0, 0], "debit_credit": "debit", "name": "Other Expenses", "total_amounts": [0, 0], "type": "expense" }, { "amounts": [0, 0], "debit_credit": "credit", "name": "Other Income", "total_amounts": [0, 0], "type": "revenue" }, { "amounts": [41263.27, 40628.4], "debit_credit": "credit", "name": "Net Profit", "total_amounts": [41263.27, 40628.4] } ] ] } }, "type": "object", "required": ["periods", "records"], "title": "IncomeStatementPeriods" }, "Instance": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["RKtPbubK5NcbBsUmU1ktSP"] }, "entries_start": { "type": "string", "format": "date-time", "title": "Entries Start", "description": "The datetime in UTC time from which the API will \n sync an Instance's accounting data. Transactions or journal entries cannot \n be entered before this date. The time component is ignored — the value \n is always stored as start-of-day UTC (00:00:00Z).", "examples": ["2024-01-01T00:00:00Z"] }, "name": { "type": "string", "title": "Name", "description": "The name of the business.", "examples": ["ACME Goods Inc"] }, "subscription": { "$ref": "#/components/schemas/SubscriptionLevel", "description": "The Instance's subscription tier.", "examples": ["tier3"] }, "accounting_basis": { "$ref": "#/components/schemas/AccountingBasis", "description": "The accounting method used: cash basis or accrual basis.", "examples": ["accrual"] }, "coa_template_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Coa Template Id", "description": "The ID of the Chart of Accounts Template used \n to pre-populate the Instance's ledgers.", "examples": ["CNmWM3X6AcvRdEwZKxq4bL"] } }, "type": "object", "required": [ "id", "entries_start", "name", "subscription", "accounting_basis", "coa_template_id" ], "title": "Instance" }, "InstanceCreate": { "properties": { "coa_template_id": { "type": "string", "title": "Coa Template Id", "description": "The ID of the Chart of Accounts Template used \n to pre-populate the Instance's ledgers.", "examples": ["CNmWM3X6AcvRdEwZKxq4bL"] }, "entries_start": { "type": "string", "format": "date-time", "title": "Entries Start", "description": "The datetime in UTC time from which the API will \n sync an Instance's accounting data. Transactions or journal entries cannot \n be entered before this date. The time component is ignored — the value \n is always stored as start-of-day UTC (00:00:00Z).", "examples": ["2024-01-01T00:00:00Z"] }, "name": { "type": "string", "title": "Name", "description": "The name of the business.", "examples": ["ACME Goods Inc"] }, "subscription": { "$ref": "#/components/schemas/SubscriptionLevel", "description": "The Instance's subscription tier.", "default": "tier0", "examples": ["tier3"] }, "accounting_basis": { "$ref": "#/components/schemas/AccountingBasis", "description": "The accounting method used: cash basis or accrual basis.", "default": "cash", "examples": ["accrual"] } }, "type": "object", "required": ["coa_template_id", "entries_start", "name"], "title": "InstanceCreate" }, "InstancePage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/Instance" }, "type": "array", "title": "Records", "description": "List of instances" } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "InstancePage" }, "InstanceSort": { "type": "string", "enum": ["name", "-name"], "title": "InstanceSort" }, "InstanceSubscriptionUpdate": { "properties": { "subscription": { "$ref": "#/components/schemas/SubscriptionLevel", "description": "The Instance's subscription tier.", "examples": ["tier3"] } }, "type": "object", "required": ["subscription"], "title": "InstanceSubscriptionUpdate" }, "InstanceTagSort": { "type": "string", "enum": ["name", "-name", "enabled", "-enabled"], "title": "InstanceTagSort" }, "InstanceUpdate": { "properties": { "entries_start": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Entries Start", "description": "The datetime in UTC time from which the API will \n sync an Instance's accounting data. Transactions or journal entries cannot \n be entered before this date. The time component is ignored — the value \n is always stored as start-of-day UTC (00:00:00Z).", "examples": ["2024-01-01T00:00:00Z"] }, "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "The name of the business.", "examples": ["ACME Goods Inc"] } }, "type": "object", "title": "InstanceUpdate" }, "JournalEntry": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "An arbitrary string on the object, useful for \n displaying to the user.", "examples": ["Payroll#230215"] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The datetime the Journal Entry was created in UTC \n time.", "examples": ["2023-02-15T06:42:18Z"] }, "creation_date": { "type": "string", "format": "date-time", "title": "Creation Date", "description": "The timestamp when this journal entry record was created in the database.", "examples": ["2023-02-15T06:42:18Z"] }, "is_opening_balance": { "type": "boolean", "title": "Is Opening Balance", "description": "Whether the Journal Entry represents an\n opening balance.", "examples": [false] }, "line_entry_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Line Entry Ids", "description": "The ids of the Line Entries detailing the Journal\n Entry's movement of value.", "examples": [["XMDsKVuW4Wmi3LTW31Qw6E", "NULcvXTkLczde32qs1rqgB"]] }, "linked_entity": { "type": "null", "title": "Linked Entity", "description": "Deprecated - always null" }, "creation_source": { "$ref": "#/components/schemas/JournalEntryCreationSource", "description": "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." }, "categorization_status": { "$ref": "#/components/schemas/JournalEntryCategorizationStatus", "description": "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)." }, "review_status": { "$ref": "#/components/schemas/JournalEntryReviewStatus", "description": "Whether the user has reviewed the Journal Entry. New Journal Entries default to 'unreviewed'." }, "review_status_set_at": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Review Status Set At", "description": "When the review status was last set. Null if the Journal Entry has never been reviewed.", "examples": ["2023-02-15T06:42:18Z"] } }, "type": "object", "required": [ "id", "description", "datetime", "creation_date", "is_opening_balance", "creation_source", "categorization_status", "review_status" ], "title": "JournalEntry" }, "JournalEntryBulkDelete": { "properties": { "journal_entry_ids": { "items": { "type": "string" }, "type": "array", "title": "Journal Entry Ids", "description": "The journal entries to delete", "examples": [ ["V513k5KHCGZ8M7CcyfLDk6", "EkPG5ZfyqdVjtXFsRddmCV", "34EAnzMaMz8Sm1Z7QkmXRw"] ] } }, "type": "object", "required": ["journal_entry_ids"], "title": "JournalEntryBulkDelete" }, "JournalEntryCategorizationStatus": { "type": "string", "enum": ["pending", "delayed", "completed", "not_attempted"], "title": "JournalEntryCategorizationStatus" }, "JournalEntryCreate": { "properties": { "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The datetime the Journal Entry was created in UTC \n time.", "examples": ["2023-02-15T06:42:18Z"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "An arbitrary string on the object, useful for \n displaying to the user.", "examples": ["Payroll#230215"] }, "line_entries": { "items": { "$ref": "#/components/schemas/LineEntryWithTags" }, "type": "array", "title": "Line Entries", "description": "The Line Entry objects to be associated with the \n Journal Entry. Must include at least two Line Entries, one debit and one \n credit, and the sum of the `amount`s of all debit entries must equal the \n sum of the `amount`s of the credit entries.", "examples": [ [ { "amount": "31282.27999999999883584678173065185546875", "debit_credit": "credit", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC" }, { "amount": "31282.27999999999883584678173065185546875", "debit_credit": "debit", "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco" } ] ] } }, "type": "object", "required": ["datetime", "description", "line_entries"], "title": "JournalEntryCreate" }, "JournalEntryCreationSource": { "type": "string", "enum": [ "manual", "transaction", "accrual", "payment_application", "legacy", "scheduled_accrual" ], "title": "JournalEntryCreationSource", "description": "The source that created a journal entry.\n\n- `manual`: Created manually by the user via the UI.\n- `transaction`: Created automatically from a transaction categorization (e.g., Plaid sync).\n- `accrual`: Created automatically as part of an accrual workflow.\n- `payment_application`: Created automatically as part of a payment application workflow.\n- `legacy`: Created automatically from the old AR/AP system (receivables/payables).\n- `scheduled_accrual`: Created automatically by the background accrual schedule job." }, "JournalEntryExpandPath": { "type": "string", "enum": [ "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" ], "title": "JournalEntryExpandPath" }, "JournalEntryMetrics": { "properties": { "unreviewed": { "type": "integer", "title": "Unreviewed", "description": "Journal entries awaiting review (review status 'unreviewed')." } }, "type": "object", "required": ["unreviewed"], "title": "JournalEntryMetrics", "description": "Journal-entry counts for filter menus — currently just the unreviewed\ncount, equal to the number of entries the review_status=unreviewed filter\nwould return on the list endpoint." }, "JournalEntryPage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "total_count": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Total Count", "description": "Total number of Journal Entries matching the provided filters across all pages, not just this page. Only populated when the include_total_count query parameter is true.", "examples": [1] }, "records": { "items": { "$ref": "#/components/schemas/ExpandableJournalEntry" }, "type": "array", "title": "Records", "description": "List of journal entries", "examples": [ [ { "categorization_status": "completed", "creation_date": "2023-02-15T06:42:18Z", "creation_source": "manual", "datetime": "2023-02-15T06:42:18Z", "description": "Payroll#230215", "id": "C4ocnUQze8kDwQ3EczkZXn", "is_opening_balance": false, "line_entry_ids": ["XMDsKVuW4Wmi3LTW31Qw6E", "NULcvXTkLczde32qs1rqgB"], "review_status": "unreviewed" } ] ] } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "JournalEntryPage" }, "JournalEntryReconciliationStatus": { "type": "string", "enum": ["unreconciled", "reconciled", "skipped"], "title": "JournalEntryReconciliationStatus" }, "JournalEntryReviewStatus": { "type": "string", "enum": ["unreviewed", "reviewed"], "title": "JournalEntryReviewStatus" }, "JournalEntrySort": { "type": "string", "enum": [ "creation_date", "-creation_date", "description", "-description", "datetime", "-datetime", "transaction_source_account", "-transaction_source_account", "transaction_contra_ledger", "-transaction_contra_ledger", "debit_ledger", "-debit_ledger", "credit_ledger", "-credit_ledger", "reconciliation_contra_ledger", "-reconciliation_contra_ledger", "tag_name", "-tag_name" ], "title": "JournalEntrySort" }, "JournalEntrySortAmount": { "type": "string", "enum": ["amount", "-amount"], "title": "JournalEntrySortAmount" }, "JournalEntryUpdate": { "properties": { "datetime": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Datetime", "description": "The datetime the Journal Entry was created in UTC \n time.", "examples": ["2023-02-15T06:42:18Z"] }, "description": { "anyOf": [{ "type": "string", "maxLength": 512 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for \n displaying to the user.", "examples": ["Payroll#230215"] }, "line_entry_changes": { "anyOf": [{ "$ref": "#/components/schemas/LineEntryChanges" }, { "type": "null" }], "description": "An object with optional `create`, `update`,\n and `delete` parameters to modify the Line Entries associated with\n the Journal Entry. The `create` and `update` parameters accept lists of\n Line Entry objects, while the `delete` parameter accepts a list of\n existing Line Entry IDs." }, "review_status": { "anyOf": [ { "$ref": "#/components/schemas/JournalEntryReviewStatus" }, { "type": "null" } ], "description": "Set the review status of the Journal Entry.", "examples": ["reviewed"] } }, "type": "object", "title": "JournalEntryUpdate" }, "JournalEntryUpdateWithId": { "properties": { "datetime": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Datetime", "description": "The datetime the Journal Entry was created in UTC \n time.", "examples": ["2023-02-15T06:42:18Z"] }, "description": { "anyOf": [{ "type": "string", "maxLength": 512 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for \n displaying to the user.", "examples": ["Payroll#230215"] }, "line_entry_changes": { "anyOf": [{ "$ref": "#/components/schemas/LineEntryChanges" }, { "type": "null" }], "description": "An object with optional `create`, `update`,\n and `delete` parameters to modify the Line Entries associated with\n the Journal Entry. The `create` and `update` parameters accept lists of\n Line Entry objects, while the `delete` parameter accepts a list of\n existing Line Entry IDs." }, "review_status": { "anyOf": [ { "$ref": "#/components/schemas/JournalEntryReviewStatus" }, { "type": "null" } ], "description": "Set the review status of the Journal Entry.", "examples": ["reviewed"] }, "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["TYcnEf8yEYMXSwUui3E2df"] } }, "type": "object", "required": ["id"], "title": "JournalEntryUpdateWithId" }, "Ledger": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "name": { "type": "string", "maxLength": 255, "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the ledger is a credit or debit ledger.", "examples": ["debit"] }, "actions": { "anyOf": [{ "$ref": "#/components/schemas/LedgerActions" }, { "type": "null" }], "description": "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." }, "editable": { "type": "boolean", "title": "Editable", "description": "Whether line entries can be manually added or removed from the ledger.", "examples": [false] }, "financial_account_type": { "anyOf": [{ "$ref": "#/components/schemas/FinancialAccountType" }, { "type": "null" }], "description": "Indicates that the ledger represents a real-world financial account.", "examples": ["bank_account"] }, "is_required": { "type": "boolean", "title": "Is Required", "description": "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).", "examples": [false] }, "required_ledger_purpose": { "anyOf": [{ "$ref": "#/components/schemas/SpecialLedgerType" }, { "type": "null" }], "description": "Required ledgers fulfill specific system functions and are necessary for the accounting system to operate.", "examples": ["account_transfers"] }, "parent": { "anyOf": [{ "$ref": "#/components/schemas/Ledger" }, { "type": "null" }], "description": "Expandable. If the ledger is a child ledger, the parent ledger object." }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the ledger is a child Ledger, the ID of the parent ledger object.", "examples": [null] }, "report_cash_flow": { "type": "boolean", "title": "Report Cash Flow", "description": "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.", "examples": [false] }, "sort_code": { "type": "string", "maxLength": 20, "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.", "examples": ["1400"] }, "sub_type": { "$ref": "#/components/schemas/LedgerSubType", "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.", "examples": ["current_assets"] }, "type": { "$ref": "#/components/schemas/LedgerType", "description": "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.", "examples": ["asset"] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime when the ledger was created.", "examples": ["2024-01-01T00:00:00Z"] } }, "type": "object", "required": [ "id", "name", "debit_credit", "editable", "is_required", "parent_id", "report_cash_flow", "sort_code", "sub_type", "type", "created_at" ], "title": "Ledger" }, "LedgerActions": { "properties": { "delete": { "$ref": "#/components/schemas/LedgerDeleteAction" } }, "type": "object", "required": ["delete"], "title": "LedgerActions" }, "LedgerClearField": { "type": "string", "enum": ["parent_id"], "title": "LedgerClearField" }, "LedgerCreate": { "properties": { "editable": { "type": "boolean", "title": "Editable", "description": "Whether line entries can be manually added or removed from the ledger.\n\nSet 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", "examples": [true] }, "debit_credit": { "anyOf": [{ "$ref": "#/components/schemas/DebitCredit" }, { "type": "null" }], "description": "Indicates if the ledger is a credit or debit ledger.\n\nRequired if `financial_account_type` is not specified.", "examples": ["debit"] }, "financial_account_type": { "anyOf": [{ "$ref": "#/components/schemas/FinancialAccountType" }, { "type": "null" }], "description": "Indicates that the ledger represents a real-world financial account.\n\nIf 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.\n\nSee the [default parameters](https://docs.teal.dev/guides/platform/financial_account_types) for financial account types.", "examples": [null] }, "name": { "type": "string", "maxLength": 255, "title": "Name", "description": "The name of the ledger.\n\nTeal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.", "examples": ["Pluto Checking 4242"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the ledger is a child Ledger, the ID of the parent ledger object.", "examples": [null] }, "report_cash_flow": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Report Cash Flow", "description": "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.", "examples": [false] }, "sort_code": { "anyOf": [ { "type": "string", "maxLength": 20, "pattern": "^[0-9]+$" }, { "type": "null" } ], "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.\n\nTeal 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.\n\nRequired if `financial_account_type` is not specified.", "examples": ["1400"] }, "sub_type": { "anyOf": [{ "$ref": "#/components/schemas/LedgerSubType" }, { "type": "null" }], "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.\n\nRequired if `financial_account_type` is not specified.", "examples": ["current_assets"] }, "opening_balance": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Opening Balance", "description": "Sets the opening balance of the ledger.", "examples": ["450.25"] }, "type": { "anyOf": [{ "$ref": "#/components/schemas/LedgerType" }, { "type": "null" }], "description": "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.\n\nRequired if `financial_account_type` is not specified.", "examples": ["asset"] } }, "type": "object", "required": ["editable", "name"], "title": "LedgerCreate" }, "LedgerDeleteAction": { "properties": { "allowed": { "type": "boolean", "title": "Allowed" }, "reason": { "anyOf": [ { "type": "string", "enum": ["required_ledger", "has_line_entries", "linked_transaction_source"] }, { "type": "null" } ], "title": "Reason" }, "message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Message" } }, "type": "object", "required": ["allowed"], "title": "LedgerDeleteAction" }, "LedgerDeleteResult": { "properties": { "success": { "type": "boolean", "title": "Success", "description": "Whether the ledger deletion was successful." }, "error": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Error", "description": "The error message if deletion failed" } }, "type": "object", "required": ["success"], "title": "LedgerDeleteResult" }, "LedgerDetails": { "properties": { "earliest_journal_entry_datetime": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Earliest Journal Entry Datetime", "description": "The datetime of the earliest non-opening balance journal entry in the ledger." }, "opening_balance": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Opening Balance", "description": "The ledger's opening balance in its natural direction (positive = positive balance for both debit- and credit-natural ledgers). `null` if there are no opening balance entries." } }, "type": "object", "required": ["earliest_journal_entry_datetime"], "title": "LedgerDetails" }, "LedgerExpandPath": { "type": "string", "enum": ["parent", "parent.parent", "details"], "title": "LedgerExpandPath" }, "LedgerLinkStatus": { "properties": { "token_handle": { "$ref": "#/components/schemas/TransactionSource" }, "ledger": { "anyOf": [{ "$ref": "#/components/schemas/Ledger" }, { "type": "null" }] }, "instance": { "$ref": "#/components/schemas/Instance" }, "txn_processing_task": { "anyOf": [{ "$ref": "#/components/schemas/TxnProcessingTask" }, { "type": "null" }] } }, "type": "object", "required": ["token_handle", "ledger", "instance", "txn_processing_task"], "title": "LedgerLinkStatus" }, "LedgerLinkStatusPage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/LedgerLinkStatus" }, "type": "array", "title": "Records", "description": "List of source account statuses" } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "LedgerLinkStatusPage" }, "LedgerPage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/Ledger" }, "type": "array", "title": "Records", "description": "List of ledgers", "examples": [ [ { "created_at": "2024-01-01T00:00:00", "debit_credit": "debit", "editable": false, "financial_account_type": "bank_account", "id": "7JRNsKwy2Lw66caxVU7WGC", "is_autocat_category": false, "is_required": false, "name": "Pluto Checking 4242", "report_cash_flow": true, "sort_code": "2240", "sub_type": "current_assets", "type": "asset" } ] ] } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "LedgerPage" }, "LedgerSort": { "type": "string", "enum": [ "name", "-name", "type", "-type", "sub_type", "-sub_type", "debit_credit", "-debit_credit" ], "title": "LedgerSort" }, "LedgerStatement": { "properties": { "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The unique ID of the object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "type": { "$ref": "#/components/schemas/LedgerType", "description": "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.", "examples": ["asset"] }, "sub_type": { "$ref": "#/components/schemas/LedgerSubType", "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.", "examples": ["operating_expenses"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the ledger is a credit or debit ledger.", "examples": ["debit"] }, "amount": { "type": "number", "title": "Amount", "description": "The sum, in decimal dollar cents, of all line entries in the ledger.", "examples": ["17080.110000000000582076609134674072265625"] }, "opening_balance": { "type": "number", "title": "Opening Balance", "description": "The balance, in decimal dollar cents, of the ledger at the start date.", "examples": ["14173.1800000000002910383045673370361328125"] }, "closing_balance": { "type": "number", "title": "Closing Balance", "description": "The balance, in decimal dollar cents, of the ledger at the end date.", "examples": ["31253.2900000000008731149137020111083984375"] }, "lines": { "items": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" }, "type": "array", "title": "Lines", "description": "A list all Line Entries in the Ledger.", "examples": [ [ { "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, "transaction_id": "txn_MtcXSgvy" } ] ] }, "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The start date of the report (inclusive). Must be in YYYY-MM-DD format.", "examples": ["2024-01-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The end date of the report (inclusive). Must be in YYYY-MM-DD format.", "examples": ["2024-03-31"] } }, "type": "object", "required": [ "ledger_id", "name", "type", "sub_type", "debit_credit", "amount", "opening_balance", "closing_balance", "lines", "start_date", "end_date" ], "title": "LedgerStatement" }, "LedgerStatementPage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "ledger_statement": { "$ref": "#/components/schemas/LedgerStatement", "description": "The Ledger Statement object.", "examples": [ { "amount": 17080.11, "closing_balance": 31253.29, "debit_credit": "debit", "end_date": "2024-03-31", "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "lines": [ { "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, "transaction_id": "txn_MtcXSgvy" } ], "name": "Pluto Checking 4242", "opening_balance": 14173.18, "start_date": "2024-01-01", "sub_type": "current_assets", "type": "asset" } ] } }, "type": "object", "required": ["next_page_token", "prev_page_token", "ledger_statement"], "title": "LedgerStatementPage" }, "LedgerSubType": { "type": "string", "enum": [ "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" ], "title": "LedgerSubType" }, "LedgerTemplate": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "children": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LedgerTemplate" }, "type": "array" }, { "type": "null" } ], "title": "Children", "description": "If the Ledger has child ledgers, a list of the \n Ledger objects.", "examples": [null] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the ledger is a credit or debit ledger.", "examples": ["debit"] }, "editable": { "type": "boolean", "title": "Editable", "description": "Whether line entries can be manually added or removed from the ledger.", "examples": [false] }, "financial_account_type": { "anyOf": [{ "$ref": "#/components/schemas/FinancialAccountType" }, { "type": "null" }], "description": "Indicates that the ledger represents a real-world financial account.", "examples": ["bank_account"] }, "is_required": { "type": "boolean", "title": "Is Required", "description": "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).", "examples": [false] }, "required_ledger_purpose": { "anyOf": [{ "$ref": "#/components/schemas/SpecialLedgerType" }, { "type": "null" }], "description": "Required ledgers fulfill specific system functions and are necessary for the accounting system to operate.", "examples": ["account_transfers"] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the ledger is a child Ledger, the ID of the parent ledger object.", "examples": [null] }, "report_cash_flow": { "type": "boolean", "title": "Report Cash Flow", "description": "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.", "examples": [true] }, "sort_code": { "type": "string", "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.", "examples": ["1400"] }, "sub_type": { "$ref": "#/components/schemas/LedgerSubType", "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.", "examples": ["current_assets"] }, "type": { "$ref": "#/components/schemas/LedgerType", "description": "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.", "examples": ["asset"] } }, "type": "object", "required": [ "id", "debit_credit", "editable", "financial_account_type", "is_required", "name", "parent_id", "report_cash_flow", "sort_code", "sub_type", "type" ], "title": "LedgerTemplate" }, "LedgerTemplateBulkCreate": { "properties": { "ledgers": { "items": { "$ref": "#/components/schemas/LedgerTemplateBulkCreateNode" }, "type": "array", "minItems": 1, "title": "Ledgers", "description": "Ledger Template trees to create." } }, "type": "object", "required": ["ledgers"], "title": "LedgerTemplateBulkCreate" }, "LedgerTemplateBulkCreateNode": { "properties": { "editable": { "type": "boolean", "title": "Editable", "description": "Whether line entries can be manually added or removed from the ledger.", "examples": [false] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the ledger is a credit or debit ledger.", "examples": ["debit"] }, "financial_account_type": { "anyOf": [{ "$ref": "#/components/schemas/FinancialAccountType" }, { "type": "null" }], "description": "Indicates that the ledger represents a real-world financial account.", "examples": ["bank_account"] }, "ledger_sub_type": { "$ref": "#/components/schemas/LedgerSubType", "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.", "examples": ["current_assets"] }, "ledger_type": { "$ref": "#/components/schemas/LedgerType", "description": "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.", "examples": ["asset"] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "report_cash_flow": { "type": "boolean", "title": "Report Cash Flow", "description": "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.", "examples": [true] }, "sort_code": { "type": "string", "maxLength": 20, "pattern": "^[0-9]+$", "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.", "examples": ["1400"] }, "special_type": { "anyOf": [{ "$ref": "#/components/schemas/SpecialLedgerType" }, { "type": "null" }], "description": "The system ledger type to update during replacement." }, "children": { "items": { "$ref": "#/components/schemas/LedgerTemplateBulkCreateNode" }, "type": "array", "title": "Children", "description": "Nested Ledger Templates attached to their enclosing ledger." } }, "type": "object", "required": [ "editable", "debit_credit", "ledger_sub_type", "ledger_type", "name", "report_cash_flow", "sort_code" ], "title": "LedgerTemplateBulkCreateNode" }, "LedgerTemplateCreate": { "properties": { "editable": { "type": "boolean", "title": "Editable", "description": "Whether line entries can be manually added or removed from the ledger.", "examples": [false] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the ledger is a credit or debit ledger.", "examples": ["debit"] }, "financial_account_type": { "anyOf": [{ "$ref": "#/components/schemas/FinancialAccountType" }, { "type": "null" }], "description": "Indicates that the ledger represents a real-world financial account.", "examples": ["bank_account"] }, "ledger_sub_type": { "$ref": "#/components/schemas/LedgerSubType", "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.", "examples": ["current_assets"] }, "ledger_type": { "$ref": "#/components/schemas/LedgerType", "description": "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.", "examples": ["asset"] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the ledger is a child Ledger, the ID of the parent ledger object.", "examples": [null] }, "report_cash_flow": { "type": "boolean", "title": "Report Cash Flow", "description": "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.", "examples": [true] }, "sort_code": { "type": "string", "maxLength": 20, "pattern": "^[0-9]+$", "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.", "examples": ["1400"] } }, "type": "object", "required": [ "editable", "debit_credit", "ledger_sub_type", "ledger_type", "name", "report_cash_flow", "sort_code" ], "title": "LedgerTemplateCreate" }, "LedgerTemplateUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "The name of the ledger." }, "sort_code": { "anyOf": [ { "type": "string", "maxLength": 20, "pattern": "^[0-9]+$" }, { "type": "null" } ], "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`." }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the ledger is a child Ledger, the ID of the parent ledger object." }, "clear_fields": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LedgerClearField" }, "type": "array" }, { "type": "null" } ], "title": "Clear Fields", "description": "Fields to clear. Supports detaching the parent ledger.", "examples": [["parent_id"]] } }, "type": "object", "title": "LedgerTemplateUpdate" }, "LedgerType": { "type": "string", "enum": ["asset", "liability", "equity", "revenue", "expense"], "title": "LedgerType" }, "LedgerUpdate": { "properties": { "debit_credit": { "anyOf": [{ "$ref": "#/components/schemas/DebitCredit" }, { "type": "null" }], "description": "Indicates if the ledger is a credit or debit ledger.\n\nRequired if `financial_account_type` is not specified.", "examples": ["debit"] }, "name": { "anyOf": [{ "type": "string", "maxLength": 255 }, { "type": "null" }], "title": "Name", "description": "The name of the ledger.\n\nTeal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.", "examples": ["Pluto Checking 4242"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the ledger is a child Ledger, the ID of the parent ledger object.", "examples": [null] }, "sort_code": { "anyOf": [ { "type": "string", "maxLength": 20, "pattern": "^[0-9]+$" }, { "type": "null" } ], "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.\n\nTeal 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.\n\nRequired if `financial_account_type` is not specified.", "examples": ["1400"] }, "sub_type": { "anyOf": [{ "$ref": "#/components/schemas/LedgerSubType" }, { "type": "null" }], "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.\n\nRequired if `financial_account_type` is not specified.", "examples": ["current_assets"] }, "type": { "anyOf": [{ "$ref": "#/components/schemas/LedgerType" }, { "type": "null" }], "description": "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.\n\nRequired if `financial_account_type` is not specified.", "examples": ["asset"] }, "report_cash_flow": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Report Cash Flow", "description": "Whether to include this ledger in cash flow reports. **Important:** This field can only be updated for ledgers without a `financial_account_type`. For financial account ledgers, attempting to update this field will result in an error. Recommended values: true for operating accounts (checking, credit card), false for non-operating accounts (loans, investments).", "examples": [true] }, "clear_fields": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LedgerClearField" }, "type": "array" }, { "type": "null" } ], "title": "Clear Fields", "description": "A list of fields to be cleared.", "examples": [["parent_id"]] } }, "type": "object", "title": "LedgerUpdate" }, "LedgerUpdateOpeningBalance": { "properties": { "balance": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Balance", "description": "The opening balance of the ledger on the `entries_start` date of the Instance." } }, "type": "object", "required": ["balance"], "title": "LedgerUpdateOpeningBalance" }, "LineEntryChanges": { "properties": { "create": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LineEntryWithTags" }, "type": "array" }, { "type": "null" } ], "title": "Create", "description": "A list of new Line Entry objects to be created on the Journal Entry." }, "update": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LineEntryUpdate" }, "type": "array" }, { "type": "null" } ], "title": "Update", "description": "A list of existing Line Entry objects to be updated on the Journal Entry." }, "delete": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Delete", "description": "A list of existing Line Entry IDs to delete." } }, "type": "object", "title": "LineEntryChanges" }, "LineEntryExpandPath": { "type": "string", "enum": [ "transaction", "ledger", "journal_entry", "opposing_ledger_ids", "payment_applications", "line_payment_applications", "accrual_source" ], "title": "LineEntryExpandPath" }, "LineEntryLinePaymentApplication": { "properties": { "line_payment_application_id": { "type": "string", "title": "Line Payment Application Id" }, "matched_amount": { "type": "number", "title": "Matched Amount" }, "accrual_source": { "$ref": "#/components/schemas/LineEntryLinePaymentApplicationAccrualSource" }, "source_type": { "$ref": "#/components/schemas/PaymentApplicationSourceType" }, "status": { "$ref": "#/components/schemas/PaymentApplicationStatus" } }, "type": "object", "required": [ "line_payment_application_id", "matched_amount", "accrual_source", "source_type", "status" ], "title": "LineEntryLinePaymentApplication" }, "LineEntryLinePaymentApplicationAccrualSource": { "properties": { "accrual_source_id": { "type": "string", "title": "Accrual Source Id" }, "type": { "type": "string", "const": "payroll", "title": "Type" }, "start_date": { "type": "string", "format": "date", "title": "Start Date" }, "end_date": { "type": "string", "format": "date", "title": "End Date" } }, "type": "object", "required": ["accrual_source_id", "type", "start_date", "end_date"], "title": "LineEntryLinePaymentApplicationAccrualSource" }, "LineEntryPaymentApplication": { "properties": { "payment_application_id": { "type": "string", "title": "Payment Application Id" }, "matched_amount": { "type": "number", "title": "Matched Amount" }, "accrual_source": { "anyOf": [ { "$ref": "#/components/schemas/LineEntryPaymentApplicationAccrualSource" }, { "type": "null" } ] }, "source_type": { "$ref": "#/components/schemas/PaymentApplicationSourceType" }, "status": { "$ref": "#/components/schemas/PaymentApplicationStatus" }, "adjustments": { "items": { "$ref": "#/components/schemas/PaymentApplicationAccrualAdjustment" }, "type": "array", "title": "Adjustments" } }, "type": "object", "required": [ "payment_application_id", "matched_amount", "accrual_source", "source_type", "status", "adjustments" ], "title": "LineEntryPaymentApplication" }, "LineEntryPaymentApplicationAccrualSource": { "properties": { "accrual_source_id": { "type": "string", "title": "Accrual Source Id" }, "type": { "$ref": "#/components/schemas/AccrualSourceType" }, "external_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id" }, "external_party_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Party Id" }, "reference_number": { "type": "string", "title": "Reference Number", "default": "" }, "effective_date": { "type": "string", "format": "date", "title": "Effective Date" }, "gross_amount": { "type": "number", "title": "Gross Amount" } }, "type": "object", "required": [ "accrual_source_id", "type", "external_id", "external_party_id", "effective_date", "gross_amount" ], "title": "LineEntryPaymentApplicationAccrualSource" }, "LineEntryUpdate": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["XMDsKVuW4Wmi3LTW31Qw6E"] }, "amount": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Amount", "description": "The value of the line entry in decimal dollar cents.", "examples": ["31282.27999999999883584678173065185546875"] }, "debit_credit": { "anyOf": [{ "$ref": "#/components/schemas/DebitCredit" }, { "type": "null" }], "description": "Indicates if the amount is a credit or debit.", "examples": ["credit"] }, "description": { "anyOf": [{ "type": "string", "maxLength": 4000 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for displaying to the user or for categorization." }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ID of the Line Entry's Ledger.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "tag_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Tag Ids", "description": "A list of IDs of the Tag objects associated with the Line Entry." }, "sort_order": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Sort Order", "description": "The position of the Line Entry within its Journal Entry, used to determine display order.", "examples": [1] } }, "type": "object", "required": ["id"], "title": "LineEntryUpdate" }, "LineEntryWithTags": { "properties": { "amount": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Amount", "description": "The value of the line entry in decimal dollar cents.", "examples": ["31282.27999999999883584678173065185546875"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the amount is a credit or debit.", "examples": ["credit"] }, "description": { "anyOf": [{ "type": "string", "maxLength": 4000 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for displaying to the user or for categorization.", "examples": ["Payroll#230215"] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Line Entry's Ledger.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "tag_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Tag Ids", "description": "A list of IDs of the Tag objects associated with the Line Entry." }, "sort_order": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Sort Order", "description": "The position of the Line Entry within its Journal Entry, used to determine display order.", "examples": [1] } }, "type": "object", "required": ["amount", "debit_credit", "ledger_id"], "title": "LineEntryWithTags" }, "NestedLedgerStatement": { "properties": { "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The unique ID of the object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "type": { "$ref": "#/components/schemas/LedgerType", "description": "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.", "examples": ["asset"] }, "sub_type": { "$ref": "#/components/schemas/LedgerSubType", "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.", "examples": ["operating_expenses"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the ledger is a credit or debit ledger.", "examples": ["debit"] }, "amount": { "type": "number", "title": "Amount", "description": "The sum, in decimal dollar cents, of all line entries in the ledger.", "examples": ["17080.110000000000582076609134674072265625"] }, "opening_balance": { "type": "number", "title": "Opening Balance", "description": "The balance, in decimal dollar cents, of the ledger at the start date.", "examples": ["14173.1800000000002910383045673370361328125"] }, "closing_balance": { "type": "number", "title": "Closing Balance", "description": "The balance, in decimal dollar cents, of the ledger at the end date.", "examples": ["31253.2900000000008731149137020111083984375"] }, "lines": { "items": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" }, "type": "array", "title": "Lines", "description": "A list all Line Entries in the Ledger.", "examples": [ [ { "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, "transaction_id": "txn_MtcXSgvy" } ] ] }, "total_amount": { "type": "number", "title": "Total Amount", "description": "The sum, in decimal dollar cents, of the ledger `amount` and the `amount` of all child ledgers, if any.", "examples": ["17080.110000000000582076609134674072265625"] }, "children": { "items": { "$ref": "#/components/schemas/NestedLedgerStatement" }, "type": "array", "title": "Children", "description": "If the Ledger has any children, a list of the Ledger objects.", "examples": [[]] } }, "type": "object", "required": [ "ledger_id", "name", "type", "sub_type", "debit_credit", "amount", "opening_balance", "closing_balance", "lines", "total_amount", "children" ], "title": "NestedLedgerStatement" }, "NetCashFlowTimeSeriesEntry": { "properties": { "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The first day of this bucket (inclusive). Bucket dates are authoritative: edge buckets widen to whole calendar periods and may extend beyond the requested range.", "examples": ["2024-02-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The last day of this bucket (inclusive).", "examples": ["2024-02-29"] }, "net_cash_flow": { "type": "number", "title": "Net Cash Flow", "description": "Net cash flow across cash accounts within the bucket, in decimal dollar cents. Signed: negative when outflows exceed inflows.", "examples": ["4041.26999999999998181010596454143524169921875"] } }, "type": "object", "required": ["start_date", "end_date", "net_cash_flow"], "title": "NetCashFlowTimeSeriesEntry" }, "NetProfit": { "properties": { "entries": { "items": { "$ref": "#/components/schemas/NetProfitRecord" }, "type": "array", "title": "Entries", "description": "A list of report summary totals broken down by period between the start date and end date.", "examples": [ [ { "period": "Jan 2024", "totals": { "expense": 148934.41, "net_profit": 26469.88, "revenue": 175404.29 } }, { "period": "Feb 2024", "totals": { "expense": 172624.45, "net_profit": 12163.96, "revenue": 184788.41 } }, { "period": "Mar 2024", "totals": { "expense": 291035.17, "net_profit": 32163.24, "revenue": 323198.41 } } ] ] } }, "type": "object", "required": ["entries"], "title": "NetProfit" }, "NetProfitRecord": { "properties": { "period": { "type": "string", "title": "Period", "description": "The month and year of the period in `mm YYYY` format.", "examples": ["Jan 2024"] }, "totals": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Totals", "description": "The financial summary for the period.", "examples": [{ "expense": "600", "net_profit": "400", "revenue": "1000" }] } }, "type": "object", "required": ["period", "totals"], "title": "NetProfitRecord" }, "PageToken": { "properties": { "offset": { "type": "integer", "title": "Offset", "default": 0 } }, "type": "object", "title": "PageToken" }, "ParsedStatement": { "properties": { "id": { "type": "string", "title": "Id", "description": "The Parsed Statement ID.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] }, "statement_file_id": { "type": "string", "title": "Statement File Id", "description": "The Statement File the parse belongs to.", "examples": ["WTjdK47SHxokWUdypL8zyB"] }, "line_count": { "type": "integer", "title": "Line Count", "description": "The number of parsed statement lines created.", "examples": [42] } }, "type": "object", "required": ["id", "statement_file_id", "line_count"], "title": "ParsedStatement" }, "ParsedStatementCreate": { "properties": { "period_start": { "type": "string", "format": "date", "title": "Period Start", "description": "The start date of the statement period.", "examples": ["2024-01-01"] }, "period_end": { "type": "string", "format": "date", "title": "Period End", "description": "The end date of the statement period.", "examples": ["2024-01-31"] }, "opening_balance": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d{0,2}0*$" } ], "title": "Opening Balance", "description": "The opening balance of the statement period.", "examples": ["3022.50"] }, "ending_balance": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d{0,2}0*$" } ], "title": "Ending Balance", "description": "The ending balance of the statement period.", "examples": ["4719.29"] }, "transactions": { "items": { "$ref": "#/components/schemas/ParsedStatementLineCreate" }, "type": "array", "maxItems": 10000, "title": "Transactions", "description": "The transactions parsed from the statement." } }, "type": "object", "required": [ "period_start", "period_end", "opening_balance", "ending_balance", "transactions" ], "title": "ParsedStatementCreate" }, "ParsedStatementLineCreate": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the transaction on the statement.", "examples": ["2024-01-15"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "The transaction description as it appears on the statement." }, "amount": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000, "exclusiveMinimum": 0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d{0,2}0*$" } ], "title": "Amount", "description": "The transaction amount as a positive magnitude; direction is carried by debit_credit.", "examples": ["81.00"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Whether the transaction is a debit or a credit from the statement's perspective.", "examples": ["debit"] } }, "type": "object", "required": ["date", "description", "amount", "debit_credit"], "title": "ParsedStatementLineCreate" }, "PaymentApplicationAccrualAdjustment": { "properties": { "accrual_adjustment_id": { "type": "string", "title": "Accrual Adjustment Id" }, "debit_account_id": { "type": "string", "title": "Debit Account Id" }, "credit_account_id": { "type": "string", "title": "Credit Account Id" }, "amount": { "type": "number", "title": "Amount" } }, "type": "object", "required": ["accrual_adjustment_id", "debit_account_id", "credit_account_id", "amount"], "title": "PaymentApplicationAccrualAdjustment" }, "PaymentApplicationLineEntry": { "properties": { "line_entry_id": { "type": "string", "title": "Line Entry Id" }, "line_entry_description": { "type": "string", "title": "Line Entry Description" }, "line_entry_amount": { "type": "number", "title": "Line Entry Amount" }, "journal_entry_id": { "type": "string", "title": "Journal Entry Id" }, "journal_entry_description": { "type": "string", "title": "Journal Entry Description" } }, "type": "object", "required": [ "line_entry_id", "line_entry_description", "line_entry_amount", "journal_entry_id", "journal_entry_description" ], "title": "PaymentApplicationLineEntry" }, "PaymentApplicationSourceType": { "type": "string", "enum": ["bank_transaction", "customer_credit", "manual"], "title": "PaymentApplicationSourceType" }, "PaymentApplicationStatus": { "type": "string", "enum": ["proposed", "confirmed", "rejected"], "title": "PaymentApplicationStatus" }, "Period": { "type": "string", "enum": ["daily", "monthly", "quarterly", "yearly"], "title": "Period" }, "PlaidError-Input": { "properties": { "error_type": { "type": "string", "title": "Error Type", "description": "The Plaid error type.", "examples": ["API_ERROR"] }, "error_code": { "type": "string", "title": "Error Code", "description": "The Plaid error code.", "examples": ["INTERNAL_SERVER_ERROR"] }, "error_message": { "type": "string", "title": "Error Message", "description": "The Plaid error message.", "examples": ["An unexpected error occurred."] }, "display_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Display Message", "description": "A display message supplied by Plaid.", "examples": ["Something went wrong."] }, "request_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Request Id", "description": "The Plaid request identifier.", "examples": ["KipL51BWnPIpOmi"] }, "causes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PlaidError-Input" }, "type": "array" }, { "type": "null" } ], "title": "Causes" }, "status": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Status", "description": "The status code returned from Plaid.", "examples": [500] }, "documentation_url": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Documentation Url", "description": "A url to Plaid's documentation about the error.", "examples": [ "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error" ] }, "suggested_action": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Suggested Action", "description": "Plaid's suggested action to resolve the error." } }, "type": "object", "required": ["error_type", "error_code", "error_message"], "title": "PlaidError" }, "PlaidError-Output": { "properties": { "error_type": { "type": "string", "title": "Error Type", "description": "The Plaid error type.", "examples": ["API_ERROR"] }, "error_code": { "type": "string", "title": "Error Code", "description": "The Plaid error code.", "examples": ["INTERNAL_SERVER_ERROR"] }, "error_message": { "type": "string", "title": "Error Message", "description": "The Plaid error message.", "examples": ["An unexpected error occurred."] }, "display_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Display Message", "description": "A display message supplied by Plaid.", "examples": ["Something went wrong."] }, "request_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Request Id", "description": "The Plaid request identifier.", "examples": ["KipL51BWnPIpOmi"] }, "causes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PlaidError-Output" }, "type": "array" }, { "type": "null" } ], "title": "Causes" }, "status": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Status", "description": "The status code returned from Plaid.", "examples": [500] }, "documentation_url": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Documentation Url", "description": "A url to Plaid's documentation about the error.", "examples": [ "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error" ] }, "suggested_action": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Suggested Action", "description": "Plaid's suggested action to resolve the error." } }, "type": "object", "required": ["error_type", "error_code", "error_message"], "title": "PlaidError" }, "PlaidLinkCreate": { "properties": { "p_token": { "type": "string", "title": "P Token", "description": "The permanent Plaid processor token" }, "calculate_opening_balance": { "type": "boolean", "title": "Calculate Opening Balance", "description": "If true the opening balance will be calculated automatically", "default": false }, "start_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Start Date", "description": "The start date of transactions to sync. Only transactions after this date will be imported. If not provided, transactions will be imported up to the instance's entries start date" }, "time_zone": { "type": "string", "enum": [ "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/Coyhaique", "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", "localtime" ], "minLength": 1, "title": "Time Zone", "description": "Time Zone Identifier", "default": "UTC" }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ledger where transactions are automatically posted for business accounts. If not provided, a ledger will be automatically created for business accounts." } }, "type": "object", "required": ["p_token"], "title": "PlaidLinkCreate" }, "Platform": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["Va5Zc9NAP46aYXEmki8Hb1"] }, "name": { "type": "string", "title": "Name", "description": "The name of the Platform", "examples": ["Pauly's Pet Palace"] } }, "type": "object", "required": ["id", "name"], "title": "Platform" }, "PlatformRuleCreate": { "properties": { "expression": { "type": "string", "title": "Expression", "description": "A pattern matching expression using the\n match(pattern, field) function. Use `t` to access the Transaction\n object. The pattern supports regular expression syntax.\n \n \n Read more: [Categorization guide](https://docs.teal.dev/guides/platform/categorization/rules#expressions)", "examples": ["match(\".*(?i)SHELL GAS\", t.description)"] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the destination ledger.", "examples": ["Fuel Expenses"] }, "name": { "type": "string", "title": "Name", "description": "An arbitrary string to name the rule.", "examples": ["Shell to Fuel Expenses"] }, "priority": { "type": "integer", "title": "Priority", "description": "The priority of the rule.", "examples": ["100"] } }, "type": "object", "required": ["expression", "ledger_name", "name", "priority"], "title": "PlatformRuleCreate" }, "PostedStatus": { "type": "string", "enum": ["not_posted", "posted", "deleted"], "title": "PostedStatus" }, "Reconciliation": { "properties": { "id": { "type": "string", "title": "Id", "description": "The Reconciliation ID.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The Ledger ID", "examples": ["WTjdK47SHxokWUdypL8zyB"] }, "start_datetime": { "type": "string", "format": "date-time", "title": "Start Datetime", "description": "The start datetime of the Reconciliation.", "examples": ["2024-01-01T00:00:00Z"] }, "end_datetime": { "type": "string", "format": "date-time", "title": "End Datetime", "description": "The end datetime of the Reconciliation.", "examples": ["2024-01-01T00:00:00Z"] }, "reconciled_balance": { "type": "number", "title": "Reconciled Balance", "description": "The balance of all reconciled journal entries in the ledger with a datetime before the end datetime. Excludes journal entries that were skipped to be reconciled in a later reconciliation after the end datetime.", "examples": [132629.38] }, "statement_starting_balance": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Statement Starting Balance", "description": "The starting balance of the statement. Equal to the statement_ending_balance of the previous reconciliation or the opening balance of the ledger", "examples": [122629.38] }, "statement_ending_balance": { "type": "number", "title": "Statement Ending Balance", "description": "The ending balance of the statement used to perform the Reconciliation.", "examples": [132629.38] }, "reconciliation_status": { "$ref": "#/components/schemas/ReconciliationStatus", "description": "The status of the Reconciliation.", "examples": ["unreconciled", "reconciled"] }, "progress_status": { "type": "string", "title": "Progress Status", "description": "The progress of the Reconciliation.", "examples": ["in_progress", "completed"] }, "completed_on_datetime": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Completed On Datetime", "description": "The datetime when the Reconciliation was last changed to completed.", "examples": ["2024-01-01T00:00:00Z"] }, "final_reconciled_balance": { "type": "number", "title": "Final Reconciled Balance", "description": "The statement balance after applying all journal entries in the reconciliation period. For completed reconciliations this equals the reconciled_balance. For in-progress reconciliations this is the running balance through the last journal entry.", "examples": [132629.38] }, "statement_file_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Statement File Id", "description": "The ID of the statement file linked to this Reconciliation, if one exists.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] } }, "type": "object", "required": [ "id", "start_datetime", "end_datetime", "reconciled_balance", "statement_ending_balance", "reconciliation_status", "progress_status", "final_reconciled_balance" ], "title": "Reconciliation" }, "ReconciliationCreate": { "properties": { "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The Ledger ID", "examples": ["WTjdK47SHxokWUdypL8zyB"] }, "statement_ending_date": { "type": "string", "format": "date", "title": "Statement Ending Date", "description": "The end date of the statement used to perform the Reconciliation.", "examples": ["2024-01-01"] }, "time_zone": { "type": "string", "enum": [ "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/Coyhaique", "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", "localtime" ], "minLength": 1, "title": "Time Zone", "description": "Time Zone Identifier", "default": "UTC" }, "statement_ending_balance": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Statement Ending Balance", "description": "The ending balance of the statement used to perform the Reconciliation.", "examples": [132629.38] }, "progress_status": { "$ref": "#/components/schemas/ReconciliationProgressStatus", "description": "The progress of the Reconciliation.", "examples": ["completed"] }, "statement_file_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Statement File Id", "description": "Optional Statement File ID to link to the new Reconciliation. The file's source account must belong to the reconciliation's ledger, and the file must not already be linked to a reconciliation.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] }, "statement_period_start": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Statement Period Start", "description": "Optional start date of the statement period. When provided, it must equal the derived reconciliation window start (the day after the last reconciliation's ending date, or the instance entries start). A later date raises reconciliation_gap; an earlier date raises reconciliation_overlap.", "examples": ["2024-01-01"] } }, "type": "object", "required": [ "ledger_id", "statement_ending_date", "statement_ending_balance", "progress_status" ], "title": "ReconciliationCreate" }, "ReconciliationJournalEntries": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/ReconciliationJournalEntryWithRunningBalance" }, "type": "array", "title": "Records" } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "ReconciliationJournalEntries" }, "ReconciliationJournalEntry": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "An arbitrary string on the object, useful for \n displaying to the user.", "examples": ["Payroll#230215"] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The datetime the Journal Entry was created in UTC \n time.", "examples": ["2023-02-15T06:42:18Z"] }, "creation_date": { "type": "string", "format": "date-time", "title": "Creation Date", "description": "The timestamp when this journal entry record was created in the database.", "examples": ["2023-02-15T06:42:18Z"] }, "is_opening_balance": { "type": "boolean", "title": "Is Opening Balance", "description": "Whether the Journal Entry represents an\n opening balance.", "examples": [false] }, "line_entry_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Line Entry Ids", "description": "The ids of the Line Entries detailing the Journal\n Entry's movement of value.", "examples": [["XMDsKVuW4Wmi3LTW31Qw6E", "NULcvXTkLczde32qs1rqgB"]] }, "linked_entity": { "type": "null", "title": "Linked Entity", "description": "Deprecated - always null" }, "creation_source": { "$ref": "#/components/schemas/JournalEntryCreationSource", "description": "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." }, "categorization_status": { "$ref": "#/components/schemas/JournalEntryCategorizationStatus", "description": "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)." }, "review_status": { "$ref": "#/components/schemas/JournalEntryReviewStatus", "description": "Whether the user has reviewed the Journal Entry. New Journal Entries default to 'unreviewed'." }, "review_status_set_at": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Review Status Set At", "description": "When the review status was last set. Null if the Journal Entry has never been reviewed.", "examples": ["2023-02-15T06:42:18Z"] }, "line_entries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" }, "type": "array" }, { "type": "null" } ], "title": "Line Entries", "description": "List of Line Entries. Included in expanded responses.", "examples": [ [ { "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": { "anyOf": [{ "$ref": "#/components/schemas/AccrualSourceDetails" }, { "type": "null" }], "description": "The accrual source associated with this journal entry, if any. Included in expanded responses." }, "transfer": { "anyOf": [{ "$ref": "#/components/schemas/Transfer" }, { "type": "null" }], "description": "The transfer linking this journal entry to the journal entry on the other side of the transfer, if any. Included in expanded responses." }, "autocat_result": { "anyOf": [{ "$ref": "#/components/schemas/AutocatResult" }, { "type": "null" }], "description": "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." }, "reconciliation_status": { "$ref": "#/components/schemas/JournalEntryReconciliationStatus", "description": "The reconciliation status of the Journal Entry.", "examples": ["reconciled"] }, "reconciliation_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Reconciliation Id", "description": "The reconciliation that the journal entry is associated with.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] }, "original_reconciliation_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Original Reconciliation Id", "description": "The reconciliation that the journal entry naturally belongs to based on its datetime.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] } }, "type": "object", "required": [ "id", "description", "datetime", "creation_date", "is_opening_balance", "creation_source", "categorization_status", "review_status", "reconciliation_status" ], "title": "ReconciliationJournalEntry" }, "ReconciliationJournalEntryExpandPath": { "type": "string", "enum": ["statement_balance"], "title": "ReconciliationJournalEntryExpandPath" }, "ReconciliationJournalEntryUpdate": { "properties": { "journal_entry_id": { "type": "string", "title": "Journal Entry Id", "description": "The unique ID of the object.", "examples": ["TYcnEf8yEYMXSwUui3E2df"] }, "reconciliation_status": { "$ref": "#/components/schemas/JournalEntryReconciliationStatus", "description": "The reconciliation status of the Journal Entry.", "examples": ["reconciled"] } }, "type": "object", "required": ["journal_entry_id", "reconciliation_status"], "title": "ReconciliationJournalEntryUpdate" }, "ReconciliationJournalEntryUpdateResult": { "properties": { "reconciliation_journal_entry": { "anyOf": [ { "$ref": "#/components/schemas/ReconciliationJournalEntry" }, { "type": "null" } ] }, "error": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Error", "description": "The error message if update failed" } }, "type": "object", "required": ["reconciliation_journal_entry"], "title": "ReconciliationJournalEntryUpdateResult" }, "ReconciliationJournalEntryWithRunningBalance": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "An arbitrary string on the object, useful for \n displaying to the user.", "examples": ["Payroll#230215"] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The datetime the Journal Entry was created in UTC \n time.", "examples": ["2023-02-15T06:42:18Z"] }, "creation_date": { "type": "string", "format": "date-time", "title": "Creation Date", "description": "The timestamp when this journal entry record was created in the database.", "examples": ["2023-02-15T06:42:18Z"] }, "is_opening_balance": { "type": "boolean", "title": "Is Opening Balance", "description": "Whether the Journal Entry represents an\n opening balance.", "examples": [false] }, "line_entry_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Line Entry Ids", "description": "The ids of the Line Entries detailing the Journal\n Entry's movement of value.", "examples": [["XMDsKVuW4Wmi3LTW31Qw6E", "NULcvXTkLczde32qs1rqgB"]] }, "linked_entity": { "type": "null", "title": "Linked Entity", "description": "Deprecated - always null" }, "creation_source": { "$ref": "#/components/schemas/JournalEntryCreationSource", "description": "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." }, "categorization_status": { "$ref": "#/components/schemas/JournalEntryCategorizationStatus", "description": "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)." }, "review_status": { "$ref": "#/components/schemas/JournalEntryReviewStatus", "description": "Whether the user has reviewed the Journal Entry. New Journal Entries default to 'unreviewed'." }, "review_status_set_at": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Review Status Set At", "description": "When the review status was last set. Null if the Journal Entry has never been reviewed.", "examples": ["2023-02-15T06:42:18Z"] }, "line_entries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExpandableDetailedLineEntry" }, "type": "array" }, { "type": "null" } ], "title": "Line Entries", "description": "List of Line Entries. Included in expanded responses.", "examples": [ [ { "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": { "anyOf": [{ "$ref": "#/components/schemas/AccrualSourceDetails" }, { "type": "null" }], "description": "The accrual source associated with this journal entry, if any. Included in expanded responses." }, "transfer": { "anyOf": [{ "$ref": "#/components/schemas/Transfer" }, { "type": "null" }], "description": "The transfer linking this journal entry to the journal entry on the other side of the transfer, if any. Included in expanded responses." }, "autocat_result": { "anyOf": [{ "$ref": "#/components/schemas/AutocatResult" }, { "type": "null" }], "description": "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." }, "reconciliation_status": { "$ref": "#/components/schemas/JournalEntryReconciliationStatus", "description": "The reconciliation status of the Journal Entry.", "examples": ["reconciled"] }, "reconciliation_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Reconciliation Id", "description": "The reconciliation that the journal entry is associated with.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] }, "original_reconciliation_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Original Reconciliation Id", "description": "The reconciliation that the journal entry naturally belongs to based on its datetime.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] }, "statement_balance": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Statement Balance", "description": "The balance after the journal entry is applied to the ledger. May be null if running balance calculation is disabled.", "examples": [234.45] } }, "type": "object", "required": [ "id", "description", "datetime", "creation_date", "is_opening_balance", "creation_source", "categorization_status", "review_status", "reconciliation_status" ], "title": "ReconciliationJournalEntryWithRunningBalance" }, "ReconciliationPage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/Reconciliation" }, "type": "array", "title": "Records", "description": "A list of Reconciliations." } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "ReconciliationPage" }, "ReconciliationProgressStatus": { "type": "string", "enum": ["completed", "in_progress"], "title": "ReconciliationProgressStatus" }, "ReconciliationSort": { "type": "string", "enum": ["ending_date", "-ending_date"], "title": "ReconciliationSort" }, "ReconciliationStatus": { "type": "string", "enum": ["reconciled", "unreconciled"], "title": "ReconciliationStatus" }, "ReconciliationUpdate": { "properties": { "statement_ending_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Statement Ending Date", "description": "The end date of the statement used to perform the Reconciliation. Can only be updated if the reconciliation is in-progress", "examples": ["2024-01-01"] }, "time_zone": { "type": "string", "enum": [ "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/Coyhaique", "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", "localtime" ], "minLength": 1, "title": "Time Zone", "description": "Time Zone Identifier", "default": "UTC" }, "statement_ending_balance": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Statement Ending Balance", "description": "The end date of the statement used to perform the Reconciliation.", "examples": [132629.38] }, "progress_status": { "anyOf": [ { "$ref": "#/components/schemas/ReconciliationProgressStatus" }, { "type": "null" } ], "description": "The progress of the Reconciliation.", "examples": ["completed"] } }, "type": "object", "title": "ReconciliationUpdate" }, "ReportPeriodsRecord": { "properties": { "amounts": { "items": { "type": "number" }, "type": "array", "title": "Amounts", "description": "The sum, in decimal dollar cents, of all line entries in the ledger.", "examples": [ [ "10237.22999999999956344254314899444580078125", "12736.2099999999991268850862979888916015625" ] ] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the ledger is a credit or debit ledger.", "examples": ["debit"] }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the ledger is a child Ledger, the ID of the parent ledger object.", "examples": [null] }, "sort_code": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.", "examples": ["1400"] }, "sub_type": { "anyOf": [{ "$ref": "#/components/schemas/LedgerSubType" }, { "type": "null" }], "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.", "examples": ["current_assets"] }, "total_amounts": { "items": { "type": "number" }, "type": "array", "title": "Total Amounts", "description": "The sum, in decimal dollar cents, of the ledger `amount` and the `amount` of all child ledgers, if any.", "examples": [ [ "10237.22999999999956344254314899444580078125", "12736.2099999999991268850862979888916015625" ] ] }, "type": { "anyOf": [{ "$ref": "#/components/schemas/LedgerType" }, { "type": "null" }], "description": "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.", "examples": ["asset"] }, "children": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ReportPeriodsRecord" }, "type": "array" }, { "type": "null" } ], "title": "Children", "description": "If the Ledger has any children, a list of the Ledger objects.", "examples": [null] }, "required_ledger_purpose": { "anyOf": [{ "$ref": "#/components/schemas/SpecialLedgerType" }, { "type": "null" }], "description": "Required ledgers fulfill specific system functions and are necessary for the accounting system to operate.", "examples": [null] } }, "type": "object", "required": ["amounts", "debit_credit", "name", "total_amounts"], "title": "ReportPeriodsRecord" }, "ReportRecord": { "properties": { "amount": { "type": "number", "title": "Amount", "description": "The sum, in decimal dollar cents, of all line entries in the ledger.", "examples": ["10237.22999999999956344254314899444580078125"] }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Indicates if the ledger is a credit or debit ledger.", "examples": ["debit"] }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "name": { "type": "string", "title": "Name", "description": "The name of the ledger.", "examples": ["Pluto Checking 4242"] }, "parent_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Id", "description": "If the ledger is a child Ledger, the ID of the parent ledger object.", "examples": [null] }, "sort_code": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Sort Code", "description": "Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.", "examples": ["1400"] }, "sub_type": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Sub Type", "description": "Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.", "examples": ["current_assets"] }, "total_amount": { "type": "number", "title": "Total Amount", "description": "The sum, in decimal dollar cents, of the ledger `amount` and the `amount` of all child ledgers, if any.", "examples": ["10237.22999999999956344254314899444580078125"] }, "type": { "anyOf": [{ "$ref": "#/components/schemas/LedgerType" }, { "type": "null" }], "description": "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.", "examples": ["asset"] }, "children": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ReportRecord" }, "type": "array" }, { "type": "null" } ], "title": "Children", "description": "If the Ledger has any children, a list of the Ledger objects.", "examples": [null] }, "required_ledger_purpose": { "anyOf": [{ "$ref": "#/components/schemas/SpecialLedgerType" }, { "type": "null" }], "description": "Required ledgers fulfill specific system functions and are necessary for the accounting system to operate.", "examples": [null] } }, "type": "object", "required": ["amount", "debit_credit", "name", "total_amount"], "title": "ReportRecord" }, "RetainedEarningsMetadata": { "properties": { "calculated_retained_earnings": { "type": "number", "title": "Calculated Retained Earnings", "description": "System-computed Retained Earnings (prior-year revenues minus prior-year expenses) for the period, before any user-posted journal entries on the Retained Earnings ledger are layered in.", "examples": ["48215.1500000000014551915228366851806640625"] }, "calculated_current_year_earnings": { "type": "number", "title": "Calculated Current Year Earnings", "description": "System-computed Current Year Earnings (current-year revenues minus current-year expenses) for the period, before any user-posted journal entries on the Current Year Earnings ledger are layered in.", "examples": ["39300.5599999999976716935634613037109375"] } }, "type": "object", "required": ["calculated_retained_earnings", "calculated_current_year_earnings"], "title": "RetainedEarningsMetadata", "description": "System-computed Retained Earnings and Current Year Earnings amounts for\na single balance-sheet period. These are the income-statement roll-up\nvalues (revenues - expenses) that the report layers on top of any\nuser-posted journal entries against the writable Retained Earnings and\nCurrent Year Earnings system ledgers. Clients can compare these\n`calculated_*` values against the corresponding ledger row totals in\n`records` to surface the manual-vs-calculated split to users." }, "RetainedEarningsMetadataPeriods": { "properties": { "calculated_retained_earnings": { "items": { "type": "number" }, "type": "array", "title": "Calculated Retained Earnings", "description": "System-computed Retained Earnings per period (prior-year revenues minus prior-year expenses), before any user-posted journal entries on the Retained Earnings ledger are layered in.", "examples": [ [ "37952.4400000000023283064365386962890625", "48215.1500000000014551915228366851806640625" ] ] }, "calculated_current_year_earnings": { "items": { "type": "number" }, "type": "array", "title": "Calculated Current Year Earnings", "description": "System-computed Current Year Earnings per period (current-year revenues minus current-year expenses), before any user-posted journal entries on the Current Year Earnings ledger are layered in.", "examples": [ [ "9260.7900000000008731149137020111083984375", "39300.5599999999976716935634613037109375" ] ] } }, "type": "object", "required": ["calculated_retained_earnings", "calculated_current_year_earnings"], "title": "RetainedEarningsMetadataPeriods", "description": "Per-period system-computed Retained Earnings and Current Year Earnings\namounts. Each list mirrors the order of ``periods`` on the parent\nresponse. See :class:`RetainedEarningsMetadata` for what these values\nrepresent and how they relate to the writable equity special ledgers." }, "RevenueLedgerEntry": { "properties": { "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the ledger.", "examples": ["Sales Revenue"] }, "amount": { "type": "number", "title": "Amount", "description": "The revenue attributed to this ledger within the period, in decimal dollar cents. May be zero for ledgers whose activity nets out within the period.", "examples": ["182521.95999999999185092747211456298828125"] } }, "type": "object", "required": ["ledger_id", "ledger_name", "amount"], "title": "RevenueLedgerEntry" }, "RevenueReport": { "properties": { "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The first day of the requested period (inclusive).", "examples": ["2024-02-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The last day of the requested period (inclusive).", "examples": ["2024-02-29"] }, "prior_start_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Prior Start Date", "description": "The first day of the derived comparison period (inclusive). Null when `include_prior` is false.", "examples": ["2024-01-01"] }, "prior_end_date": { "anyOf": [{ "type": "string", "format": "date" }, { "type": "null" }], "title": "Prior End Date", "description": "The last day of the derived comparison period (inclusive). Null when `include_prior` is false.", "examples": ["2024-01-31"] }, "granularity": { "$ref": "#/components/schemas/TrendGranularity", "description": "The bucket size used for `time_series`.", "examples": ["monthly"] }, "total": { "type": "number", "title": "Total", "description": "The total revenue within the period, in decimal dollar cents.", "examples": ["29980.0999999999985448084771633148193359375"] }, "prior_total": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Prior Total", "description": "The total revenue within the comparison period, in decimal dollar cents. Null when `include_prior` is false.", "examples": ["26469.88000000000101863406598567962646484375"] }, "by_ledger": { "items": { "$ref": "#/components/schemas/RevenueLedgerEntry" }, "type": "array", "title": "By Ledger", "description": "Revenue within the period split by ledger, ordered by amount descending (ties broken by ledger name). Only ledgers with at least one line entry in the period are included; a ledger whose entries net to zero returns a zero amount, sorting after positive-amount ledgers (contra/negative rows follow).", "examples": [ [ { "amount": 25000.1, "ledger_id": "7JRNsKwy2Lw66caxVU7WGC", "ledger_name": "Sales Revenue" }, { "amount": 4980, "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco", "ledger_name": "Interest Income" } ] ] }, "time_series": { "items": { "$ref": "#/components/schemas/RevenueTimeSeriesEntry" }, "type": "array", "title": "Time Series", "description": "Revenue bucketed by `granularity`. Every bucket spans its full calendar period, so when the requested range starts or ends mid-period the edge buckets extend beyond `start_date`/`end_date` and their amounts include revenue from outside the requested range — the series is not guaranteed to sum to `total`. Empty only when no matching revenue line entries exist anywhere the series covers (the requested range or its widened edge buckets); buckets whose entries net to zero are returned as zero-valued.", "examples": [ [{ "amount": 29980.1, "end_date": "2024-02-29", "start_date": "2024-02-01" }] ] } }, "type": "object", "required": ["start_date", "end_date", "granularity", "total", "by_ledger", "time_series"], "title": "RevenueReport" }, "RevenueTimeSeriesEntry": { "properties": { "start_date": { "type": "string", "format": "date", "title": "Start Date", "description": "The first day of the bucket (inclusive). The first bucket may start before the requested range: buckets span full calendar periods.", "examples": ["2024-01-01"] }, "end_date": { "type": "string", "format": "date", "title": "End Date", "description": "The last day of the bucket (inclusive). The last bucket may end after the requested range (including in the future): buckets span full calendar periods.", "examples": ["2024-01-31"] }, "amount": { "type": "number", "title": "Amount", "description": "The total revenue within the bucket, in decimal dollar cents.", "examples": ["29980.0999999999985448084771633148193359375"] } }, "type": "object", "required": ["start_date", "end_date", "amount"], "title": "RevenueTimeSeriesEntry" }, "ReviewStatus": { "type": "string", "enum": ["unreviewed", "reviewed"], "title": "ReviewStatus" }, "SingleLineEntryUpdate": { "properties": { "description": { "anyOf": [{ "type": "string", "maxLength": 4000 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for displaying to the user or for categorization." }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ID of the Line Entry's Ledger.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "tag_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Tag Ids", "description": "A list of IDs of the Tag objects associated with the Line Entry." } }, "type": "object", "title": "SingleLineEntryUpdate" }, "SourceAccount": { "properties": { "id": { "type": "string", "title": "Id", "examples": ["KdE7Q37LeQhFQCfEejfibT"] }, "name": { "type": "string", "title": "Name", "description": "Deprecated. Returns the linked ledger's name; read it from the ledger directly.", "deprecated": true }, "debit_credit": { "$ref": "#/components/schemas/DebitCredit", "description": "Whether the account is a debit or credit account." }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ledger ID where transactions will be posted." }, "type": { "$ref": "#/components/schemas/SourceType", "description": "The type of the transaction source." }, "business_personal": { "$ref": "#/components/schemas/BusinessOrPersonal", "description": "Whether the account is a business or personal account." }, "invert_transaction_amounts": { "type": "boolean", "title": "Invert Transaction Amounts", "description": "If true transaction amounts are inverted during manual import only.", "default": false } }, "type": "object", "required": ["id", "name", "debit_credit", "ledger_id", "type", "business_personal"], "title": "SourceAccount" }, "SourceAccountCashBalance": { "properties": { "source_account_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Source Account Id", "description": "The source account this balance belongs to. Null for cash held in a cash-flow ledger with no source account (e.g. manual petty cash, or entries posted directly to a grouping parent ledger).", "examples": ["KdE7Q37LeQhFQCfEejfibT"] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ledger backing this account; source accounts map one-to-one to ledgers.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "name": { "type": "string", "title": "Name", "description": "The account's display name (the backing ledger's name).", "examples": ["Checking 2478"] }, "cash_balance": { "type": "number", "title": "Cash Balance", "description": "The account's book balance as of the end of `end_date`, in decimal dollar cents, derived from its ledger's line entries.", "examples": ["33739.8199999999997089616954326629638671875"] } }, "type": "object", "required": ["ledger_id", "name", "cash_balance"], "title": "SourceAccountCashBalance" }, "SourceAccountCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "Deprecated. The source account's name now mirrors the linked ledger's name; provide the ledger name when creating the ledger instead.", "deprecated": true }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ledger where transactions will be posted. The ledger must have a financial account type. Exactly one of ledger_id or ledger must be provided." }, "ledger": { "anyOf": [ { "$ref": "#/components/schemas/CreateSourceAccountLedger" }, { "type": "null" } ], "description": "Details for a new ledger to create for this source account. Exactly one of ledger_id or ledger must be provided." }, "business_personal": { "$ref": "#/components/schemas/BusinessOrPersonal", "description": "Whether the account is a business or personal account." }, "invert_transaction_amounts": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Invert Transaction Amounts", "description": "If true transaction amounts are inverted during manual import only.", "default": false } }, "type": "object", "required": ["name", "business_personal"], "title": "SourceAccountCreate" }, "SourceAccountUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Deprecated. Renames now cascade to the linked ledger; rename the ledger directly instead.", "deprecated": true }, "invert_transaction_amounts": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Invert Transaction Amounts", "description": "If true transaction amounts are inverted during manual import only." } }, "type": "object", "title": "SourceAccountUpdate" }, "SourceType": { "type": "string", "enum": ["plaid", "manual"], "title": "SourceType" }, "SpecialLedgerType": { "type": "string", "enum": [ "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" ], "title": "SpecialLedgerType", "description": "Special ledgers are ledgers that have special behaviour in the system." }, "StatementFile": { "properties": { "id": { "type": "string", "title": "Id", "description": "The Statement File ID.", "examples": ["FYQxHfWNCMnUuXr6iQhjgG"] }, "source_account_id": { "type": "string", "title": "Source Account Id", "description": "The Source Account the statement belongs to.", "examples": ["WTjdK47SHxokWUdypL8zyB"] }, "reconciliation_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Reconciliation Id", "description": "The Reconciliation this statement was uploaded for, if any.", "examples": ["Mnre3PLDbEPmwQzGBtaVpr"] }, "file_name": { "type": "string", "title": "File Name", "description": "The original name of the uploaded file.", "examples": ["statement-2024-01.pdf"] }, "status": { "$ref": "#/components/schemas/StatementFileStatus", "description": "The processing status of the statement file.", "examples": ["uploaded"] } }, "type": "object", "required": ["id", "source_account_id", "file_name", "status"], "title": "StatementFile" }, "StatementFileStatus": { "type": "string", "enum": ["uploaded", "parsed", "parse_failed"], "title": "StatementFileStatus" }, "SubscriptionLevel": { "type": "string", "enum": ["tier0", "tier1", "tier2", "tier3", "tier4"], "title": "SubscriptionLevel" }, "Tag": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["UjL3BQnEaJtecuC7CUeDk"] }, "name": { "type": "string", "title": "Name", "description": "An arbitrary string, useful for identifying the tag to the user.", "examples": ["Sprinter - 1ab-c23"] }, "tag_group_id": { "type": "string", "title": "Tag Group Id", "description": "The ID of the tag group.", "examples": ["NCB2xo5S1yQbNgyWskXpwG"] } }, "type": "object", "required": ["id", "name", "tag_group_id"], "title": "Tag" }, "TagCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "An arbitrary string, useful for identifying the tag to the user.", "examples": ["Sprinter - 1ab-c23"] }, "tag_group_id": { "type": "string", "title": "Tag Group Id", "description": "The ID of the tag group.", "examples": ["NCB2xo5S1yQbNgyWskXpwG"] } }, "type": "object", "required": ["name", "tag_group_id"], "title": "TagCreate" }, "TagGroup": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["UjL3BQnEaJtecuC7CUeDk"] }, "name": { "type": "string", "title": "Name", "description": "An arbitrary string, useful for identifying the tag to the user.", "examples": ["Sprinter - 1ab-c23"] } }, "type": "object", "required": ["id", "name"], "title": "TagGroup" }, "TagGroupCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "An arbitrary string, useful for identifying the tag group to the user.", "examples": ["Delivery vehicles"] } }, "type": "object", "required": ["name"], "title": "TagGroupCreate" }, "TagGroupUpdate": { "properties": { "name": { "type": "string", "title": "Name", "description": "An arbitrary string, useful for identifying the tag group to the user.", "examples": ["Sprinter - 1ab-c23"] } }, "type": "object", "required": ["name"], "title": "TagGroupUpdate" }, "TagRule": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object.", "examples": ["yB2xokXpQb5S1NgyWsNCwG"] }, "name": { "type": "string", "title": "Name", "description": "An arbitrary string, useful for identifying the tag rule.", "examples": ["Tag gas expense"] }, "tag_id": { "type": "string", "title": "Tag Id", "description": "If the rule finds a match, the ID of the tag that will be assigned.", "examples": ["NCB2xo5S1yQbNgyWskXpwG"] }, "expression": { "type": "string", "title": "Expression", "description": "A pattern matching expression using the match(pattern, field) function. Use `t` to access the Transaction object. The pattern supports regular expression syntax.\n\nRead more: [Categorization guide](https://docs.teal.dev/guides/platform/categorization/rules#expressions)", "examples": ["match(\".*(?i)SHELL GAS\", t.description)"] }, "priority": { "type": "integer", "title": "Priority", "description": "The priority of the rule.", "examples": [10] } }, "type": "object", "required": ["id", "name", "tag_id", "expression", "priority"], "title": "TagRule" }, "TagRuleCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "An arbitrary string, useful for identifying the tag rule.", "examples": ["Tag gas expense"] }, "tag_id": { "type": "string", "title": "Tag Id", "description": "If the rule finds a match, the ID of the tag that will be assigned.", "examples": ["NCB2xo5S1yQbNgyWskXpwG"] }, "expression": { "type": "string", "title": "Expression", "description": "A pattern matching expression using the match(pattern, field) function. Use `t` to access the Transaction object. The pattern supports regular expression syntax.\n\nRead more: [Categorization guide](https://docs.teal.dev/guides/platform/categorization/rules#expressions)", "examples": ["match(\".*(?i)SHELL GAS\", t.description)"] }, "priority": { "type": "integer", "title": "Priority", "description": "The priority of the rule.", "examples": [10] } }, "type": "object", "required": ["name", "tag_id", "expression", "priority"], "title": "TagRuleCreate" }, "TagRulePage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/TagRule" }, "type": "array", "title": "Records", "description": "A list of tag rules.", "examples": [ [ { "expression": "match(\".*(?i)SHELL GAS\", t.description)", "id": "yB2xokXpQb5S1NgyWsNCwG", "name": "Tag gas expense", "priority": 10, "tag_id": "NCB2xo5S1yQbNgyWskXpwG" } ] ] } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "TagRulePage" }, "TagRuleUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "An arbitrary string, useful for identifying the tag rule.", "examples": ["Tag gas expense"] }, "tag_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Tag Id", "description": "An arbitrary string, useful for identifying the tag rule.", "examples": ["Tag gas expense"] }, "expression": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Expression", "description": "A pattern matching expression using the match(pattern, field) function. Use `t` to access the Transaction object. The pattern supports regular expression syntax.\n\nRead more: [Categorization guide](https://docs.teal.dev/guides/platform/categorization/rules#expressions)", "examples": ["match(\".*(?i)SHELL GAS\", t.description)"] }, "priority": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Priority", "description": "The priority of the rule.", "examples": [10] } }, "type": "object", "title": "TagRuleUpdate" }, "TagUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "An arbitrary string, useful for identifying the tag to the user.", "examples": ["Delivery vehicles"] }, "enabled": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Enabled", "description": "Whether the tag is able to be assigned to objects.", "examples": [true] } }, "type": "object", "title": "TagUpdate" }, "TealErrorCode": { "type": "string", "enum": [ "invalid_date", "invalid_ledger", "invalid_accounting_basis", "missing_parameters", "duplicate_name", "duplicate_sort_code", "invalid_ledger_type", "invalid_ledger_report_cash_flow", "deleting_required_ledger", "repeated_tag_group", "deleting_transaction_line", "modifying_read_only_ledger", "debits_credits_not_equal", "modifying_opening_balance_journal_entry", "modifying_accrual_journal_entry", "modifying_payment_application_journal_entry", "deleting_accrual_linked_journal_entry", "selecting_opening_balance_ledger", "invalid_deferral_ledger", "payment_exceeds_amount_remaining", "line_entry_already_applied", "payment_total_mismatch", "accrual_source_not_payable", "accrual_source_not_found", "line_entry_direction_mismatch", "duplicate_statement_ending_date", "reconciliation_in_progress", "reconciliation_gap", "reconciliation_overlap", "reconciled_balance_does_not_match", "journal_entry_outside_reconciliation_period", "parsed_statement_balance_mismatch", "entries_start_date_after_transactions", "entries_start_date_after_reconciliations", "entries_start_date_after_journal_entries" ], "title": "TealErrorCode" }, "TealErrorResponse": { "properties": { "message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Message", "description": "A description of the error for API developers." }, "data": { "title": "Data", "description": "Data associated with the error." }, "display_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Display Message", "description": "A description of the error for end users." }, "error_code": { "anyOf": [{ "$ref": "#/components/schemas/TealErrorCode" }, { "type": "null" }], "description": "Error code associated with the error." } }, "type": "object", "required": ["message"], "title": "TealErrorResponse" }, "TopExpenses": { "properties": { "entries": { "items": { "$ref": "#/components/schemas/TopExpensesEntry" }, "type": "array", "title": "Entries", "description": "A list of the top highest `expense` type ledgers within the period.", "examples": [ [ { "ledger_amount": 182521.96, "ledger_id": "Qm6MjL7pKRPhoUD3dZsPH1", "ledger_name": "Contract Labor Expense", "percent_total": 56.85 }, { "ledger_amount": 44809.92, "ledger_id": "GDKCCTVMjrAb6FUDBJPUB4", "ledger_name": "Cost Of Goods Sold", "percent_total": 13.96 }, { "ledger_amount": 36256.44, "ledger_id": "AfnWQVE4iXuNd91iyceCJt", "ledger_name": "Advertising Expense", "percent_total": 11.29 }, { "ledger_amount": 26400, "ledger_id": "BdEdx5xFGAWcwuwdtFGHpS", "ledger_name": "Rent Expense", "percent_total": 8.22 }, { "ledger_amount": 25727.86, "ledger_id": "LxokBiGqsNk9Yu3sLgFWz8", "ledger_name": "Gas and Auto Expense (Vehicle Expense)", "percent_total": 8.01 } ] ] } }, "type": "object", "required": ["entries"], "title": "TopExpenses" }, "TopExpensesEntry": { "properties": { "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ID of the Ledger object.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "ledger_name": { "type": "string", "title": "Ledger Name", "description": "The name of the ledger.", "examples": ["Payroll Expense"] }, "percent_total": { "type": "number", "title": "Percent Total", "description": "The percent of total expenses.", "examples": ["83"] }, "ledger_amount": { "type": "number", "title": "Ledger Amount", "description": "The sum, in decimal dollar cents, of all line entries in the ledger.", "examples": ["17080.110000000000582076609134674072265625"] } }, "type": "object", "required": ["ledger_id", "ledger_name", "percent_total", "ledger_amount"], "title": "TopExpensesEntry" }, "Transaction": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique ID of the object. This is used as an idempotency \n key to prevent duplicates. This is manually set as part of the create \n transactions request. If the transaction is created via a data integration, \n Plaid for example, it will be set to the `transaction_id` to enforce \n idempotency with the data source.", "examples": ["t_9237232"] }, "amount": { "type": "number", "title": "Amount", "description": "The value of the transaction in decimal dollar cents.", "examples": [132629.38] }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "The UTC datetime that the Transaction was created. This\n will never be before an Instance's `entries_start` date. When importing \n transactions, transactions whose datetime is before the Instance’s \n `entries_start` date will be skipped. Other transactions will be processed \n as normal.", "examples": ["2024-03-15T15:28:53Z"] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "An arbitrary string on the object, useful for\n displaying information to the user. \n Descriptions over 512 characters will be truncated.", "examples": ["Payroll March 15 2024"] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "Arbitrary structured information about the transaction.\n This could be location of the transaction to display to the user or vendor \n information to use as part of a Platform or Instance categorization rule. \n Teal does not use metadata for any accounting purposes.", "examples": [null] }, "categorization_method": { "anyOf": [{ "$ref": "#/components/schemas/CategorizerType" }, { "type": "null" }], "description": "How the Transaction was assigned its \n category.\n\nSee the [categorization guide](https://docs.teal.dev/guides/platform/categorization/pipeline) \n for more details.", "examples": ["similarity"] }, "posted_status": { "$ref": "#/components/schemas/PostedStatus", "description": "Indicates if the corresponding journal entry and \n line entries for the transaction have been have been created. `deleted` \n indicates that the transaction is `posted` but the corresponding journal entry\n and line entries have been deleted.", "examples": ["posted"] }, "review_status": { "$ref": "#/components/schemas/ReviewStatus", "description": "Indicates if the transaction has been reviewed. \n See the [reviewing transactions](https://docs.teal.dev/guides/transactions/reviewing_transactions) \n for steps on how to use this.", "examples": ["reviewed"] }, "journal_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Journal Entry Id", "description": "The ID of the Journal Entry that the \n Transaction's Line Entry is associated with.", "examples": ["C4ocnUQze8kDwQ3EczkZXn"] }, "journal_entry": { "type": "null", "title": "Journal Entry", "description": "Expandable. The associated Journal Entry object.", "examples": [null] }, "source_account_id": { "type": "string", "title": "Source Account Id", "description": "The ID of the transaction source account\n where the transaction is stored." }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ID of the financial account ledger associated \n with the Transaction.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "ledger": { "type": "null", "title": "Ledger", "description": "Expandable. The Ledger object of the financial \n account associated with the Transaction.", "examples": [null] }, "line_entry_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Line Entry Id", "description": "The ID of the financial account ledger associated \n with the Transaction.", "examples": ["XMDsKVuW4Wmi3LTW31Qw6E"] }, "line_entry": { "type": "null", "title": "Line Entry", "description": "Expandable. The associated Line Entry.", "examples": [null] }, "opposing_line_entry_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Opposing Line Entry Ids", "description": "A list of IDs of all the Line Entries \n objects in the journal entry with the opposite `debit_credit` status. For\n example if the Transaction's line entry is a debit this opposing line entries\n will be credit line entries.", "examples": [["NULcvXTkLczde32qs1rqgB"]] }, "opposing_line_entries": { "type": "null", "title": "Opposing Line Entries", "description": "Expandable. A list of the Line Entry objects\n with the opposite `debit_credit` status.", "examples": [null] }, "tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "A list of all the Tags associated with the Transaction, \n if any. Tags are transitive — the tags on a Transaction are applied to \n its corresponding Line Entry or Line Entries.", "examples": [null] }, "personal": { "type": "boolean", "title": "Personal", "description": "Deprecated. Always false.", "default": false, "deprecated": true, "examples": [false] } }, "type": "object", "required": [ "id", "amount", "datetime", "description", "posted_status", "review_status", "source_account_id" ], "title": "Transaction" }, "TransactionDeleteResult": { "properties": { "transaction_id": { "type": "string", "title": "Transaction Id", "description": "The transaction ID that was processed" }, "success": { "type": "boolean", "title": "Success", "description": "Whether the transaction was successfully deleted" }, "error": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Error", "description": "Error message if deletion failed" } }, "type": "object", "required": ["transaction_id", "success", "error"], "title": "TransactionDeleteResult" }, "TransactionExpandPath": { "type": "string", "enum": [ "ledger", "line_entry", "journal_entry", "opposing_line_entries", "opposing_line_entries.ledger", "autocat_result" ], "title": "TransactionExpandPath" }, "TransactionLine": { "properties": { "amount": { "anyOf": [ { "type": "number", "maximum": 1000000000000000000, "minimum": -1000000000000000000 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Amount", "description": "The amount for this line item", "examples": [1000] }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "Description for this line item", "examples": ["Office supplies"] }, "ledger_id": { "type": "string", "title": "Ledger Id", "description": "The ledger ID for this line item", "examples": ["HLn8oy2eqMUCwjp1Cwdgco"] } }, "type": "object", "required": ["amount", "description", "ledger_id"], "title": "TransactionLine" }, "TransactionPage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/ExpandableTransaction" }, "type": "array", "title": "Records", "description": "A list of Transaction objects" } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "TransactionPage" }, "TransactionProcessingStatus": { "type": "string", "enum": ["pending", "posted", "complete", "failed"], "title": "TransactionProcessingStatus" }, "TransactionSort": { "type": "string", "enum": ["description", "-description", "datetime", "-datetime"], "title": "TransactionSort" }, "TransactionSource": { "properties": { "id": { "type": "string", "title": "Id", "examples": ["UjL3BQnEaJtecuC7CUeDk"] }, "type": { "$ref": "#/components/schemas/SourceType", "examples": ["plaid"] }, "date": { "type": "string", "format": "date-time", "title": "Date", "description": "The date the token was last updated.", "examples": ["2022-01-01T00:00:00Z"] }, "enabled": { "type": "boolean", "title": "Enabled", "description": "If the transaction source is active" } }, "type": "object", "required": ["id", "type", "date", "enabled"], "title": "TransactionSource" }, "TransactionSourceInitialized": { "properties": { "event_type": { "type": "string", "const": "transaction.source.initialized", "title": "Event Type", "default": "transaction.source.initialized" }, "instance_id": { "type": "string", "title": "Instance Id", "description": "The instance ID.", "examples": ["6r9B18rN8xv6eE8c1q1Aqk"] }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ledger ID.", "examples": ["9jXyj7EpZNizehSd9wJN3G"] }, "source_account_id": { "type": "string", "title": "Source Account Id", "description": "The transaction source account ID.", "examples": ["7Ae95WZGvGLuaM7LaU7Fon"] } }, "type": "object", "required": ["instance_id", "ledger_id", "source_account_id"], "title": "TransactionSourceInitialized" }, "TransactionSourceProcessingComplete": { "properties": { "event_type": { "type": "string", "const": "transaction.source.processing.complete", "title": "Event Type", "default": "transaction.source.processing.complete" }, "txn_processing_task_id": { "type": "string", "title": "Txn Processing Task Id", "description": "The transaction processing task ID.", "examples": ["ApXpZNPKL1PGmat2DizAzD"] }, "instance_id": { "type": "string", "title": "Instance Id", "description": "The instance ID.", "examples": ["6r9B18rN8xv6eE8c1q1Aqk"] }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ledger ID.", "examples": ["9jXyj7EpZNizehSd9wJN3G"] }, "source_account_id": { "type": "string", "title": "Source Account Id", "description": "The transaction source account ID.", "examples": ["7Ae95WZGvGLuaM7LaU7Fon"] } }, "type": "object", "required": ["txn_processing_task_id", "instance_id", "ledger_id", "source_account_id"], "title": "TransactionSourceProcessingComplete" }, "TransactionSourceProcessingError": { "properties": { "event_type": { "type": "string", "const": "transaction.source.processing.error", "title": "Event Type", "default": "transaction.source.processing.error" }, "txn_processing_task_id": { "type": "string", "title": "Txn Processing Task Id", "description": "The transaction processing task ID.", "examples": ["ApXpZNPKL1PGmat2DizAzD"] }, "instance_id": { "type": "string", "title": "Instance Id", "description": "The Teal instance ID.", "examples": ["6r9B18rN8xv6eE8c1q1Aqk"] }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ledger ID.", "examples": ["9jXyj7EpZNizehSd9wJN3G"] }, "source_account_id": { "type": "string", "title": "Source Account Id", "description": "The transaction source account ID.", "examples": ["7Ae95WZGvGLuaM7LaU7Fon"] }, "transaction_source_error": { "anyOf": [ { "$ref": "#/components/schemas/GeneralError" }, { "$ref": "#/components/schemas/PlaidError-Input" } ], "title": "Transaction Source Error" } }, "type": "object", "required": [ "txn_processing_task_id", "instance_id", "ledger_id", "source_account_id", "transaction_source_error" ], "title": "TransactionSourceProcessingError" }, "TransactionSourceUpdate": { "properties": { "enabled": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Enabled", "description": "Toggles the enabled state of the transaction source." }, "auth_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Auth Token", "description": "A new auth token. For Plaid sources this will be a p token." }, "sync_from": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Sync From", "description": "The datetime to sync transactions from. Transaction changes received before this datetime will be ignored." } }, "type": "object", "title": "TransactionSourceUpdate" }, "TransactionUpdate": { "properties": { "description": { "anyOf": [{ "type": "string", "maxLength": 512 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for\n displaying information to the user. \n Descriptions over 512 characters will be truncated." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "Arbitrary structured information about the transaction.\n This could be location of the transaction to display to the user or vendor \n information to use as part of a Platform or Instance categorization rule. \n Teal does not use metadata for any accounting purposes." }, "review_status": { "anyOf": [{ "$ref": "#/components/schemas/ReviewStatus" }, { "type": "null" }], "description": "Indicates if the transaction has been reviewed. \n See the [reviewing transactions](https://docs.teal.dev/guides/transactions/reviewing_transactions) \n for steps on how to use this.", "examples": ["reviewed"] }, "tag_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Tag Ids", "description": "An array of IDs of the Tag objects associated with \n the Transaction.\n\nTags are transitive — the tags on a Transaction are \n applied to its corresponding Line Entry or Line Entries." } }, "type": "object", "title": "TransactionUpdate" }, "TransactionUpdateMultiple": { "properties": { "transactions": { "items": { "$ref": "#/components/schemas/TransactionUpdateWithId" }, "type": "array", "maxItems": 100, "title": "Transactions", "description": "List of transactions to update. Limit 100." } }, "type": "object", "required": ["transactions"], "title": "TransactionUpdateMultiple" }, "TransactionUpdateWithId": { "properties": { "description": { "anyOf": [{ "type": "string", "maxLength": 512 }, { "type": "null" }], "title": "Description", "description": "An arbitrary string on the object, useful for\n displaying information to the user. \n Descriptions over 512 characters will be truncated." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "Arbitrary structured information about the transaction.\n This could be location of the transaction to display to the user or vendor \n information to use as part of a Platform or Instance categorization rule. \n Teal does not use metadata for any accounting purposes." }, "review_status": { "anyOf": [{ "$ref": "#/components/schemas/ReviewStatus" }, { "type": "null" }], "description": "Indicates if the transaction has been reviewed. \n See the [reviewing transactions](https://docs.teal.dev/guides/transactions/reviewing_transactions) \n for steps on how to use this.", "examples": ["reviewed"] }, "tag_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Tag Ids", "description": "An array of IDs of the Tag objects associated with \n the Transaction.\n\nTags are transitive — the tags on a Transaction are \n applied to its corresponding Line Entry or Line Entries." }, "id": { "type": "string", "title": "Id", "description": "The unique ID of the object. This is used as an idempotency \n key to prevent duplicates. This is manually set as part of the create \n transactions request. If the transaction is created via a data integration, \n Plaid for example, it will be set to the `transaction_id` to enforce \n idempotency with the data source." } }, "type": "object", "required": ["id"], "title": "TransactionUpdateWithId" }, "Transfer": { "properties": { "id": { "type": "string", "title": "Id", "description": "The id of the transfer." }, "from_entry": { "$ref": "#/components/schemas/TransferEntry", "description": "The 'from' side of the transfer." }, "to_entry": { "$ref": "#/components/schemas/TransferEntry", "description": "The 'to' side of the transfer." } }, "type": "object", "required": ["id", "from_entry", "to_entry"], "title": "Transfer" }, "TransferEntry": { "properties": { "journal_entry_id": { "type": "string", "title": "Journal Entry Id", "description": "The id of this side's Journal Entry." }, "description": { "type": "string", "title": "Description", "description": "This side's Journal Entry description." }, "datetime": { "type": "string", "format": "date-time", "title": "Datetime", "description": "This side's Journal Entry datetime." }, "line_entries": { "items": { "$ref": "#/components/schemas/DetailedLineEntry" }, "type": "array", "title": "Line Entries", "description": "This side's Line Entries (used to derive the amount and source account)." } }, "type": "object", "required": ["journal_entry_id", "description", "datetime", "line_entries"], "title": "TransferEntry", "description": "One side of a transfer: a journal entry summary with its line entries,\nenough to render a linked-transfer row (amount, account, description, date)\nwithout a second request." }, "TrendGranularity": { "type": "string", "enum": ["daily", "weekly", "monthly", "quarterly", "yearly"], "title": "TrendGranularity", "description": "Bucket size for trend time series.\n\nSuperset of ``Period``: adds ``weekly`` (ISO Monday-start weeks), which the\npartition helpers do not support." }, "TxnProcessingPipeline": { "type": "string", "enum": ["internal", "external", "disabled"], "title": "TxnProcessingPipeline" }, "TxnProcessingTask": { "properties": { "id": { "type": "string", "title": "Id", "examples": ["UjL3BQnEaJtecuC7CUeDk"] }, "status": { "$ref": "#/components/schemas/TransactionProcessingStatus", "description": "Status of the transaction processing task", "examples": ["pending"] }, "created_datetime": { "type": "string", "format": "date-time", "title": "Created Datetime", "description": "Indicates the datetime in UTC when the \n task was created.", "examples": ["2024-01-01T00:00:00Z"] }, "updated_datetime": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Updated Datetime", "description": "Indicates the datetime in UTC when the \n task was last updated.", "examples": ["2024-01-01T00:00:00Z"] }, "error": { "anyOf": [ { "$ref": "#/components/schemas/PlaidError-Output" }, { "$ref": "#/components/schemas/GeneralError" }, { "type": "null" } ], "title": "Error", "description": "The Error object if any errors were encountered in the\n processing. If the processing task was created by a Plaid import, the Plaid\n errors will be passed through there. See [Plaid's documentation](https://plaid.com/docs/errors/)\n for more information on their error messages.", "examples": [null] }, "source_account_id": { "type": "string", "title": "Source Account Id", "description": "The source account containing the transactions" }, "task_type": { "$ref": "#/components/schemas/TxnProcessingTaskType", "description": "Type of transaction processing task" }, "ledger_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ledger Id", "description": "The ID of the ledger that the transactions are being\n created for.", "examples": ["7JRNsKwy2Lw66caxVU7WGC"] }, "created_transaction_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Created Transaction Ids", "description": "The IDs of Transactions successfully \n processed by this task." }, "removed_transaction_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Removed Transaction Ids", "description": "The IDs of Transactions that were \n removed by this task." }, "modified_transaction_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Modified Transaction Ids", "description": "The IDs of Transactions that were \n modified by this task." }, "skipped_transaction_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Skipped Transaction Ids", "description": "The IDs of Transactions that were\n skipped by this task." }, "failed_transaction_ids": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Failed Transaction Ids", "description": "The IDs of Transactions that failed\n to process in this task." } }, "type": "object", "required": [ "id", "status", "created_datetime", "updated_datetime", "error", "source_account_id", "task_type", "ledger_id" ], "title": "TxnProcessingTask" }, "TxnProcessingTaskPage": { "properties": { "next_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the next page", "examples": ["ikal0NEVfMhF8dJf4yQ6KQZmGD"] }, "prev_page_token": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The token to use to request the previous page", "examples": ["vuA7JeKI5c6FLnPt5JfRcZcJxW"] }, "records": { "items": { "$ref": "#/components/schemas/TxnProcessingTask" }, "type": "array", "title": "Records", "description": "A list of Transaction Processing Tasks" } }, "type": "object", "required": ["next_page_token", "prev_page_token", "records"], "title": "TxnProcessingTaskPage" }, "TxnProcessingTaskSort": { "type": "string", "enum": ["created_datetime", "-created_datetime"], "title": "TxnProcessingTaskSort" }, "TxnProcessingTaskType": { "type": "string", "enum": [ "import_transactions", "recategorization", "delete_date_range", "process_aged_unposted", "retry_unposted", "legacy" ], "title": "TxnProcessingTaskType" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": ["loc", "msg", "type"], "title": "ValidationError" } }, "securitySchemes": { "OAuth2PasswordBearer": { "type": "oauth2", "description": "Bearer authentication header of the form Bearer , where is your auth token.", "flows": { "password": { "scopes": {}, "tokenUrl": "https://developer.teal.dev" } } } } } }