Starfish (CampingCare/HotelCare) icon

Starfish (CampingCare/HotelCare)

Interact with the Starfish API for CampingCare and HotelCare
Join our community

Actions30

Overview

This node interacts with the Starfish API specifically for the Invoices API resource, focusing on the 'Meta' operation. It allows users to update metadata for a specific invoice by specifying the invoice ID, a meta key, and a value to set for that key. This is useful for managing additional custom information related to invoices, such as tags or notes, which can be programmatically updated via the API.

Use Case Examples

  1. Updating the 'first_name' meta key of an invoice with ID '2750123' to 'John Doe'.
  2. Setting a custom meta key 'pin' for an invoice to store a unique identifier.

Properties

Name Meaning
Meta Operation Specifies the meta operation to perform, currently supports updating meta data for an invoice.
Invoice ID Unique identifier of the invoice to update meta data for.
Key The meta key to update or set on the invoice (e.g., 'pin', 'first_name').
Value The value to assign to the specified meta key (e.g., 'John Doe').
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • metaUpdateResponse - The response from the API after updating the invoice meta data, typically containing the updated meta information or status.

Dependencies

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

Troubleshooting

  • Common issues include invalid or missing invoice ID, incorrect meta key or value formats, and network-related errors such as timeouts or SSL certificate validation failures.
  • Error messages may indicate authorization failures if the API key is invalid or missing, or HTTP errors if the invoice ID does not exist or the API endpoint is incorrect.
  • To resolve errors, verify the invoice ID and meta key/value inputs, ensure the API key is valid and has necessary permissions, and check network settings including proxy and SSL options.

Links

Discussion