Skip to main content

AccountingClient

Struct AccountingClient 

Source
pub struct AccountingClient { /* private fields */ }
Expand description

Client for the Yuki Accounting SOAP service.

Implementations§

Source§

impl AccountingClient

Source

pub fn new() -> Self

Source

pub async fn authenticate(&mut self, api_key: &str) -> Result<String, YukiError>

Authenticate with the Yuki API and store the session ID.

Source

pub async fn administrations(&self) -> Result<Vec<Administration>, YukiError>

List all administrations accessible with the current session.

Source

pub async fn set_current_domain( &mut self, domain_id: &str, ) -> Result<(), YukiError>

Set the active domain (administration) for subsequent calls.

Source

pub async fn gl_account_balance( &self, administration_id: &str, gl_account_code: &str, transaction_date: &str, ) -> Result<String, YukiError>

Retrieve the balance of a GL account as of a given date.

Source

pub async fn gl_account_transactions( &self, administration_id: &str, gl_account_code: &str, start_date: &str, end_date: &str, ) -> Result<String, YukiError>

Retrieve transactions for a GL account over a date range.

Source

pub async fn outstanding_debtor_items( &self, administration_id: &str, ) -> Result<Vec<OutstandingItem>, YukiError>

Retrieve outstanding debtor items.

Source

pub async fn outstanding_debtor_items_by_date( &self, administration_id: &str, start_date: &str, end_date: &str, ) -> Result<Vec<OutstandingItem>, YukiError>

Retrieve outstanding debtor items filtered by date range.

Source

pub async fn outstanding_creditor_items( &self, administration_id: &str, ) -> Result<Vec<OutstandingItem>, YukiError>

Retrieve outstanding creditor items.

Source

pub async fn outstanding_creditor_items_by_date( &self, administration_id: &str, start_date: &str, end_date: &str, ) -> Result<Vec<OutstandingItem>, YukiError>

Retrieve outstanding creditor items filtered by date range.

Source

pub async fn gl_account_transactions_and_contact( &self, administration_id: &str, gl_account_code: &str, start_date: &str, end_date: &str, ) -> Result<Vec<GlTransactionWithContact>, YukiError>

Retrieve transactions for a GL account with contact info over a date range.

Source

pub async fn net_revenue( &self, administration_id: &str, start_date: &str, end_date: &str, ) -> Result<String, YukiError>

Retrieve net revenue for a date range.

Source

pub async fn check_outstanding_item_admin( &self, administration_id: &str, reference: &str, ) -> Result<String, YukiError>

Check if a specific reference is still outstanding in an administration.

Source

pub fn parse_gl_transactions(xml: &str) -> Result<Vec<GlTransaction>, YukiError>

Parse a GLAccountTransactions SOAP response into a list of GlTransaction values.

Each GLAccountTransaction element carries an ID attribute and child elements Date, Description, Amount, and GLAccountCode.

Source

pub fn parse_gl_transactions_with_contact( xml: &str, ) -> Result<Vec<GlTransactionWithContact>, YukiError>

Parse a GLAccountTransactionsAndContact SOAP response.

Like parse_gl_transactions but also captures Contact/ContactName.

Source

pub fn parse_administrations( xml: &str, ) -> Result<Vec<Administration>, YukiError>

Parse an Administrations SOAP response into a list of Administration values.

The Yuki API returns Administration elements with the ID as an XML attribute and Name as a child element: <Administration ID="uuid"><Name>Company</Name>...</Administration>

Source

pub fn parse_outstanding_items( xml: &str, result_tag: &str, ) -> Result<Vec<OutstandingItem>, YukiError>

Parse an outstanding items SOAP response into a list of OutstandingItem values.

The result_tag identifies the wrapper element in the response (e.g. "OutstandingDebtorItemsResult").

Trait Implementations§

Source§

impl Default for AccountingClient

Source§

fn default() -> Self

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

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> 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: 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: 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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