API CompetenceProtocols

01. VISÃO GERAL

A API competenceProtocols tem como objetivo retornar os dados de fechamento de competências (B0J) do prestador informado e de alterar o status do lote de fechamento. Os verbos disponibilizados são GET e PUT.

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
GET	https://<url>:porta>/rest/totvsHealthPlans/v1/competenceProtocols	Retorna os dados de fechamento de competências do prestador
PUT	https://<url>:porta>/rest/totvsHealthPlans/v1/competenceProtocols/{sequencial}	Altera o status do lote de fechamento do prestador

04. USO DA API

GET

Dados do queryparam de envio:

Atributo	Tipo	Descrição	Obrigatoriedade
healthProviderCode	Caracter	Código da RDA	Obrigatório
page	Caracter	Controle de número de paginas da aplicação	Opcional
pageSize	Caracter	Controle de quantidade de itens que serão retornados.	Opcional

PUT

Dados do pathparam da requisição:

Tipo	Descrição
Caracter	Sequencial (B0J_LOTENF)

Detalhamento do body da requisição:

Atributo

Tipo

Descrição

status

Caracter

Status do lote de fechamento. Opções:

"A" = Aberto;

"F" = Fechado.

Exemplo de JSON de envio

{
    "status" : "F"
}

05. ATRIBUTOS DE RESPOSTA

GET - JSON de resposta

Atributo	Campo Protheus
sequential	B0J_LOTENF
healthProviderId	B0J_CODRDA
year	B0J_ANO
month	B0J_MES
processingDate	B0J_DATPRO
valueApr	B0J_VLRAPR
valuePag	B0J_VLRPAG
valueGlo	B0J_VLRGLO
status	B0J_STATUS
codeGlosa
descriptionGlosa	BDX_DESGLO
quantityGlosa

PUT - JSON de resposta

Quando houver sucesso na alteração do registro:

Em casos de erro, será retornado o status 400 com o seguinte JSON de resposta:

Erro 400

{
    "code": 400,
    "message": "Ocorreu um erro ao atualizar o registro!",
    "detailedMessage": "Nao foi localizado nenhum registro para o sequencial informado."
}

06. TABELAS UTILIZADAS

B0J - Lote Fechamento PEG

BCI - Protocolos

BDX - Glosas das Movimentações

Árvore de páginas