create_report
Generate custom financial reports in CSV format for detailed analysis, reconciliation, or export. Supports report types like transactions, adjustments, discounts, and product pricing. Filter data and track report status using unique IDs.
Instructions
This tool creates custom reports in your Paddle account for financial analysis and reconciliation.
Use this tool over list_transactions when trying to gather larger amounts of data from Paddle.
Available report types:
'adjustments': For information about refunds, credits, and chargebacks
'adjustment_line_items': For information about refunds, credits, and chargebacks, broken down by line item level
'transactions': For information about revenue received, past due invoices, draft and issued invoices, and canceled transactions
'transaction_line_items': For information about revenue received, past due invoices, draft and issued invoices, and canceled transactions, broken down by line item level
'products_prices': For information about your products and prices. May include non-catalog products and prices.
'discounts': For information about your product and checkout discounts
Reports are generated asynchronously - you'll receive a report ID that can be used to check status. Reports initially have 'pending' status, then move to 'ready' when available to download. Reports are available in CSV format and can be downloaded once ready. Reports expire after a certain period and are no longer available to download after expiration.
Use this tool when you need detailed financial data for analysis, reconciliation, or export to spreadsheet applications.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filters | No | Filter criteria for this report. | |
| type | Yes | Type of report to create. |
Implementation Reference
- src/functions.ts:953-960 (handler)The main handler function that executes the create_report tool by calling paddle.reports.create(params).export const createReport = async (paddle: Paddle, params: z.infer<typeof Parameters.createReportParameters>) => { try { const report = await paddle.reports.create(params); return report; } catch (error) { return error; } };
- src/tools.ts:938-948 (schema)Tool schema definition for create_report, including Zod parameters schema reference, description from prompts, name, method, and required actions.method: "create_report", name: "Create a report", description: prompts.createReportPrompt, parameters: params.createReportParameters, actions: { reports: { write: true, create: true, }, }, },
- src/api.ts:86-86 (registration)Maps the CREATE_REPORT tool method to its handler function in the central toolMap object used by PaddleAPI.[TOOL_METHODS.CREATE_REPORT]: funcs.createReport,
- src/constants.ts:78-78 (helper)Constant defining the string identifier for the create_report tool method.CREATE_REPORT: "create_report",