Conta Azul API icon

Conta Azul API

Allows making requests to the Conta Azul API

Search Sale By ID

AI-generated

Overview

This node operation allows users to search for a specific sale by its unique Sale ID (UUID) using the Conta Azul API. It is useful in scenarios where detailed information about a particular sale transaction is needed, such as retrieving sale details for review, reporting, or further processing within an automation workflow.

Use Case Examples

  1. Retrieve sale details by providing the Sale ID to fetch the exact sale record from the Conta Azul system.
  2. Use this operation to verify the status or details of a sale before proceeding with related business logic.

Properties

Name Meaning
Sale ID The unique identifier (UUID) of the sale to search for.

Output

JSON

  • id - The unique identifier of the sale.
  • customerName - Name of the customer associated with the sale.
  • saleDate - Date when the sale was made.
  • totalAmount - Total amount of the sale.
  • status - Current status of the sale (e.g., approved, in progress).
  • items - List of items included in the sale, each with details such as product/service ID, description, quantity, and value.

Dependencies

  • Conta Azul API OAuth2 credentials required for authentication.

Troubleshooting

  • Ensure the Sale ID provided is a valid UUID and exists in the Conta Azul system to avoid 'Sale not found' errors.
  • Check that the OAuth2 credentials are correctly configured and have the necessary permissions to access sale data.
  • If the node throws an 'Operation not supported' error, verify that the operation parameter is correctly set to 'getSaleById'.

Links

  • Conta Azul API Documentation - Official API documentation for Conta Azul, useful for understanding the sale data structure and API capabilities.

Discussion