Modificação de uma cobrança

put

https://sandbox.osigu.com/rcm/v1/charges/{chargeCode}

A modificação de uma cobrança é permitida desde que a cobrança não tenha sido faturada. Os dados são modificados de acordo com o que é recebido na solicitação.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

chargeCode

string

required

ID do item de cobrança enviado, no momento da entrega.

Body Params

chargeCode

string

Código de cobrança que você deseja alterar Exemplo Prático Seringa 10Ml Código 123456 está com a quantidade 2 precisa ser alterado para 1

origin_event_description

string

Representa o diagnóstico inicial que motivou o atendimento na unidade de saúde. Deve ser informado de forma clara e objetiva, descrevendo o motivo pelo qual o paciente procurou a instituição, incluindo sintomas ou condições relevantes. Por exemplo: "Internação hospitalar devido a forte dor abdominal" ou "Atendimento ambulatorial por febre alta e tosse persistente".

invoiceable

boolean

Neste campo, devem ser apresentados os itens de cobrança que constarão na conta ao finalizar. Exemplo: A paciente Maria realizou um procedimento de Ressonância Magnética com cobrança em pacote. Sem excedentes: Incluir apenas "Pacote de Ressonância Magnética". Com excedentes: Incluir "Pacote de Ressonância Magnética" + "Colírio" (item excedente).

creation_date_time

date

Data e hora de quando a cobrança foi criada, pode ter valor em data passada, mas não com valor futuro. String no formato ISO 8601. Exemplo 2023-07-14T16:00:47.000Z

patient_id

string

Este campo representa o identificador único do paciente no sistema. Ele é usado para vincular todas as informações e interações associadas ao paciente de forma consistente e precisa.

patient_name

string

Este campo armazena o nome completo do paciente. Ele é utilizado para identificação e conferência de informações no sistema.

patient_document_type

string

Este campo especifica o tipo de documento utilizado para identificar o paciente. Ele deve indicar, em texto, qual documento foi apresentado para vinculação ao atendimento. Regras de Uso O tipo de documento deve ser registrado de forma clara e padronizada. Valores permitidos: Carteirinha – Para atendimentos vinculados a operadoras de saúde que exigem o número da carteirinha do convênio. CPF – Para pacientes onde o CPF é aceito como documento de identificação. RG – Para pacientes identificados com o Registro Geral (documento de identidade). Passaporte – Para pacientes estrangeiros sem CPF ou RG. Exemplo Prático Carteirinha – Operadora de saúde exige este documento. CPF – Documento utilizado em atendimentos sem exigência de carteirinha. RG – Documento de identificação pessoal para residentes no Brasil. Passaporte – Identificação para pacientes estrangeiros.

patient_document_number

string

Este campo especifica o número do documento utilizado para identificar o paciente. Ele deve indicar, em Número, qual documento foi apresentado para vinculação ao atendimento. Regras de Uso O tipo de documento deve ser registrado de forma clara e padronizada. Valores permitidos: Carteirinha – Para atendimentos vinculados a operadoras de saúde que exigem o número da carteirinha do convênio. CPF – Para pacientes onde o CPF é aceito como documento de identificação. RG – Para pacientes identificados com o Registro Geral (documento de identidade). Passaporte – Para pacientes estrangeiros sem CPF ou RG. Exemplo Prático Carteirinha – 12345678910 CPF – 12345678910 RG – 12345678910 Passaporte – 12345678910

quantity

double

Esse campo corresponde a quantidade do item de cobrança Exemplo Prático Foi realizado um lançamento de duas Seringas Preechidas 10ml com o código 6789 na conta da paciente Maria no dia 01/01/2025, com o valor Unitário de R$ 1,00 . O valor da quantidade é 2

provider_product_code

string

Esse campo corresponde ao código de apresentação do item de cobrança Exemplo Prático Um lançamento foi realizado para uma AGULHA com o código 12345 na conta da paciente Maria no dia 01/01/2025. O código deste é 12345

description

string

Esse campo corresponde a descrição do item cobrança Exemplo Prático Foi realizado um lançamento de Seringa Preechida 10ml com o código 6789 na conta da paciente Maria no dia 01/01/2025. A descrição é : Seringa Preechida 10ml

amount

double

Esse campo corresponde ao valor unitário do item de cobrança Exemplo Prático Foi realizado um lançamento de duas Seringas Preechidas 10ml com o código 6789 na conta da paciente Maria no dia 01/01/2025, com o valor Unitário de R$ 1,00 . O valor unitário é 1,00

total_amount

double

Esse campo corresponde ao valor total dos itens de cobrança Exemplo Prático Foi realizado um lançamento de duas Seringas Preechidas 10ml com o código 6789 na conta da paciente Maria no dia 01/01/2025, com o valor Unitário de R$ 1,00 . O valor total é de 2,00

currency

string

Moeda de cobrança. Por exemplo: COP, GTQ, USD, MXN, BRL Exemplo Prático R$ 2,00

diagnostic_test_number

string

Esse campo apresenta o identificador do exame de diagnóstico

diagnosis_code

string

Esse campo apresenta o código de diagnóstico na CID-10 Exemplo Prático: Dor localizada no abdome superior (R10.1). O código é R10.1

diagnosis_name

string

Esse campo apresenta a descrição do código de diagnóstico na CID-10 Exemplo Prático: Dor localizada no abdome superior (R10.1). A descrição é Dor localizada no abdome superior

authorization_id

string

Indica a senha de autorização fornecida pela operadora de saúde para cada conta médica do atendimento. Exemplo Prático: Paciente Maria, Carteirinha 123456, Senha 2B7VX / 10111234

Responses

200200

400400