Struct ListBudgetAccountsOptions 

#[non_exhaustive]
pub struct ListBudgetAccountsOptions {

    pub page: Option<u32>,
    pub limit: Option<u32>,
    pub cursor: Option<String>,
    pub shape: Option<String>,
    pub flat: bool,
    pub flat_lists: bool,
    pub federal_account_symbol: Option<String>,
    pub fiscal_year: Option<String>,
    pub fiscal_year_gte: Option<String>,
    pub fiscal_year_lte: Option<String>,
    pub agency_code: Option<String>,
    pub bureau_name: Option<String>,
    pub account_title: Option<String>,
    pub subfunction_code: Option<String>,
    pub bea_category: Option<String>,
    pub on_off_budget: Option<String>,
    pub search: Option<String>,
    pub ordering: Option<String>,
    pub extra: BTreeMap<String, String>,
}

Options for Client::list_budget_accounts and Client::iterate_budget_accounts.

The API rejects an unknown filter name with a 400 rather than ignoring it. The exact, __gte and __lte range filters on the numeric lifecycle and ratio fields (e.g. enacted_ba__gte), and the __in multi-value variants, are reachable via the extra map.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

page: Option<u32>

1-based page number. Mutually exclusive with cursor.

limit: Option<u32>

Page size (server caps at 100).

cursor: Option<String>

Keyset cursor.

shape: Option<String>

Comma-separated field selector. Use SHAPE_BUDGET_ACCOUNTS_MINIMAL or roll your own.

flat: bool

Collapse nested objects into dot-separated keys.

flat_lists: bool

When flat is also true, flatten list-valued fields.

federal_account_symbol: Option<String>

Federal account symbol filter (exact, e.g. "097-0100").

fiscal_year: Option<String>

fiscal_year filter (exact).

fiscal_year_gte: Option<String>

Lower bound for fiscal_year (inclusive).

fiscal_year_lte: Option<String>

Upper bound for fiscal_year (inclusive).

agency_code: Option<String>

Agency code filter (exact).

bureau_name: Option<String>

Bureau name filter (exact).

account_title: Option<String>

Case-insensitive substring match on the account title (sent as account_title__icontains).

subfunction_code: Option<String>

Budget subfunction code filter (exact).

bea_category: Option<String>

Bureau of Economic Analysis category filter (exact).

on_off_budget: Option<String>

On/off-budget flag filter (exact).

search: Option<String>

Free-text search filter.

ordering: Option<String>

Server-side sort spec (prefix - for descending).

extra: BTreeMap<String, String>

Escape hatch for filter keys not yet first-classed on this struct (e.g. the *_gte / *_lte range filters on the numeric metrics).

Implementations

impl ListBudgetAccountsOptions

pub fn builder() -> ListBudgetAccountsOptionsBuilder

Create an instance of ListBudgetAccountsOptions using the builder syntax

Trait Implementations

impl Clone for ListBudgetAccountsOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListBudgetAccountsOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListBudgetAccountsOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ListBudgetAccountsOptions

impl PartialEq for ListBudgetAccountsOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ListBudgetAccountsOptions