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 |
|---|
| | 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 de reembolso retornados |
|
| | items. | | 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 | - 2 - Em analise
- 3 - Reembolso aprovado
- 4 - Reembolso rejeitado
- 5 - Aguardando informação do Beneficiário
- 6 - Aprovado Parcialmente
- 7 - Cancelado
- 8 - Reembolso revertido
| BOW_STATUS | *required | | items.protocol | string | Numero do protocolo de reembolso | BOW_PROTOC | *required | | items.request-date | string (date) | Data da | requestDate | string (date) | Data de solicitação | BOW_DTDIGI | *required | presentedAmount| items.presented-amount | numeric (double) | Valor apresentado | BOW_VLRAPR | *requiredrefundedAmount | | items.refunded-amount | numeric (double) | Valor reembolsado | BOW_VLRREE | paymentDate
| | items.payment-date | string (date) | Data de pagamento do reembolso | BOW_PGMTO |
| beneficiaryName| items.beneficiary-name | string | Nome do beneficiário solicitante | BOW_NOMUSR | *requiredlinks | | items.observation | string | Observação do Protocolo |
|
| | items.links | array | links relacionados ao recurso refunds | 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 |
|---|
| {
"protocolitems": "41750520230607000003",[
"status": "1",
"requestDate": "2023-06-07",
{
"presentedAmount": 250,
"refundedAmount": 0,
"paymentDatestatus": "2",
"beneficiaryName": "HERNANDES ALVES DA SILVA",
"linksprotocol": ["41750520230607000001",
{
"rel""request-date": "expenses2023-06-07",
"hrefpresented-amount": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/expenses"250,
},
{"refunded-amount": 0,
"relpayment-date": "attachments",
"hrefbeneficiary-name": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/attachments"HERNANDES ALVES DA SILVA",
}
]
} |
|
| | 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 "observation": "",
"links": [
{
"rel": "expenses",
"message": "JSON inválido",
"detailedMessage": "Json Error: >>\"healthInsurerCode\" : \"0001\",\r\n\t\"subscriberId\" : \"00011008000027010\",\r\n"href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000001/expenses"
\"refundReceipts\" : [\r\n {\r\n },
\"unreferencedNetworkIdentifier\" : \"77077733000159\",\r\n {
\"unreferencedNetworkName\" : \"JOSE\",\r\n \"stateAbbreviation\" "rel": \"SP\",\r\nattachments",
\"cityCode\href" : \"3500105\",\r\n"/totvsHealthPlans/attendance/v1/refunds/41750520230607000001/attachments"
\"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": [
{ ]
},
{
"status": "1",
"protocol": "41750520230607000003",
"request-date": "2023-06-07",
"presented-amount": 250,
"refunded-amount": 0,
"payment-date": "",
"codebeneficiary-name": "E002D-406HERNANDES ALVES DA SILVA",
"messageobservation": "Tipo inválido para o campo status",
"detailedMessagelinks": "O[
valor do campo status deve ser do tipo (C)."
},{
{
"coderel": "E002F-406expenses",
"message": "Valor inválido para o campo status",
"detailedMessagehref": "O valor do campo status deve ser: 0;1/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/expenses"
},
{},
"code": "E002B-406",
{
"message": "Campo healthInsurerCode obrigatório",
"detailedMessagerel": "attachments"Não,
foi informado valor do campo healthInsurerCode."
},
"href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/attachments"
{
"code": "E002E-406", }
"message": "Tamanho inválido para o campo healthInsurerCode",]
}
],
"hasNext": false,
"detailedMessage": "O "remainingRecords": 0
} |
|
| 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 |
|---|
| {
valor do campo healthInsurerCode deve ter o tamanho 4."
},
{
"code": "E002E-406E001",
"message": "Tamanhoas chaves inválidodo paraquery oparam campoestão subscriberIdinválidos",
"detailedMessage": "OVerifique a valorlista dode campoerros subscriberIdno devecampo terdetails opara tamanhomais 17detalhes.",
},"details": [
{
"code": "E002BE001A-406",
"message": "Campo refundReceipts obrigatório",
"detailedMessage": "Não foi informado valor do campo refundReceipts."
request-date-initial não informado",
}
]
} |
|
| | 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": [
{ "detailedMessage": "Não foi informado o campo request-date-initial."
},
{
"code": "E001A-406",
"message": "Campo request-date-final não informado",
"detailedMessage": "Não foi informado o campo request-date-final."
},
{
"code": "E001A-406",
"message": "Campo subscriber-id não informado",
"codedetailedMessage": "E004A-404",Não foi informado o campo subscriber-id."
}
"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)"
},
{
]
} |
|
| 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 | | 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": "E004B-404E002",
"message": "Beneficiário solicitante não encontrado",
"detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 0001100800002701200011008000027013 no cadastro (BA1)"
}
]
} |
|
|
|
