{
  "opencollection": "1.0.0",
  "info": {
    "name": "Modern Treasury AccountCapability LedgerEntry API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "LedgerEntry",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "list ledger_entries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:3000/api/ledger_entries",
            "params": [
              {
                "name": "after_cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query"
              },
              {
                "name": "id[]",
                "value": "",
                "type": "query",
                "description": "If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`."
              },
              {
                "name": "ledger_account_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "ledger_transaction_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "ledger_account_payout_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "ledger_account_settlement_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "effective_date",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the transaction's effective date. Format YYYY-MM-DD"
              },
              {
                "name": "effective_at",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the transaction's effective time. Format ISO8601"
              },
              {
                "name": "updated_at",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use updated_at%5Bgt%5D=2000-01-01T12:00:00Z."
              },
              {
                "name": "as_of_lock_version",
                "value": "",
                "type": "query",
                "description": "Shows all ledger entries that were present on a ledger account at a particular `lock_version`. You must also specify `ledger_account_id`."
              },
              {
                "name": "ledger_account_lock_version",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the lock_version of a ledger account. For example, for all entries created at or before before lock_version 1000 of a ledger account, use `ledger_account_lock_version%5Blte%5D=1000`."
              },
              {
                "name": "ledger_account_category_id",
                "value": "",
                "type": "query",
                "description": "Get all ledger entries that match the direction specified. One of `credit`, `debit`."
              },
              {
                "name": "ledger_account_statement_id",
                "value": "",
                "type": "query",
                "description": "Get all ledger entries that are included in the ledger account statement."
              },
              {
                "name": "show_deleted",
                "value": "",
                "type": "query",
                "description": "If true, response will include ledger entries that were deleted. When you update a ledger transaction to specify a new set of entries, the previous entries are deleted."
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "If true, response will include ledger entries that were deleted. When you update a ledger transaction to specify a new set of entries, the previous entries are deleted."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Get all ledger entries that match the status specified. One of `pending`, `posted`, or `archived`. For multiple statuses, use `status[]=pending&status[]=posted`."
              },
              {
                "name": "status[]",
                "value": "",
                "type": "query",
                "description": "Get all ledger entries that match the status specified. One of `pending`, `posted`, or `archived`. For multiple statuses, use `status[]=pending&status[]=posted`."
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Order by `created_at` or `effective_at` in `asc` or `desc` order. For example, to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering by only one field at a time is supported."
              },
              {
                "name": "amount",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by amount."
              },
              {
                "name": "show_balances",
                "value": "",
                "type": "query",
                "description": "If true, response will include the balances attached to the ledger entry. If there is no balance available, null will be returned instead."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "For example, if you want to query for records with metadata key `Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a list of all ledger entries."
        },
        {
          "info": {
            "name": "get ledger_entry",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:3000/api/ledger_entries/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              },
              {
                "name": "show_balances",
                "value": "",
                "type": "query",
                "description": "If true, response will include the balances attached to the ledger entry. If there is no balance available, null will be returned instead."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get details on a single ledger entry."
        },
        {
          "info": {
            "name": "update ledger_entry",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:3000/api/ledger_entries/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update the details of a ledger entry."
        }
      ]
    }
  ],
  "bundled": true
}