Ikoula Business API icon

Ikoula Business API

Interact with Ikoula Business API for business operations management. Developed by Ascenzia - www.ascenzia.fr
Join our community

Actions9

Overview

This node integrates with the Ikoula Business API to manage various business operations such as retrieving product categories, ordering services or domains, managing terminations, and specifically for this operation, fetching detailed information about a specific invoice. The "Get Invoice Details" operation allows users to retrieve comprehensive data about an invoice by providing its ID.

Practical scenarios include:

  • Automatically fetching invoice details for accounting or auditing purposes.
  • Integrating invoice data into financial dashboards or reporting tools.
  • Verifying invoice status or contents before processing payments.

Properties

Name Meaning
Invoice ID The unique numeric identifier of the invoice to retrieve details for.
Response Format The format in which the API response is returned. Options: JSON, XML.

Output

The node outputs the invoice details in the specified response format under the json field. If the response format is JSON, the output will be a parsed JSON object containing all invoice-related data returned by the API. If XML is selected, the raw XML string is provided within the data property of the JSON output.

Example JSON output structure (simplified):

{
  "invoiceId": 12345,
  "date": "2024-01-01",
  "amount": 100.00,
  "status": "Paid",
  "items": [
    {
      "description": "Service A",
      "quantity": 1,
      "price": 100.00
    }
  ],
  ...
}

Dependencies

  • Requires valid credentials for the Ikoula Business API, including email, password, and optionally a custom API URL.
  • The password is encrypted using RSA public key encryption before being sent.
  • The node makes HTTP requests to the Ikoula API endpoints.
  • No additional external dependencies beyond standard n8n HTTP request helpers and Node.js crypto module.

Troubleshooting

  • No credentials provided!
    This error occurs if the required API credentials are missing. Ensure that you have configured the API authentication credentials correctly in n8n before running the node.

  • Invalid Invoice ID or Not Found
    If the invoice ID does not exist or is invalid, the API may return an error or empty response. Verify the invoice ID is correct and exists in your Ikoula account.

  • API Response Format Issues
    Selecting XML format returns raw XML data inside a JSON wrapper. Make sure downstream nodes can handle XML if chosen.

  • Network or Authentication Errors
    Check network connectivity and validity of the API credentials. Also verify that the API URL is correct if customized.

Links and References

Discussion