01. VISÃO GERAL

Esta API tem como finalidade a busca dos Pacotes de Intercâmbio - SISPAC através de um documento do Revisão de Contas Médicas.

02. REQUISIÇÃO

Em seguida descrevemos os campos que podem ser enviados na requisição, alguns serão utilizados para filtrar os dados dos documentos do Revisão de Contas Médicas, outros modificam a quantidade de dados retornados na resposta da requisição ou mudam a ordenação dos resultados.

CampoDescriçãoTipoObrigatório?Formato
unidadePrestadoraUtilizado para filtrar os documentos através da unidade prestadora do documento.NuméricoSim9999
transacaoUtilizado para filtrar os documentos através da transação do documento.NuméricoSim99
serieUtilizado para filtrar os documentos através da série do documento.AlfanuméricoSimx(4)
documentoUtilizado para filtrar os documentos através do número do documento.NuméricoSim99999999
sequenciaUtilizado para filtrar os documentos através da sequencia do documento.NuméricoSim999999999

03. RESULTADO

Em seguida descrevemos os campos que podem ser retornados na requisição.

numRegisters

Número de registros retornados.

Numérico

hasNext

Variável responsavel só a indicação de mais registro dentro da paginação.

Logical

items

JsonArray que contém o objeto do documento.

JsonArray

unidade

Unidade que realizou a criação do documento. Sempre será a unidade operando o sistema.

Numérico

unidadePrestadora

Unidade que executou o documento.

Numérico

transacao

Transação à qual o documento pertence.

Numérico

serieDocumento

Série à qual o documento pertence.

Alfanumérico

documentoOriginal

Número do documento no Revisão de Contas Médicas.

Numérico

documentoSistema

Número Sequencial de controle utilizado pelo sistema para diferenciar documentos em alguns casos.

Numérico






















04. EXEMPLOS

Requisição:

https://servidor:porta/dts/datasul-rest/resources/prg/hrc/v1/documents/get/?pageSize=20&page=1&dataDigitacaoInicio=2025/01/11&dataDigitacaoFim=2025/05/11&anoFatura=2025&serieFatura=FAT&codigoFatura=123456&serieDocumento=SERI&situacaoDocumento=1&unidadePrestador=1&codigoPrestador=1&ordenacao=asc&expand=detalhes,fatura


Resposta:

Exemplo de retorno quando nenhum documento é encontrado:
Resposta HTTP 200.
{
    "total": 0,
    "hasNext": false,
    "items": []
}
Exemplo de retorno quando 1 ou mais documentos são encontrados:
Resposta HTTP 200.
{
    "total": 1,
    "hasNext": false,
    "items": [
        {
            "dataImportacaoFatura": null,
            "transacao": 5002,
            "dataVencimentoFatura": null,
            "carteiraBeneficiario": 1234567890123,
            "unidadeBeneficiario": 999,
            "codigoPrestador": 999,
            "periodoReferencia": 5,
            "anoGuia": 0,
            "serieFatura": null,
            "unidade": 120,
            "anoFatura": null,
            "codigoFatura": null,
            "documentoOriginal": 123456,
            "numeroGuia": 0,
            "anoReferencia": 2025,
            "dataRecebimentoFatura": null,
            "unidadePrestadora": 999,
            "documentoSistema": 0,
            "serieDocumento": "PTU",
            "situacaoDocumento": "6",
            "unidadePrestador": 999
        }
    ]
}


Resposta em casos que ocorrem erros:

Resposta HTTP 400.
{
    "detailedMessage": "Nao foi possivel converter o campo dataDigitacaoInicio",
    "code": "1",
    "message": "",
    "type": "error"
}
Resposta HTTP 500.
{
    "detailedMessage": null,
    "code": "400",
    "message": "Falha ao obter conexão com o AppServer [http://servidor:porta/appserver/apsv], não existem sessões (Agentes) disponíveis."
}