Viridem icon

Viridem

Interact's with Viridem

Actions77

Tax Groups → List Tax Group

AI-generated

Overview

This node operation lists tax groups from the Viridem API based on specified parameters such as company ID, status, and feed entity. It is useful for retrieving tax group data for accounting, financial reporting, or tax management purposes within a company.

Use Case Examples

  1. Retrieve all active tax groups for a specific company by providing the company ID and setting the status filter.
  2. Fetch tax groups with feed entity enabled to integrate with other systems or feeds.

Properties

Name Meaning
Company Id The unique identifier of the company for which tax groups are to be listed. This is a required numeric input.
Status Filter tax groups by their status. This is an optional numeric query parameter.
Feed Entity Boolean flag to include feed entity information in the query. This is an optional query parameter.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings to control the API request behavior.

Output

JSON

  • taxGroups - Array of tax group objects returned from the API, containing details about each tax group.

Dependencies

  • Viridem API with OAuth2 authentication

Troubleshooting

  • Ensure the Company Id is provided and is a valid number, as it is required for the request.
  • Check network connectivity and proxy settings if the request fails to reach the API.
  • If SSL certificate validation errors occur, consider enabling the 'Ignore SSL Issues' option cautiously.
  • Timeout errors may occur if the server is slow to respond; adjust the timeout setting accordingly.

Links

Discussion