ADVBOX icon

ADVBOX

Consume Advbox API.

Actions17

Transaction → Get All

AI-generated

Overview

This node operation retrieves a list of financial transactions from the Advbox API with comprehensive filtering options. It is useful for scenarios where users need to fetch transaction data based on various criteria such as process number, customer identification, responsible person, debit bank, lawsuit ID, customer name, category, description, protocol number, cost center, and date ranges for competence, creation, due date, and payment date. Pagination is supported through limit and offset parameters.

Use Case Examples

  1. Fetch all transactions related to a specific lawsuit within a date range.
  2. Retrieve transactions filtered by customer identification and category.
  3. Get a paginated list of transactions filtered by due date and payment date.

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.
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

JSON

  • process_number - The process number associated with the transaction.
  • customer_identification - Identification number of the customer (CPF/CNPJ).
  • responsible - Name or ID of the responsible person for the transaction.
  • debit_bank - The debit bank involved in the transaction.
  • lawsuit_id - ID of the lawsuit related to the transaction.
  • customer_name - Name of the customer involved in the transaction.
  • category - Category of the transaction.
  • description - Description of the transaction.
  • protocol_number - Protocol number associated with the transaction.
  • cost_center - Cost center related to the transaction.
  • competence_start - Start date for competence filtering.
  • competence_end - End date for competence filtering.
  • created_start - Start date for creation date filtering.
  • created_end - End date for creation date filtering.
  • date_due_start - Start date for due date filtering.
  • date_due_end - End date for due date filtering.
  • date_payment_start - Start date for payment date filtering.
  • date_payment_end - End date for payment date filtering.
  • limit - Limit on the number of transactions returned.
  • offset - Offset for pagination to skip a number of transactions.

Dependencies

  • Advbox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and valid to avoid authentication errors.
  • Verify that date filters are in the correct YYYY-MM-DD format to prevent request failures.
  • Check that the limit parameter is within the allowed range (1 to 1000) to avoid errors.
  • If no transactions are returned, confirm that the filter criteria match existing data.

Links

Discussion