Histórico da Página

...

Visão Geral
Exemplo de utilização
Tela api continuousMedications
1. Outras Ações / Ações relacionadas
Tela api continuousMedications
1. Principais Campos e Parâmetros
Tabelas utilizadas

...

Nomenclatura das APIs

Dica

title	Autenticação das APIs

API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

Informações

title

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items

02. EXEMPLO DE UTILIZAÇÃO

...

Painel

titleColor	Orange
borderStyle	solid
title	ContinuousMedications - Inclusão de medicamentos de uso contínuo

Realiza a inclusão de novos medicamentos de uso contínuo para o beneficiário.

/totvsHealthPlans/attendancerefundSetup/v1/refundscontinuousMedications

POST

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required

Dica

Expandir

title	Request

solicitante do protocoloBOWUSUARIrefundReceiptsComprovantes de reembolso

statushealthInsurerCode	string	Define o status final do protocolo, sendo: 1 - Protocolado 0 - Solicitação não concluída	*required	healthInsurerCode	string	Código da operadora de saúde Código da operadora de saúde no sistema	BOWBB0_OPEMOVCODOPE	*required
subscriberId	string	Matricula do beneficiário	(obtido através da API Beneficiaries - v1.000 (Family Contract))	B4F_	MATRIC	*required
professionalCouncil	array	string	Sigla do conselho regional do profissional de saúde da receita (obtido através da API RegionalCouncils - v1.000 (Attendance Network))	B4F_SIGLA	*required
refundReceipts.unreferencedNetworkIdentifierprofessionalCouncilNumber	string	CPF/CNPJ do prestador de serviço	Numero do conselho regional do profissional de saúde da receita	B4F_REGSOLB1N_PRCNPJ	*required
refundReceipts.unreferencedNetworkNamestateAbbreviation	string	Nome do prestador de serviço (obtido através da api /totvsHealthPlans/attendanceNetwork/v1/unreferencedNetworks)	Estado do conselho regional do profissional de saúde da receita	B4F_ESTSOLB1N_PRNOME	*required
refundReceipts.stateAbbreviationprofessionalName	string	Estado do prestadorNome do profissional de saúde da receita (obtido através da api /totvsHealthPlans/attendanceNetwork/v1/unreferencedNetworks) API Professionals - v1.000 (Attendance Network))	BB0_NOME	*required
prescriptionDate	string (date)	Data da receita	B4F_DATINI	*required
medications	array	Medicamentos de uso contínuoB1N_EST		*required
refundReceiptsmedications.cityCodetableCode	string	Código da tabela do Município do prestadormedicamento (obtido através da API Cities Medications - v1.000 (Locality) ou api /totvsHealthPlans/attendanceNetwork/v1/unreferencedNetworksProcedure))	B1NB7D_CODMUNCODPAD	*required
refundReceiptsmedications.documentCodemedicationCode	string	Código do tipo de comprovantemedicamento (obtido através da API Documents Medications - v1.000 (Refund SetupProcedure))	B1N_TIPDOC (BBS_COD)B7D_CODMED	*required
refundReceipts.documentNumberattachments	string	Numero do documento	B1N_NUMDOC
refundReceipts.documentDate	string (date)	Data de emissão do documento	B1N_DATDOC	*required
refundReceipts.expenses	array	Despesas do comprovante de reembolso	*required
refundReceipts.expenses.subscriberId	string	Matricula do beneficiário da despesa (obtido através da API Beneficiaries - v1.000 (Family Contract))	B1N_MATRIC	*required
refundReceipts.expenses.procedureClass	string	Código do tipo de despesa utilizado (obtido através da api totvsHealthPlans/procedure/v1/classes)	B1N_TIPSER	*required
refundReceipts.expenses.tableCode	string	Código da tabela da despesa (obtido através da api /totvsHealthPlans/procedure/v1/classes/{classId}/procedures)	B1N_CODPAD	*required
refundReceipts.expenses.procedureCode	string	Código da despesa (obtido através da api /totvsHealthPlans/procedure/v1/classes/{classId}/procedures)	B1N_CODPRO	*required
refundReceipts.expenses.continuousUse	string	Quando a despesa for medicamento, informa se é de uso contínuo, sendo: 0 - Não 1 - Sim	B1N_USOCON	*required
refundReceipts.expenses.prescriptionCode	string	Código da receita do medicamento de uso continuo (obtivo através da api /totvsHealthPlans/refundSetup/v1/continuousMedications) Obrigatório quando continuousUse for igual a 1	B1N_CODREC
refundReceipts.expenses.expenseAmount	number (double)	Valor total da despesa	B1N_VLRTOT	*required
refundReceipts.expenses.quantity	number (integer)	Quantidade de despesa	B1N_QTDPRO	*required
refundReceipts.expenses.executionDate	string (date)	Data de execução da despesa	B1N_DATPRO	*required
refundReceipts.attachments	array	Anexos do comprovante Obrigatório quando for informado o status igual a 1 - Protocolado	refundReceipts.attachments.href	string	Url do arquivo para que seja realizado o download	*required
array	Anexos dos medicamentos		*required
attachments.href	string	Url do arquivo para que seja realizado o download		*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
	"healthInsurerCode" : "0001",
	"subscriberId" : "00011008000027010",
	"professionalCouncil" : "CRM",
    "stateAbbreviation" : "SP",
    "professionalName" : "VINICIUS",
    "prescriptionDate" : "2023-04-03",
	"professionalCouncilNumber" : "334456",
	"medications" : [
        {
            "tableCode" : "04",
            "medicationCode" : "0490173961"
        }
	],
    "attachments" : [
        {
            "href" : "https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste"
        }
    ]
}

Dica

Expandir

title	(201) - Operação realizada com sucesso

prescriptionCode	string	Código da receita no sistema	B4F_CODREC	*required
status	string	Status da receita dos medicamentos, sendo: 0 - Solicitado (Portal) 1 - Protocolado 2 - Em Analise 3 - Deferido 4 - Indeferido 5 - Deferido Parcialmente 6 - Pendente Inf. beneficiário A - Solicitação não concluída	B4F_STATUS	*required
prescriptionDescription	string	Descrição da receita	B4F_DESCRI	*required
subscriberId	string	Matricula do beneficiário	B4F_MATRIC	*required
subscriberName	string	Nome do beneficiário	BA1_NOMUSR	*required
registrationDate	string (date)	Data de cadastro da receita do medicamento	B4F_DTCAD	*required
professionalCouncil	string	Sigla do conselho regional do profissional da receita	B4F_SIGLA	*required
stateAbbreviation	string	Estado do conselho regional do profissional da receita	B4F_ESTSOL	*required
professionalCouncilNumber	string	Numero do conselho regional do profissional da receita	B4F_REGSOL	*required
professionalName	string	Nome do profissional da receita	BB0_NOME	*required
startValidityDate	string (date)	Data inicial de validade da receita	B4F_DATINI	*required
endValidityDate	string (date)	Data final de validade da receita	B4F_DATFIN	*required
medications	array	Medicamentos de contínuo da receita		*required
medications.tableCode	string	Código da tabela do medicamento	B7D_CODPAD	*required
medications.medicationCode	string	Código do medicamento	B7D_CODMED	*required
medications.medicationDescription	string	Descrição do medicamento	BR8_DESCRI	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "prescriptionCode": "41750520230619000003",
    "status": "1",
    "prescriptionDescription": "Receita Nº 41750520230619000003.",
    "subscriberId": "00011008000027010",
    "subscriberName": "HERNANDES ALVES DA SILVA",
    "registrationDate": "2023-06-19",
    "professionalCouncil": "CRM",
    "stateAbbreviation": "SP",
    "professionalCouncilNumber": "334457",
    "professionalName": "VINICIUS",
    "startValidityDate": "2023-04-03",
    "endValidityDate": "2023-04-03",
    "medications": [

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "status" : "1",
	"healthInsurerCode" : "0001",
	"subscriberId" : "00011008000027010",
    "refundReceipts" : [
        {
            "unreferencedNetworkIdentifier" : "77077733000159",
            "unreferencedNetworkName" : "JOSE",
            "stateAbbreviation" : "SP",
            "cityCode" : "3500105",
            "documentCode" : "03",
            "documentNumber" : "000001235",
            "documentDate" : "2023-06-07",
            "expenses" : [
                {
        {
            "subscriberIdtableCode" : "0001100800002701004",
                    "procedureClassmedicationCode" : "0000050490173961",
                    "tableCode" : "04",
                    "procedureCode": "0490173961","medicationDescription": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20"
        }
            "continuousUse" : "1",
                    "prescriptionCode" : "41750520230419000001",
                    "expenseAmount": 250]
}

Aviso

Expandir

title	(406) - Json do body invalido

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"professionalCouncil\" : \"CRM\",\r\n    \"stateAbbreviation\" : \"SP\",\r\n     \"quantityprofessionalName\" : 1,
\"VINICIUS\",\r\n    \"prescriptionDate\"                "executionDate: \"2023-04-03\",\r\n\t\"professionalCouncilNumber\" : "2023-06-07"		
  \"334457\",\r\n\t\"medications\" : [\r\n         {\r\n     }
       \"tableCode\"     ],
: \"04\",\r\n            \"attachmentsmedicationCode\" : [
\"0490173961\"\r\n        }\r\n\t],\r\n    \"attachments\" : [\r\n  {
      {\r\n              \"href\" : \"https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste\"
\r\n        }\r\n        }
            ]
        }
    ]
}]\r\n}<<"
}

Avisotip

Expandir

title	(201406) - Operação realizada com sucessoCampos inválidos

codeprotocol	string	Numero do protocolo gerado para o reembolso	BOW_PROTOCCódigo identificador do erro.	*required
statusmessage	string	Status do protocolo: 0 - Solicitação não concluída 1 - Protocolado	BOW_STATUS	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
requestDatedetailedMessage	string (date)	Data de solicitação		Mensagem técnica e mais detalhada do erro.BOW_DTDIGI	*required
details
presentedAmount	numeric (double)	Valor apresentado	BOW_VLRAPR	*required
refundedAmount	numeric (double)	Valor reembolsado	BOW_VLRREE	paymentDate	string (date)	Data de pagamento do reembolso	BOW_PGMTO
beneficiaryName	string	Nome do beneficiário solicitante	BOW_NOMUSR	*required
links	array	links relacionados ao recurso refunds (Padrão HATEOAS): rel: expenses (Despesas do protocolo) rel: attachments (Anexos do protocolo)	*required
array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "protocol": "41750520230607000003",
    "statusdetailedMessage": "1",
Verifique a lista  "requestDate": "2023-06-07",
    "presentedAmount": 250de erros no campo details para mais detalhes.",
    "refundedAmountdetails": 0,[
    "paymentDate": "",    {
    "beneficiaryName": "HERNANDES ALVES DA SILVA",
    "linkscode": ["E002D-406",
        {
    "message": "Tipo inválido para o campo   "rel": "expenses"professionalCouncilNumber",
            "hrefdetailedMessage": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/expensesO valor do campo professionalCouncilNumber deve ser do tipo (C)."
        },
        {
            "relcode": "attachmentsE002A-406",
            "hrefmessage": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/attachments"Campo attachments não informado",
            "detailedMessage": "Não foi informado o campo attachments."
        }
    ]
}

Aviso

Expandir

title	(406404) - Json do body invalidoOperadora não encontrada

array

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required	details	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001E003",
    "message": "JSON inválidoOperadora de Saúde não encontrada",
    "detailedMessage": "JsonNão Error: >>\"healthInsurerCode\" : \"0001\",\r\n\t\"subscriberId\" : \"00011008000027010\",\r\n    \"refundReceipts\" : [\r\n        {\r\n            \"unreferencedNetworkIdentifier\" : \"77077733000159\",\r\n            \"unreferencedNetworkName\" : \"JOSE\",\r\n            \"stateAbbreviation\" : \"SP\",\r\n            \"cityCode\" : \"3500105\",\r\n            \"documentCode\" : \"03\",\r\n            \"documentNumber\" : \"000001235\",\r\n            \"documentDate\" : \"2023-06-07\",\r\n            \"expenses\" : [\r\foi encontrada nenhum operadora de saúde com o código 0099"
}

Aviso

Expandir

title	(404) - Beneficiário não encontrado

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E004",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027012"
}

Aviso

Expandir

title	(400) - Dados inválidos

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E005",
    "message": "Erro ao incluir receita de medicamentos de uso continuo.",
    "detailedMessage": "Verifique a lista de erros para mais detalhes",
    "details": [
n        {
        {\r\n      "code": "E005-1",
              \"subscriberId\message" : \"00011008000027010\",\r\n           "Não existe registro relacionado a chave informada no alias BR8, ordenação 1.",
         \"procedureClass\"    "detailedMessage": \"000005\",\r\n         "Id do campo de erro: B7D_CODMED; Id do erro: REGNOIS"
           \"tableCode\" : \"04\",\r\n},
        {
            \"procedureCode\code": \"0490173961\",\r\n        E005-1",
            \"continuousUse\message" : \"1\",\r\n     "Erro ao realizar download do arquivo.",
            "detailedMessage": "Status  \"prescriptionCode\" : \"41750520230419000001\",\code: 404; Erro: Not Found\r\n;                    \"expenseAmount\": 250,\r\nUrl: https://www.totvs.com/wp-content/uploads/2022/04/totvs-shared.png?teste"
        }
             \"quantity\" : 1,\r\n                    \"executionDate\" : \"2023-06-07\"\t\t\r\n                }\r\n            ],\r\n            \"attachments\" : [\r\n                {\r\n                    \"href\" : \"https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste\"\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}<<"
}]
}

Âncora

	continuousMedicationsGet
	continuousMedicationsGet

Painel

titleColor	Orange
borderStyle	solid
title	ContinuousMedications - Retorna os medicamentos de uso contínuo

Retorna os medicamentos de uso contínuo do beneficiário

/totvsHealthPlans/refundSetup/v1/continuousMedications

GET

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
subscriberId (query)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) (obtido através da API Beneficiaries - v1.000 (Family Contract))	*required
prescriptionCode (query)	string	Filtro de medicamentos pelo código da receita no sistema
prescriptionStatus (query)	string	Filtro de medicamentos pelo status da receita, sendo: 0 - Solicitado (Portal) 1 - Protocolado 2 - Em Analise 3 - Deferido 4 - Indeferido 5 - Deferido Parcialmente 6 - Pendente Inf. beneficiário A - Solicitação não concluída pode ser enviado mais de um status. Exemplo: 0,1,2,3
medicationCode (query)	string	Filtro de medicamentos pelo código
expirationDate (query)	string	Filtro de medicamentos pela validade, sendo: 1 - Medicamentos dentro da validade 2 - Medicamentos fora da validade
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de medicamentos
items.prescription_status	string	Status da receita do medicamento: 0 - Solicitado (Portal) 1 - Protocolado 2 - Em Analise 3 - Deferido 4 - Indeferido 5 - Deferido Parcialmente 6 - Pendente Inf. beneficiário A - Solicitação não concluída	B4F_STATUS	*required
items.prescription_Code	string	Código da receita do medicamento	B7D_CODREC	*required
items.initial_medication_date	string (date)	Data inicial da validade do medicamento	B7D_DTVINI	*required
items.final_medication_date	string (date)	Data final da validade do medicamento	B7D_DTFVAL	*required
items.medication_code	string	Código do medicamento	B7D_CODMED	*required
items.medication_description	string	Descrição do medicamento	BR8_DESCRI	*required
items.unit_measure	string	Unidade de consumo do medicamento	B7D_UNICON
items.quantity_authorized	numeric (integer)	Quantidade autorizada do medicamento	B7D_QTDAUT
items.quantity_executed	numeric (integer)	Quantidade utilizada (executada) do medicamento	B7D_QTDEXE
items.state_abbreviation	string	Estado do conselho regional do profissional da receita	B4F_ESTSOL	*required
items.professional_council	string	Sigla do conselho regional do profissional da receita	B4F_SIGLA	*required
items.professional_council_number	string	Numero do conselho regional do profissional da receita	B4F_REGSOL	*required
items.professional_name	string	Nome do profissional da receita	BB0_NOME	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "prescription_status": "3",
            "prescription_code": "41750520230419000001",
            "initial_medication_date": "2023-01-01",
            "final_medication_date": "2023-01-01",
            "medication_code": "0490269497",
            "medication_description": "AAS ADULTO 500 MG COM CT BL AL PLAS INC X 20",
            "unit_measure": "",
            "quantity_authorized": 9999,
            "quantity_executed": 0,
            "state_abbreviation": "SP",
            "professional_council": "CRM",
            "professional_council_number": "1244477111",
            "professional_name": "FRANCISCO"
        },
        {
            "prescription_status": "1",
            "prescription_code": "41750520230619000001",
            "initial_medication_date": "2023-04-03",
            "final_medication_date": "2023-04-03",
            "medication_code": "0490173961",
            "medication_description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "unit_measure": "",
            "quantity_authorized": 0,
            "quantity_executed": 0,
            "state_abbreviation": "SP",
            "professional_council": "CRM",
            "professional_council_number": "334456",
            "professional_name": "VINICIUS"
        }
    ],
    "hasNext": true,
    "remainingRecords": 3
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave subscriberId obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave subscriber-id."
        }
    ]
}

Aviso

Expandir

title	(404) - Beneficiário não encontrado

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

Âncora

	refunds
	refunds

Painel

titleColor	Orange
borderStyle	solid
title	Refunds - Retorna os protocolos de reembolso do medicamento

Retorna protocolos de reembolso vinculado ao medicamento de uso contínuo.

/totvsHealthPlans/refundSetup/v1/continuousMedications/refunds

GET

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
prescriptionCode (query)	string	Código da receita do medicamento	*required
medicationCode (query)	string	Filtro de medicamentos pelo código
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de protocolos do medicamento
items.prescription_code	string	Código da receita do medicamento	B1N_CODREC	*required
items.medication_code	string	Código do medicamento	B1N_CODPRO	*required
items.medication_description	string	Descrição do medicamento	BR8_DESCRI	*required
items.protocol	string	Numero do protocolo de reembolso	B1N_PROTOC	*required
items.status	string	Status do protocolo de reembolso, sendo: 0 = Solicitado (Portal) 1 = Protocolado 2 = Em analise 3 = Deferido 4 = Indeferido 5 = Em digitação 6 = Lib. financeiro 7 = Não lib. financeiro 8 = Glosado 9 = Auditoria A = Solicitação não concluída B = Aguardando informação do Beneficiário C = Aprovado Parcialmente D = Cancelado E = Reembolso Revertido	BOW_STATUS	*required
items.request_date	string (date)	Data de solicitação do reembolso	BOW_DTDIGI	*required
items.quantity_requested	numeric (integer)	Quantidade no reembolso	B1N_QTDMED	*required
items.repayment_date	string (date)	Data de pagamento do reembolso	BOW_DATPAG

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [

Aviso

Expandir

title	(406) - Campos do body inválidos

code

string

Código identificador do erro.

*required

message

string

Literal no idioma da requisição descrevendo o erro para o usuário.

*required

detailedMessage

string

Mensagem técnica e mais detalhada do erro.

*required

details

array

Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002D-406",
            "message": "Tipo inválido para o campo status",
            "detailedMessage": "O valor do campo status deve ser do tipo (C)."
        },
        {
            "code": "E002F-406",
            "message": "Valor inválido para o campo status",
            "detailedMessage": "O valor do campo status deve ser: 0;1"
        },
        {
            "prescription_code": "E002B-40641750520230419000001",
            "messagemedication_code": "Campo healthInsurerCode obrigatório0490173961",
            "detailedMessagemedication_description": "Não foi informado valor do campo healthInsurerCode."DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
        },
        {"protocol": "41750520230525000002",
            "codestatus": "E002E-406A",
            "messagerequest_date": "Tamanho inválido para o campo healthInsurerCode2023-05-25",
            "detailedMessagequantity_requested": "O valor do campo healthInsurerCode deve ter o tamanho 4.1,
            "repayment_date": "2023-05-24"
        },
        {
            "prescription_code": "E002E-40641750520230419000001",
            "messagemedication_code": "Tamanho inválido para o campo subscriberId0490173961",
            "detailedMessagemedication_description": "ODRAMIN 100 valorMG doCOM campoCT subscriberIdBL deveAL terPLAS oINC tamanhoX 17.20",
        }    "protocol": "41750520230529000001",
         {    "status": "A",
            "coderequest_date": "E002B2023-05-40629",
            "messagequantity_requested": "Campo refundReceipts obrigatório"1,
            "detailedMessagerepayment_date": "Não foi informado valor do campo refundReceipts."2023-04-24"
        }
    ],
    }"hasNext": true,
    "remainingRecords": ]30
}

Aviso

Expandir

title	(400406) - Dados do reembolso inválidosParâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E003E001",
    "message": "DadosExistem inválidoschaves paraobrigatórias realizarque anão solicitação de reembolsoforam informadas.",
    "detailedMessage": "Verifique osa detalheslista dosde erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E004AE001-404406",
            "message": "OperadoraChave de saúde não encontradaprescriptionCode obrigatória",
            "detailedMessage": "Não foi encontrada nenhuma operadora de saúde com o código 0099 no cadastro (BA0)"
        },
        {
            "code": "E004B-404",
            "message": "Beneficiário solicitante não encontradoinformado no queryParams da requisição a chave prescription-code."
        }
    ]
}

Aviso

Expandir

title	(404) - Receita não encontrada

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Receita Não Encontrada",
     "detailedMessage": "Não foi possível retornar encontradoos nenhumdados beneficiárioda comreceita aatravés matriculado 00011008000027012código noda cadastro (BA1)"
        }
    ]
}

03. TELA API CONTINUOUSMEDICATIONS

Outras Ações / Ações relacionadas

...

receita informada."
}

03. TELA API CONTINUOUSMEDICATIONS

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica	Não se aplica

04. TELA API CONTINUOUSMEDICATIONS

Principais Campos e Parâmetros

Campo	Descrição
B4F_CODREC	Código da receita no sistema
B7D_CODMED	Código do medicamento
B4F_STATUS	Status da receita do medicamento
MV_PLVALRE	Valida os medicamentos na solicitação de reembolso no portal pela data da receita ou pela data dos medicamentos

05. TABELAS UTILIZADAS

Beneficiários (BA1)
Operadoras de Saúde (BA0)
Cab. Cad. Receitas (B4F)
Medicamentos da Receita (B7D)
Profissionais de Saúde (BB0)
Tabela Padrão (BR8)

04. TELA API CONTINUOUSMEDICATIONS

Principais Campos e Parâmetros

...

Card documentos

Informacao	Use esse box para destacar informações relevantes e/ou de destaque.
Titulo	IMPORTANTE!

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

02. EXEMPLO DE UTILIZAÇÃO

03. TELA API CONTINUOUSMEDICATIONS

03. TELA API CONTINUOUSMEDICATIONS

04. TELA API CONTINUOUSMEDICATIONS

05. TABELAS UTILIZADAS

04. TELA API CONTINUOUSMEDICATIONS