Viridem

Interact's with Viridem

Actions77

Columns Actions
- List Column
- Get By Id Column
Comments Actions
- Get Comments Document Anchor
- Add Comment Document Anchor
Companies Actions
- List Company
- List Company 2
Currencies Actions
- List Currency
Document Anchors Actions
- List Document Anchor
- List Basket Document Anchor
- Count Basket Document Anchor
- Check Edited Document Anchor
- Get By Id Document Anchor
- Update Document Anchor
- Delete Document Anchor
- Get Versions Document Anchor
- Get History Document Anchor
- Rotate Document Anchor
- Split Document Anchor
- Reassign Document Anchor
- Reassign All Document Anchor
- Redetect Document Anchor
- Get File Document Anchor
- Get Symbolic Links Document Anchor
- Get Group Treatments Document Anchor
- Get Group Documents Document Anchor
- Count Without Template Document Anchor
- List Without Template Document Anchor
- Set Template Document Anchor
- Transition Document Anchor
- Get State Document Anchor
- Update State Document Anchor
Annotations Actions
- Add Annotations Document Anchor
Expenses Actions
- List Expense
- Delete Attachment Expense
- Lock Expense
- Unlock Expense
- Get By Id Expense
- Delete Expense
- Update Expense
- Get Ai Result Expense
- Get Image Expense
- Get Configurations Expense
Expense Categories Actions
- List Expense Category
Expense Projects Actions
- List Expense Project
Expense Reports Actions
- Publish Expense Report
- Get Status Expense Report
External Attachments Actions
- Get File External Attachment
Fields Actions
- List Field
- Count Field
- Get By Id Field
Files Actions
- Update File
- Upload Multiple File
- Create Form File
Groups Actions
- List Group
Pending Transaction Actions
- List Pending Transaction
- Get Pending Transaction Document Anchor
- Update Pending Transaction
Taxes Actions
- List Tax
Tax Groups Actions
- List Tax Group
- Get By Id Tax Group
- Get Last Used Tax Group
Templates Actions
- List Template
- List All Template
- Get By Id Template
- List Forms Template
Template Types Actions
- List Template Type
- Get By Id Template Type
Streams Actions
- Get By Id Stream
Users Actions
- Get Profile User
- List User 2
- Get Functionality Access User
- Get Access User
- Get Profile Signature User 2
- Get Profile Signature User
- List User
- Get By Id User
Viridem Actions
- Get Versions Viridem

Streams → Get By Id Stream

AI-generated

Overview

This node operation retrieves a specific stream by its ID within a company context. It is useful for scenarios where detailed information about a particular stream is needed, such as monitoring or processing data related to that stream. For example, it can be used to fetch stream details for auditing or integration purposes.

Use Case Examples

Fetch stream details by providing the company ID and document anchor ID to get the exact stream information.
Use optional query parameters like current step ID, edition date, and pending program status to refine the stream retrieval.

Properties

Name	Meaning
Company Id	The unique identifier of the company to which the stream belongs.
Document Anchor Id	The unique identifier of the document anchor associated with the stream.
Current Step Id	Optional query parameter to specify the current step ID in the stream process.
Edition Date	Optional query parameter to specify the edition date for filtering the stream.
Has Pending Program	Optional boolean query parameter indicating if the stream has a pending program.
Request Options	Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

streamId - The unique identifier of the retrieved stream.
companyId - The company ID associated with the stream.
documentAnchorId - The document anchor ID linked to the stream.
currentStepId - The current step ID in the stream process.
editionDate - The edition date of the stream.
hasPendingProgram - Indicates if the stream has a pending program.
streamDetails - Additional details and metadata about the stream.

Dependencies

An API key credential for authentication with the Viridem API

Troubleshooting

Ensure that the required properties 'Company Id' and 'Document Anchor Id' are provided; missing these will cause errors.
Check network connectivity and proxy settings if requests time out or fail.
If SSL certificate validation fails and 'Ignore SSL Issues' is not enabled, the request will be rejected.
Verify that the API credentials are correctly configured and have the necessary permissions.

ViridemInstall