Struct ArchiveClient 

pub struct ArchiveClient { /* private fields */ }

Client for the Yuki Archive SOAP service.

Implementations

impl ArchiveClient

pub fn new() -> 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.

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

Authenticate with the Yuki API and store the session ID.

pub async fn documents_in_folder_page( &self, folder_id: i32, start_date: &str, end_date: &str, number_of_records: usize, start_record: usize, ) -> Result<Vec<ArchiveDocument>, YukiError>

Fetch one page of documents from an archive folder.

pub async fn documents_in_folder( &self, folder_id: i32, start_date: &str, end_date: &str, ) -> Result<Vec<ArchiveDocument>, YukiError>

List every document in an archive folder.

pub async fn documents_in_folder_paged( &self, folder_id: i32, start_date: &str, end_date: &str, limit: Option<usize>, offset: Option<usize>, ) -> Result<Vec<ArchiveDocument>, YukiError>

List documents in an archive folder, paging until the folder is exhausted.

offset skips records server-side; limit caps the total returned. With no limit every document is fetched, so a folder larger than one page is never silently truncated.

pub async fn documents_by_type( &self, doc_type: i32, ) -> Result<String, YukiError>

List all documents of a given document type.

pub async fn search_documents( &self, search_text: &str, start_date: &str, end_date: &str, ) -> Result<Vec<ArchiveDocument>, YukiError>

Search documents in the archive using a free-text query within a date range.

Pass an empty string for search_text to retrieve all documents in the period. Returns up to 500 results sorted by document date descending.

pub async fn modified_documents_by_type( &self, doc_type: i32, modified_since: &str, ) -> Result<String, YukiError>

List documents of a given type that were modified since the specified date.

pub async fn upload_document( &self, admin_id: &str, filename: &str, data_base64: &str, folder_id: i32, ) -> Result<String, YukiError>

Upload a document to the archive without additional metadata.

Returns the document ID assigned by Yuki.

pub async fn upload_document_with_data( &self, admin_id: &str, filename: &str, data_base64: &str, folder_id: i32, currency: &str, amount: f64, cost_category: Option<&str>, payment_method: Option<&str>, project: Option<&str>, remarks: Option<&str>, ) -> Result<String, YukiError>

Upload a document to the archive with invoice metadata.

Returns the document ID assigned by Yuki.

pub async fn cost_categories(&self) -> Result<Vec<CostCategory>, YukiError>

Retrieve all available cost categories.

pub async fn payment_methods(&self) -> Result<Vec<PaymentMethod>, YukiError>

Retrieve all available payment methods.

pub fn parse_archive_documents( xml: &str, ) -> Result<Vec<ArchiveDocument>, YukiError>

Parse a SearchDocuments or DocumentsInFolder SOAP response into a list of documents.

Each <Document ID="uuid"> element carries child elements for each field. The document ID is an XML attribute; all other fields are child text nodes.

pub fn parse_cost_categories(xml: &str) -> Result<Vec<CostCategory>, YukiError>

Parse a CostCategories SOAP response.

Each CostCategory element carries an ID attribute and a Description child element: <CostCategory ID="45100"><Description>...</Description></CostCategory>

pub fn parse_payment_methods(xml: &str) -> Result<Vec<PaymentMethod>, YukiError>

Parse a PaymentMethods SOAP response.

Each PaymentMethod element carries an ID attribute and a Description child element: <PaymentMethod ID="4"><Description>...</Description></PaymentMethod>

Trait Implementations

impl Default for ArchiveClient

fn default() -> Self

Returns the “default value” for a type.