Lista operações (padrão de filtros igual ao módulo de contas)

Lista e filtra registros de Bank Account.

Visão geral

Lista operações (padrão de filtros igual ao módulo de contas).

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`F_isMasterViewer`	query	`boolean`	opcional	—	`true`
`searchString`	query	`string`	opcional	—	`valor`
`EscrowBankAccountId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`F_account`	query	`integer (int64)`	opcional	—	`10`
`F_borrowerName`	query	`string`	opcional	—	`valor`
`F_creditorName`	query	`string`	opcional	—	`valor`
`F_status`	query	`objeto`	opcional	—	`valor`
`OrderBy`	query	`string`	opcional	—	`valor`
`Page`	query	`integer`	opcional	—	`10`
`Size`	query	`integer`	opcional	—	`10`
`WithEscrowBalance`	query	`boolean`	opcional	—	`true`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`items`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`total`	`integer`	opcional	—	—	`0`
`page`	`integer`	opcional	—	—	`0`
`pageSize`	`integer`	opcional	—	—	`0`

Detalhe de `items`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`creditors`	`array de string`	opcional	—	—	`[ … ]`
`borrowerName`	`string`	opcional	—	—	`"Fulano de Tal"`
`principalAmount`	`integer (int64)`	opcional	—	—	`0`
`outstandingBalance`	`integer (int64)`	opcional	—	—	`0`
`escrowBalance`	`integer (int64)`	opcional	—	—	`0`
`installmentsCount`	`integer`	opcional	—	—	`0`
`openInstallments`	`integer`	opcional	—	—	`0`
`guaranteePercentOverPMT`	`number (decimal)`	opcional	—	—	`1.99`
`status`	`integer`	opcional	—	—	`0`
`statusDescription`	`string`	opcional	—	—	`"texto"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`

Exemplo de resposta

{
  "items": [
    {
      "id": "texto",
      "creditors": [
        "texto"
      ],
      "borrowerName": "Fulano de Tal",
      "principalAmount": 0,
      "outstandingBalance": 0,
      "escrowBalance": 0,
      "installmentsCount": 0,
      "openInstallments": 0,
      "guaranteePercentOverPMT": 1.99,
      "status": 0,
      "statusDescription": "texto",
      "createdAt": "2025-08-11T13:45:00Z"
    }
  ],
  "total": 0,
  "page": 0,
  "pageSize": 0
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operations" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/BankAccount/AutomaticSplit/Operations";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/v1/BankAccount/AutomaticSplit/Operations`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads