Quipu icon

Quipu

Interact with Quipu API for invoicing, accounting and taxes

Actions37

Paysheets → Get Paysheets

AI-generated

Overview

This node operation retrieves paysheets from the Quipu API based on various filter criteria and pagination options. It is useful for scenarios where users need to query and fetch paysheet data filtered by search queries, periods, payment status, contact IDs, or custom field queries. It also supports sorting and pagination to manage large datasets efficiently. For example, a user can fetch all paid paysheets for a specific period or contact, sorted by issue date and total amount.

Use Case Examples

  1. Fetch all paid paysheets for the period 2015-Q1 sorted by issue date and total amount.
  2. Retrieve unpaid paysheets for a specific contact ID with pagination to handle large result sets.

Properties

Name Meaning
Filter Q Search query to filter paysheets by text.
Filter Period Filter paysheets by a specific period, e.g., '2015-Q1'.
Filter Payment Status Filter paysheets by their payment status such as paid, unpaid, due, or pending.
Filter Contact Id Filter paysheets by a specific contact ID.
Filter Field Query Filter paysheets by custom field queries provided as JSON.
Sort Sort criteria for the paysheets, e.g., '-issue_date,total_amount'.
Page Number Page number for pagination to retrieve specific pages of results.

Output

JSON

  • paysheets - Array of paysheet objects returned from the API based on the applied filters and pagination.

Dependencies

  • Quipu API

Troubleshooting

  • Ensure the API credentials are correctly configured to avoid authentication errors.
  • Check the filter values for correct formatting, especially JSON in 'Filter Field Query'.
  • Pagination parameters should be valid numbers to avoid request errors.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option in request settings.

Links

Discussion