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

Dados dentro do JsonArray TAG ITEMS

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

pacotesIntercambio

JsonArray que contém o objeto do Pacote de Intercâmbio.

JsonArray

Dados dentro do JsonArray TAG pacotesIntercambio

unidadeExec

Unidade Prestador Executante

Numérico

prestadorExec

Código Prestador Executante

Numérico

dataExecucao

Data de Execução

Alfanumérico (AAAA/MM/DD)

horaInicial

Hora Inicial

Alfanumérico (HH:MM:SS)

horaFinal

Hora Final

Alfanumérico (HH:MM:SS)

qtdCobrada

Quantidade Cobrada

Decimal

vlPacoteCobrado

Valor Cobrado do Pacote

Decimal

vlFatorCobrado

Fator Cobrado do Pacote

Decimal

vlTaxaCobrado

Taxa Cobrado do Pacote

Decimal

vlPacoteReconhecido

Valor Reconhecido do Pacote

Decimal

vlFatorReconhecido

Valor Reconhecido do Pacote

Decimal

vlTaxaCobrado

Valor Reconhecido do Pacote

Decimal

equipeProfissional

JsonArray que contém a equipe de profissionais do pacote.

JsonArray

Dados dentro do JsonArray TAG equipeProfissional

registroProfissional

Registro Profissional

Alfanumérico

tipoParticipacao

Tipo de Participação

Alfanumérico

unidadePrestador

Unidade do Prestador

Numérico

prestador

Código do Prestador

Numérico

cpfProfissional

CPF do Profissional

Alfanumérico

nomeProfissional

Nome do Profissional

Alfanumérico

ufConselhoProfissional

UF do Conselho do Profissional

Numérico

cboProfissional

CBO do Profissional

Alfanumérico

cnpjProfissional

CNPJ do Profissional

Alfanumérico

siglaConselhoProfissional

Sigla do Conselho do Profissional

Alfanumérico

pacoteIntercambio

JsonArray que contém o pacote do documento.

JsonArray 

Dados dentro do JsonArray TAG pacoteIntercambio

dataAprovacaoReprovacao

Data da Aprovação do Pacote

Alfanumérico (AAAA/MM/DD)

unidadeOrigem

Unidade Origemdo Pacote

Numérico

statusPacote

Status do Pacote

Numérico

tipoAcomodacao

Tipo de Acomodação do Pacote

Alfanumérico

dataPublicacao

Data de Publicação do Pacote

Alfanumérico (AAAA/MM/DD)

indicadorOpme

Indicador de OPME do Pacote

Numérico

etiquetaPacote

Etiqueta do Pacote

Numérico

tipoRede

Tipo de Rede do Pacote

Numérico

indicadorHm

Indicador de HM do Pacote

Numérico

indicadorDiaria

Indicador de Diária do Pacote

Numérico

valorInsumo

Valor do Insumo do Pacote

Numérico

valorTotal

Valor Total do do Pacote

Decimal

tipoPacote

Tipo do Pacote do Pacote

Decimal

prestadores

JsonArray que contém os prestadores do pacote.

JsonArray 

detalhes

JsonArray que contém os detalhes do pacote.

JsonArray 

Dados dentro do JsonArray TAG prestadores

codigoPrestador

Código do Prestador

Numérico

cnes

CNES do Prestador

Alfanumérico

nomePrestador

Nome do Prestador

Alfanumérico

cpfCnpj

CPF/CNPJ do Prestador

Alfanumérico

Dados dentro do JsonArray TAG detalhes

item

Código do Item

Alfanumérico

quantidadeServico

Quantidade do Serviço

Decimal

tipoComposicao

Tipo da Composição

Numérico

tipoTabela

Tipo da Tabela

Alfanumérico

descricaoItem

Descrição do Item

Alfanumérico

valorTotal

Valor Total do Item

Decimal

unidadeMedida

Unidade de Medida do Item

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."
}