getAllPayments
Retrieve all payments from the Mews hospitality platform using filters for payment IDs, customer IDs, bill IDs, date ranges, states, and pagination settings.
Instructions
Returns all payments based on filter parameters
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| PaymentIds | No | Filter by specific payment IDs | |
| CustomerIds | No | Filter by customer IDs | |
| BillIds | No | Filter by bill IDs | |
| CreatedUtc | No | Date range filter for payment creation | |
| ConsumedUtc | No | Date range filter for payment consumption | |
| States | No | Filter by payment states | |
| Limitation | No | Pagination settings |
Implementation Reference
- The execute handler function that performs the HTTP request to retrieve payments based on input filters.
async execute(config: MewsAuthConfig, args: unknown): Promise<ToolResult> { const inputArgs = args as Record<string, unknown>; const requestData = { Limitation: { Count: 100 }, ...inputArgs }; const result = await mewsRequest(config, '/api/connector/v1/payments/getAll', requestData); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }] }; } - Input schema defining parameters for filtering payments by IDs, dates, states, and pagination.
inputSchema: { type: 'object', properties: { PaymentIds: { type: 'array', items: { type: 'string' }, description: 'Filter by specific payment IDs', maxItems: 1000 }, CustomerIds: { type: 'array', items: { type: 'string' }, description: 'Filter by customer IDs', maxItems: 1000 }, BillIds: { type: 'array', items: { type: 'string' }, description: 'Filter by bill IDs', maxItems: 1000 }, CreatedUtc: { type: 'object', properties: { StartUtc: { type: 'string', description: 'Start of creation date range (ISO 8601)' }, EndUtc: { type: 'string', description: 'End of creation date range (ISO 8601)' } }, description: 'Date range filter for payment creation' }, ConsumedUtc: { type: 'object', properties: { StartUtc: { type: 'string', description: 'Start of consumption date range (ISO 8601)' }, EndUtc: { type: 'string', description: 'End of consumption date range (ISO 8601)' } }, description: 'Date range filter for payment consumption' }, States: { type: 'array', items: { type: 'string' }, description: 'Filter by payment states' }, Limitation: { type: 'object', properties: { Count: { type: 'number', description: 'Maximum number of payments to return' }, Cursor: { type: 'string', description: 'Pagination cursor for next page' } }, description: 'Pagination settings' } }, additionalProperties: false }, - src/tools/index.ts:43-43 (registration)Import of the getAllPaymentsTool.
import { getAllPaymentsTool } from './payments/getAllPayments.js'; - src/tools/index.ts:128-128 (registration)Inclusion of getAllPaymentsTool in the allTools array for registration.
getAllPaymentsTool, - src/tools/payments/getAllPayments.ts:5-5 (handler)Tool object definition with name and description.
export const getAllPaymentsTool: Tool = {