Retorna os protocolos de reembolso do beneficiário /totvsHealthPlans/attendance/v1/refunds | |
Nota |
---|
Expandir |
---|
| 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 | subscriber-id (query) | string | Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) | *required | request-date-initial (query) | string (date) | Data inicial de solicitação do protocolo Obrigatório para quando não for informado o query param protocol |
| request-date-final (query) | string (date) | Data final de solicitação do protocolo Obrigatório para quando não for informado o query param protocol |
| protocol (query) | string | Numero do protocolo (BOW_PROTOC) |
| status (query) | string | Status do protocolo de reembolso, sendo: - 0 - Solicitação não concluída
- 1 - Protocolado
- 2 - Em analise
- 3 - Reembolso aprovado
- 4 - Reembolso rejeitado
- 5 - Aguardando informação do Beneficiário
- 6 - Aprovado Parcialmente
- 7 - Cancelado
- 8 - Reembolso revertido
pode ser enviado mais de um status. Exemplo: 0,1,2,3 |
| page (query) | | Valor numérico (maior que zero) representando a página solicitada |
| pageSize (query) | | Valor numérico (maior que zero) representando o total de registros retornados na consulta |
| order (query) | | Lista de campos para ordenação, separada por virgula (,). |
| fields (query) | | Lista com o nome das propriedades JSON que serão retornadas. |
| filter (query) | | Filtros seguindo o padrão ODATA |
|
|
|
Dica |
---|
Expandir |
---|
| Body
Não possui body! |
|
Dica |
---|
Expandir |
---|
title | (200) - Operação realizada com sucesso |
---|
| 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 |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"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"
}
]
} |
|
|
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: >>\"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}<<"
} |
|
|
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"
},
{
"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."
}
]
} |
|
|
Aviso |
---|
Expandir |
---|
title | (400) - Dados do reembolso 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": "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)"
}
]
} |
|
|
|