Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	Refunds - Inclusão de um protocolo de reembolso

Realiza a inclusão de um novo protocolo de reembolso para o beneficiário

/totvsHealthPlans/attendance/v1/refunds

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

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	Lista com os 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	*required
refundReceipts.documentDate	string (date)	Data de emissão do documento	B1N_DATDOC	*required
refundReceipts.expenses	array	Despesas do comprovante de reembolso		*required

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "status" : "items""0",
	"healthInsurerCode" : "0001",
	"subscriberId" : "00011008000027010",
    "refundReceipts" : [
        {
            "company-codeunreferencedNetworkIdentifier" : "000177077733000159",
            "descriptionunreferencedNetworkName" : "CONTRATOS PESSOA FISICAJOSE",
            "group-typestateAbbreviation" : "1SP",
            "usecityCode" : "13500105",
        }    "documentCode" : "03",
           { "documentNumber" : "00007674",
            "company-codedocumentDate" : "00022023-06-02",
            "descriptionexpenses" : [
                {
        "CONTRATOS PESSOA JURIDICA",
            "subscriberId" : "00011008000027010",
                    "group-typeprocedureClass" : "2000001",
            "use"        "tableCode" : "101",
                    "linksprocedureCode": ["10101012",
                    "continuousUse" : {"0",
                    "relexpenseAmount": 250,
                    "contractsquantity" : 1,
                    "hrefexecutionDate" : "/totvsHealthPlans/familyContract/v1/companies/0002/contracts?health-insurer-code=0001"2023-06-02"		
                }
            ],
        }
    "attachments" : [
                ],
{
                    "href"hasNext : "https: false,//www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste"
                }
            ]
    "remainingRecords": 0    }
    ]
}

Dica

Expandir

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

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	integer	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de empresas retornadas
items.company-code	string	Código	BG9_CODIGO	*required
items.description	string	Descrição	BG9_DESCRI	*required
items.group-type	string	Tipo de grupo: 1 = Pessoa Física 2 = Pessoa Juridica	BG9_TIPO	*required
items.use	string	Uso: 1 = Normal 2 = Usuários Admissionais/Contratos não cadastrados	BG9_USO	*required
items.links	array	links relacionados ao recurso companies (Padrão HATEOAS): rel: contracts (somente para pessoa jurídica).

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "company-code": "0001",
            "description": "CONTRATOS PESSOA FISICA",
            "group-type": "1",
            "use": "1"
        },
        {
            "company-code": "0002",
            "description": "CONTRATOS PESSOA JURIDICA",
            "group-type": "2",
            "use": "1",
            "links": [
                {
                    "rel": "contracts",
                    "href": "/totvsHealthPlans/familyContract/v1/companies/0002/contracts?health-insurer-code=0001"
                }
            ]
        }
    ],
    "hasNext": false,
    "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	RDark
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 health-insurer-code obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão 6

Chave