Páginas filhas
  • ER_PCREQ-8286 Lista_Documentos_Enviados_por_Filial

Versões comparadas

Chave

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

...

{
"status": 200,
"result":
{
"documento":
[
{"ENTIDADE":"000002","IDEMPRESA":"00000000000000000001","DOCID":"1000005","DOCUMENTO":"5","DTENVIO":"20140115","DTPROC":"20140115",
"HRENVIO":"08:59:44","HRPROC":"10:36:15","LOGID":"","SERIE":"1","SITUACAO":"MDE0IC0gTkZlIG7jbyBhdXRvcml6YWRhIC0gQ29ycmlqYSBvIHByb2Js
ZW1hIGUgcmV0cmFuc21pdGEgYXMgbm90YXMgZmlzY2FpcyBlbGV0cvRuaWNhcy4gNTM5L1JlamVp5+NvOiBEdXBsaWNpZGFkZSBkZSBORi1lLCBjb20g
ZGlmZXJlbudhIG5hIENoYXZlIGRlIEFjZXNzbyBbY2hORmU6MzUxMzAyNTMxMTM3OTEwMDAxMjI1NTAwMTAwMDAwMDAwNTEwMDU1NTU1NTJdW25S
ZWM6MzUxMDAwMDY4MzU4NjEzXQ==","STATUS":"OK","TIPO":"NFE","AMBIENTE":""},
],
"Paginacao":{"Recno":3}
} ,
"error": null
}


Função: VALENTRADA ()

A função ValEntrada() receberá como parâmetro o objeto da requisição, validará todos os campos quanto a obrigatoriedade, tamanho e tipo de dados. Se algum dado estiver inconsistente, deverá retorna a mensagem de validação correspondente informando.

Os dados contidos no objeto recebido como parâmetro, serão validados afim de identificar quais foram preenchidos, os campos CNPJ, Inscrição Estadual e UF são obrigatórios, os demais não são e, portanto, podem ou não vir preenchidos.

Para obter o ID_ENT do CNPJ informado, será chamada a função GetEntTSS(), será passado como parâmetro o CNPJ, Inscrição Estadual e UF do cliente, informações que estão dentro do objeto recebido como parâmetro, assim a função GetEntTSS() terá como retorno o número da entidade do cliente (ID_ENT).

A função validará o tipo de documento, afim de identificar se é válida, esta informação estará contida dentro do objeto recebido como parâmetro.

Com as informações obtidas como, tipo de documento e número da entidade, será chamada a função ListDocTab(), para essa função serão passados como parâmetros: o número da entidade do cliente, o tipo de documento, número do documento, série do documento, data inicial (DATE_NFE), data final (DATE_NFE) e situação do documento. O retorno desta função será uma matriz com objetos.

Após obter o retorno da rotina ListDocTab(), a função ValEntrada() será encerrada, retornando a matriz com objetos.

 


Parâmetros: 

oObjeto – Mensagem JSon deserializada e transformada em Objeto.

@cError – Mensagem de erro.

@cHttpStatus – Código de status, baseados no formato padrão de mensagens HTTP, conforme o link: https://pt.wikipedia.org/wiki/Lista_de_c%C3%B3digos_de_status_HTTP.

 

Retorno:

aMatriz – Matriz de retorno no formato:

aMatriz

{

{"DOC":"754000595","DTFIM":"","DTINI":"20150805","HFIM":"","HINI":"17:05:28","SERIE":"754","SITUA":"002 - Não foi possível assinar a Nfe - entre em contato com o responsável. 028 - Certificado digital Ausente.","STATUS":"Não Transmitido","TIPO":"NFE"},
{"DOC":"754000596","DTFIM":"2015-08-05","DTINI":"2015-08-05","HFIM":"17:12:55","HINI":"17:11:54","SERIE":"754","SITUA":"014 - NFe não autorizada - Corrija o problema e retransmita as notas fiscais eletrônicas. 525\/Rejeição: CFOP de Importação e não informado dados da DI","STATUS":"OK","TIPO":"NFE"},
{"DOC":"754000597","DTFIM":"2015-08-05","DTINI":"2015-08-05","HFIM":"18:03:32","HINI":"18:02:32","SERIE":"754","SITUA":"014 - NFe não autorizada - Corrija o problema e retransmita as notas fiscais eletrônicas. 525\/Rejeição: CFOP de Importação e não informado dados da DI","STATUS":"OK","TIPO":"NFE"},
{"DOC":"AAA123","DTFIM":" - - ","DTINI":"2015-06-19","HFIM":"","HINI":"13:29:44","SERIE":"AAA","SITUA":"002 - Não foi possível assinar a Nfe - entre em contato com o responsável. 028 - Certificado digital Ausente.","STATUS":"Não Transmitido","TIPO":"NFE"}
}


 
Função: ListDocTab()
A rotina ListDocTab() deverá executar filtros nas tabelas do TSS de acordo os dados de entrada, deverá ter como retorno, uma matriz contendo as informações dos documentos.
Antes de executar o filtro, a rotina identificará qual o modelo de documento, pois, para cada modelo será usado uma query diferente, como exemplo: Modelo 55 – tabela SPED050; Modelo 56 –tabela SPED051.
Para modelo '56', após obter os Âncora_GoBack_GoBack registros, será chamada a rotina NFSERecomen() que tem como retorno uma string com situação do documento.
Para os modelos: 55,57,58 e 65 após obter os registros, será chamada a rotina NfeRec () que tem como retorno uma string com situação do documento.
Após executar a query, a rotina gravará todos os dados encontrados em uma matriz. Essa matriz será o retorno da função.

Parâmetros: 

cEnt – Código da Entidade

cTipo – Tipo de documento

cDoc – Número do documento

cSerie – Série do Documento

cStatus – Status do Documento

dDtini – Data inicial de inclusão do documento do TSS

dDtfim – Data final de inclusão do documento no TSS

cError – Mensagem de erro

cHttpStatus – Status HTTP, https://pt.wikipedia.org/wiki/Lista_de_c%C3%B3digos_de_status_HTTP

Retorno:

aMatriz - Matriz multidimensional contendo objetos, na seguinte estrutura:

aMatriz

{

{"DOC":"754000595","DTFIM":"","DTINI":"20150805","HFIM":"","HINI":"17:05:28","SERIE":"754","SITUA":"002 - Não foi possível assinar a Nfe - entre em contato com o responsável. 028 - Certificado digital Ausente.","STATUS":"Não Transmitido","TIPO":"NFE"},
{"DOC":"754000596","DTFIM":"2015-08-05","DTINI":"2015-08-05","HFIM":"17:12:55","HINI":"17:11:54","SERIE":"754","SITUA":"014 - NFe não autorizada - Corrija o problema e retransmita as notas fiscais eletrônicas. 525\/Rejeição: CFOP de Importação e não informado dados da DI","STATUS":"OK","TIPO":"NFE"},
{"DOC":"754000597","DTFIM":"2015-08-05","DTINI":"2015-08-05","HFIM":"18:03:32","HINI":"18:02:32","SERIE":"754","SITUA":"014 - NFe não autorizada - Corrija o problema e retransmita as notas fiscais eletrônicas. 525\/Rejeição: CFOP de Importação e não informado dados da DI","STATUS":"OK","TIPO":"NFE"},
{"DOC":"AAA123","DTFIM":" - - ","DTINI":"2015-06-19","HFIM":"","HINI":"13:29:44","SERIE":"AAA","SITUA":"002 - Não foi possível assinar a Nfe - entre em contato com o responsável. 028 - Certificado digital Ausente.","STATUS":"Não Transmitido","TIPO":"NFE"}

}

Função: NFSERECOMEN()
A rotina NFSERecomen() deverá obter a situação do documento com base nos parâmetros de entrada.
A rotina receberá um Alias com dados das tabelas: SPED051/SPED053/SPED055. Com esses dados validados, a rotina retornará a mensagem correspondente à situação do documento.

...

cJSONResponse – String na estrutura JSON.

Opcional

Protótipo de Tela

 
<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.
 
Protótipo 01
 
 

Opcional

Fluxo do Processo

 
<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>. 

Opcional

 

Dicionário de Dados

 
Arquivo ou Código do Script: AAA – Negociação Financeira / Versao=CP.2014.12_03/
  

Índice

Chave

01

<FI9_FILIAL+FI9_IDDARF+FI9_STATUS>

02

<FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_EMISS+FI9_IDDARF>

03

<FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_PREFIX+FI9_NUM+FI9_PARCEL+FI9_TIPO>

Campo

<AAA_PERESP>

Tipo

<N>

Tamanho

<6>

Valor Inicial

<Varia de acordo com o tipo informado. Por exemplo, quando o campo "tipo" for date, neste campo pode ser informado uma data>. 

Mandatório

Sim (  ) Não (  )

Descrição

<Referência Mínima para Cálculo>

Título

<Ref.Calc.>

Picture

<@E999.99>

Help de Campo

<Informar o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação>
 

(Opcional)

Grupo de Perguntas

 
<Informações utilizadas na linha Protheus>.
 
Nome: FINSRF2

X1_ORDEM

01

X1_PERGUNT

Emissão De

X1_TIPO

D

X1_TAMANHO

8

X1_GSC

G

X1_VAR01

MV_PAR01

X1_DEF01

Comum

X1_CNT01

'01/01/08'

X1_HELP

Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório 
 

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>
 
Consulta: AMB

Descrição

Configurações de Planejamento

Tipo

Consulta Padrão

Tabela

"AMB"

Índice

"Código"

Campo

"Código"; "Descrição"

Retorno

AMB->AMB_CODIGO
 

(Opcional)

Estrutura de Menu

 
<Informações utilizadas na linha Datasul>.
 
Procedimentos
 

Procedimento

 

 

 

Descrição

(Max 40 posições)

(Max 40 posições)

(Max 40 posições)

Módulo

 

 

 

Programa base

 

 

 

Nome Menu

(Max 32 posições)

(Max 32 posições)

(Max 32 posições)

Interface

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

Registro padrão

Sim

Sim

Sim

Visualiza Menu

Sim/Não

Sim/Não

Sim/Não

Release de Liberação

 

 

 

 
 
 
Programas
 

Programa

 

 

 

Descrição

(Max 40 posições)

(Max 40 posições)

(Max 40 posições)

Nome Externo

 

 

 

Nome Menu/Programa

(Max 32 posições)

(Max 32 posições)

(Max 32 posições)

Nome Verbalizado[1]

(Max 254 posições)

(Max 254 posições)

(Max 254 posições)

Procedimento

 

 

 

Template

(Verificar lista de opções no man01211)

(Verificar lista de opções no man01211)

(Verificar lista de opções no man01211)

Tipo[2]

Consulta/Manutenção/ Relatório/Tarefas

Consulta/Manutenção/ Relatório/Tarefas

Consulta/Manutenção/ Relatório/Tarefas

Interface

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

Categoria[3]

 

 

 

Executa via RPC

Sim/Não

Sim/Não

Sim/Não

Registro padrão

Sim

Sim

Sim

Outro Produto

Não

Não

Não

Visualiza Menu

Sim/Não

Sim/Não

Sim/Não

Query on-line

Sim/Não

Sim/Não

Sim/Não

Log Exec.

Sim/Não

Sim/Não

Sim/Não

Rotina (EMS)

 

 

 

Sub-Rotina (EMS)

 

 

 

Localização dentro da Sub Rotina (EMS)

 

 

 

Compact[4]

Sim/Não

Sim/Não

Sim/Não

Home[5]

Sim/Não

Sim/Não

Sim/Não

Posição do Portlet[6]

0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right

0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right

0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right

Informar os papeis com os quais o programa deve ser vinculado

 

 

 

 
Cadastro de Papéis
<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.
<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.
 

Código Papel

(máx 3 posições)

Descrição em Português*

 

Descrição em Inglês*

 

 

[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.
[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante
[3] Categorias são obrigatórias para os programas FLEX.
[4] Obrigatório quando o projeto for FLEX
[5] Obrigatório quando o projeto for FLEX
[6] Obrigatório quando o projeto for FLEX

...

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.