finance_reports__list
Retrieve monthly financial reports from Apple App Store Connect, showing actual payments by region and currency. Filter by vendor, region, report type, date, and parse gzipped data into structured rows.
Instructions
Download the monthly financial report — what Apple actually paid, by region and currency, for a fiscal period. This is the money report, as opposed to units sold. Needs ASC_VENDOR_NUMBER and a Finance role on the API key. [GET /v1/financeReports] Set parse=true to receive decoded rows instead of the raw gzipped blob.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| parse | No | When true, gunzip and decode the TSV payload into structured rows ({ headers, rows, totalRows, truncated }) instead of returning the raw base64 blob. Defaults to false — unparsed, byte-for-byte identical to the raw response. | |
| max_rows | No | Maximum number of data rows to include when parse=true (default 200, hard cap 1000). Ignored when parse is not true. Use truncated/totalRows in the response to tell whether more rows exist. | |
| next_url | No | Absolute links.next URL from a previous response. | |
| filter_regionCode | Yes | filter by attribute 'regionCode' | |
| filter_reportDate | Yes | filter by attribute 'reportDate' | |
| filter_reportType | Yes | filter by attribute 'reportType' | |
| filter_vendorNumber | Yes | filter by attribute 'vendorNumber' |