Overview
- The Share A Refund Statement API lets you access periodic financial summaries and account balance history. You can develop applications that integrate with Share A Refund to reconcile monthly ledgers, track credit utilization, and provide stakeholders with a consolidated view of financial performance.
- View Doc →
- The following figure shows the relationship between your Share A Refund app, the Share A Refund API, and Statement services.
Share A Refund App
Share A Refund’s statement services give users a high-level perspective on account health, aggregating multiple invoices and credits into single period-based records for simplified accounting.
Share A Refund API
The REST API that allows users to retrieve statement lines, balance totals, and period details from within your app.
Ledger Reconciliation
A system that aligns Share A Refund financial activity with internal accounting periods to ensure that every credit and fee finds its place in the correct fiscal month.
Balance Tracking
A record that maintains the running total of the account that accounts for new invoices issued, payments received, and credits applied over time.
What can users do with the Share A Refund Statement API?
Users can use the Share A Refund Statement API to perform common workflows, such as:
- Retrieve monthly financial statements
- View beginning and ending balances for a specific period
- List individual transactions included in a statement
- Download PDF copies of period summaries
- Check the payment status for a statement cycle
- Export statement data for external accounting software
Statement properties available to view, query, and analyze through the Share A Refund Statement API:
- Account Balances
- Line Items
- Statement Dates
- Statement Periods
- Transactions
Additional info
- Learn more about developing with Share A Refund Statement API, including handling authentication, authorization, reference the Develop on Share A Refund API for your workspace.
- More →
- Learn more about how to launch and run a Share A Refund Statement API app, read the Developer Getting Started Guide.
- More →
