Actions8
Overview
This node integrates with the Nimba SMS API to retrieve purchase history and invoices. Specifically, the "Purchase - Get All" operation fetches a list of purchase records from the user's account. It supports filtering by payment type and date range, as well as pagination controls like limit and offset.
Typical use cases include:
- Generating reports on all purchases made through the SMS service.
- Filtering purchases by payment method (e.g., Orange Money, MTN Mobile Money).
- Retrieving purchases within a specific time frame for accounting or auditing purposes.
- Exporting purchase data for further analysis or integration with other systems.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all purchase records or only up to a specified limit. |
| Limit | Maximum number of purchase records to return when not returning all. |
| Additional Fields | Optional filters and parameters: |
| - Payment Type | Filter purchases by payment method. Options: Orange Money, MTN Mobile Money, Moov Money, Bank Transfer, Card Payment. |
| - Start Date | Filter purchases starting from this date/time. |
| - End Date | Filter purchases up to this date/time. |
| - Offset | The initial index from which to start returning results (for pagination). |
Output
The node outputs an array of purchase objects in the json output field. Each object represents a single purchase record retrieved from the Nimba SMS API. The exact structure of each purchase object depends on the API response but typically includes details such as purchase ID, amount, payment type, date, and invoice information.
No binary data is output by this node.
Dependencies
- Requires an active connection to the Nimba SMS API using an API key credential configured in n8n.
- The node uses internal helper functions to make authenticated HTTP requests to the Nimba SMS API endpoints.
- No additional external dependencies are required beyond the configured API credentials.
Troubleshooting
Common Issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing invalid filter values (e.g., unsupported payment types or malformed dates) may result in empty responses or errors.
- Requesting too many records without pagination may lead to timeouts or rate limiting.
Error Messages:
- Errors related to API request failures will be thrown if the API returns an error status.
- If the node encounters issues parsing the response, it may throw unexpected errors.
Resolutions:
- Ensure that the API key credential is correctly set up and has sufficient permissions.
- Validate filter inputs before running the node.
- Use the "Return All" option judiciously to avoid large data loads; otherwise, use "Limit" and "Offset" for pagination.
Links and References
- Nimba SMS API Documentation (hypothetical link)
- n8n Documentation on Creating Custom Nodes
- General info on SMS payment methods and mobile money services relevant to the supported payment types.