Realiza a inclusão de um novo protocolo de reembolso para o beneficiário | /totvsHealthPlans/attendance/v1/refunds | |
| Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required |
|
|
| status | 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 no sistema | BOW_OPEMOV | *required | | subscriberId | string | Matricula do beneficiário solicitante do protocolo | BOW_USUARI | *required | | refundReceipts | array | Comprovantes de reembolso |
| *required | | refundReceipts.unreferencedNetworkIdentifier | string | CPF/CNPJ do prestador de serviço | B1N_PRCNPJ | *required | | refundReceipts.unreferencedNetworkName | string | Nome do prestador de serviço | B1N_PRNOME | *required | | refundReceipts.stateAbbreviation | string | Estado do prestador | B1N_EST | *required | | refundReceipts.cityCode | string | Código do Município do prestador (obtido através da api /totvsHealthPlans/locality/v1/cities) | B1N_CODMUN | *required | | refundReceipts.documentCode | string | Código do tipo de comprovante (obtido através da api /totvsHealthPlans/refundSetup/v1/documents) | B1N_TIPDOC (BBS_COD) | *required | | refundReceipts.documentNumber | 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 | 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 | B1N_CODPAD | *required | | refundReceipts.expenses.procedureCode | string | Código da despesa | B1N_CODPRO | *required | | refundReceipts.expenses.continuousUse | string | Quando a despesa for medicamento, informa se é de uso contínuo, sendo: | 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 |
{
"status" : "1",
"healthInsurerCode" : "0001",
"subscriberId" : "00011008000027010",
"refundReceipts" : [
{
"unreferencedNetworkIdentifier" : "77077733000159",
"unreferencedNetworkName" : "JOSE",
"stateAbbreviation" : "SP",
"cityCode" : "3500105",
"documentCode" : "03",
"documentNumber" : "000001235",
"documentDate" : "2023-06-07",
"expenses" : [
{
"subscriberId" : "00011008000027010",
"procedureClass" : "000005",
"tableCode" : "04",
"procedureCode": "0490173961",
"continuousUse" : "1",
"prescriptionCode" : "41750520230419000001",
"expenseAmount": 250,
"quantity" : 1,
"executionDate" : "2023-06-07"
}
],
"attachments" : [
{
"href" : "https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste"
}
]
}
]
} |
|
|
| protocol | string | Numero do protocolo gerado para o reembolso | BOW_PROTOC | *required | | status | string | Status do protocolo: - 0 - Solicitação não concluída
- 1 - Protocolado
| BOW_STATUS | *required | | requestDate | string (date) | Data de solicitação | BOW_DTDIGI | *required | | 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 companies (Padrão HATEOAS): - rel: expenses (Despesas do protocolo)
- rel: attachments (Anexos do protocolo)
|
| *required |
{
"protocol": "41750520230607000003",
"status": "1",
"requestDate": "2023-06-07",
"presentedAmount": 250,
"refundedAmount": 0,
"paymentDate": "",
"beneficiaryName": "HERNANDES ALVES DA SILVA",
"links": [
{
"rel": "expenses",
"href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/expenses"
},
{
"rel": "attachments",
"href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/attachments"
}
]
} |
|
|
| 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. |
|
{
"code": "E001",
"message": "JSON inválido",
"detailedMessage": "Json 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\n {\r\n \"subscriberId\" : \"00011008000027010\",\r\n \"procedureClass\" : \"000005\",\r\n \"tableCode\" : \"04\",\r\n \"procedureCode\": \"0490173961\",\r\n \"continuousUse\" : \"1\",\r\n \"prescriptionCode\" : \"41750520230419000001\",\r\n \"expenseAmount\": 250,\r\n \"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}<<"
} |
|
|
| 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. |
|
{
"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"
},
{
"code": "E002B-406",
"message": "Campo healthInsurerCode obrigatório",
"detailedMessage": "Não foi informado valor do campo healthInsurerCode."
},
{
"code": "E002E-406",
"message": "Tamanho inválido para o campo healthInsurerCode",
"detailedMessage": "O valor do campo healthInsurerCode deve ter o tamanho 4."
},
{
"code": "E002E-406",
"message": "Tamanho inválido para o campo subscriberId",
"detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
},
{
"code": "E002B-406",
"message": "Campo refundReceipts obrigatório",
"detailedMessage": "Não foi informado valor do campo refundReceipts."
}
]
} |
|
|
| 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 |
{
"code": "E003",
"message": "Dados inválidos para realizar a solicitação de reembolso",
"detailedMessage": "Verifique os detalhes dos erros no campo details",
"details": [
{
"code": "E004A-404",
"message": "Operadora de saúde não encontrada",
"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 encontrado",
"detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027012 no cadastro (BA1)"
}
]
} |
|
|
|