Home

Série 1

Páginas filhas
  • ExtractGrouping

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Este serviço exibe os totais financeiros de Títulos a Pagar e a Receber agrupados por banco, saldo...


Parâmetros


inidateData inicial para pesquisa. Se não informado uma data final, será considerado tudo a partir da data inicial.
enddateData final para definir intervalo de datas.
bankBusca pelo código do banco informado.
groupAgrupamento dos registros. Aceita DATE ou BANK.
highlightedFiltro de Indicador de gestão (TRUE/FALSE)
pageDetermina a página que deve ser retornada. Pode ser utilizada com o parâmetro max.
maxNúmero de registros máximos a ser apresentados.
orderCampo para ordenação dos registros. Aceita campos e ordem decrescente (DESC)

 

Campos do retorno

 

totalQuantidade de registros do retorno
hasNextIndica se há mais registros na próxima página
syncingIndica se no momento da requisição o sistema estava recebendo alguma nova informação
linesContém as informações dos registros
totalValor total dos títulos
groupingIndica o valor do agrupamento que foi solicitado


Exemplos de consultas e retornos com parâmetros

Exemplo 1: Retornando totais financeiros agrupados por banco.

localhost/ExtractGrouping?group=BANK

{
"total": 6,
"hasNext": false,
"lines": [
{
"total": 95993.41,
"grouping": "0"
},
{
"total": 16198983.75,
"grouping": "001"
},
{
"total": 74837.61,
"grouping": "033"
},
{
"total": 4030762.54,
"grouping": "104"
},
{
"total": 302232.61,
"grouping": "CX1"
},
{
"total": -542385.23,
"grouping": "EMP"
}
]
}

Exemplo 2: Retornando totais financeiros agrupados por data.

localhost/ExtractGrouping?group=DATE

{
"total": 695,
"hasNext": false,
"lines": [
{
"total": -80,
"grouping": "20041103"
},
{
"total": 0,
"grouping": "20120828"
},
{
"total": 5369.9,
"grouping": "20120905"
},
{
"total": 3050.34,
"grouping": "20120906"
},
{
"total": 6118.76,
"grouping": "20120910"
}
]

Exemplo 3: Especificando intervalos de data para o retorno de títulos

localhost/ExtractGrouping?group=DATE&inidate=2004-11-03&enddate=2012-08-28

{
"total": 2,
"hasNext": false,
"lines": [
{
"total": -80,
"grouping": "20041103"
},
{
"total": 0,
"grouping": "20120828"
}
]
}

Exemplo 4: Especificando um código do banco para o retorno de títulos

localhost/ExtractGrouping?group=BANK&bank=001

{
"total": 1,
"hasNext": false,
"lines": [
{
"total": 16198983.75,
"grouping": "001"
}
]
}

Exemplo 5: Retornando a página 10 com 3 registros por página

localhost/ExtractGrouping?group=DATE&max=3&page=10

{
"total": 695,
"hasNext": true,
"lines": [
{
"total": 39034.1,
"grouping": "20121010"
},
{
"total": 38943.22,
"grouping": "20121011"
},
{
"total": 40003.82,
"grouping": "20121015"
}
]
}