POST

api/financas/gf/Portador/ImprimirSaldoPortadores

Notas de Implementação:

Gerar a impressão do relatório de Saldo dos Portadores com os filtros informados. Nome Público: AA02449. Grupo: AA02449.

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Modelo:

FiltrosSaldoPortadoresDTO

NomeDescriçãoTipoInformação Adicional
SaldoData

date

Opcional
PortadorInicial

string

Opcional
PortadorFinal

string

Opcional
TgPortador

integer

Opcional
CategoriaCodigoInicial

string

Opcional
CategoriaCodigoFinal

string

Opcional
UnidadeNegocioInicial

string

Opcional
UnidadeNegocioFinal

string

Opcional
SepararPorUnidadeNegocio

boolean

Opcional
SomenteSaldo

boolean

Opcional
ModoImpressao

string

Opcional
NomeRelatorio

string

Opcional

Formato de Envio:

application/json, text/json

Exemplo: 
{
  "SaldoData": "2026-01-13",
  "PortadorInicial": "string 1",
  "PortadorFinal": "string 2",
  "TgPortador": 3,
  "CategoriaCodigoInicial": "string 4",
  "CategoriaCodigoFinal": "string 5",
  "UnidadeNegocioInicial": "string 6",
  "UnidadeNegocioFinal": "string 7",
  "SepararPorUnidadeNegocio": true,
  "SomenteSaldo": true,
  "ModoImpressao": "string 10",
  "NomeRelatorio": "string 11"
}

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo: 
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
401 Não autorizado

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
500 Requisição falhou

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}