Get Transactions
whmcs_get_transactionsRetrieve payment transactions with optional filters by invoice ID, client ID, or transaction ID.
Instructions
Get payment transactions
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| invoiceid | No | Filter by invoice ID | |
| clientid | No | Filter by client ID | |
| transid | No | Filter by transaction ID |
Implementation Reference
- src/index.ts:391-408 (registration)Registers the 'whmcs_get_transactions' tool on the MCP server with its input schema (invoiceid, clientid, transid) and a handler that delegates to whmcsClient.getTransactions()
server.registerTool( 'whmcs_get_transactions', { title: 'Get Transactions', description: 'Get payment transactions', inputSchema: { invoiceid: z.number().optional().describe('Filter by invoice ID'), clientid: z.number().optional().describe('Filter by client ID'), transid: z.string().optional().describe('Filter by transaction ID'), }, }, async (params) => { const result = await whmcsClient.getTransactions(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } ); - src/index.ts:396-400 (schema)Input schema for whmcs_get_transactions tool: optional filters by invoiceid (number), clientid (number), and transid (string)
inputSchema: { invoiceid: z.number().optional().describe('Filter by invoice ID'), clientid: z.number().optional().describe('Filter by client ID'), transid: z.string().optional().describe('Filter by transaction ID'), }, - src/index.ts:402-407 (handler)Handler function for whmcs_get_transactions - calls whmcsClient.getTransactions(params) and returns the result as JSON text content
async (params) => { const result = await whmcsClient.getTransactions(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } - src/whmcs-client.ts:581-605 (helper)Helper method on WhmcsApiClient - calls the WHMCS 'GetTransactions' API action, returns typed response with transaction details including id, userid, gateway, date, amounts, and transid
async getTransactions(params: { invoiceid?: number; clientid?: number; transid?: string; } = {}) { return this.call<WhmcsApiResponse & { totalresults: number; startnumber: number; numreturned: number; transactions: { transaction: Array<{ id: number; userid: number; currency: number; gateway: string; date: string; description: string; amountin: string; amountout: string; rate: string; transid: string; invoiceid: number; refundid: number; }> }; }>('GetTransactions', params); }