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 to retrieve invoice data. It supports fetching detailed invoice information or just the total count of invoices based on various filters and options. This node is useful for scenarios where users need to query invoices with specific criteria such as date ranges, status, type, or related entities like contacts and reservations. For example, it can be used to generate reports on unpaid invoices, retrieve invoices for a particular reservation, or get a summary count of invoices within a date range.

Use Case Examples

  1. Retrieve all unpaid invoices created after a specific date.
  2. Get the total count of invoices for a particular channel.
  3. Fetch detailed invoice data including contact and payment terms for a specific reservation.

Properties

Name Meaning
Count Whether to return only the total count of invoices instead of full invoice details.
Filter Root Meta Whether to filter root meta information in the response.
Get Contact Whether to include contact information in the invoice data.
Get Meta Whether to include meta information in the invoice data.
Get Payment Terms Whether to include payment terms in the invoice data.
Get Payments Whether to include payment information related to the invoices.
Get Reservation Whether to include reservation information related to the invoices.
Get Rows Whether to include detailed row information of the invoices.
Channel ID Filter invoices by a specific channel ID.
Create Date From Filter invoices created from this date (format: YYYY-MM-DD).
Create Date Operator Operator to apply for the create date filter (e.g., =, >, >=, <, <=).
Create Date To Filter invoices created up to this date (format: YYYY-MM-DD).
Invoice ID Filter Filter by a specific invoice ID.
Limit Maximum number of invoices to return (maximum 30).
Offset Number of invoices to skip before starting to return results.
Order Sort order of the results (ascending or descending).
Order By Field by which to sort the invoices.
Reservation ID Filter invoices for a specific reservation.
Status Filter invoices by their status (e.g., draft, paid, unpaid).
Type Filter invoices by type (invoice or concept).
Request Options Additional request options such as batching, SSL handling, proxy, and timeout settings.

Output

JSON

  • invoices - Array of invoice objects retrieved from the API.
  • totalCount - Total count of invoices when 'Count' option is true.

Dependencies

  • Starfish API with API key authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has necessary permissions to access invoice data.
  • Check date filters are in the correct YYYY-MM-DD format to avoid API errors.
  • Limit the 'Limit' property to a maximum of 30 to prevent request rejection by the API.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security implications.
  • Verify proxy settings if using a proxy to ensure requests are routed correctly.

Links

Discussion