Quipu icon

Quipu

Interact with Quipu API for invoicing, accounting and taxes

Actions37

Book Entries → Get Book Entries

AI-generated

Overview

This node operation retrieves book entries from the Quipu API, allowing users to filter and sort accounting records such as invoices, tickets, paysheets, and more. It supports filtering by type, kind, payment status, contact ID, period, and custom field queries, as well as sorting and pagination. This is useful for automating the extraction and processing of financial data for reporting, auditing, or integration with other systems.

Use Case Examples

  1. Retrieve all paid invoices for a specific period and sort them by issue date and total amount.
  2. Filter book entries to get only expenses related to a particular contact ID.
  3. Search book entries using a custom field query to find specific accounting records.

Properties

Name Meaning
Filter Type Filter book entries by type such as invoices, tickets, or paysheets.
Filter Kind Filter book entries by kind such as income, expenses, employee, supplier, client, or assets.
Filter Q Search query string to filter book entries by text.
Filter Period Filter book entries by a specific period, e.g., '2015-Q1'.
Filter Payment Status Filter book entries by payment status such as paid, unpaid, due, or pending.
Filter Contact Id Filter book entries by a specific contact ID.
Filter Field Query Filter book entries by a JSON object specifying field and term queries.
Sort Sort criteria for the book entries, e.g., '-issue_date,total_amount'.
Page Number Page number for pagination of results.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • id - Unique identifier of the book entry.
  • type - Type of the book entry, e.g., invoice, ticket.
  • kind - Kind of the book entry, e.g., income, expenses.
  • issue_date - Date when the book entry was issued.
  • total_amount - Total amount of the book entry.
  • payment_status - Payment status of the book entry, e.g., paid, unpaid.
  • contact_id - Identifier of the contact associated with the book entry.
  • description - Description or details of the book entry.

Dependencies

  • Quipu API authentication token or API key credential

Troubleshooting

  • Ensure that the API credentials are correctly configured and valid to avoid authentication errors.
  • Check that the filter parameters are correctly formatted and valid according to the API documentation to prevent request errors.
  • If pagination is used, verify that the page number is within the valid range to avoid empty responses.
  • Network issues or SSL certificate problems can cause request failures; use the 'Ignore SSL Issues' option cautiously if needed.

Links

Discussion