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 interacts with the Starfish API for CampingCare and HotelCare, specifically supporting the 'Add Invoice' operation under the 'Invoices API' resource. It allows users to create new invoices by specifying details such as contact ID, reservation ID, invoice type, metadata, and invoice rows. This node is useful for automating invoice creation in booking and reservation management workflows, enabling integration with the Starfish system for streamlined financial operations.
Use Case Examples
- Automatically create an invoice for a specific contact after a reservation is confirmed.
- Add detailed invoice rows with product or rate types, including VAT percentages and descriptions.
- Attach custom metadata to invoices for tracking external statuses or other business-specific information.
Properties
| Name | Meaning |
|---|---|
| Contact ID | Filter or associate the invoice with a specific contact by their ID. |
| Reservation ID | Filter or associate the invoice with a specific reservation by its ID. |
| Meta | Add multiple key-value pairs as metadata to the invoice for additional information or external system integration. |
| Rows | Add multiple invoice rows, each specifying details like amount, count, description, price, type (product or rate), type ID, and VAT percentage. |
| Type | Filter or specify the invoice type, such as invoice or concept. |
Output
JSON
id- The unique identifier of the created invoice.contact_id- The contact ID associated with the invoice.reservation_id- The reservation ID associated with the invoice.type- The type of the invoice (e.g., invoice, concept).meta- Metadata key-value pairs attached to the invoice.rows- Array of invoice rows with details such as amount, count, description, price, type, type ID, and VAT percentage.created_at- Timestamp when the invoice was created.
Dependencies
- Requires an API key credential for authentication with the Starfish API.
Troubleshooting
- Ensure the API key credential is correctly configured and has the necessary permissions to create invoices.
- Verify that numeric fields such as amount, count, price, and VAT percentage are provided in the correct format to avoid request errors.
- Check that required fields for invoice rows are properly filled to prevent incomplete invoice creation errors.
- If SSL certificate validation issues occur, consider enabling the 'Ignore SSL Issues' option in request settings, but use with caution.
Links
- Starfish API Invoices Documentation - Official documentation for the Invoices API, including details on adding invoices and supported fields.