Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Billing

Retrieve an existing patient payment

get/api/patient_payments/{id}

Path parameters

idstring required

Query parameters

sincestring
patientinteger
doctorinteger

Response

OK

line_iteminteger
posted_datestring
appointmentinteger

If this is absent, the apponitment will be inferred from line item

doctorinteger
payment_method'DRCP' | 'CASH' | 'CHCK' | 'DBIT' | 'CRDT' | 'AMEX' | 'VISA' | 'MSTR' | 'DISC' | 'SQR1' | 'SQRE' | 'PTPA' | 'ONPT' | 'OTHR'

"CASH", "CHCK" for Check, "DBIT" for Debit, "CRDT" for Credit Card, "AMEX" for American Express, "VISA", "MSTR" for Mastercard, "DISC" for Discover, "SQR1" for Square (legacy), "SQRE" for Square, "PTPA" for Patient Payments, "ONPT" for onpatient, "OTHR" for Other

created_atstring
payment_transaction_type'' | 'REF' | 'COR' | 'COPAY' | 'COINSR' | 'OTHR'

"" for Credit, "REF" for Refund, "COR" for Correction, "COPAY" for Copay, "COINSR" for Coinsurance, "OTHR" for Other

created_bystring
updated_atstring
amountnumber

Amount of cash for this payment, cannot be zero

notesstring
trace_numberstring
patientinteger required
idinteger
received_datestring