Listar vendas no Conta Azul, por uma API

Lista as vendas emitidas em um período, com número, cliente, total e situação, além de totais e quantidades das vendas aprovadas, canceladas e aguardando. A resposta traz itens e total_itens; pagine com pagina, e uma página menor que tamanho_pagina é a última.

Identificador
conta_azul_list_sales

A chamada

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

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
data_iniciostringNãoFirst issue date of the sales, in YYYY-MM-DD.
data_fimstringNãoLast issue date of the sales, in YYYY-MM-DD.
termo_buscastringNãoText to search in the customer name or email or in the sale number.
ids_clientesarrayNãoOnly the sales of these customers, ids from List people.
campo_ordenado_descendentestringNãoField to sort by, newest or highest first: DATA (sale date), NUMERO or CLIENTE (customer name).Valores: DATA, NUMERO, CLIENTE
paginaintegerNãoPage number, starting at 1. The default is 1.
tamanho_paginaintegerNãoSales per page. Any other value is refused with 400.Valores: 10, 20, 50, 100, 200, 500, 1000

Conexões possíveis

O seu cliente conecta a conta do Conta Azul uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/conta_azul, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/conta_azul_list_sales. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Conta Azul

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.