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 specifically for the Invoices API resource to retrieve detailed information about a single invoice. It is useful in scenarios where users need to fetch comprehensive invoice data including optional related details such as contact information, payment terms, payments, reservation details, VAT totals, and metadata. For example, it can be used in financial workflows to automate invoice processing, auditing, or reporting by fetching invoice data programmatically.
Use Case Examples
- Retrieve an invoice by its unique ID to display or process its details in an accounting system.
- Fetch an invoice along with its contact and payment information to generate a detailed customer billing report.
- Get invoice metadata and VAT totals for tax calculation and compliance purposes.
Properties
| Name | Meaning |
|---|---|
| Invoice ID | Unique identifier of the invoice to retrieve, required for the operation. |
| Filter Root Meta | Whether to filter root meta information in the response. |
| Get Contact | Whether to include contact information related to the invoice. |
| Get Contact Meta | Whether to include metadata about the contact. |
| Get Meta | Whether to include general meta information about the invoice. |
| Get Payment Terms | Whether to include payment terms associated with the invoice. |
| Get Payments | Whether to include payment details related to the invoice. |
| Get Reservation | Whether to include reservation information linked to the invoice. |
| Get Reservation Meta | Whether to include metadata about the reservation. |
| Get Rows | Whether to include detailed row information of the invoice. |
| Get VAT Totals | Whether to include VAT totals in the invoice data. |
| Request Options | Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings. |
Output
JSON
invoice- The detailed invoice data retrieved from the API, including optional related information based on input flags such as contact, payments, reservation, VAT totals, and metadata.
Dependencies
- Requires an API key credential for authentication with the Starfish API.
Troubleshooting
- Common issues include invalid or missing Invoice ID, resulting in errors or empty responses. Ensure the Invoice ID is correctly provided.
- API authentication errors may occur if the API key credential is invalid or expired. Verify and update the API key as needed.
- Network issues such as proxy misconfiguration or SSL certificate validation failures can cause request failures. Adjust proxy settings or enable ignoring SSL issues if necessary.
- Timeout errors may occur if the server response is delayed beyond the configured timeout. Increase the timeout setting if needed.
Links
- Starfish API Invoices - Get Invoice - Official documentation for the Get Invoice operation in the Starfish API.