Conta Azul API icon

Conta Azul API

Allows making requests to the Conta Azul API

Actions18

Create Sale

AI-generated

Overview

This node operation creates a new sale record in the Conta Azul system. It is useful for automating the process of recording sales transactions, including client details, sale date, payment conditions, installments, payment method, status, additional notes, and sale items. Practical examples include recording sales for retail, service businesses, or any scenario where detailed sale tracking is required.

Use Case Examples

  1. Creating a sale with multiple installments and specifying payment method as credit card.
  2. Recording a sale with detailed items including product IDs, descriptions, quantities, and values.
  3. Adding additional observations and payment notes to a sale record.

Properties

Name Meaning
Client ID UUID of the client associated with the sale, used to link the sale to a specific customer.
Sale Number Unique number identifying the sale.
Sale Date Date and time when the sale occurred, formatted as YYYY-MM-DDTHH:mm:ssZ.
Payment Condition Option Description of the payment terms, e.g., 'À vista', '3x', '30,60,90', etc.
Installments Collection of sale installments, each with due date, value, and optional description.
Payment Method Method used for payment, such as Cash, Credit Card, Bank Transfer, PIX, etc.
Status Current status of the sale, either 'In Progress' or 'Approved'.
Additional Fields (Sale Creation) Optional additional fields for sale creation, including observations and payment observations.
Items Collection of items included in the sale, each with product/service ID, description, quantity, and value.

Output

JSON

  • id - Unique identifier of the created sale.
  • clientId - UUID of the client associated with the sale.
  • saleNumber - Number identifying the sale.
  • saleDate - Date and time of the sale.
  • paymentConditionOption - Payment condition description.
  • installments - Array of installments with due dates, values, and descriptions.
  • paymentMethod - Method used for payment.
  • status - Status of the sale.
  • observations - Additional observations about the sale.
  • paymentObservations - Additional observations about the payment.
  • items - Array of items included in the sale with details.

Dependencies

  • Conta Azul API OAuth2 credentials

Troubleshooting

  • Common issues include invalid or missing client ID, incorrect date format for sale date or installments, and missing required fields such as sale number or items.
  • Error messages may indicate unsupported operations if the operation parameter is incorrect.
  • Ensure all required fields are provided and correctly formatted to avoid errors during sale creation.

Discussion