GET
/
api
/
external
/
v2
/
ledger_entries
{
  "current_page": 1,
  "items": [
    {
      "created_at": "2023-06-14T12:12:56.146343Z",
      "date": "2023-08-30",
      "id": 1,
      "journal_id": 123,
      "label": "Payment for Services",
      "ledger_attachment_filename": "filename.pdf",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    },
    {
      "created_at": "2023-06-14T12:12:56.146343Z",
      "date": "2023-08-30",
      "id": 1,
      "journal_id": 123,
      "label": "Payment for Services",
      "ledger_attachment_filename": "filename.pdf",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    }
  ],
  "per_page": 40,
  "total_items": 12,
  "total_pages": 5
}

Query Parameters

​
page
string

Items are paginated, this is the current page which will be returned. The page index is starting at 1.

Example:

"1"

​
per_page
string

Items are paginated. By default, you get 20 items per page. You can specify another number of items per page.

Example:

"20"

​
filter
string

You can choose to filter items on specific fields. Available fields and values:

  • updated_at, created_at, date: lt, lteq, gt, gteq, eq, not_eq
  • journal_id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
Example:

"[{\"field\": \"updated_at\", \"operator\": \"gteq\", \"value\": \"2024-01-01T17:10:09Z\"}]"

​
sort
string

You can choose to sort items on specific attributes Sort field may be prefixed with - for descending order. Example : updated_at will sort by ascending order, -updated_at will sort by descending order. Available fields : updated_at, created_at, date

Example:

"-updated_at"

Response

200
application/json

Returns a list of ledger entries. By default, entries from fiscal periods that are closed or frozen are excluded. However, if a 'date' filter is provided, it will return all entries within the specified date range, even if they fall within a closed or fro

The response is of type object.