Actions91
- Account Setting Actions
- Addon Actions
- Ceiling Actions
- Company Info Actions
- Device Actions
- Exercise Actions
- Feedback Actions
- File Actions
- File Type Actions
- Gender Actions
- Guest Actions
- License Actions
- Log Actions
- Payment Actions
- Permission Actions
- Relationship Actions
- Role Actions
- Service Actions
- Service Price Actions
- Social Actions
- Topic Actions
- User Actions
- Workout Execution Actions
- Worksheet Actions
Overview
The node integrates with the GymControl system to update payment records. It allows users to modify details of an existing payment such as amount, payment date, method, category, item description, notes, and refund status. This is useful in scenarios where payment information needs correction or updating after initial entry, for example, adjusting a payment amount, changing the payment method from card to cash, or marking a payment as refunded with a reason.
Practical examples:
- Correcting the payment amount if it was entered incorrectly.
- Updating the payment method when a customer changes their payment preference.
- Adding notes or categorizing payments for better financial tracking.
- Marking a payment as refunded and specifying the refund reason.
Properties
| Name | Meaning |
|---|---|
| Show Complete Response | Whether to return the full API response or just the main data result (true/false). |
| ID | The unique identifier of the payment record to update (required). |
| Amount | The new payment amount (number, minimum 1). |
| Payment Date | The date and time when the payment was made (dateTime). |
| Method | The payment method used; options are "Card" or "Cash". |
| Category | A string to categorize the payment (e.g., membership, merchandise). |
| Item | Description or name of the item related to the payment. |
| Notes | Additional notes about the payment. |
| Is Refund | Boolean indicating if this payment is a refund (true/false). |
| Refund Reason | Reason for the refund if applicable. |
Output
The node outputs JSON data representing the updated payment record as returned by the GymControl API. If "Show Complete Response" is enabled, the entire API response is returned; otherwise, only the main data portion is output. The output includes all updated fields of the payment, reflecting the changes made.
No binary data output is involved.
Dependencies
- Requires an API key credential for authenticating with the GymControl API.
- The node uses the base URL and authentication token configured in the credentials.
- The API endpoint for updating payments is accessed via HTTP PUT requests.
Troubleshooting
- Missing or invalid ID: The payment ID must be provided and valid; otherwise, the API will reject the request.
- Invalid amount: Amount must be a number greater than or equal to 1; entering zero or negative values will cause errors.
- Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
- API connectivity issues: Verify network access to the GymControl API URL.
- Refund logic: If marking a payment as a refund, ensure the refund reason is provided if required by the API.
Common error messages typically relate to validation failures or authorization issues and can be resolved by verifying input parameters and credentials.
Links and References
- GymControl API documentation (not provided here, but users should consult the official GymControl API docs for detailed field descriptions and error codes).