Class: CandidApiClient::PatientPayments::V4::V4Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/patient_payments/v_4/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::PatientPayments::V4::V4Client

Parameters:



24
25
26
 
# File 'lib/candidhealth/patient_payments/v_4/client.rb', line 24

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



20
21
22
 
# File 'lib/candidhealth/patient_payments/v_4/client.rb', line 20

def request_client
  @request_client
end

Instance Method Details

#create(amount_cents:, patient_external_id:, allocations:, payment_timestamp: nil, payment_note: nil, invoice: nil, request_options: nil) ⇒ CandidApiClient::PatientPayments::V4::Types::PatientPayment

Creates a new patient payment record and returns the newly created

PatientPayment object.
The allocations can describe whether the payment is being applied toward a
specific service line,
claim, or billing provider.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.patient_payments.v_4.create(
  amount_cents: 1,
  payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z),
  payment_note: "string",
  patient_external_id: "string",
  allocations: [{ amount_cents: 1 }],
  invoice: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
)

Parameters:

  • amount_cents (Integer)
  • payment_timestamp (DateTime) (defaults to: nil)
  • payment_note (String) (defaults to: nil)
  • patient_external_id (String)
  • allocations (Array<Hash>) —

    Request of type Array<CandidApiClient::Financials::Types::AllocationCreate>, as a Hash

    • :amount_cents (Integer)

    • :target (Hash)

  • invoice (String) (defaults to: nil)
  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/candidhealth/patient_payments/v_4/client.rb', line 139

def create(amount_cents:, patient_external_id:, allocations:, payment_timestamp: nil, payment_note: nil,
           invoice: nil, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = {
      **(request_options&.additional_body_parameters || {}),
      amount_cents: amount_cents,
      payment_timestamp: payment_timestamp,
      payment_note: payment_note,
      patient_external_id: patient_external_id,
      allocations: allocations,
      invoice: invoice
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/patient-payments/v4"
  end
  CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
end

#delete(patient_payment_id:, request_options: nil) ⇒ Void

Deletes the patient payment record matching the provided patient_payment_id.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.patient_payments.v_4.delete(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:

  • (Void) 


204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/candidhealth/patient_payments/v_4/client.rb', line 204

def delete(patient_payment_id:, request_options: nil)
  @request_client.conn.delete do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/patient-payments/v4/#{patient_payment_id}"
  end
end

#get(patient_payment_id:, request_options: nil) ⇒ CandidApiClient::PatientPayments::V4::Types::PatientPayment

Retrieves a previously created patient payment by its ‘patient_payment_id`.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.patient_payments.v_4.get(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/candidhealth/patient_payments/v_4/client.rb', line 98

def get(patient_payment_id:, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/patient-payments/v4/#{patient_payment_id}"
  end
  CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
end

#get_multi(limit: nil, patient_external_id: nil, claim_id: nil, service_line_id: nil, billing_provider_id: nil, unattributed: nil, invoice_id: nil, sources: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil) ⇒ CandidApiClient::PatientPayments::V4::Types::PatientPaymentsPage

Returns all patient payments satisfying the search criteria AND whose

organization_id matches
the current organization_id of the authenticated user.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.patient_payments.v_4.get_multi(
  limit: 1,
  patient_external_id: "string",
  claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  unattributed: true,
  invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  sources: MANUAL_ENTRY,
  sort: PAYMENT_SOURCE,
  sort_direction: ASC,
  page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
)

Parameters:

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/candidhealth/patient_payments/v_4/client.rb', line 60

def get_multi(limit: nil, patient_external_id: nil, claim_id: nil, service_line_id: nil,
              billing_provider_id: nil, unattributed: nil, invoice_id: nil, sources: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "limit": limit,
      "patient_external_id": patient_external_id,
      "claim_id": claim_id,
      "service_line_id": service_line_id,
      "billing_provider_id": billing_provider_id,
      "unattributed": unattributed,
      "invoice_id": invoice_id,
      "sources": sources,
      "sort": sort,
      "sort_direction": sort_direction,
      "page_token": page_token
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/patient-payments/v4"
  end
  CandidApiClient::PatientPayments::V4::Types::PatientPaymentsPage.from_json(json_object: response.body)
end

#update(patient_payment_id:, payment_timestamp: nil, payment_note: nil, invoice: nil, request_options: nil) ⇒ CandidApiClient::PatientPayments::V4::Types::PatientPayment

Updates the patient payment record matching the provided patient_payment_id.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.patient_payments.v_4.update(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))

Parameters:

Returns:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/candidhealth/patient_payments/v_4/client.rb', line 175

def update(patient_payment_id:, payment_timestamp: nil, payment_note: nil, invoice: nil, request_options: nil)
  response = @request_client.conn.patch do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = {
      **(request_options&.additional_body_parameters || {}),
      payment_timestamp: payment_timestamp,
      payment_note: payment_note,
      invoice: invoice
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/patient-payments/v4/#{patient_payment_id}"
  end
  CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
end