O objetivo deste documento é mostrar como devem ser utilizados os modelos de dados existentes no módulo Pré-faturamento de Serviços (SIGAPFS), que usam o modelo padrão, FWMODEL.
Além disso, documentar quais modelos estão disponíveis.
Modelos disponíveis:
| Modelo | Descrição | Apelido |
|---|---|---|
| Parâmetros | JURA171 | JPARAM |
| Empresas / filiais | JURA193 | JEMPRESA |
| Fila de Sincronização | JURA170 | JFILASINC |
| Idiomas de Faturamento | JURA029 | JIDIOMA |
| Moedas Contábeis | CTBA140 | JMOEDA |
| Centros de Custos / Grupos Jurídicos | CTBA030 | JGRPJUR |
| Cotações Diárias | MATA090 | JCOTDIARIA |
| Lançamentos Tabelados | JURA027 | JLANCTAB |
| Fechamento de Período | JURA030 | JFECHPER |
| Áreas Jurídicas | JURA038 | JAREAJUR |
| Tipos de Despesa | JURA044 | JTPDESP |
| Despesas | JURA049 | JDESPESA |
Todos os modelos listados acima usam o padrão FWMODEL. Suportam todas as operações (POST PUT, GET, DELETE) RESTFUL. A documentação completa pode ser vista no documento FWRestModel.
A api pode retornar todos os registros ou apenas um registro específico. Para acessar um registro específico, deve ser informada a chave única do registro em formato BASE64.
QueryStrings
COUNT = Quantidade de registro que devem ser retornados (padrão: 10)
STARTINDEX = Indica a partir que qual index deverá ser retornado (padrão: 1)
FILTER = Filtro que será aplicado no método SetFilter()
FIELDDETAIL = Habilita mostrar mais informações nos campos do modelo (padrão: 10)
FIELDVIRTUAL = Habilita o retorno de campos virtuais (padrão: false)
FIELDEMPTY = Habilita o retorno de campos sem valores (padrão: false)
FIRSTLEVEL = Habilita o retorno dos sub modelos (padrão: true)
FIELDS = Indica os campos a serem filtrados no retorno do modelo, incluindo os sub modelos, caso não informado todos os campos serão retornados
DEBUG = Valor booleano para habilitar o modo debug (padrão: false)
CACHE = Indica se será feito cache do total de registros por alias, refere-se ao valor do total no retorno (padrão: true)
INTERNALID = Indica se deve retornar o ID (Recno) como informação complementar das linhas do GRID (padrão: false)