A API protocols tem como objetivo retornar os dados de protocolos/pegs(BCI) do prestador informado. O verbo disponibilizado é o GET.
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:
Seguem os verbos disponíveis na API:
Verbo | URL | Descrição |
|---|---|---|
| GET | https://<url>:porta>/rest/totvsHealthPlans/v1/protocols | Retorna os protocolos do prestador. |
Dados do queryparam de envio:
Atributo | Tipo | Descrição | Obrigatoriedade |
|---|---|---|---|
| healthProvider | Caracter | Código da RDA(BCI_CODRDA) | Obrigatório |
| year | Caracter | Ano(BCI_ANO) | Se loteNF não for informado, se torna obrigatório |
| mounth | Caracter | Mês(BCI_MES) | Se loteNF não for informado, se torna obrigatório |
| loteNF | Caracter | Sequencial(BCI_LOTENF) | Opcional |
| page | Caracter | Controle de número de paginas da aplicação | Opcional |
| pageSize | Caracter | Controle de quantidade de itens que serão retornados. | Opcional |
| pegs | Caracter | Protocolos separados por "," (BCI_CODPEG) | Opcional |
Dados do queryparam de envio utilizados para integração do Faturamento Portal Autorizador HAT x Planos de Saúde SIGAPLS:
Atributo | Tipo | Descrição | Obrigatoriedade |
|---|---|---|---|
| hatInvoicingJourney | Lógico | Indica que é integração do Faturamento HAT x PLS | Opcional |
| batchNumber | Caracter | Ano(BCI_ANO) | Se loteNF não for informado, se torna obrigatório |
| protocol | Caracter | Mês(BCI_MES) | Se loteNF não for informado, se torna obrigatório |
| authType | Caracter | Tipo da guias (BCI_TIPGUI) | Opcional |
| status | Caracter | Status do lote (BCI_STTISS) | Opcional |
| dateFrom | Data | Data de criação da PEG De (BCI_DTDIGI) | Opcional |
| dateTo | Data | Data de criação da PEG Até (BCI_DTDIGI) | Opcional |
JSON de resposta.
Atributo | Campo Protheus |
|---|---|
| protocol | BCI_CODPEG |
| batchNumber | BCI_LOTGUI |
| providerNumber | BCI_IDXML |
| status | BCI_STTISS |
| givenValue | BCI_VALORI |
| glossValue | BCI_VLRGLO |
| value | BCI_VLRGUI |
| mounth | BCI_MES |
| year | BCI_ANO |
| batchId | BCI_RECNO |
| batchDate | BCI_DTDIGI |
| healthProviderId | BCI_CODRDA |
| authQuantity | BCI_QTDDIG |
| authType | BCI_TIPGUI |
| value | BCI_VLRGUI |
| batchCover | Se (BCI_STTISS = '2' Ou BCI_STTISS = '3' Ou BCI_STTISS = '6') Então '1' Senão '0' |
| batchSend | Se (BCI_STTISS = '0') Então '1' Senão '0' |
| origin | BXX_STATUS |
| healthProviderName | BCI_NOMRDA |
| idxml | BCI_IDXML |
| step | BCI_FASE |
{
"hasNext": false,
"items": [
{
"protocol": "00035389",
"batchNumber": "00029252",
"providerNumber": "",
"status": "2",
"givenValue": 100,
"glossValue": 0,
"value": 949.69,
"mounth": "02",
"year": "2025",
"batchId": 37441,
"batchDate": "20250407",
"healthProviderId": "000004",
"authQuantity": 3,
"authType": "2",
"batchCover": "1",
"batchSend": "0",
"origin": "G",
"healthProviderName": "HMU ESSE É O DO HAT",
"idxml": "",
"step": "3",
"guiasPLS": "1",
"accountReview": "0",
"reviewPeding": "0",
"reviewStatus": "",
"chat": "",
"azureStorageFilePath": "",
"azureStorageSasToken": "",
"fileName": "",
"notes": "",
"valueType": "",
"trackingStatus": 1,
"rejectionCount": 0,
"batchValue": 0
},
{
"protocol": "00030587",
"batchNumber": "00003696",
"providerNumber": "00003696",
"status": "2",
"givenValue": 0,
"glossValue": 0,
"value": 729.37,
"mounth": "07",
"year": "2024",
"batchId": 36129,
"batchDate": "20240704",
"healthProviderId": "000004",
"authQuantity": 2,
"authType": "2",
"batchCover": "1",
"batchSend": "0",
"origin": "X",
"healthProviderName": "HMU ESSE É O DO HAT",
"idxml": "00003696",
"step": "2",
"guiasPLS": "0",
"accountReview": "0",
"reviewPeding": "0",
"reviewStatus": "",
"chat": "",
"azureStorageFilePath": "",
"azureStorageSasToken": "",
"fileName": "",
"notes": "",
"valueType": "",
"trackingStatus": 1,
"rejectionCount": 0,
"batchValue": 0
}
],
"totalRecords": 2
} |
BCI - Protocolos
BD7 - Composição eventos
Parâmetro | Tipo | Descrição | Conteúdo padrão |
|---|---|---|---|
| MV_PLPROT | Caracter | Indica se apresenta todas as guias na API protocols. (0=Somente criadas pelo HAT / 1=Todas guias) | 1 |