finance command provides access to App Store financial reports and payment data. These reports detail your earnings, payments, and financial transactions.
Overview
Financial reports are monthly aggregated reports available to Account Holders, Admins, and users with the Finance role. They provide detailed breakdowns of:- Developer proceeds and payments
- Regional sales and taxes
- Commission adjustments
- Currency conversions
- Settlement dates
Permissions
Financial reports require Account Holder, Admin, or Finance role in App Store Connect.Download Financial Reports
Download financial reports for a specific month and region.--vendor- Vendor number (orASC_VENDOR_NUMBERenv)--report-type- Report type:FINANCIALorFINANCE_DETAIL--region- Region code (see Region Codes)--date- Report date inYYYY-MMformat (Apple fiscal month)
--output- Custom output path (default:finance_report_{date}_{type}_{region}.tsv.gz)--decompress- Decompress to.tsvformat
Report Types
The App Store Connect UI shows four report types, but only two are available via API:FINANCIAL
Aggregated monthly financial report. UI Equivalents:- “All Countries or Regions (Single File)” → Use
--region ZZ - “All Countries or Regions (Multiple Files)” → Use specific region codes (
US,EU, etc.)
- Monthly summary of proceeds and payments
- Available for individual countries or regional aggregates
- Most commonly used report type
FINANCE_DETAIL
Detailed report with transaction and settlement dates. UI Equivalent:- “All Countries or Regions (Detailed)”
- Transaction-level detail
- Settlement date information
- IMPORTANT: Requires
--region Z1(only valid region for this type)
Transaction Tax Reports
Transaction Tax reports are NOT available via API. To download these reports:- Sign in to App Store Connect
- Go to Payments and Financial Reports
- Select Create Reports
- Choose Transaction Tax
Region Codes
Financial reports use specific region codes to identify geographic areas.View Available Regions
List all region codes with their currencies:Common Region Codes
Individual Countries:US- United States (USD)CA- Canada (CAD)GB- United Kingdom (GBP)AU- Australia (AUD)JP- Japan (JPY)DE- Germany (EUR)FR- France (EUR)
EU- Euro-Zone countriesLL- Latin AmericaAP- Asia-PacificWW- Rest of World
ZZ- Consolidated (all regions in single file) - Use withFINANCIALZ1- Financial Detail (required forFINANCE_DETAIL)
Region Selection Guide
For FINANCIAL reports:- Use
ZZfor a single consolidated file with all regions - Use specific region codes (
US,EU, etc.) for regional breakdowns - Use country codes for country-specific reports
- Must use
Z1(only valid region for detailed reports)
Report Format
Financial reports are tab-separated value (TSV) files compressed with gzip.Sample Structure
Key Columns
- Start Date / End Date: Reporting period
- Vendor Identifier: Your product ID (SKU)
- Quantity: Units sold or returned
- Partner Share: Your proceeds
- Partner Share Currency: Currency for proceeds
- Apple Identifier: App ID
- Country Of Sale: Transaction country
- Customer Price: Price paid by customer
- Product Type Identifier: Product type (e.g.,
IA1for in-app purchase)
Vendor Number
Your vendor number identifies your organization in financial reports. Finding Your Vendor Number:- Sign in to App Store Connect
- Go to Payments and Financial Reports
- Your vendor number appears in the top right corner
--vendor flag:
Common Workflows
Download Monthly Reports for All Regions
Download Detailed Report
Multi-Region Analysis
Automated Monthly Download
Report Availability
Timeline:- Financial reports are typically available by the 15th of each month for the previous month
- Example: December 2025 report available around January 15, 2026
- Reports are retained for approximately 1 year
- Download and archive reports for longer-term record keeping
Troubleshooting
”Vendor number not found”
Ensure you’re using the correct vendor number from App Store Connect → Payments and Financial Reports.”Report not available”
- Check the date format (
YYYY-MM) - Verify the report is available (typically by the 15th of the following month)
- Confirm your account has Finance role permissions
”Invalid region code for report type”
- For
FINANCE_DETAIL, you must use--region Z1 - For
FINANCIAL, use country codes (US,EU) orZZfor consolidated
Related Commands
- Analytics - Sales and trends reports
- Insights - Weekly and daily metrics analysis
- Subscriptions - Manage subscription pricing
