Skip to main content

Transaction

Struct Transaction 

Source
pub struct Transaction {
Show 30 fields pub deprecated: TransactionDeprecated, pub account_id: i64, pub amount: i64, pub bills: Option<Vec<Bill>>, pub cash_discount_amount: Option<i64>, pub cash_discount_id: Option<i64>, pub contra_account_id: i64, pub contra_cost_center_id: Option<i64>, pub cost_center_id: Option<i64>, pub document_date: NaiveDate, pub document_number: String, pub donator: Option<DomainObjectPerson>, pub donator_id: Option<i64>, pub donator_spouse: Option<DomainObjectPerson>, pub donator_spouse_id: Option<i64>, pub id: i64, pub is_immutable: bool, pub is_synced: bool, pub is_waiver_of_reimbursement_of_expenses: bool, pub meta: MetaDataEntityId, pub note: Option<String>, pub permissions: Option<TransactionPermissions>, pub split_transaction_id: Option<i64>, pub storno_base_id: Option<i64>, pub storno_transaction_id: Option<i64>, pub tax_base_id: Option<i64>, pub tax_rate_id: Option<i64>, pub tax_transaction_id: Option<i64>, pub transaction_date: NaiveDate, pub extra: Map<String, Value>,
}
Expand description

A single accounting transaction (a booking). Every transaction posts a given amount between a debit account (accountId) and a credit account (contraAccountId) within one accounting period. Equal account IDs represent a transfer from costCenterId to contraCostCenterId. Monetary values are always integers in the currency’s smallest denomination (e.g. cents). A transaction that belongs to a split transaction references its parent via splitTransactionId and cannot be edited or deleted on its own.

Fields§

§deprecated: TransactionDeprecated

Compatibility marker mapping the deprecated donor ID fields to their replacements.

§account_id: i64

ID of the debit account the amount is posted to.

§amount: i64

Stored booking amount in minor currency units. When this is the main booking of a tax split, it excludes the separate taxTransactionId amount; add both amounts to obtain the gross input amount.

§bills: Option<Vec<Bill>>

Receipts attached to this booking, included when include[]=bills is requested.

§cash_discount_amount: Option<i64>

Granted cash discount in the currency’s smallest denomination (e.g. cents). null if no cash discount applies.

§cash_discount_id: Option<i64>

ID of the applied cash discount, or null if none.

§contra_account_id: i64

ID of the credit (contra) account the amount is posted from.

§contra_cost_center_id: Option<i64>

ID of the target cost center for a cost center transfer. Required when accountId and contraAccountId are equal, otherwise it must be null.

§cost_center_id: Option<i64>

ID of the assigned cost center, or null if none. For a cost center transfer this is the source cost center.

§document_date: NaiveDate

Document date of the booking. Used for accounting-period validation, date filters and accounting reports.

§document_number: String

Document number of the transaction. Auto-generated when the accounting period increments document numbers, otherwise required on creation.

§donator: Option<DomainObjectPerson>

Resolved donor person, or null when no person has been resolved. Without donor visibility the response contains a censored person placeholder.

§donator_id: Option<i64>
👎Deprecated:

deprecated in the ChurchTools API

Deprecated: use donator instead.

§donator_spouse: Option<DomainObjectPerson>

Resolved spouse for joint donation receipts, or null. Without donor visibility the response contains a censored person placeholder.

§donator_spouse_id: Option<i64>
👎Deprecated:

deprecated in the ChurchTools API

Deprecated: use donatorSpouse instead.

§id: i64

Unique ID of the transaction.

§is_immutable: bool

If a transaction is immutable, none of its fields can be changed and it cannot be deleted (it has been finalized/locked).

§is_synced: bool

True, if the transaction has been created through a sync.

§is_waiver_of_reimbursement_of_expenses: bool

True, if this transaction is a waiver of reimbursement of expenses (“Aufwandsspende”).

§meta: MetaDataEntityId§note: Option<String>

Free-text booking note. Null when unset or hidden because the current user may view the transaction but not its donor information.

§permissions: Option<TransactionPermissions>

Permissions calculated for the current caller, or null when this booking was serialized without a permission collection, for example a newly generated tax child.

§split_transaction_id: Option<i64>

ID of the parent split transaction, or null if this is a normal standalone transaction.

§storno_base_id: Option<i64>

Reference to the transaction which gets stornoed by this transaction.

§storno_transaction_id: Option<i64>

Reference to the transaction which stornoed this transaction.

§tax_base_id: Option<i64>

Reference to the transaction which is the base for a tax split booking.

§tax_rate_id: Option<i64>

If a tax rate is set for the transaction, the corresponding tax transaction is returned in the field taxTransactionId.

§tax_transaction_id: Option<i64>

Reference to the transaction which is a split booking for taxes.

§transaction_date: NaiveDate

Date on which the transaction was created, derived from meta.createdDate. Date filters and accounting reports use documentDate.

§extra: Map<String, Value>

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

Trait Implementations§

Source§

impl Clone for Transaction

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 Transaction

Source§

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

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

impl Default for Transaction

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Transaction

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 Transaction

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 Transaction

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 Transaction

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