Tross
Demo dataBook a demo
THERAPYNOTES

Fetch patient billing statement

Retrieve a patient's billing statement.

POSThttps://preview.ontross.com/api/integrations/tn/fetch-patient-billing-statement
Request Fields
input.patientID
string
required
Internal numeric chart ID used across billing and chart pages.
Example
"75843069"
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
billing_statement
object
The patient's billing ledger as the portal shows it.
billing_statement.Items
array
One row per billed appointment or payment on the statement.
billing_statement.Items[].RecordType
integer
Coded kind of ledger row, such as appointment or payment.
Example
1
billing_statement.Items[].Date
string
Date of service or payment for this ledger row.
Example
"2025-03-12T00:00:00"
billing_statement.Items[].CalendarEntryID
integer
The calendar entry this billing row or patient link points to.
Example
87654012
billing_statement.Items[].EncryptedCalendarEntryID
string
Obfuscated appointment id used in portal URLs.
Example
"m7Qp2Vx9Lc4Rt8Bn6Hs3Aw"
billing_statement.Items[].CalendarEntryTypeCode
integer
Coded appointment type behind the billed entry.
Example
1
billing_statement.Items[].CalendarEntryTypeName
string
Readable appointment type such as individual therapy.
Example
"Individual Therapy"
billing_statement.Items[].PatientID
integer
Numeric patient id carried on this billing row.
Example
98760421
billing_statement.Items[].EncryptedPatientID
string
Obfuscated patient id used in portal URLs.
Example
"t4Nv8Ks2Xq7Bm5Lc9Rp6Dw"
billing_statement.Items[].PatientFirstName
string
Patient first name copied onto the billing row.
Example
"Avery"
billing_statement.Items[].PatientLastName
string
Patient last name copied onto the billing row.
Example
"Sampleton"
billing_statement.Items[].PatientDOB
string
Patient birth date as submitted on the claim.
Example
"1986-07-24T00:00:00"
billing_statement.Items[].PatientInsuredsIdNumber
string
Member id on the primary insurance for this claim.
Example
"XYZ987654321"
billing_statement.Items[].PatientSecondaryInsuredsIdNumber
string
Member id on the secondary insurance, blank when none.
Example
"ABC990275318"
billing_statement.Items[].NoteTypeCode
integer
Coded kind of clinical note tied to this appointment.
Example
1
billing_statement.Items[].SkipCreatingNote
boolean
True when staff marked the appointment as needing no note.
Example
false
billing_statement.Items[].BillableItemID
integer
Identifier of the billable line behind this ledger row.
Example
87654903
billing_statement.Items[].PaymentMethod
integer
Coded way the primary payer or patient pays.
Example
1
billing_statement.Items[].SecondaryPaymentMethod
integer
Coded payment method for the secondary payer.
Example
0
billing_statement.Items[].Comments
string
Free text note staff typed on this record.
Example
"Copay collected at check-in."
billing_statement.Items[].PlaceOfServiceCode
string
Two digit CMS place of service for the visit.
Example
"11"
billing_statement.Items[].ClinicianID
integer
Clinician who delivered or is booked for this appointment.
Example
87651234
billing_statement.Items[].EncryptedClinicianID
string
Obfuscated clinician id used in portal URLs.
Example
"b6Wq3Nm8Kr2Vx9Lt5Hs7Cg"
billing_statement.Items[].ClinicianFirstName
string
Clinician first name as billed on the claim.
Example
"Jordan"
billing_statement.Items[].ClinicianLastName
string
Clinician last name as billed on the claim.
Example
"Exampleton"
billing_statement.Items[].ClinicianNPI
string
National provider id billed for this service.
Example
"1999999973"
billing_statement.Items[].ClinicianLicense
string
License number billed for this clinician.
Example
"PSY987654"
billing_statement.Items[].ClinicianDisplayTitle
string
Credential suffix shown after the clinician's name.
Example
"LCSW"
billing_statement.Items[].InsurancePayerID
integer
TherapyNotes record for the primary payer on this row.
Example
48217
billing_statement.Items[].InsurancePayerName
string
Readable name of the primary insurance payer.
Example
"Aetna"
billing_statement.Items[].InsurancePayerPayerID
string
Clearinghouse payer id used when submitting the claim.
Example
"60054"
billing_statement.Items[].InsuranceProviderGroupID
integer
Payer group the primary insurance belongs to.
Example
48218
billing_statement.Items[].EncryptedProviderID
string
Obfuscated primary insurance provider id for portal URLs.
Example
"c8Rt4Wn7Lp2Kx6Bs9Mv3Qg"
billing_statement.Items[].InsuranceProviderGroupHasActiveSetting
boolean
True when that payer group has billing settings configured.
Example
true
billing_statement.Items[].SecondaryInsurancePayerID
integer
TherapyNotes record for the secondary payer, zero when none.
Example
0
billing_statement.Items[].SecondaryInsuranceProviderGroupID
integer
Payer group the secondary insurance belongs to.
Example
0
billing_statement.Items[].EncryptedSecondaryProviderID
string
Obfuscated secondary insurance provider id for portal URLs.
Example
"v3Kp8Rn2Wm7Bx5Lt9Qs4Cg"
billing_statement.Items[].SecondaryInsuranceProviderGroupHasActiveSetting
boolean
True when the secondary payer group has billing settings configured.
Example
false
billing_statement.Items[].SecondaryInsurancePayerName
string
Readable name of the secondary insurance payer.
Example
"Cigna"
billing_statement.Items[].SecondaryInsurancePayerPayerID
string
Clearinghouse payer id for the secondary claim.
Example
"62308"
billing_statement.Items[].LocationType
integer
Coded office or telehealth location for the appointment.
Example
1
billing_statement.Items[].CustomLocation
integer
Numeric id of a practice defined location, not its name.
Example
87651
billing_statement.Items[].Services
array
Billable service lines charged under this statement row.
billing_statement.Items[].Services[].BillableServiceID
integer
Identifier of this charge line in TherapyNotes.
Example
87654321
billing_statement.Items[].Services[].ServiceCodeID
integer
TherapyNotes record for the service code billed or scheduled.
Example
48216
billing_statement.Items[].Services[].ServiceCodeType
integer
Coded family the service code belongs to.
Example
1
billing_statement.Items[].Services[].ServiceCodeText
string
The CPT code itself, as printed on claims.
Example
"90834"
billing_statement.Items[].Services[].ServiceCodeDesc
string
Readable description of the billed service code.
Example
"Psychotherapy, 45 minutes"
billing_statement.Items[].Services[].ProcedureModifierCodes
array
CPT modifiers sent with this service, often an empty list.
billing_statement.Items[].Services[].PatientAmtOwed
number
Amount the patient still owes on this service.
Example
25
billing_statement.Items[].Services[].PatientRate
number
Rate charged to the patient for this service.
Example
25
billing_statement.Items[].Services[].PatientPaid
number
Amount the patient has already paid on this service.
Example
0
billing_statement.Items[].Services[].InsurancePaid
number
Amount the payer has actually paid on this service.
Example
100
billing_statement.Items[].Services[].DirectPaymentStatus
integer
Coded state of a direct card or cash payment.
Example
0
billing_statement.Items[].Services[].InsuranceAmtOwed
number
Amount still expected from the payer on this service.
Example
0
billing_statement.Items[].Services[].InsuranceRate
number
Contracted rate the payer allows for this service.
Example
125
billing_statement.Items[].Services[].InsuranceStatus
string
Readable claim state such as submitted or paid.
Example
"Paid"
billing_statement.Items[].Services[].InsuranceStatusCode
integer
Numeric form of that same claim state.
Example
1
billing_statement.Items[].Services[].AmountToClaimToInsurance
number
Amount that will be billed to the payer.
Example
150
billing_statement.Items[].ItemIndex
integer
Position of this row within the Items array.
Example
0
billing_statement.IsBiller
boolean
True when your signed in user has billing rights.
Example
true
billing_statement.IsLimitedBiller
boolean
True when billing rights cover only their own clients.
Example
false
billing_statement.BalanceOwed
number
Total the patient still owes across the whole statement.
Example
75
billing_statement.UnassignedCredit
number
Money received but not yet applied to any charge.
Example
20
billing_statement.PastFutureChangeIndex
integer
Index in Items where future appointments begin.
Example
3
billing_statement.ContainsPastItems
boolean
True when the statement includes appointments already held.
Example
true
billing_statement.ContainsFutureItems
boolean
True when the statement includes appointments not yet held.
Example
true
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/tn/fetch-patient-billing-statement \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientID":"75843069"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientID": "75843069"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "billing_statement": {
      "Items": [
        {
          "RecordType": 1,
          "Date": "2025-03-12T00:00:00",
          "CalendarEntryID": 87654012,
          "EncryptedCalendarEntryID": "m7Qp2Vx9Lc4Rt8Bn6Hs3Aw",
          "CalendarEntryTypeCode": 1,
          "CalendarEntryTypeName": "Individual Therapy",
          "PatientID": 98760421,
          "EncryptedPatientID": "t4Nv8Ks2Xq7Bm5Lc9Rp6Dw",
          "PatientFirstName": "Avery",
          "PatientLastName": "Sampleton",
          "PatientDOB": "1986-07-24T00:00:00",
          "PatientInsuredsIdNumber": "XYZ987654321",
          "PatientSecondaryInsuredsIdNumber": "ABC990275318",
          "NoteTypeCode": 1,
          "SkipCreatingNote": false,
          "BillableItemID": 87654903,
          "PaymentMethod": 1,
          "SecondaryPaymentMethod": 0,
          "Comments": "Copay collected at check-in.",
          "PlaceOfServiceCode": "11",
          "ClinicianID": 87651234,
          "EncryptedClinicianID": "b6Wq3Nm8Kr2Vx9Lt5Hs7Cg",
          "ClinicianFirstName": "Jordan",
          "ClinicianLastName": "Exampleton",
          "ClinicianNPI": "1999999973",
          "ClinicianLicense": "PSY987654",
          "ClinicianDisplayTitle": "LCSW",
          "InsurancePayerID": 48217,
          "InsurancePayerName": "Aetna",
          "InsurancePayerPayerID": "60054",
          "InsuranceProviderGroupID": 48218,
          "EncryptedProviderID": "c8Rt4Wn7Lp2Kx6Bs9Mv3Qg",
          "InsuranceProviderGroupHasActiveSetting": true,
          "SecondaryInsurancePayerID": 0,
          "SecondaryInsuranceProviderGroupID": 0,
          "EncryptedSecondaryProviderID": "v3Kp8Rn2Wm7Bx5Lt9Qs4Cg",
          "SecondaryInsuranceProviderGroupHasActiveSetting": false,
          "SecondaryInsurancePayerName": "Cigna",
          "SecondaryInsurancePayerPayerID": "62308",
          "LocationType": 1,
          "CustomLocation": 87651,
          "Services": [
            {
              "BillableServiceID": 87654321,
              "ServiceCodeID": 48216,
              "ServiceCodeType": 1,
              "ServiceCodeText": "90834",
              "ServiceCodeDesc": "Psychotherapy, 45 minutes",
              "ProcedureModifierCodes": [
                "string"
              ],
              "PatientAmtOwed": 25,
              "PatientRate": 25,
              "PatientPaid": 0,
              "InsurancePaid": 100,
              "DirectPaymentStatus": 0,
              "InsuranceAmtOwed": 0,
              "InsuranceRate": 125,
              "InsuranceStatus": "Paid",
              "InsuranceStatusCode": 1,
              "AmountToClaimToInsurance": 150
            }
          ],
          "ItemIndex": 0
        }
      ],
      "IsBiller": true,
      "IsLimitedBiller": false,
      "BalanceOwed": 75,
      "UnassignedCredit": 20,
      "PastFutureChangeIndex": 3,
      "ContainsPastItems": true,
      "ContainsFutureItems": true
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}