SearchQuery

@JsonClass(generateAdapter = true)
data class SearchQuery(    @Json(name = "accounts") var accounts: List<String>? = null,     @Json(name = "categories") var categories: List<String>? = null,     @Json(name = "externalIds") var externalIds: List<String>? = null,     @Json(name = "endDate") var endDate: Long? = null,     @Json(name = "limit") var limit: Int? = null,     @Json(name = "offset") var offset: Int? = null,     @Json(name = "order") var order: SearchQuery.OrderEnum? = null,     @Json(name = "queryString") var queryString: String? = null,     @Json(name = "sort") var sort: SearchQuery.SortEnum? = null,     @Json(name = "startDate") var startDate: Long? = null,     @Json(name = "includeUpcoming") var includeUpcoming: Boolean? = null)

Constructors

Link copied to clipboard
fun SearchQuery(    @Json(name = "accounts") accounts: List<String>? = null,     @Json(name = "categories") categories: List<String>? = null,     @Json(name = "externalIds") externalIds: List<String>? = null,     @Json(name = "endDate") endDate: Long? = null,     @Json(name = "limit") limit: Int? = null,     @Json(name = "offset") offset: Int? = null,     @Json(name = "order") order: SearchQuery.OrderEnum? = null,     @Json(name = "queryString") queryString: String? = null,     @Json(name = "sort") sort: SearchQuery.SortEnum? = null,     @Json(name = "startDate") startDate: Long? = null,     @Json(name = "includeUpcoming") includeUpcoming: Boolean? = null)

Types

Link copied to clipboard
@JsonClass(generateAdapter = false)
enum OrderEnum : Enum<SearchQuery.OrderEnum>

The order of the result. Values: ASC, DESC

Link copied to clipboard
@JsonClass(generateAdapter = false)
enum SortEnum : Enum<SearchQuery.SortEnum>

The sort order of the result. Values: SCORE, DATE, ACCOUNT, DESCRIPTION, AMOUNT, CATEGORY

Properties

Link copied to clipboard
@Json(name = "accounts")
var accounts: List<String>? = null

A list of account IDs to filter by.

Link copied to clipboard
@Json(name = "categories")
var categories: List<String>? = null

A list of category IDs to filter by. Could either be leaf node categories, such as the category ID corresponding to `expenses:food.restaurants`, or groups of categories, such as the category ID corresponding to `expenses:food`.

Link copied to clipboard
@Json(name = "endDate")
var endDate: Long? = null

The end date of the result.

Link copied to clipboard
@Json(name = "externalIds")
var externalIds: List<String>? = null

A list of external IDs to filter by.

Link copied to clipboard
@Json(name = "includeUpcoming")
var includeUpcoming: Boolean? = null

Indicates if result should include upcoming transactions.

Link copied to clipboard
@Json(name = "limit")
var limit: Int? = null

The limit for the result, used for paging. Defaults to 50 if not set or set to 0.

Link copied to clipboard
@Json(name = "offset")
var offset: Int? = null

The offset for the result, used for paging.

Link copied to clipboard
@Json(name = "order")
var order: SearchQuery.OrderEnum? = null

The order of the result.

Link copied to clipboard
@Json(name = "queryString")
var queryString: String? = null

The string query.

Link copied to clipboard
@Json(name = "sort")
var sort: SearchQuery.SortEnum? = null

The sort order of the result.

Link copied to clipboard
@Json(name = "startDate")
var startDate: Long? = null

The start date of the result.