Skip to main content

TransactionBatchFilter

Struct TransactionBatchFilter 

Source
pub struct TransactionBatchFilter {
Show 17 fields pub account_ids: Option<Vec<i64>>, pub accounting_period_id: i64, pub cost_center_ids: Option<Vec<i64>>, pub created_pid: Option<i64>, pub donator_ids: Option<Vec<i64>>, pub end_date: Option<NaiveDate>, pub exclude: Option<Vec<i64>>, pub exclude_ids: Option<Vec<i64>>, pub include: Option<Vec<i64>>, pub include_ids: Option<Vec<i64>>, pub is_donation: Option<bool>, pub is_immutable: Option<bool>, pub is_income: Option<bool>, pub order_by: Option<String>, pub query: Option<String>, pub start_date: Option<NaiveDate>, pub extra: Map<String, Value>,
}
Expand description

One accounting-period scope. Conditions within it are combined with AND; filter objects are combined with OR. Empty includeIds/excludeIds arrays impose no ID restriction. Exclusions apply only inside their own filter.

Fields§

§account_ids: Option<Vec<i64>>

Filter by account/contra account. All transactions match, where either account or contra account is in the list.

§accounting_period_id: i64

ID of accounting period to get master data for

§cost_center_ids: Option<Vec<i64>>

Filter by cost centers.

§created_pid: Option<i64>

Filter by person ID. Get all transactions the person has created. But only show those the user can see.

§donator_ids: Option<Vec<i64>>

Person IDs matching either donor or spouse, including donors of the original booking when matching cancellations.

§end_date: Option<NaiveDate>

Inclusive upper bound for documentDate.

§exclude: Option<Vec<i64>>
👎Deprecated:

deprecated in the ChurchTools API

Legacy alias for excludeIds. When both are present, this alias takes precedence.

§exclude_ids: Option<Vec<i64>>

Filter by ids to exclude.

§include: Option<Vec<i64>>
👎Deprecated:

deprecated in the ChurchTools API

Legacy alias for includeIds. When both are present, this alias takes precedence.

§include_ids: Option<Vec<i64>>

Filter by ids to include.

§is_donation: Option<bool>

Currently, either true or false selects bookings with a positive donor ID. Omit this parameter to include both donations and other bookings.

§is_immutable: Option<bool>

Filter transactions, whether transaction is immutable.

§is_income: Option<bool>

True selects a cash-asset debit account and a non-cash-asset credit account (income); false selects the reverse (expense). Transfers between two cash-asset accounts or two non-cash-asset accounts match neither value.

§order_by: Option<String>

Sort by document date, amount, modification time, document number, note, account number, contra-account number, cost-center number, donor name or receipt count. Date and modification time plus ID break ties where applicable. Document numbers use their stored text, numeric and split suffix parts. Allowed values: account, amount, bills, contra_account, cost_center, date, donator, modified, note, number.

§query: Option<String>

Search note, document number or amount. For amount matching, leading zeros and decimal separators are removed.

§start_date: Option<NaiveDate>

Inclusive lower bound for documentDate.

§extra: Map<String, Value>

Fields not described by the spec, e.g. instance-specific DB fields.

Trait Implementations§

Source§

impl Clone for TransactionBatchFilter

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TransactionBatchFilter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TransactionBatchFilter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TransactionBatchFilter

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TransactionBatchFilter

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for TransactionBatchFilter

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TransactionBatchFilter

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more