06. EXEMPLOS DE JSONS DE RESPOSTA
CONTEÚDO
- Visão Geral
- Configurações INI
- Verbos
- Uso da API - POST
- Atributos de Resposta
- Exemplos de JSON de Resposta
- Tabelas utilizadas
01. VISÃO GERAL
A API pegTransfer tem como objetivo realizar a transferência de guias que estão em PEGs temporárias para uma nova PEG que permite ser realizado o faturamento no sistema de gestão SIGAPLS. Esta API foi construída inicialmente para realizar o faturamento de guias geradas no Portal Autorizador HAT que foram comunicadas com o sistema de gestão SIGAPLS através da integração TISS Online.
A API recebe um json com o tipo e a lista de guias que devem ser faturadas. Se todas as guias existirem no sistema de gestão e estiverem em uma PEG temporária (geralmente PEGS com o BD5_CODLDP 9999), é gerada uma nova PEG e todas essa guias são transferidas para essa nova PEG. A operação só será concluída se existirem todas as guias listadas.
Para configurar o servidor REST em seu ambiente, consulte o documento: 01. Configuração
02. CONFIGURAÇÕES INI
Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | URL | Descrição |
---|---|---|
POST | https://<url>:porta>/rest/totvsHealthPlans/v1/pegTransfer | Realiza a transferência de guias entre as PEG´s |
04. USO DA API - POST
A API não tem QueryParams específicos, ela recebe um JSON no body com o seguintes conteúdo:
Atributo | Tipo | Descrição |
---|---|---|
batchNumber | Caracter | Código do lote gerado no Portal Autorizador |
authType | Caracter | Tipo do lote gerado. Valores válidos:
|
idOnHealthInsurer | Array | Array com as guias que serão transferidas |
{ "batchNumber": "123456", "authType": "2", "idOnHealthInsurer":[ "000120221100000032", "000120221100000033" ] }
Lote 00000850 criado no sistema de gestão. As guias selecionadas foram movidas para este novo lote com um Local de Digitação válido para ser faturado:
Na tabela da PEG criada, há a marcação que é um lote processado por este processo (BCI_LOTHAT):
05. ATRIBUTOS DE RESPOSTA
O JSON de resposta retorna o número do lote gerado no sistema de gestão SIGAPLS, valor do lote e quantidade de guias:
Atributo | Tipo | Descrição |
---|---|---|
batchNumber | Caracter | Código do lote gerado sistema de gestão SIGAPLS. |
value | Number | Valor do lote gerado. |
formQuantity | Number | Quantidade de guias transferidas |
06. EXEMPLOS DE JSON DE RESPOSTA
{ "batchNumber": "00000850", "value": 4.48, "formQuantity": 2 }
{ "code": 400, "message": "Bad Request", "detailedMessage": "Nao foram encontradas no SIGAPLS todas as guias informadas para processamento", "helpUrl": "", "details": [ { "code": "", "message": "", "detailedMessage": "", "helpUrl": "" } ] }
06. TABELAS UTILIZADAS
- Criação de campo na tabela BCI:
Tabela | Campo | Tipo | Tamanho | Decimal | Titulo | Descrição | Picture | Validação | Inicializador Padrão | cBox | Usado | Exibe Browser | Visual? | Contexto | Obrigatório |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BCI | BCI_LOTHAT | C | 1 | 0 | Lote do HAT | Lote do HAT | @! | 0=Nao;1=Sim | Sim | Não | Alterar | Real | Não |