Getfly icon

Getfly

Interact with Getfly CRM API
Join our community

Actions3

Overview

This node interacts with the Getfly CRM API to retrieve payment history records. Specifically, the "Get All" operation under the "Payment History" resource fetches multiple payment records with various filtering, sorting, and pagination options.

Common scenarios where this node is beneficial include:

  • Extracting detailed payment data for reporting or analytics.
  • Synchronizing payment records from Getfly CRM into other systems.
  • Filtering payments by order ID or date ranges to monitor transactions within specific periods.

For example, a user might configure this node to retrieve all payment records made in the last month, sorted by payment date descending, to generate a monthly revenue report.

Properties

Name Meaning
Fields Comma-separated list of fields to retrieve for each payment record. Example fields: payment_id, order_id, user_id, user_name, description, payment_sheet_id, amount, point, method_id, method_name, pay_date, created_at, updated_at.
Limit Maximum number of payment records to return (default 50).
Offset Number of payment records to skip before starting to collect the result set (default 0).
Additional Options Collection of optional parameters:
- Sort By Field to sort results by. Options: ID, Payment Date, Created At, Updated At (default ID).
- Sort Direction Direction to sort results. Options: Ascending, Descending (default Ascending).
- Filter by Order ID Filter payment records by a specific order ID (string).
- Filter by Payment Date From Filter payments with payment date greater than or equal to this date/time.
- Filter by Payment Date To Filter payments with payment date less than or equal to this date/time.

Output

The node outputs an array of JSON objects representing payment history records matching the query parameters. Each object contains the fields specified in the "Fields" property, such as payment IDs, order IDs, user details, amounts, payment methods, and timestamps.

No binary data output is produced by this node.

Example output snippet:

[
  {
    "payment_id": "12345",
    "order_id": "54321",
    "user_id": "1001",
    "user_name": "John Doe",
    "description": "Payment for order #54321",
    "payment_sheet_id": "ps_98765",
    "amount": 150.00,
    "point": 15,
    "method_id": "pm_001",
    "method_name": "Credit Card",
    "pay_date": "2024-05-01T10:00:00Z",
    "created_at": "2024-05-01T10:05:00Z",
    "updated_at": "2024-05-01T10:10:00Z"
  }
]

Dependencies

  • Requires an active connection to the Getfly CRM API via an API key credential.
  • The node expects the Getfly API domain URL and API key to be configured in the credentials.
  • Uses HTTP GET requests with appropriate headers including Content-Type: application/json and X-API-KEY for authentication.

Troubleshooting

  • Common issues:

    • Incorrect or missing API key credential will cause authentication failures.
    • Invalid domain URL format may lead to request errors; the node automatically prepends https:// if missing.
    • Using unsupported field names in the "Fields" property may result in empty or partial data.
    • Date filters must be valid ISO 8601 date-time strings; invalid formats can cause API errors.

  • Error messages:

    • Errors returned from the Getfly API are wrapped and presented as Getfly API Error: <message>.
    • Network or unexpected errors are thrown directly.

  • Resolution tips:

    • Verify API key and domain configuration in credentials.
    • Ensure filter values and date formats conform to expected standards.
    • Check that the requested fields exist in the Getfly payment history schema.

Links and References

Discussion