Histórico da Página

(Obrigatório)

Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

(Obrigatório)

Objetivo

<Nesta etapa informar o objetivo da especificação do requisito, ou seja, o que a funcionalidade deve fazer. Exemplo: Permitir que o usuário defina o percentual mínimo em espécie (dinheiro), a referência mínima para calculo dos débitos do aluno e o período de validade do parâmetro de negociação>Disponibilizar uma API para Bilhetagem do TSS.

(Obrigatório)

Definição da Regra de Negócio

<Regra de negócio é o que define a forma de fazer o negócio, o processo definido e/ou as regras que devem ser contempladas. Devem ser descritas restrições, validações, condições e exceções do processo. Caso necessário, incluir neste capítulo também regras de integridade que devem ser observadas no momento do desenvolvimento>.

<Na tabela abaixo informe quais são as rotinas envolvidas, o tipo de operação, a opção de menu e se necessário uma breve descrição das regras de negócio relacionadas a rotina>.

Exemplo de Aplicação:

• Criar o campo “% Mínimo Espécie” (AAA_PERESP) onde o usuário informará o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação.
• Criar o campo “Referência Mínima para Cálculo” (AAA_REFCAL) onde o usuário informará um dos 4 valores disponíveis para pagamento das mensalidades  como a referência mínima para calcular o débito total do aluno.
• Criar o parâmetro MV_ACPARNE que definirá se as informações de “% Mínimo Espécie” e “Referência Mínima para Cálculo” serão obrigatórias.
• O parâmetro MV_ACPARNE deve ter as seguintes opções: 1=Obrigatório e 2=Opcional. Deve ser inicializado como opcional>.

Tabelas Utilizadas

• SE2 – Cadastro de Contas a Pagar
• FI9 – Controle de Emissão de DARF>.

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

 Image Removed

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*/

(Opcional)

Grupo de Perguntas

<Informações utilizadas na linha Protheus>.

Nome: FINSRF2

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

Consulta: AMB

Através da API de bilhetagem do TSS, as aplicações cliente do TSS poderão obter informações sobre a quantidade de documentos que foram para a fila do TSS online. A consulta será realizada por CNPJ ou CPF, inscrição estadual, estado e tipo de pessoa, como os parâmetros mês e ano. O critério para consulta na base de dados será obtido através dos parâmetros recebidos pela API. A API terá como retorno os somatórios das quantidades dos documentos encontrados de todos os CNPJs passado na requisição, separado por ambiente de produção e homologação SEFAZ.

O consumo da API deverá ser realizado através de mensagens JSON em base 64 definidas no serviço REST TSSRESTBILLING().

O processo de Serialização e Deserialização de mensagens deverá ser realizado através das funções FwJsonSerialize() e FwJsonDeserialize() respectivamente.

Os códigos de status serão baseados no formato padrão de mensagens HTTP, conforme o link:

https://pt.wikipedia.org/wiki/Lista_de_c%C3%B3digos_de_status_HTTP

As informações obrigatórias para o consumo da API são CNPJ ou CPF, inscrição estadual, estado e tipo de pessoa, como os parâmetros mês e ano 

WebService: TSSRESTBILLING()

Serviço REST responsável pela definição da Interface da API de Bilhetagem TSS.

O serviço deverá receber mensagens na estrutura JSON codificado em base64, onde serão decodificadas e passadas como parâmetro para a função TSSBilling().

Parâmetros: 

JSON = ew0KICAgICAgICAgICAgIkVNUFJFU0EiOiBbew0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiQ0dDIjogIjA3NTQ5NzA3MDAwMTA5IiwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIklOU0MiOiAiMTIxIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIlVGIjogIlNQIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIlRJUE9QRVNTT0EiOiAiMiINCiAgICAgICAgICAgICAgICAgICAgICAgIH0sDQogICAgICAgICAgICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJDR0MiOiAiMDc1NDk3MDcwMDAxMDkiLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiSU5TQyI6ICIxMjEiLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiVUYiOiAiU1AiLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiVElQT1BFU1NPQSI6ICIyIg0KICAgICAgICAgICAgICAgICAgICAgICAgfQ0KICAgICAgICAgICAgXSwNCiAgICAgICAgICAgICJQQVJBTUVUUk9TIjogew0KICAgICAgICAgICAgICAgICAgICAgICAgIkFOTyI6ICIyMDE3IiwNCiAgICAgICAgICAgICAgICAgICAgICAgICJNRVMiOiAiMDUiDQogICAgICAgICAgICB9DQp9DQogDQo=

Mensagem JSON sem codificação 64:

{

            "EMPRESA": [{

                                   "CGC": "07549707000109",

                                   "INSC": "121",

                                   "UF": "SP",

                                   "TIPOPESSOA": "2"

                        },

                        {

                                   "CGC": "07549707000109",

                                   "INSC": "121",

                                   "UF": "SP",

                                   "TIPOPESSOA": "2"

                        }

            ],

            "PARAMETROS": {

                        "ANO": "2017",

                        "MES": "05"

            }

}

Retorno Negativo:

{

                "RESULT": {

                                               "PRODUCAO": {

                                                                              "TOTALDOCUMENTOS": 0,

                                                                              "TOTALTENTATIVAS": 0

                                                                              },

                                               "HOMOLOGACAO": {

                                                                              "TOTALDOCUMENTOS": 0,

                                                                              "TOTALTENTATIVAS": 0

                                                                              }

                                               },

                "error":" Informe os dados da empresa corretamente. "

}

Retorno Positivo: 

{

                "RESULT": {

                                               "PRODUCAO": {

                                                                              "TOTALDOCUMENTOS": 100,

                                                                              "TOTALTENTATIVAS": 360

                                                                              },

                                               "HOMOLOGACAO": {

                                                                              "TOTALDOCUMENTOS": 250,

                                                                              "TOTALTENTATIVAS": 1000

                                                                              }

                                               },

                "error":""

}

Função: TSSBilling()

A função deverá receber a mensagem JSON já convertida pela função FwJsonDeserialize(). Será realizado a validação das informações da requisição, assim será realizado a busca dos documentos das entidades envolvidas.

(Opcional)

Estrutura de Menu

<Informações utilizadas na linha Datasul>.

Procedimentos

Programas

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>.