[PR #89] [MERGED] Document finance report type mapping (UI vs API) #272

New issue

Closed

opened 2026-02-26 21:34:23 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 21:34:23 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/rudrankriyam/App-Store-Connect-CLI/pull/89
Author: @rudrankriyam
Created: 1/24/2026
Status: ✅ Merged
Merged: 1/24/2026
Merged by: @rudrankriyam

Base: main ← Head: issue/77-finance-report-docs

📝 Commits (1)

ea02dce Document finance report type mapping from API to App Store Connect UI

📊 Changes

5 files changed (+112 additions, -13 deletions)

View changed files

📝 Agents.md (+18 -2)
📝 README.md (+20 -6)
📝 cmd/finance.go (+45 -3)
📝 internal/asc/finance.go (+20 -2)
📝 internal/asc/finance_regions.go (+9 -0)

📄 Description

Summary

Clarifies and documents how App Store Connect UI financial report types map to API financeReports reportType values.

Closes #77

Key Findings

API `--report-type`	UI Option	`--region` Code(s)
`FINANCIAL`	All Countries or Regions (Single File)	`ZZ` (consolidated)
`FINANCIAL`	All Countries or Regions (Multiple Files)	`US`, `EU`, `JP`, etc.
`FINANCE_DETAIL`	All Countries or Regions (Detailed)	`Z1` (required)
Not available	Transaction Tax (Single File)	N/A

Important: Transaction Tax reports are NOT available via the API - users must download them manually from App Store Connect.

Changes

cmd/finance.go: Enhanced CLI help text with detailed report type explanations, region codes, and examples
internal/asc/finance.go: Added comprehensive Go doc comments for FinanceReportType
internal/asc/finance_regions.go: Documented special region codes (ZZ, Z1, EU, LL, AP, WW)
README.md: Added report type mapping table and updated examples
Agents.md: Added "Finance Reports Notes" section

Test plan

Verify asc finance reports --help shows the new documentation
Verify asc finance regions --help shows region code guidance
Confirm make test and make lint pass

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/rudrankriyam/App-Store-Connect-CLI/pull/89 **Author:** [@rudrankriyam](https://github.com/rudrankriyam) **Created:** 1/24/2026 **Status:** ✅ Merged **Merged:** 1/24/2026 **Merged by:** [@rudrankriyam](https://github.com/rudrankriyam) **Base:** `main` ← **Head:** `issue/77-finance-report-docs` --- ### 📝 Commits (1) - [`ea02dce`](https://github.com/rudrankriyam/App-Store-Connect-CLI/commit/ea02dce33454f07d07a9d0b66cdbc3f57343e5bc) Document finance report type mapping from API to App Store Connect UI ### 📊 Changes **5 files changed** (+112 additions, -13 deletions) <details> <summary>View changed files</summary> 📝 `Agents.md` (+18 -2) 📝 `README.md` (+20 -6) 📝 `cmd/finance.go` (+45 -3) 📝 `internal/asc/finance.go` (+20 -2) 📝 `internal/asc/finance_regions.go` (+9 -0) </details> ### 📄 Description ## Summary Clarifies and documents how App Store Connect UI financial report types map to API `financeReports` `reportType` values. Closes #77 ## Key Findings | API `--report-type` | UI Option | `--region` Code(s) | |---------------------|-----------------------------------------|-------------------------| | `FINANCIAL` | All Countries or Regions (Single File) | `ZZ` (consolidated) | | `FINANCIAL` | All Countries or Regions (Multiple Files) | `US`, `EU`, `JP`, etc. | | `FINANCE_DETAIL` | All Countries or Regions (Detailed) | `Z1` (required) | | Not available | Transaction Tax (Single File) | N/A | **Important:** Transaction Tax reports are NOT available via the API - users must download them manually from App Store Connect. ## Changes - **cmd/finance.go**: Enhanced CLI help text with detailed report type explanations, region codes, and examples - **internal/asc/finance.go**: Added comprehensive Go doc comments for `FinanceReportType` - **internal/asc/finance_regions.go**: Documented special region codes (ZZ, Z1, EU, LL, AP, WW) - **README.md**: Added report type mapping table and updated examples - **Agents.md**: Added "Finance Reports Notes" section ## Test plan - [ ] Verify `asc finance reports --help` shows the new documentation - [ ] Verify `asc finance regions --help` shows region code guidance - [ ] Confirm `make test` and `make lint` pass --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>