Asaas icon

Asaas

Integração com a API do Asaas para pagamentos e cobranças
Join our community

Actions29

Overview

This node integrates with the Asaas API to manage payment charges ("Cobrança") and related financial operations. Specifically, the Get Many operation under the Cobrança (payment) resource retrieves multiple payment charge records from Asaas, optionally filtered by customer ID and status, and limited in number.

Common scenarios where this node is useful include:

  • Fetching a list of all payment charges for reporting or reconciliation.
  • Filtering payments by customer to analyze individual client transactions.
  • Retrieving payments by their status (e.g., confirmed, pending, overdue) to monitor outstanding or completed charges.

Practical example:

  • A business wants to generate a report of all "confirmed" payments for a specific customer within the last month. Using this node's Get Many operation, they can specify the customer ID and filter by status "Confirmado" to retrieve relevant payment data efficiently.

Properties

Name Meaning
Limite Maximum number of payment records to return. Must be at least 1. Default is 50.
Cliente (Filtro) Filter payments by a specific customer ID.
Status (Filtro) Filter payments by their status. Options: Confirmado (Confirmed), Pendente (Pending), Recebido (Received), Vencido (Overdue), Todos (All). Default is no filter (all statuses).

Output

The output is an array of JSON objects representing payment charge records retrieved from the Asaas API. Each object contains detailed information about a payment, such as its ID, customer, billing type, value, due date, status, description, and other metadata as provided by the API.

No binary data output is produced by this operation.

Example output structure snippet (simplified):

[
  {
    "id": "pay_000123456789",
    "customer": "cus_000005219613",
    "billingType": "BOLETO",
    "value": 150.00,
    "dueDate": "2024-06-30",
    "status": "CONFIRMED",
    "description": "Monthly subscription fee",
    "externalReference": "INV-1001"
  },
  ...
]

Dependencies

  • Requires an active connection to the Asaas API via an API key credential.
  • The node uses the Asaas API base URL, switching between sandbox and production environments based on credential configuration.
  • No additional external services are required beyond the Asaas API.

Troubleshooting

  • Package Removal Error: If the node throws an error indicating the package was removed from npm and is no longer available, it means the underlying integration package is deprecated or missing. The user should remove or update the node accordingly.
  • Invalid Customer ID: When creating or filtering payments, providing an invalid or empty customer ID will cause errors. Ensure the customer ID is valid and correctly formatted.
  • API Authentication Errors: Missing or incorrect API keys will result in authentication failures. Verify that the API key credential is properly configured.
  • Rate Limits or Timeouts: Large requests or network issues may cause timeouts or rate limit errors. Adjust the "Limite" property to fetch fewer records per request if needed.
  • Status Filter Misuse: Providing an unsupported status value will result in no results or errors. Use only the predefined status options.

Links and References

Discussion