Versões comparadas

Chave

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

Índice

01. VISÃO GERAL

Retornar uma lista de registros, com base nos filtros encaminhados, de uma tabela sendo possíveis apenas as seguintes tabelas: FWP, SE1, SE2, SA1, SA2, SA6, SEA.

02. ENDPOINT

Método utilizado: GET

Tabela qualquer: /api/gfin/v1/Tables/<alias da tabela>

03. PARÂMETROS DA REQUISIÇÃO

        Alias da Tabela: Define qual tabela será usada para listagem, valores possíveis: FWP, SE1, SE2, SA1, SA2, SA6, SEA.

Query parameters:

Atributo

Tipo

Descrição

Padrão

pagenumericnúmero da página1
pagesizenumerictamanho da página10
filtercharacter(opcional) filtros no padrão oData-
ordercharacter(opcional) ordem de exibição dos registros-
fieldscharactercampos para o retorno-
folderscharacter'S' para retorna as configurações de folders-

Exemplo:
queryParam

/api/gfin/v1/Tables/SE1?pagesize=10&page=1&allfields=true
 
/api/gfin/v1/Tables/SE1?pagesize=10&page=1&fields=e1_hist,e1_numbor
 
/api/gfin/v1/Tables/SE1?filter=(E1_NUM eq '000000229' or E1_NUM eq '000000230')
 
Folders
/api/gfin/v1/Tables/se1?folder=S&filter=e1_filial eq 'D MG 01' and e1_prefixo eq '' and e1_num eq '000000001' and e1_parcela eq '' and e1_tipo eq 'NF'

04. RESPOSTA DA API

Objeto Json

Atributo

Tipo

Descrição

itemsArraylista de documentos
hasnextLogicaltrue se existir próxima página
structArraystruct dos campos retornados
modeAccess.CompanyCharacterModo de Acesso da Empresa
modeAccess.UnitCharacterModo de Acesso da Unidade
modeAccess.BranchCharacterModo de Acesso da Filial

folders.order

CharacterOrdem do folder
folder.labelCharacterNome do folder