ADVBOX icon

ADVBOX

Consume Advbox API

Actions14

Overview

This node integrates with the Advbox API to manage legal case data, specifically allowing users to create new lawsuits within the system. It is useful in scenarios where legal professionals or administrative staff need to automate the creation and tracking of lawsuits associated with customers, stages, and lawsuit types.

For example, a law firm could use this node to automatically register new lawsuits when a client signs a contract, linking the lawsuit to responsible users and relevant customers, and optionally adding details like process numbers, protocol numbers, folders, dates, and notes.

Properties

Name Meaning
User ID ID of the user responsible for the lawsuit (selectable from loaded users)
Customer IDs IDs of the customers associated with this lawsuit; provided as a string representing an array of integers (e.g., "[1,2,3]") or comma-separated values
Stage ID ID of the stage for this lawsuit
Lawsuit Type ID ID of the lawsuit type
Additional Fields Optional extra information about the lawsuit:
- Process Number Process number of the lawsuit
- Protocol Number Protocol number of the lawsuit
- Folder Folder name or identifier for the lawsuit
- Date Date related to the lawsuit, formatted as DD/MM/YYYY
- Notes Additional notes or comments about the lawsuit

Output

The node outputs JSON data representing the created lawsuit as returned by the Advbox API. This typically includes all the fields sent during creation along with any additional metadata or identifiers assigned by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Advbox API.
  • The node expects the Advbox API URL and token to be configured in the credentials.
  • The node uses internal helper methods to load options such as users, stages, and lawsuit types dynamically from the API settings endpoint.
  • Network connectivity to the Advbox API endpoint is required.

Troubleshooting

  • Invalid or missing API token: The node will throw an error if the API token is not provided or invalid. Ensure that the API key credential is correctly set up.
  • Malformed Customer IDs: Customer IDs must be provided as a valid JSON array string or a comma-separated list of integers. Invalid formats may cause parsing errors.
  • API endpoint unreachable: Network issues or incorrect API URL configuration can cause request failures.
  • Missing required fields: All required properties (User ID, Customer IDs, Stage ID, Lawsuit Type ID) must be provided; otherwise, the API may reject the request.
  • Date format errors: The optional date field must follow the DD/MM/YYYY format; incorrect formatting may lead to API errors.

To resolve these issues, verify credentials, input formats, and network connectivity. Review error messages returned by the node for specific API response details.

Links and References

Discussion