pub struct AccountingClient { /* private fields */ }Expand description
Client for the Yuki Accounting SOAP service.
Implementations§
Source§impl AccountingClient
impl AccountingClient
pub fn new() -> Self
Sourcepub fn with_client(http: Client) -> Self
pub fn with_client(http: Client) -> Self
Build over a caller-provided HTTP client, so a long-running consumer can share a single pooled client across all service clients.
Sourcepub async fn authenticate(&mut self, api_key: &str) -> Result<String, YukiError>
pub async fn authenticate(&mut self, api_key: &str) -> Result<String, YukiError>
Authenticate with the Yuki API and store the session ID.
Sourcepub async fn administrations(&self) -> Result<Vec<Administration>, YukiError>
pub async fn administrations(&self) -> Result<Vec<Administration>, YukiError>
List all administrations accessible with the current session.
Sourcepub async fn set_current_domain(
&mut self,
domain_id: &str,
) -> Result<(), YukiError>
pub async fn set_current_domain( &mut self, domain_id: &str, ) -> Result<(), YukiError>
Set the active domain (administration) for subsequent calls.
Sourcepub async fn gl_account_balances(
&self,
administration_id: &str,
transaction_date: &str,
) -> Result<Vec<GlAccountBalance>, YukiError>
pub async fn gl_account_balances( &self, administration_id: &str, transaction_date: &str, ) -> Result<Vec<GlAccountBalance>, YukiError>
Retrieve balances for all GL accounts as of a given date.
Yuki’s GLAccountBalance operation returns the full chart of accounts
(balance sheet and profit & loss) in one response and ignores any
account-code filter, so this returns every account; callers select the
ones they need by GlAccountBalance::code.
Sourcepub async fn gl_account_transactions(
&self,
administration_id: &str,
gl_account_code: &str,
start_date: &str,
end_date: &str,
) -> Result<String, YukiError>
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.
Sourcepub async fn outstanding_debtor_items(
&self,
administration_id: &str,
) -> Result<Vec<OutstandingItem>, YukiError>
pub async fn outstanding_debtor_items( &self, administration_id: &str, ) -> Result<Vec<OutstandingItem>, YukiError>
Retrieve outstanding debtor items.
Sourcepub async fn outstanding_debtor_items_by_date(
&self,
administration_id: &str,
start_date: &str,
end_date: &str,
) -> Result<Vec<OutstandingItem>, YukiError>
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.
Sourcepub async fn outstanding_creditor_items(
&self,
administration_id: &str,
) -> Result<Vec<OutstandingItem>, YukiError>
pub async fn outstanding_creditor_items( &self, administration_id: &str, ) -> Result<Vec<OutstandingItem>, YukiError>
Retrieve outstanding creditor items.
Sourcepub async fn outstanding_creditor_items_by_date(
&self,
administration_id: &str,
start_date: &str,
end_date: &str,
) -> Result<Vec<OutstandingItem>, YukiError>
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.
Sourcepub 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>
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.
Sourcepub async fn net_revenue(
&self,
administration_id: &str,
start_date: &str,
end_date: &str,
) -> Result<String, YukiError>
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.
Sourcepub async fn check_outstanding_item_admin(
&self,
administration_id: &str,
reference: &str,
) -> Result<String, YukiError>
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.
Sourcepub fn parse_gl_account_balances(
xml: &str,
) -> Result<Vec<GlAccountBalance>, YukiError>
pub fn parse_gl_account_balances( xml: &str, ) -> Result<Vec<GlAccountBalance>, YukiError>
Parse a GLAccountBalance SOAP response into per-account balances.
Each repeating GLAccount element carries Code and BalanceType
attributes and child elements Description and Amount:
<GLAccount Code="20200" BalanceType="B"><Description>RC Ruben Jongejan</Description><Amount>3472.31</Amount></GLAccount>
Sourcepub fn parse_gl_transactions(xml: &str) -> Result<Vec<GlTransaction>, YukiError>
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.
Sourcepub fn parse_gl_transactions_with_contact(
xml: &str,
) -> Result<Vec<GlTransactionWithContact>, YukiError>
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.
Sourcepub fn parse_administrations(
xml: &str,
) -> Result<Vec<Administration>, YukiError>
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>
Sourcepub fn parse_outstanding_items(
xml: &str,
result_tag: &str,
) -> Result<Vec<OutstandingItem>, YukiError>
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").