Kobana icon

Kobana

Interact with Kobana API - Quick access to common operations

Actions215

Overview

This node integrates with the Kobana API to manage DARF (Documento de Arrecadação de Receitas Federais) payments, specifically supporting the Update operation on DARFs. It allows users to update existing DARF payment records by specifying the resource ID and providing a JSON request body with the updated data.

Typical use cases include:

  • Modifying details of a DARF payment after creation, such as changing amounts, due dates, or other payment attributes.
  • Automating updates to DARF payments in bulk workflows.
  • Integrating DARF payment management into broader financial automation processes.

Example: Updating a DARF payment's due date or amount programmatically based on external triggers or business logic.

Properties

Name Meaning
ID The unique identifier of the DARF payment resource to update.
Request Body A JSON object containing the fields and values to update for the DARF payment.
Additional Fields Optional JSON object with extra fields to include in the request (not typically used here).

Output

The node outputs the JSON response returned by the Kobana API after updating the DARF payment. This JSON contains the updated DARF payment data, reflecting the changes made.

The output is structured as an array of JSON objects, each representing the updated resource corresponding to an input item.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kobana API.
  • The node dynamically selects the API base URL depending on environment (production or sandbox).
  • No additional external dependencies beyond the Kobana API and its authentication.

Troubleshooting

  • Invalid ID error: If the provided ID does not correspond to an existing DARF payment, the API will return an error. Verify the ID is correct.
  • Malformed JSON in Request Body: Ensure the JSON provided in the "Request Body" property is valid and matches the expected schema for DARF updates.
  • Authentication errors: Confirm that the API key credential is correctly configured and has permissions to update DARF payments.
  • API environment mismatch: Make sure you are using the correct environment (sandbox vs production) matching your API credentials.
  • Network issues: Check connectivity to the Kobana API endpoints.

Links and References

  • Kobana API Documentation (general reference for API endpoints and payloads)
  • DARF Payment API section within Kobana docs (for detailed field definitions and update semantics)

Discussion