Overview

This node interacts with the Starfish API for CampingCare and HotelCare, specifically supporting the Invoices API resource with the operation to create a credit for an invoice. It allows users to create a credit note against an existing invoice by specifying the invoice ID. This is useful in scenarios where adjustments or refunds need to be issued for previously invoiced amounts, such as correcting billing errors or processing returns.

Use Case Examples

1. Create a credit for an invoice by providing the unique invoice ID to adjust the billed amount.
2. Automate credit note creation in a booking or accommodation management workflow to handle cancellations or discounts.

Properties

Output

JSON

• creditId - Identifier of the created credit note.
• invoiceId - Identifier of the invoice for which the credit was created.
• amount - Amount credited to the invoice.
• status - Status of the credit creation operation.

Dependencies

• Requires an API key credential for authentication with the Starfish API.

Troubleshooting

• Common issues include invalid or missing invoice ID, resulting in errors from the API indicating the invoice could not be found.
• Network or SSL certificate validation errors can occur if the API endpoint is unreachable or the SSL certificate is invalid; these can be mitigated by enabling the 'Ignore SSL Issues' option or configuring a proxy.
• Timeout errors may occur if the server does not respond within the specified timeout period; increasing the timeout value may help.

Links

• Starfish API Invoices - Create Credit - Official documentation for creating credits on invoices using the Starfish API.