CONTEÚDO

  1. Visão Geral
  2. Configurações INI
  3. Verbos
  4. Uso da API - POST
  5. Atributos de Resposta
  6. Tabelas utilizadas


01. VISÃO GERAL

A API protocols tem como objetivo retornar os dados de protocolos/pegs(BCI) do prestador informado. O verbo disponibilizado é o GET.


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

GEThttps://<url>:porta>/rest/totvsHealthPlans/v1/protocolsRetorna os protocolos do prestador.

04. USO DA API - GET

Dados do queryparam de envio:

Atributo

Tipo

Descrição

Obrigatoriedade

healthProviderCaracterCódigo da RDA(BCI_CODRDA)Obrigatório
yearCaracter

Ano(BCI_ANO)

Se loteNF não for informado, se torna obrigatório

mounthCaracter

Mês(BCI_MES)

Se loteNF não for informado, se torna obrigatório

loteNFCaracter

Sequencial(BCI_LOTENF)

Opcional

pageCaracter

Controle de número de paginas da aplicação

Opcional

pageSizeCaracter

Controle de quantidade de itens que serão retornados.

Opcional

pegsCaracter

Protocolos separados por "," (BCI_CODPEG)

Opcional

05. ATRIBUTOS DE RESPOSTA

JSON de resposta.

Atributo

Campo Protheus

protocolBCI_CODPEG
batchNumberBCI_LOTGUI
providerNumberBCI_IDXML
statusBCI_STTISS
givenValueBD7_VALORI
glossValueBD7_VLRGLO + BD7_VLRGTX
valueBD7_VLRPAG
mounthBCI_MES
yearBCI_ANO




06. TABELAS UTILIZADAS

BCI - Protocolos

BD7 - Composição eventos