Listar ventas en Conta Azul, con una API

Lista las ventas emitidas en un período, con número, cliente, total y situación, además de totais y quantidades de las ventas aprobadas, canceladas y en espera. La respuesta trae itens y total_itens; pagina con pagina, y una página menor que tamanho_pagina es la última.

Identificador
conta_azul_list_sales

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
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).Valores: DATA, NUMERO, CLIENTE
paginaintegerNoPage number, starting at 1. The default is 1.
tamanho_paginaintegerNoSales per page. Any other value is refused with 400.Valores: 10, 20, 50, 100, 200, 500, 1000

Conexiones posibles

Tu cliente conecta su cuenta de Conta Azul una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/conta_azul, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/conta_azul_list_sales. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Conta Azul

Ver las 13 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.