01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

Possibilitar a criação dos romaneios no Originação de Grãos, com base nos dados fornecidos pela pesagem da carga, via integração REST.

Retornar para o TOTVS Agro Pesagem os cadastros necessários para o correto funcionamento da integração.

03. SOLUÇÃO

Com o objetivo de prover os dados corretos ao TOTVS Agro Pesagem e permitir a geração dos romaneios de carga no Originação de Grãos, foi desenvolvido o serviço REST "TPesagService" que possibilita acesso aos métodos detalhados abaixo:

Composition Fields

API: /api/ggp/v1/TPesagService/v1/composition/fields

Método: GET

Descritivo: O método irá retornar os campos adicionais, que serão disponibilizados na tela de pesagem, afim de prover todas as informações necessárias ao módulo de Originação de Grãos. O método é responsável por retornar apenas os campos, sem a estrutura e relacionamentos das entidades.

São disponibilizados os seguintes campos:

codDepos - Informação referente ao código do depósito da carga;

desSafra - Informação referente a safra da carga;

codEmitente - Informação referente ao código do emitente da carga;

codInscricao - Informação referente ao código da inscrição do emitente;

cdnTranspdor - Informação referente ao código do transportador da carga;

numInstruc - Informação referente ao número da instrução de liberação;

lote - Informação referente ao fardo da carga.

EntityHeader

API: /api/ggp/v1/TPesagService/v1/entityHeader

Método: GET

Descritivo: O método irá retornar a estrutura de campos das entidades adicionais da pesagem. Com ele será possível modelar cada uma das entidade e seus relacionamentos.

As estruturas retornadas referem-se as entidades:

deposito - Estrutura dos campos referente a tabela de depósito;

safra - Estrutura dos campos referente a tabela de safra;

emitente - Estrutura dos campos referente a tabela de emitente;

inscricao - Estrutura dos campos referente a tabela de inscrição;

transportador - Estrutura dos campos referente a tabela de transportador;

instrucao - Estrutura dos campos referente a tabela de instrução;

lote - Estrutura dos campos referente a tabela de lotes.

Data

API: /api/ggp/v1/TPesagService/v1/data/<entidade>

Método: GET

Descritivo: O método irá retornar a carga de dados das entidades adicionais da pesagem, bem como a estrutura de campos da entidade consultada.

Entidades possíveis de serem consultadas:

deposito - Dados e estrutura referentes aos depósitos cadastrados no EMS;

safra - Dados e estrutura referentes as safras cadastradas no Originação de Grãos;

emitente - Dados e estrutura referentes aos emitentes que possuem contratos com o Originação de Grãos;

inscricao - Dados e estrutura referentes as inscrições cadastradas no Originação de Grãos;

transportador - Dados e estrutura referentes aos transportadores cadastrados no EMS;

instrucao - Dados e estrutura referentes as instruções de embarque aprovadas no Originação de Grãos;

lote - Dados e estrutura referentes aos lotes/fardos já instruídos e aprovados no Originação de Grãos.

Unity

API: /api/ggp/v1/TPesagService/v1/unity

Método: GET

Descritivo: O método irá retornar a carga de dados das entidades nativas, ou seja, já existentes na pesagem. O objetivo é apenas alimentar os cadastros com os dados do Originação de Grãos. Neste caso, serão retornados os dados referentes aos estabelecimentos.

Entidades retornadas:

estabelecimento - Dados referentes aos estabelecimentos cadastrados no EMS.

Product

API: /api/ggp/v1/TPesagService/v1/product

Método: GET

Descritivo: O método irá retornar a carga de dados das entidades nativas, ou seja, já existentes na pesagem. O objetivo é apenas alimentar os cadastrados com os dados do Originação de Grãos. Neste caso, serão retornados os dados referentes aos produtos.

Entidades retornadas:

produto - Dados referentes aos produtos/itens cadastrados no Originação de Grãos.

Composition

API: /api/ggp/v1/TPesagService/v1/composition

Método: POST

Descritivo: O método irá registrar a pesagem recebida, bem como os dados adicionais da carga, gerando um Romaneio (GG2000) no Originação de Grãos. Os dados recebidos neste método precisam estar adequados com as informações retornadas nos métodos descritos anteriormente. Como retorno, o método informa o número do romaneio gerado e possíveis erros de negócio.

Como Integrar

Como este serviço foi disponibilizado para consumo via padrão REST, basta que a aplicação de origem faça a requisição conforme desejado (GET ou POST).

É importante observar que não existe um cadastro de DE-PARA dos dados trafegados via integração, por isso o método "Composition" (POST) necessita que os dados recebidos estejam de acordo com os cadastros adicionais do Originação de Grãos, fornecidos pelos demais métodos (GET).

Para mais detalhes sobre APIs REST, basta acessar o Guia de APIs Datasul.

Após Integrar

Após realizada a integração da pesagem com o Originação de Grãos, é possível fazer a consulta deste romaneio por intermédio da tela de Romaneios (GG2000) ou via Monitor de Romaneios (html.ggp.packingListsList), onde o romaneio poderá ser localizado utilizando-se do número retornado pelo método "Composition".

Também via tela de Romaneios (GG2000) será possível ajustar algum dado pendente do romaneio e fazer sua confirmação gerando a nota fiscal. Já via Monitor de Romaneios (html.ggp.packingListsList) é possível somente confirmar a nota fiscal.