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:
| Descrição | Modelo | 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 |
| Escritórios | JURA068 | JESCRITORIO |
| Casos | JURA070 | JCASO |
| Contratos de Faturamento | JURA096 | JCONTRATO |
| Time Sheets | JURA144 | JTIMESHEET |
| Clientes | JURA148 | JCLIENTE |
| Participantes | JURA159 | JPARTICIPANTE |
| Pré-faturas | JURA202 | JPREFAT |
| Modelo resumido de Pré-fatura | JURA202E | JURA202RES |
| Faturas | JURA204 | JFATURA |
| Municípios | FISA010 | JMUNICIPIO |
| Países | JURA194 | JPAIS |
| Estados | JURA195 | JESTADO |
| Tipos de Honorários | JURA037 | JTPHONOR |
| Tipos de Atividade | JURA039 | JTPATIV |
| Serviços Tabelados | JURA040 | JSERVTAB |
| Tabela de Serviços | JURA041 | JTABSERV |
| Tipo de Originação | JURA045 | JTPORIG |
| Tipo da Tabela de Serviços | JURA047 | JTPTABSERV |
| Subárea Jurídica | JURA048 | JSUBAREAJUR |
| Categoria de Participante | JURA050 | JCATEGPART |
| Documento E-billing | JURA057 | JDOCEBILL |
| Empresa E-billing | JURA058 | JEMPEBILL |
| Feriados | JURA078 | JFERIADO |
| Cotações Mensais | JURA111 | JCOTMENSAL |
| Localidades | JURA123 | JLOCALIDADE |
| Tipo de Prestação de Contas | JURA164 | JTPPREST |
| Tipo de Retorno / Situação de Cobrança | JURA073 | JTPRET |
| Grupo de Clientes | FATA110 | JGRPCLI |
| Condição de Pagamento | MATA360 | JCONDPAG |
| Motivo de WO | JURA140 | JMOTIVOWO |
| Anexos | JURA026 | JANEXOS |
| Contatos | JURA232 | JCONTATOS |
| Tabela de Honorários | JURA042 | JTABHONOR |
| Faturas Adicionais | JURA033 | JFATADIC |
| Solicitações de Despesa | JURA235 | JSOLICDES |
| Consulta WO | JURA146 | JCONSULTWO |
| Naturezas Financeiras | FINA010 | JNATUREZA |
| Tabelas de Rateio | JURA238 | JTABRATEIO |
| Lançamentos Financeiros | JURA241 | JLANCAMENTOS |
| Orçamentos | JURA252 | JORCAMENTOS |
| Calendário Contábil | JURA253 | JCALENDARIO |
| Controles de Adiantamentos | JURA069 | JADIANTAMENTO |
| Posição Histórica do Contas a Receber | JURA255 | JPOSRECEBER |
| Rastreio de Recebimento dos Casos da Fatura | JURA256 | JRASTRECEBER |
| Bancos | MATA070 | JBANCO |
| Projetos e Finalidades | JURA264 | JPROJETO |
| Fornecedores | MATA020 | JFORNECE |
| Cobrança | JURA244 | JCOBRANCA |
| Segmentos | CRMA610 | JSEGMENTO |
| Anexos (NUM) | JURA290 | JDOCANEXO |
| Tabela de Honorários Padrão | JURA028 | JTABPADRAO |
| Controle de Versão Legal Desk | JURA300 | - |
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.
Exemplo para o modelo de Time Sheets:
A chave da tabela de processos é NUE_FILIAL + NUE_COD
GET para retornar todos os registros:
<HTTPRESTCLIENTE:/fwmodel/jura144/
Se quisermos retornar um registro específico (registro filial 01 código 0000000001:
<HTTPRESTCLIENTE:/fwmodel/jura144/MDEwMDAwMDAwMDAx
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)