List all Journal Entries

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "<string>",
      "description": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "creation_date": "2023-11-07T05:31:56Z",
      "is_opening_balance": true,
      "line_entry_ids": [
        "XMDsKVuW4Wmi3LTW31Qw6E",
        "NULcvXTkLczde32qs1rqgB"
      ],
      "linked_entity": null,
      "line_entries": [
        {
          "amount": 31282.28,
          "categorization_status": "completed",
          "datetime": "2023-02-15T06:42:18Z",
          "debit_credit": "debit",
          "description": "Payroll#230215",
          "editable": false,
          "id": "XMDsKVuW4Wmi3LTW31Qw6E",
          "journal_entry_description": "Payroll#230215",
          "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
          "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
          "ledger_name": "Pluto Checking 4242",
          "sort_order": 1,
          "tags": [],
          "transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
        },
        {
          "amount": 31282.28,
          "categorization_status": "completed",
          "datetime": "2023-02-15T06:42:18Z",
          "debit_credit": "credit",
          "description": "Payroll#230215",
          "editable": false,
          "id": "NULcvXTkLczde32qs1rqgB",
          "journal_entry_description": "Payroll#230215",
          "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
          "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
          "ledger_name": "Payroll Expense",
          "sort_order": 2,
          "tags": []
        }
      ],
      "accrual_source": {
        "id": "<string>",
        "instance_id": "<string>",
        "reference_number": "<string>",
        "effective_date": "2023-12-25",
        "gross_amount": 123,
        "amount_paid": 123,
        "amount_adjusted": 123,
        "amount_outstanding": 123,
        "external_id": "<string>",
        "external_party_id": "<string>",
        "due_date": "2023-12-25",
        "notes": "<string>",
        "service_period_start": "2023-12-25",
        "service_period_end": "2023-12-25",
        "lines": [
          {
            "id": "<string>",
            "accrual_source_id": "<string>",
            "account_id": "<string>",
            "line_number": 123,
            "description": "<string>",
            "amount": 123,
            "external_id": "<string>"
          }
        ],
        "journal_entry_ids": [],
        "files": [
          {
            "id": "<string>",
            "file_name": "<string>"
          }
        ],
        "payment_applications": [
          {
            "payment_application_id": "<string>",
            "matched_amount": 123,
            "line_entry": {
              "line_entry_id": "<string>",
              "line_entry_description": "<string>",
              "line_entry_amount": 123,
              "journal_entry_id": "<string>",
              "journal_entry_description": "<string>"
            },
            "adjustments": [
              {
                "accrual_adjustment_id": "<string>",
                "debit_account_id": "<string>",
                "credit_account_id": "<string>",
                "amount": 123
              }
            ]
          }
        ]
      },
      "transfer": {
        "id": "<string>",
        "from_entry": {
          "journal_entry_id": "<string>",
          "description": "<string>",
          "datetime": "2023-11-07T05:31:56Z",
          "line_entries": [
            {
              "amount": 123,
              "ledger_id": "<string>",
              "id": "XMDsKVuW4Wmi3LTW31Qw6E",
              "datetime": "2023-11-07T05:31:56Z",
              "editable": true,
              "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
              "journal_entry_description": "<string>",
              "ledger_name": "<string>",
              "description": "Payroll#230215",
              "related_line_entry_id": "<string>",
              "transaction_id": "<string>",
              "sort_order": 1,
              "journal_entry": null,
              "ledger": null,
              "opposing_ledger_ids": [
                "<string>"
              ],
              "tags": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "tag_group_id": "<string>"
                }
              ],
              "transaction": null,
              "payment_applications": [
                {
                  "payment_application_id": "<string>",
                  "matched_amount": 123,
                  "accrual_source": {
                    "accrual_source_id": "<string>",
                    "external_id": "<string>",
                    "external_party_id": "<string>",
                    "reference_number": "<string>",
                    "effective_date": "2023-12-25",
                    "gross_amount": 123
                  },
                  "adjustments": [
                    {
                      "accrual_adjustment_id": "<string>",
                      "debit_account_id": "<string>",
                      "credit_account_id": "<string>",
                      "amount": 123
                    }
                  ]
                }
              ],
              "accrual_source": {
                "id": "<string>",
                "instance_id": "<string>",
                "reference_number": "<string>",
                "effective_date": "2023-12-25",
                "gross_amount": 123,
                "amount_paid": 123,
                "amount_adjusted": 123,
                "amount_outstanding": 123,
                "external_id": "<string>",
                "external_party_id": "<string>",
                "due_date": "2023-12-25",
                "notes": "<string>",
                "service_period_start": "2023-12-25",
                "service_period_end": "2023-12-25",
                "lines": [
                  {
                    "id": "<string>",
                    "accrual_source_id": "<string>",
                    "account_id": "<string>",
                    "line_number": 123,
                    "description": "<string>",
                    "amount": 123,
                    "external_id": "<string>"
                  }
                ]
              }
            }
          ]
        },
        "to_entry": {
          "journal_entry_id": "<string>",
          "description": "<string>",
          "datetime": "2023-11-07T05:31:56Z",
          "line_entries": [
            {
              "amount": 123,
              "ledger_id": "<string>",
              "id": "XMDsKVuW4Wmi3LTW31Qw6E",
              "datetime": "2023-11-07T05:31:56Z",
              "editable": true,
              "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
              "journal_entry_description": "<string>",
              "ledger_name": "<string>",
              "description": "Payroll#230215",
              "related_line_entry_id": "<string>",
              "transaction_id": "<string>",
              "sort_order": 1,
              "journal_entry": null,
              "ledger": null,
              "opposing_ledger_ids": [
                "<string>"
              ],
              "tags": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "tag_group_id": "<string>"
                }
              ],
              "transaction": null,
              "payment_applications": [
                {
                  "payment_application_id": "<string>",
                  "matched_amount": 123,
                  "accrual_source": {
                    "accrual_source_id": "<string>",
                    "external_id": "<string>",
                    "external_party_id": "<string>",
                    "reference_number": "<string>",
                    "effective_date": "2023-12-25",
                    "gross_amount": 123
                  },
                  "adjustments": [
                    {
                      "accrual_adjustment_id": "<string>",
                      "debit_account_id": "<string>",
                      "credit_account_id": "<string>",
                      "amount": 123
                    }
                  ]
                }
              ],
              "accrual_source": {
                "id": "<string>",
                "instance_id": "<string>",
                "reference_number": "<string>",
                "effective_date": "2023-12-25",
                "gross_amount": 123,
                "amount_paid": 123,
                "amount_adjusted": 123,
                "amount_outstanding": 123,
                "external_id": "<string>",
                "external_party_id": "<string>",
                "due_date": "2023-12-25",
                "notes": "<string>",
                "service_period_start": "2023-12-25",
                "service_period_end": "2023-12-25",
                "lines": [
                  {
                    "id": "<string>",
                    "accrual_source_id": "<string>",
                    "account_id": "<string>",
                    "line_number": 123,
                    "description": "<string>",
                    "amount": 123,
                    "external_id": "<string>"
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

GET

journal-entries

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "<string>",
      "description": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "creation_date": "2023-11-07T05:31:56Z",
      "is_opening_balance": true,
      "line_entry_ids": [
        "XMDsKVuW4Wmi3LTW31Qw6E",
        "NULcvXTkLczde32qs1rqgB"
      ],
      "linked_entity": null,
      "line_entries": [
        {
          "amount": 31282.28,
          "categorization_status": "completed",
          "datetime": "2023-02-15T06:42:18Z",
          "debit_credit": "debit",
          "description": "Payroll#230215",
          "editable": false,
          "id": "XMDsKVuW4Wmi3LTW31Qw6E",
          "journal_entry_description": "Payroll#230215",
          "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
          "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
          "ledger_name": "Pluto Checking 4242",
          "sort_order": 1,
          "tags": [],
          "transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
        },
        {
          "amount": 31282.28,
          "categorization_status": "completed",
          "datetime": "2023-02-15T06:42:18Z",
          "debit_credit": "credit",
          "description": "Payroll#230215",
          "editable": false,
          "id": "NULcvXTkLczde32qs1rqgB",
          "journal_entry_description": "Payroll#230215",
          "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
          "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
          "ledger_name": "Payroll Expense",
          "sort_order": 2,
          "tags": []
        }
      ],
      "accrual_source": {
        "id": "<string>",
        "instance_id": "<string>",
        "reference_number": "<string>",
        "effective_date": "2023-12-25",
        "gross_amount": 123,
        "amount_paid": 123,
        "amount_adjusted": 123,
        "amount_outstanding": 123,
        "external_id": "<string>",
        "external_party_id": "<string>",
        "due_date": "2023-12-25",
        "notes": "<string>",
        "service_period_start": "2023-12-25",
        "service_period_end": "2023-12-25",
        "lines": [
          {
            "id": "<string>",
            "accrual_source_id": "<string>",
            "account_id": "<string>",
            "line_number": 123,
            "description": "<string>",
            "amount": 123,
            "external_id": "<string>"
          }
        ],
        "journal_entry_ids": [],
        "files": [
          {
            "id": "<string>",
            "file_name": "<string>"
          }
        ],
        "payment_applications": [
          {
            "payment_application_id": "<string>",
            "matched_amount": 123,
            "line_entry": {
              "line_entry_id": "<string>",
              "line_entry_description": "<string>",
              "line_entry_amount": 123,
              "journal_entry_id": "<string>",
              "journal_entry_description": "<string>"
            },
            "adjustments": [
              {
                "accrual_adjustment_id": "<string>",
                "debit_account_id": "<string>",
                "credit_account_id": "<string>",
                "amount": 123
              }
            ]
          }
        ]
      },
      "transfer": {
        "id": "<string>",
        "from_entry": {
          "journal_entry_id": "<string>",
          "description": "<string>",
          "datetime": "2023-11-07T05:31:56Z",
          "line_entries": [
            {
              "amount": 123,
              "ledger_id": "<string>",
              "id": "XMDsKVuW4Wmi3LTW31Qw6E",
              "datetime": "2023-11-07T05:31:56Z",
              "editable": true,
              "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
              "journal_entry_description": "<string>",
              "ledger_name": "<string>",
              "description": "Payroll#230215",
              "related_line_entry_id": "<string>",
              "transaction_id": "<string>",
              "sort_order": 1,
              "journal_entry": null,
              "ledger": null,
              "opposing_ledger_ids": [
                "<string>"
              ],
              "tags": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "tag_group_id": "<string>"
                }
              ],
              "transaction": null,
              "payment_applications": [
                {
                  "payment_application_id": "<string>",
                  "matched_amount": 123,
                  "accrual_source": {
                    "accrual_source_id": "<string>",
                    "external_id": "<string>",
                    "external_party_id": "<string>",
                    "reference_number": "<string>",
                    "effective_date": "2023-12-25",
                    "gross_amount": 123
                  },
                  "adjustments": [
                    {
                      "accrual_adjustment_id": "<string>",
                      "debit_account_id": "<string>",
                      "credit_account_id": "<string>",
                      "amount": 123
                    }
                  ]
                }
              ],
              "accrual_source": {
                "id": "<string>",
                "instance_id": "<string>",
                "reference_number": "<string>",
                "effective_date": "2023-12-25",
                "gross_amount": 123,
                "amount_paid": 123,
                "amount_adjusted": 123,
                "amount_outstanding": 123,
                "external_id": "<string>",
                "external_party_id": "<string>",
                "due_date": "2023-12-25",
                "notes": "<string>",
                "service_period_start": "2023-12-25",
                "service_period_end": "2023-12-25",
                "lines": [
                  {
                    "id": "<string>",
                    "accrual_source_id": "<string>",
                    "account_id": "<string>",
                    "line_number": 123,
                    "description": "<string>",
                    "amount": 123,
                    "external_id": "<string>"
                  }
                ]
              }
            }
          ]
        },
        "to_entry": {
          "journal_entry_id": "<string>",
          "description": "<string>",
          "datetime": "2023-11-07T05:31:56Z",
          "line_entries": [
            {
              "amount": 123,
              "ledger_id": "<string>",
              "id": "XMDsKVuW4Wmi3LTW31Qw6E",
              "datetime": "2023-11-07T05:31:56Z",
              "editable": true,
              "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
              "journal_entry_description": "<string>",
              "ledger_name": "<string>",
              "description": "Payroll#230215",
              "related_line_entry_id": "<string>",
              "transaction_id": "<string>",
              "sort_order": 1,
              "journal_entry": null,
              "ledger": null,
              "opposing_ledger_ids": [
                "<string>"
              ],
              "tags": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "tag_group_id": "<string>"
                }
              ],
              "transaction": null,
              "payment_applications": [
                {
                  "payment_application_id": "<string>",
                  "matched_amount": 123,
                  "accrual_source": {
                    "accrual_source_id": "<string>",
                    "external_id": "<string>",
                    "external_party_id": "<string>",
                    "reference_number": "<string>",
                    "effective_date": "2023-12-25",
                    "gross_amount": 123
                  },
                  "adjustments": [
                    {
                      "accrual_adjustment_id": "<string>",
                      "debit_account_id": "<string>",
                      "credit_account_id": "<string>",
                      "amount": 123
                    }
                  ]
                }
              ],
              "accrual_source": {
                "id": "<string>",
                "instance_id": "<string>",
                "reference_number": "<string>",
                "effective_date": "2023-12-25",
                "gross_amount": 123,
                "amount_paid": 123,
                "amount_adjusted": 123,
                "amount_outstanding": 123,
                "external_id": "<string>",
                "external_party_id": "<string>",
                "due_date": "2023-12-25",
                "notes": "<string>",
                "service_period_start": "2023-12-25",
                "service_period_end": "2023-12-25",
                "lines": [
                  {
                    "id": "<string>",
                    "accrual_source_id": "<string>",
                    "account_id": "<string>",
                    "line_number": 123,
                    "description": "<string>",
                    "amount": 123,
                    "external_id": "<string>"
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer , where is your auth token.

Headers

teal-instance-id

string

required

The Teal instance ID

Query Parameters

start_date

string<date> | null

Only return Journal Entries after the start date (inclusive). Must be in YYYY-MM-DD format.

end_date

string<date> | null

Only return Journal Entries before the end date (inclusive). Must be in YYYY-MM-DD format.

time_zone

enum<string>

default:UTC

Time Zone Identifier

Available options:

Africa/Abidjan,

Africa/Accra,

Africa/Addis_Ababa,

Africa/Algiers,

Africa/Asmara,

Africa/Asmera,

Africa/Bamako,

Africa/Bangui,

Africa/Banjul,

Africa/Bissau,

Africa/Blantyre,

Africa/Brazzaville,

Africa/Bujumbura,

Africa/Cairo,

Africa/Casablanca,

Africa/Ceuta,

Africa/Conakry,

Africa/Dakar,

Africa/Dar_es_Salaam,

Africa/Djibouti,

Africa/Douala,

Africa/El_Aaiun,

Africa/Freetown,

Africa/Gaborone,

Africa/Harare,

Africa/Johannesburg,

Africa/Juba,

Africa/Kampala,

Africa/Khartoum,

Africa/Kigali,

Africa/Kinshasa,

Africa/Lagos,

Africa/Libreville,

Africa/Lome,

Africa/Luanda,

Africa/Lubumbashi,

Africa/Lusaka,

Africa/Malabo,

Africa/Maputo,

Africa/Maseru,

Africa/Mbabane,

Africa/Mogadishu,

Africa/Monrovia,

Africa/Nairobi,

Africa/Ndjamena,

Africa/Niamey,

Africa/Nouakchott,

Africa/Ouagadougou,

Africa/Porto-Novo,

Africa/Sao_Tome,

Africa/Timbuktu,

Africa/Tripoli,

Africa/Tunis,

Africa/Windhoek,

America/Adak,

America/Anchorage,

America/Anguilla,

America/Antigua,

America/Araguaina,

America/Argentina/Buenos_Aires,

America/Argentina/Catamarca,

America/Argentina/ComodRivadavia,

America/Argentina/Cordoba,

America/Argentina/Jujuy,

America/Argentina/La_Rioja,

America/Argentina/Mendoza,

America/Argentina/Rio_Gallegos,

America/Argentina/Salta,

America/Argentina/San_Juan,

America/Argentina/San_Luis,

America/Argentina/Tucuman,

America/Argentina/Ushuaia,

America/Aruba,

America/Asuncion,

America/Atikokan,

America/Atka,

America/Bahia,

America/Bahia_Banderas,

America/Barbados,

America/Belem,

America/Belize,

America/Blanc-Sablon,

America/Boa_Vista,

America/Bogota,

America/Boise,

America/Buenos_Aires,

America/Cambridge_Bay,

America/Campo_Grande,

America/Cancun,

America/Caracas,

America/Catamarca,

America/Cayenne,

America/Cayman,

America/Chicago,

America/Chihuahua,

America/Ciudad_Juarez,

America/Coral_Harbour,

America/Cordoba,

America/Costa_Rica,

America/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

Minimum string length: 1

ledger_id

string | null

Only return Journal Entries where at least one Line Entry belongs to the specified Ledger.

creation_source

enum<string> | null

deprecated

Only return Journal Entries with the specified creation source. The source that created a journal entry.

manual: Created manually by the user via the UI.
transaction: Created automatically from a transaction categorization (e.g., Plaid sync).
accrual: Created automatically as part of an accrual workflow.
payment_application: Created automatically as part of a payment application workflow.
legacy: Created automatically from the old AR/AP system (receivables/payables).
scheduled_accrual: Created automatically by the background accrual schedule job.

Available options:

manual,

transaction,

accrual,

payment_application,

legacy,

scheduled_accrual

creation_sources

enum<string>[] | null

Only return Journal Entries with the specified creation sources.

The source that created a journal entry.

manual: Created manually by the user via the UI.
transaction: Created automatically from a transaction categorization (e.g., Plaid sync).
accrual: Created automatically as part of an accrual workflow.
payment_application: Created automatically as part of a payment application workflow.
legacy: Created automatically from the old AR/AP system (receivables/payables).
scheduled_accrual: Created automatically by the background accrual schedule job.

Available options:

manual,

transaction,

accrual,

payment_application,

legacy,

scheduled_accrual

keywords

string | null

Only return Journal Entries where the description matches the specified keyword(s).

Required string length: 3 - 100

amount

Only return journal entries with the specified monetary amount.

If specified, `min_amount` and `max_amount` parameters are ignored.

        If no decimal place provided, rounded values will be matched.
        E.g. an input of `100` will match 100.13 and 100.45, but an input of `100.13` will only match that value.

Required range: -1000000000000000000 <= x <= 1000000000000000000

min_amount

Only return journal entries with a monetary amount of at least the specified amount.

Ignored if `amount` is set.

Required range: -1000000000000000000 <= x <= 1000000000000000000

max_amount

Only return journal entries with a monetary amount less than specified amount.

Ignored if `amount` is set.

Required range: -1000000000000000000 <= x <= 1000000000000000000

sort

enum<string>[] | null

A comma separated list of sort orders for the results.

Available options:

description,

-description,

datetime,

-datetime

expand

enum<string>[] | null

Comma-separated list of expandable paths.

Available options:

accrual_source,

line_entries,

line_entries.transaction,

line_entries.ledger,

line_entries.opposing_ledger_ids,

line_entries.payment_applications,

transfer

tag_ids

string[] | null

Only return Journal Entries whose line entries collectively include all given Tags.

ids

string[] | null

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.

categorization_status

enum<string>[] | null

A comma separated list of categorization statuses ('pending', 'delayed', 'completed'). Only return Journal Entries whose categorization status matches one of the specified values.

Available options:

pending,

delayed,

completed

limit

integer

default:50

The number of records to return. Max limit is 1000.

Required range: x >= 1

page_token

string | null

Opaque page token

ledger_id_groups

string[] | null

One or more comma-separated lists of ledger IDs. Only return Journal Entries where at least one Line Entry belongs to one of the specified ledgers in a group. Specifying multiple groups will return an intersection of the matches.

Response

Successful Response

next_page_token

string | null

required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

prev_page_token

string | null

required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

records

ExpandableJournalEntry · object[]

required

List of journal entries

Show child attributes

Example:

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

Delete multiple Journal Entries Create a Journal Entry