ADVBOX icon

ADVBOX

Consume Advbox API

Actions14

Overview

This node integrates with the Advbox API to retrieve financial transaction data. Specifically, the "Transaction" resource with the "Get All" operation allows users to fetch a list of financial transactions filtered by various criteria such as process number, customer identification, responsible person, date ranges, and more.

Common scenarios where this node is beneficial include:

  • Generating reports on financial transactions within specific date ranges or categories.
  • Filtering transactions related to particular lawsuits or customers.
  • Automating workflows that require up-to-date financial transaction data from Advbox.

For example, a user might want to retrieve all transactions related to a specific lawsuit ID within a certain competence period or filter transactions by debit bank and category for reconciliation purposes.

Properties

Name Meaning
Process Number Filter transactions by process number.
Customer Identification Filter transactions by customer identification (CPF/CNPJ).
Responsible Filter transactions by responsible person name or ID.
Debit Bank Filter transactions by debit bank.
Lawsuit ID Filter transactions by lawsuit ID (number).
Customer Name Filter transactions by customer name.
Category Filter transactions by category.
Description Filter transactions by description.
Protocol Number Filter transactions by protocol number.
Cost Center Filter transactions by cost center.
Competence Start Start date for filtering transactions by competence (format: YYYY-MM-DD).
Competence End End date for filtering transactions by competence (format: YYYY-MM-DD).
Created Start Start date for filtering transactions by creation date (format: YYYY-MM-DD).
Created End End date for filtering transactions by creation date (format: YYYY-MM-DD).
Due Date Start Start date for filtering transactions by due date (format: YYYY-MM-DD).
Due Date End End date for filtering transactions by due date (format: YYYY-MM-DD).
Date Payment Start Start date for filtering transactions by payment date (format: YYYY-MM-DD).
Date Payment End End date for filtering transactions by payment date (format: YYYY-MM-DD).
Limit Number of items in the response, between 1 and 1000.
Offset Number of items to skip before starting the response (pagination).

Output

The output is a JSON array of transaction objects matching the applied filters. Each item in the output contains detailed information about a financial transaction as returned by the Advbox API's /transactions endpoint.

The exact structure depends on the Advbox API response but typically includes fields such as transaction identifiers, dates, amounts, related lawsuit or customer info, category, description, and other metadata.

This node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Advbox API.
  • The node expects the Advbox API base URL and token to be configured in the credentials.
  • No additional external dependencies are required beyond the Advbox API access.

Troubleshooting

  • Missing or Invalid API Token: The node will throw an error if the API token is missing or invalid. Ensure the API key credential is correctly set up.
  • Invalid API URL: If the API URL is not provided or incorrect, requests will fail. Verify the API URL in the credentials.
  • Date Format Errors: Date filters must be in YYYY-MM-DD format. Incorrect formats may cause the API to reject the request or return no results.
  • Pagination Issues: Setting limit too high or low can affect performance or result completeness. Use sensible values between 1 and 1000.
  • Empty Results: If no transactions match the filters, the node returns an empty array. Adjust filters accordingly.
  • API Rate Limits or Downtime: Network errors or rate limiting by the Advbox API can cause failures. Retry after some time or check API status.

Links and References


If you need details on other resources or operations, feel free to ask!

Discussion