01. DADOS GERAIS
Linha de Produto: | Virtual Age |
---|
Segmento: | Moda |
---|
Módulo: | Integração |
---|
Função: | ConsultarFisFatura |
---|
Requisito/Story/Issue (informe o requisito relacionado) : | DVAITG-2095 |
---|
02. SITUAÇÃO/REQUISITO
Criar a web API ConsultarFisFatura no projeto wsApp(ou WebApiStoreage)
03. SOLUÇÃO
Foi criada a web API ConsultarFisFatura no projeto wsApp(ou WebApiStoreage). Esta recebe como parâmetro de entrada NrCNPJEmp(tipo texto) e NrDias(tipo numérico), e retorna informações de venda através de view fiscal.
Criada a web API ConsultarFisFatura no projeto wsApp(ou WebApiStoreage) para ser disponibilizada em https://www.bhan.com.br:1443/ e https://www5.bhan.com.br:1443/ . Esta recebe como parâmetro de entrada NrCNPJEmp(tipo texto) e NrDias(tipo numérico), e retorna informações de venda através de view fiscal.
GET http://host/api/ConsultarFisFatura?NrCnpjEmp={NrCnpjEmp}&NrDias={NrDias}
Parâmetro(filtro) | Obrigatório | Tipo | Tamanho | Descrição |
NrCnpjEmp | Sim | Texto | 14 | Número de Cnpj da empresa |
NrDias | Sim | Número | - | Número de dias atrás |
Exemplo de consulta:
https://www.bhan.com.br:1443/api/ConsultarFisFatura?NrCnpjEmp=80187156000162&NrDias=25
Exemplo de retorno(JSON):
[ { "nrCnpjEmp":"80187156000162", "nrFatura":774449, "vlVenda":59.51, "dtVenda":"17/01/2019", "hrVenda":"09:50:33", "tpSituacao":"E", "tpOperacao":"S" }, { "nrCnpjEmp":"80187156000162", "nrFatura":775049, "vlVenda":189.92, "dtVenda":"17/01/2019", "hrVenda":"15:39:10", "tpSituacao":"E", "tpOperacao":"S" } ] |
Exemplo de retorno(XML):
Para retorno em XML informar Header Accept: text/xml
<Dados xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <FisFatura> <nrCnpjEmp>80187156000162</nrCnpjEmp> <nrFatura>774449</nrFatura> <vlVenda>59.51</vlVenda> <dtVenda>17/01/2019</dtVenda> <hrVenda>09:50:33</hrVenda> <tpSituacao>E</tpSituacao> <tpOperacao>S</tpOperacao> </FisFatura> <FisFatura> <nrCnpjEmp>80187156000162</nrCnpjEmp> <nrFatura>775049</nrFatura> <vlVenda>189.92</vlVenda> <dtVenda>17/01/2019</dtVenda> <hrVenda>15:39:10</hrVenda> <tpSituacao>E</tpSituacao> <tpOperacao>S</tpOperacao> </FisFatura> </Dados> |
Para esta API foi criada a view V_FIS_FATURA. Também foi alterado o componente INTFM010, onde foi adicionado no campo "Sistema" a opção "ESPHERA(NAPP)" e no campo "Função" a opção "Geral"
Para utilização da API, deverá ser configurado em INTFM010:
"Empresa": informar a empresa do usuário webservice que irá acionar a API "Sistema": "ESPHERA(NAPP)" "Função": "Geral" "Parâmetros" (com valores de exemplo): NR_CNPJ=80187156000162·; NR_DIASLIMITECON=25 |
Ao acionar a API é verificado se existe as configurações "ESPHERA(NAPP)" em INTFM010.
Em NR_CNPJ deverá estar informado o CNPJ da empresa permitida para consulta, ou seja, somente retornará registro desta empresa e se esta for informado no filtro NrCnpjEmp da API.
Em NR_DIASLIMITECON deverá estar informado o número de dias para trás que a consulta poderá buscar. Exemplo: NR_DIASLIMITECON=15 e data atual igual 20/01/2019, buscará registro com data de venda entre 05/01/2019 e 20/01/2019.