Actions30
- Accommodations API Actions
- Administrations API Actions
- Contacts API Actions
- Invoices API Actions
- Price Calculation API Actions
- Rates API Actions
- Reservations API Actions
- Timezones API Actions
Overview
This node operation interacts with the Invoices API to cancel a delayed finalized invoice by its unique identifier. It is useful in scenarios where an invoice that was finalized but delayed needs to be canceled programmatically, such as in automated billing systems or financial workflows.
Use Case Examples
- Cancel a delayed finalized invoice by providing its Invoice ID to stop further processing or payment collection.
- Use in financial automation to manage invoice states dynamically based on business rules.
Properties
| Name | Meaning |
|---|---|
| Invoice ID | Unique identifier of the invoice to be canceled. |
| Request Options | Settings to control request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration. |
Output
JSON
invoiceId- The unique identifier of the invoice that was canceled.status- The status of the invoice after the cancellation operation.message- Additional information or confirmation message about the cancellation.
Dependencies
- Requires an API key credential for authentication with the Starfish API.
Troubleshooting
- Ensure the provided Invoice ID is correct and exists in the system to avoid 'Invoice not found' errors.
- Check network connectivity and proxy settings if requests time out or fail to reach the API.
- If SSL certificate validation fails, consider enabling the 'Ignore SSL Issues' option cautiously.
- Verify that the API key credential is valid and has sufficient permissions to perform invoice cancellation.
Links
- Starfish API Invoices Documentation - Official documentation for the Invoices API including the cancel delayed finalized invoice operation.