List sales with the Conta Azul API

Lists the sales issued in a period, with number, customer, total and situation, plus totais and quantidades of the approved, canceled and waiting sales. The response has itens and total_itens; page with pagina, and a page shorter than tamanho_pagina is the last one.

Identifier
conta_azul_list_sales

The request

POST https://connect.reportei.com/api/tools/conta_azul_list_sales/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "data_inicio": "<data_inicio>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
data_iniciostringNoFirst issue date of the sales, in YYYY-MM-DD.
data_fimstringNoLast issue date of the sales, in YYYY-MM-DD.
termo_buscastringNoText to search in the customer name or email or in the sale number.
ids_clientesarrayNoOnly the sales of these customers, ids from List people.
campo_ordenado_descendentestringNoField to sort by, newest or highest first: DATA (sale date), NUMERO or CLIENTE (customer name).Values: DATA, NUMERO, CLIENTE
paginaintegerNoPage number, starting at 1. The default is 1.
tamanho_paginaintegerNoSales per page. Any other value is refused with 400.Values: 10, 20, 50, 100, 200, 500, 1000

Supported connections

Your customer connects their Conta Azul account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/conta_azul, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/conta_azul_list_sales. It becomes your agent's tool definition with no conversion.

Other Conta Azul tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.