Dolibarr icon

Dolibarr

Interact with Dolibarr API

Actions28

Contracts → List

AI-generated

Overview

This node operation interacts with the Dolibarr API to list contracts. It allows users to retrieve a list of contracts with customizable query parameters such as sorting field and order, pagination (page and limit), filtering by third-party IDs, and additional SQL filters. It supports fetching all contracts or limiting the number of results. This operation is useful for scenarios where users need to manage or analyze contract data from Dolibarr, such as generating reports, syncing contract data with other systems, or monitoring contract statuses.

Use Case Examples

  1. Retrieve a list of contracts sorted by their row ID in ascending order, limited to 50 results per page.
  2. Fetch all contracts related to specific third-party IDs with custom SQL filters applied to narrow down the results.
  3. Paginate through contract records by specifying the page number and limit to process contracts in batches.

Properties

Name Meaning
Sort Field The database field by which to sort the list of contracts.
Sort Order The order direction for sorting the contracts, either ascending (ASC) or descending (DESC).
Limit Maximum number of contract results to return in one request.
Page The page number of results to query, used for pagination.
Get All Whether to return all contracts or limit the results to the specified limit.
Thirdparty IDs Filter contracts by specific third-party IDs, provided as a comma-separated string.
SQL Filters Additional SQL-like filter criteria to apply to the contract query.
Request Options Additional request settings such as batching, SSL certificate validation, proxy, and timeout options.

Output

JSON

  • contracts
    • `` - Array of contract objects returned from the Dolibarr API, each representing a contract with its details.

Dependencies

  • Dolibarr API with valid credentials

Troubleshooting

  • Ensure the Dolibarr API credentials are correctly configured and have the necessary permissions to access contract data.
  • Verify that the base URL for the Dolibarr API is correct and accessible from the n8n environment.
  • If using SQL filters, ensure the syntax is correct to avoid query errors.
  • When pagination is used, ensure the page number and limit values are within valid ranges to prevent empty or incomplete results.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of the security implications.

Discussion