Histórico da Página
...
- Visão Geral
- Exemplo de utilização
- Autorizações
- Dados da Autorização
- Eventos da Autorização
- Tela Autorizações do Beneficiário
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela Autorizações do Beneficiário
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
01. VISÃO GERAL
Este documento tem como objetivo demonstrar a utilização dos endpoints de autorizações do beneficiário, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).
- /totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/authorizations
- /totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}
- /totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}/events
Esses endpoints serão utilizados na nova tela de
...
Gestão do
...
Beneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)
Clique aqui para detalhes sobre como habilitar o serviço de APIs
02. EXEMPLO DE UTILIZAÇÃO
Autorizações
Retorna uma coleção com as autorizações do beneficiário
Endpoint
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/authorizations |
Parâmetros
Authorization (header) | Cabeçalho usado para autorização das requisições | *required | |
Content-Type (header) | 'application/json' é o formato do conteúdo | *required | |
SubscriberId (path) | Número da carteirinha do beneficiário | *required | |
phases (query) | Fases das autorizações, sendo:
| ||
formTypes (query) | Tipos de autorizações, sendo:
Guias de acordo com o cadastro da tabela BCL | ||
initialDate (query) | Data inicial das autorizações: 'AAAA-MM-DD' | ||
finalDate (query) | Data final das autorizações: 'AAAA-MM-DD' | ||
page (query) | Paginação da Coleção | ||
pageSize (query) | Quantidade de Itens por Página | ||
order (query) | Ordenação da Coleção | ||
fields (query) | Filtro de campos dos registros | ||
filter (query) | Indica o filtro querystring recebido (pode se utilizar um filtro oData) |
...
Request
Não possui body!
...
Operação realizada com sucesso (200)
items | Autorizações do Beneficiário | |
items.{campo do SX3} | Os campos retornados da tabela SE1:
| |
items.authorizationid | Chave identificador da autorização para ser utilizado nos endpoints:
Campo: ALIAS+BD5_CODOPE+BD5_CODLDP+BD5_CODPEG+BD5_NUMERO | |
struct | Estrutura dos fields de acordo com o dicionário de dados (SX3) | |
hasNext | Indica se ainda existem registros a serem retornados | |
remainingRecords | Quantidade de registros ainda existem para retorno |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "items": [ { "bd5_codldp": "9999", "bd5_codpeg": "00000499", "bd5_numero": "00000001", "bd5_datpro": "2022-11-1", "bd5_codrda": "000004", "bd5_nomrda": "HOSPITAL BOM CLIMA", "bd5_tipgui": "01", "bd5_fase": "3", "bd5_situac": "1", "bcl_descri": "GUIA DE CONSULTA", "authorizationid": "BD5-000199990000049900000001" }, { "bd5_codldp": "9999", "bd5_codpeg": "00000500", "bd5_numero": "00000001", "bd5_datpro": "2022-11-1", "bd5_codrda": "000004", "bd5_nomrda": "HOSPITAL BOM CLIMA", "bd5_tipgui": "02", "bd5_fase": "3", "bd5_situac": "1", "bcl_descri": "GUIA DE SP_SADT", "authorizationid": "BEA-000199990000050000000001" }, { "bd5_codldp": "9999", "bd5_codpeg": "00000501", "bd5_numero": "00000001", "bd5_datpro": "2022-11-1", "bd5_codrda": "000004", "bd5_nomrda": "HOSPITAL BOM CLIMA", "bd5_tipgui": "03", "bd5_fase": "1", "bd5_situac": "1", "bcl_descri": "GUIA DE SOL. INTERNACAO", "authorizationid": "BE4-000199990000050100000001" } ], "hasNext": false, "remainingRecords": 0, "struct": [ { "field": "BD5_CODLDP", "type": "C", "title": "Cd.Local Dig", "description": "Codigo Local Digitacao", "picture": "@!", "size": 4, "decimals": 0, "cbox": [] }, { "field": "BD5_CODPEG", "type": "C", "title": "Código PEG", "description": "Codigo PEG", "picture": "@!", "size": 8, "decimals": 0, "cbox": [] }, { "field": "BD5_NUMERO", "type": "C", "title": "Número", "description": "Numero da Movimentacao", "picture": "@!", "size": 8, "decimals": 0, "cbox": [] }, { "field": "BD5_DATPRO", "type": "D", "title": "Data Evento", "description": "Data Evento", "picture": "", "size": 8, "decimals": 0, "cbox": [] }, { "field": "BD5_CODRDA", "type": "C", "title": "Cd.Cred/Coop", "description": "Cod. Credenc", "picture": "@!", "size": 6, "decimals": 0, "cbox": [] }, { "field": "BD5_NOMRDA", "type": "C", "title": "Nm.Cred/Coop", "description": "credenciado", "picture": "@!", "size": 40, "decimals": 0, "cbox": [] }, { "field": "BD5_TIPGUI", "type": "C", "title": "Tp. Guia", "description": "Tipo de Guia", "picture": "@!", "size": 2, "decimals": 0, "cbox": [] }, { "field": "BD5_FASE", "type": "C", "title": "Fase", "description": "Fase", "picture": "@!", "size": 1, "decimals": 0, "cbox": [ { "value": "1", "description": "Digitacao" }, { "value": "2", "description": "Conferencia" }, { "value": "3", "description": "Pronta" }, { "value": "4", "description": "Faturada" }, { "value": "5", "description": "Processando" } ] }, { "field": "BD5_SITUAC", "type": "C", "title": "Situação", "description": "Situacao", "picture": "@!", "size": 1, "decimals": 0, "cbox": [ { "value": "1", "description": "Ativa" }, { "value": "2", "description": "Cancelada" }, { "value": "3", "description": "Bloqueada" } ] }, { "field": "BCL_DESCRI", "type": "C", "title": "Descricao", "description": "Descricao", "picture": "@!", "size": 30, "decimals": 0, "cbox": [] } ] } |
Mensagens de Erros
code | Código identificador do erro. (Tabela de Erros) | |
message | Literal no idioma da requisição descrevendo o erro para o usuário. | |
detailedMessage | Mensagem técnica e mais detalhada do erro. |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"code": "E001",
"message": "Beneficiário não encontrado.",
"detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
} |
Informações | ||
---|---|---|
| ||
A rotina antiga da Posição do Beneficiário possuía alguns pontos de entrada para customizar a busca das autorizações, portanto foi criado o seguinte ponto de entrada: |
Dados da Autorização
Retorna os dados da autorização
Endpoint
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId} |
Parâmetros
Authorization (header) | Cabeçalho usado para autorização das requisições | *required | |
Content-Type |
...
(header) | 'application/json' é o formato do conteúdo | *required | |
authorizationId (path) | Chave de Identificação da autorização | *required | |
fields (query) | Filtro de campos dos registros |
...
Request
Não possui body!
...
Operação realizada com sucesso (200)
fields | Autorizações do Beneficiário | |
fields.{campo do SX3} | Os campos retornados da tabela de autorização: Tabela BD5 (Autorizações do Proc. Contas):
Tabela BEA (Autorizações de origem HAT - Portal Autorizador):
Tabela BE4 (Solic. de Internação):
| |
struct | Estrutura dos fields de acordo com o dicionário de dados (SX3) | |
folders | Pastas do fields (Abas) de acordo com o dicionário de dados (SXA) |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"fields": {
"bd5_codope": "0001",
"bd5_codldp": "9999",
"bd5_codpeg": "00000499",
"bd5_numero": "00000001",
"bd5_datpro": "2022-11-01",
"bd5_codrda": "000004",
"bd5_nomrda": "HOSPITAL BOM CLIMA",
"bd5_cid": "Z000",
"bd5_descid": "EXAME MEDICO GERAL",
"bd5_cidsec": "",
"bd5_regsol": "280384",
"bd5_nomsol": "ALINE MARGON PERINI",
"bd5_tipcon": "1",
"bd5_valor": 0,
"bd5_vlrbpr": 76.4,
"bd5_vlrman": 77.12,
"bd5_vlrglo": 0,
"bd5_vlrpag": 77.12,
"bd5_vlrbpf": 76.4,
"bd5_vlrpf": 15.28,
"bd5_fase": "3",
"bd5_situac": "1",
"bd5_aterna": "0",
"bd5_cid3": "",
"bd5_cid4": "",
"bd5_cid5": "",
"bd5_vlrtad": 0,
"bd5_vlrtpf": 15.28,
"bd5_indaci": "",
"bd5_datsol": "2022-11-01",
"bd5_horsol": "1904",
"bd5_indcli": "",
"bd5_indcl2": "",
"bd5_tipate": "07",
"bd5_tipadm": "6",
"bd5_desadm": "ELETIVA / PROGRAMADA / ROTINA"
},
"struct": [
{
"field": "BD5_CODOPE",
"type": "C",
"title": "Operadora",
"description": "Operadora",
"picture": "@!",
"size": 4,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "03"
},
{
"field": "BD5_CODLDP",
"type": "C",
"title": "Cd.Local Dig",
"description": "Codigo Local Digitacao",
"picture": "@!",
"size": 4,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "10"
},
{
"field": "BD5_CODPEG",
"type": "C",
"title": "Código PEG",
"description": "Codigo PEG",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "11"
},
{
"field": "BD5_NUMERO",
"type": "C",
"title": "Número",
"description": "Numero da Movimentacao",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "12"
},
{
"field": "BD5_DATPRO",
"type": "D",
"title": "Data Evento",
"description": "Data Evento",
"picture": "",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "14"
},
{
"field": "BD5_CODRDA",
"type": "C",
"title": "Cd.Cred/Coop",
"description": "Cod. Credenc",
"picture": "@!",
"size": 6,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "20"
},
{
"field": "BD5_NOMRDA",
"type": "C",
"title": "Nm.Cred/Coop",
"description": "credenciado",
"picture": "@!",
"size": 40,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "24"
},
{
"field": "BD5_CID",
"type": "C",
"title": "CID",
"description": "CID",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "31"
},
{
"field": "BD5_DESCID",
"type": "C",
"title": "Desc. CID",
"description": "Desc CID",
"picture": "@!",
"size": 50,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "32"
},
{
"field": "BD5_REGSOL",
"type": "C",
"title": "C.R. Solic.",
"description": "C.R Solicita",
"picture": "@R !!!!!!!!!!",
"size": 15,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "38"
},
{
"field": "BD5_NOMSOL",
"type": "C",
"title": "Solicitante",
"description": "Solicitante",
"picture": "@!",
"size": 30,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "39"
},
{
"field": "BD5_TIPCON",
"type": "C",
"title": "Tp. Consulta",
"description": "Tp Consulta",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Primeira"
},
{
"value": "2",
"description": "Retorno "
},
{
"value": "3",
"description": "Pre-Natal"
},
{
"value": "4",
"description": "Por Encaminhamento"
}
],
"folder": "1",
"order": "40"
},
{
"field": "BD5_ATERNA",
"type": "C",
"title": "Atdo.Rec.Na?",
"description": "Atendimento Recem Nascido",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Sim"
},
{
"value": "0",
"description": "Nao"
}
],
"folder": "1",
"order": "73"
},
{
"field": "BD5_INDACI",
"type": "C",
"title": "Indic Aciden",
"description": "Indicação de Acidente",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "0",
"description": "Trabalho"
},
{
"value": "1",
"description": "Trânsito"
},
{
"value": "2",
"description": "Outros"
},
{
"value": "9",
"description": "Nao Acidente"
}
],
"folder": "1",
"order": "AN"
},
{
"field": "BD5_DATSOL",
"type": "D",
"title": "Data Solicit",
"description": "Data Solicitação",
"picture": "@D",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "AQ"
},
{
"field": "BD5_HORSOL",
"type": "C",
"title": "Hora Solicit",
"description": "Hora Solicitação",
"picture": "@R !!:!!",
"size": 4,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "AR"
},
{
"field": "BD5_INDCLI",
"type": "C",
"title": "Indic Clínic",
"description": "Indicação Clínica",
"picture": "@S70",
"size": 250,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "AS"
},
{
"field": "BD5_INDCL2",
"type": "C",
"title": "Cont. IndClí",
"description": "Indicação Clínica",
"picture": "@S70",
"size": 250,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "AT"
},
{
"field": "BD5_TIPATE",
"type": "C",
"title": "Tipo Atendim",
"description": "Tipo Atendimento",
"picture": "@!",
"size": 2,
"decimals": 0,
"cbox": [
{
"value": "01",
"description": "Remoção"
},
{
"value": "02",
"description": "Pequena Cirurgia"
},
{
"value": "03",
"description": "Outras Terapias"
},
{
"value": "04",
"description": "Consulta"
},
{
"value": "05",
"description": "Exame Ambulatorial"
},
{
"value": "06",
"description": "Atendimento Domiciliar"
},
{
"value": "07",
"description": "Internação"
},
{
"value": "08",
"description": "Quimioterapia"
},
{
"value": "09",
"description": "Radioterapia"
},
{
"value": "10",
"description": "Terapia Renal Substitutiva (TRS)"
},
{
"value": "11",
"description": "Pronto Socorro"
},
{
"value": "13",
"description": "Pequeno atendimento (sutura, gesso e outros)"
},
{
"value": "14",
"description": "Saúde Ocupacional - Admissional"
},
{
"value": "15",
"description": "Saúde Ocupacional - Demissional"
},
{
"value": "16",
"description": "Saúde Ocupacional - Periódico"
},
{
"value": "17",
"description": "Saúde Ocupacional - Retorno ao trabalho"
},
{
"value": "18",
"description": "Saúde Ocupacional - Mudança de função"
},
{
"value": "19",
"description": "Saúde Ocupacional - Promoção a saúde"
},
{
"value": "20",
"description": "Saúde Ocupacional - Beneficiário novo"
},
{
"value": "21",
"description": "Saúde Ocupacional - Assistência a demitidos"
},
{
"value": "22",
"description": "TELESSAÚDE"
},
{
"value": "23",
"description": "Exame"
}
],
"folder": "1",
"order": "AV"
},
{
"field": "BD5_TIPADM",
"type": "C",
"title": "Tp. Admissao",
"description": "Tp. Admissao",
"picture": "@!",
"size": 6,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "BI"
},
{
"field": "BD5_DESADM",
"type": "C",
"title": "Descricao",
"description": "Descricao",
"picture": "@C",
"size": 30,
"decimals": 0,
"cbox": [],
"folder": "1",
"order": "BJ"
},
{
"field": "BD5_VALOR",
"type": "N",
"title": "Vlr.Compra",
"description": "Valor Guia Comprada",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "51"
},
{
"field": "BD5_VLRBPR",
"type": "N",
"title": "Vlr.Contr.",
"description": "Valor Contrato Prestador",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "52"
},
{
"field": "BD5_VLRMAN",
"type": "N",
"title": "Vlr.Bs.Pagto",
"description": "Valor Procedimento",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "53"
},
{
"field": "BD5_VLRGLO",
"type": "N",
"title": "Vlr.Glosas",
"description": "Valor Glosas",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "54"
},
{
"field": "BD5_VLRPAG",
"type": "N",
"title": "Vlr.Pagto",
"description": "Valor Pagto Prestador",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "55"
},
{
"field": "BD5_VLRBPF",
"type": "N",
"title": "Vlr.Base PF",
"description": "Valor Base Part. Financ.",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "56"
},
{
"field": "BD5_VLRPF",
"type": "N",
"title": "Vlr.Co-Par",
"description": "Valor Co-Participacao",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "57"
},
{
"field": "BD5_VLRTAD",
"type": "N",
"title": "Vlr.Taxa.Adm",
"description": "Valor Taxa Administracao",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "91"
},
{
"field": "BD5_VLRTPF",
"type": "N",
"title": "Vlr.Total PF",
"description": "Valor Total PF",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": [],
"folder": "5",
"order": "92"
},
{
"field": "BD5_CIDSEC",
"type": "C",
"title": "CID Secund.",
"description": "CID Secundario",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "8",
"order": "34"
},
{
"field": "BD5_FASE",
"type": "C",
"title": "Fase",
"description": "Fase",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Digitacao"
},
{
"value": "2",
"description": "Conferencia"
},
{
"value": "3",
"description": "Pronta"
},
{
"value": "4",
"description": "Faturada"
},
{
"value": "5",
"description": "Processando"
}
],
"folder": "8",
"order": "59"
},
{
"field": "BD5_SITUAC",
"type": "C",
"title": "Situação",
"description": "Situacao",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Ativa"
},
{
"value": "2",
"description": "Cancelada"
},
{
"value": "3",
"description": "Bloqueada"
}
],
"folder": "8",
"order": "60"
},
{
"field": "BD5_CID3",
"type": "C",
"title": "CID 3",
"description": "CID 3",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "8",
"order": "78"
},
{
"field": "BD5_CID4",
"type": "C",
"title": "CID 4",
"description": "CID 4",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "8",
"order": "80"
},
{
"field": "BD5_CID5",
"type": "C",
"title": "CID 5",
"description": "CID 5",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": [],
"folder": "8",
"order": "82"
}
],
"folders": [
{
"id": "1",
"title": "Dados Principais"
},
{
"id": "2",
"title": "Rede Atendimento"
},
{
"id": "3",
"title": "Usuario"
},
{
"id": "4",
"title": "Solicitante"
},
{
"id": "5",
"title": "Financeiro"
},
{
"id": "6",
"title": "Procedimento"
},
{
"id": "7",
"title": "ANS"
},
{
"id": "8",
"title": "Outros"
},
{
"id": "9",
"title": "Produtividade"
},
{
"id": "A",
"title": "Proc em Serie"
}
]
} |
Mensagens de Erros
code | Código identificador do erro. (Tabela de Erros) | |
message | Literal no idioma da requisição descrevendo o erro para o usuário. | |
detailedMessage | Mensagem técnica e mais detalhada do erro. |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"code": "E001",
"message": "Beneficiário não encontrado.",
"detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
} |
Informações | ||
---|---|---|
| ||
A rotina antiga da Posição do Beneficiário possuía alguns parâmetros para customizar os campos que serão apresentados no cabeçalho da autorização, portanto foi criado o seguinte ponto de entrada: |
Eventos da Autorização
Retorna uma coleção com os eventos da autorização
Endpoint
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}/events |
Parâmetros
Authorization (header) | Cabeçalho usado para autorização das requisições | *required | |
Content-Type (header) | 'application/json' é o formato do conteúdo | *required | |
authorizationId (path) | Chave de Identificação da Autorização | *required | |
fields (query) | Filtro de campos dos registros |
...
Request
Não possui body!
...
Operação realizada com sucesso (200)
items | Eventos da Autorização | |
items.{campo do SX3} | Os campos retornados da autorização Tabela BD6 (Autorizações do Proc. Contas):
Tabela BEA (Autorizações de origem HAT - Portal Autorizador):
Tabela BEJ (Solic. de Internação):
| |
struct | Estrutura dos fields de acordo com o dicionário de dados (SX3) | |
hasNext | Indica se ainda existem registros a serem retornados | |
remainingRecords | Quantidade de registros ainda existem para retorno |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"items": [
{
"bd6_codpad": "01",
"bd6_codpro": "10101012",
"bd6_despro": "CONSULTA EM CONSULTORIO",
"bd6_qtdpro": 1,
"bd6_vlrbpr": 76.4,
"bd6_vlrapr": 0,
"bd6_vlracb": 0,
"bd6_vlrman": 77.12,
"bd6_vlrglo": 0,
"bd6_vlrpag": 77.12,
"bd6_vltxpg": 0,
"bd6_vlrbpf": 76.4,
"bd6_vlrpf": 15.28,
"bd6_percop": 20,
"bd6_vlrtad": 0,
"bd6_pertad": 0,
"bd6_vlrtpf": 15.28,
"bd6_datpro": "2022-11-1",
"bd6_status": "1",
"bd6_valor": 0,
"bd6_prprrl": 0,
"bd6_vrprda": 0
}
],
"hasNext": false,
"remainingRecords": 0,
"struct": [
{
"field": "BD6_CODPAD",
"type": "C",
"title": "Cd.Tp.Tabela",
"description": "Cod Tipo Tabela",
"picture": "@!",
"size": 2,
"decimals": 0,
"cbox": []
},
{
"field": "BD6_CODPRO",
"type": "C",
"title": "Cd.Proc.",
"description": "Cod Proc.",
"picture": "@!",
"size": 16,
"decimals": 0,
"cbox": []
},
{
"field": "BD6_DESPRO",
"type": "C",
"title": "Desc. Proc.",
"description": "Desc Proc.",
"picture": "@!",
"size": 80,
"decimals": 0,
"cbox": []
},
{
"field": "BD6_QTDPRO",
"type": "N",
"title": "Qtd Realizad",
"description": "Quantidade Realizada",
"picture": "9999.99",
"size": 9,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRBPR",
"type": "N",
"title": "Vlr.Contr.",
"description": "Valor Contrato Prestador",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRAPR",
"type": "N",
"title": "Vlr.Apr.Pag.",
"description": "Vlr Apresentado Pagamento",
"picture": "@E 999,999,999.9999",
"size": 17,
"decimals": 4,
"cbox": []
},
{
"field": "BD6_VLRACB",
"type": "N",
"title": "Vlr.Apr.Cob.",
"description": "Vlr Apresentado Cobranca",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRMAN",
"type": "N",
"title": "Vlr.Bs.Pagto",
"description": "Valor Base Pagto",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRGLO",
"type": "N",
"title": "Vlr.Glosas",
"description": "Valor Glosas",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRPAG",
"type": "N",
"title": "Vlr.Pagto",
"description": "Valor PAGTO",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLTXPG",
"type": "N",
"title": "Vlr.Taxa Pg.",
"description": "Valor Taxa Adm. Pagto",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRBPF",
"type": "N",
"title": "Vlr.Base PF",
"description": "Valor Base PF",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRPF",
"type": "N",
"title": "Vlr.Co-Par",
"description": "Valor Co-Participacao",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_PERCOP",
"type": "N",
"title": "% Co-Part.",
"description": "% Co-Participacao",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRTAD",
"type": "N",
"title": "Vlr.Taxa.Adm",
"description": "Valor Taxa Administracao",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_PERTAD",
"type": "N",
"title": "% Taxa Adm.",
"description": "% Taxa Administracao",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VLRTPF",
"type": "N",
"title": "Vlr.Total PF",
"description": "Valor Total PF",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_DATPRO",
"type": "D",
"title": "Dt.Proced.",
"description": "Data Proced.",
"picture": "@D",
"size": 8,
"decimals": 0,
"cbox": []
},
{
"field": "BD6_STATUS",
"type": "C",
"title": "Status",
"description": "Status",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Autorizada"
},
{
"value": "0",
"description": "Nao Autorizada"
}
]
},
{
"field": "BD6_VALOR",
"type": "N",
"title": "Vlr. Compra",
"description": "Valor da Compra",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_PRPRRL",
"type": "N",
"title": "Percentual",
"description": "Percentual",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BD6_VRPRDA",
"type": "N",
"title": "Vlr.Pag.Rda",
"description": "Valor Pagto Direto aRDA?",
"picture": "@E 999,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
}
]
} |
Mensagens de Erros
code | Código identificador do erro. (Tabela de Erros) | |
message | Literal no idioma da requisição descrevendo o erro para o usuário. | |
detailedMessage | Mensagem técnica e mais detalhada do erro. |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"code": "E001",
"message": "Beneficiário não encontrado.",
"detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
} |
Informações | ||
---|---|---|
| ||
A rotina antiga da Posição do Beneficiário possuía alguns parâmetros para customizar os campos que serão apresentados no cabeçalho da autorização, portanto foi criado o seguinte ponto de entrada: |
Tabela de Código de Erros
Código de erros informado no Json de retorno com falha:
Code | message | detailedMessage | Status code |
---|---|---|---|
E001 | Beneficiário não encontrado. | Não foi encontrado nenhum Beneficiário com a matricula {subscriberId} | 404 |
E002 | Autorização não encontrada. | Autorização informada não encontrada na base de dados. | 404 |
E003 | Autorização informada invalida. | Dados da autorização informada estão inválidos. | 400 |
03. TELA AUTORIZAÇÕES DO BENEFICIÁRIO
Outras Ações / Ações relacionadas
Ação | Descrição |
---|---|
Não se aplica | Não se aplica |
04. TELA
...
AUTORIZAÇÕES DO BENEFICIÁRIO
Principais Campos e Parâmetros
Campo | Descrição |
---|
Card documentos | ||||
---|---|---|---|---|
|
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO | Carteirinha do beneficiário |
ALIAS+BD5_CODOPE+BD5_CODLDP+BD5_CODPEG+BD5_NUMERO | Chave de identificação da autorização |
05. TABELAS UTILIZADAS
- BA1 - Beneficiários
- BD5 - Processamento de Contas
- BD6 - Eventos Processamentos Contas
- BE2 - Autorização e Procedimentos
- BE4 - Internações
- BEA - Complementos Movimentações
- BEJ - Itens Autorização Internação
...