@rinse-dental/open-dental 3.4.2 → 4.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +388 -16
- package/dist/api/accountModules.d.ts +23 -3
- package/dist/api/accountModules.d.ts.map +1 -1
- package/dist/api/accountModules.js +17 -6
- package/dist/api/adjustments.d.ts +5 -2
- package/dist/api/adjustments.d.ts.map +1 -1
- package/dist/api/adjustments.js +11 -5
- package/dist/api/allergies.d.ts +5 -2
- package/dist/api/allergies.d.ts.map +1 -1
- package/dist/api/allergies.js +11 -5
- package/dist/api/allergydefs.d.ts +27 -0
- package/dist/api/allergydefs.d.ts.map +1 -0
- package/dist/api/allergydefs.js +40 -0
- package/dist/api/appointmentTypes.d.ts +12 -2
- package/dist/api/appointmentTypes.d.ts.map +1 -1
- package/dist/api/appointmentTypes.js +12 -2
- package/dist/api/appointments.d.ts +5 -2
- package/dist/api/appointments.d.ts.map +1 -1
- package/dist/api/appointments.js +19 -13
- package/dist/api/apptFieldDefs.d.ts +54 -0
- package/dist/api/apptFieldDefs.d.ts.map +1 -0
- package/dist/api/apptFieldDefs.js +79 -0
- package/dist/api/apptFields.d.ts +60 -0
- package/dist/api/apptFields.d.ts.map +1 -0
- package/dist/api/apptFields.js +102 -0
- package/dist/api/asapComms.d.ts +44 -0
- package/dist/api/asapComms.d.ts.map +1 -0
- package/dist/api/asapComms.js +64 -0
- package/dist/api/autoNoteControls.d.ts +48 -0
- package/dist/api/autoNoteControls.d.ts.map +1 -0
- package/dist/api/autoNoteControls.js +74 -0
- package/dist/api/autoNotes.d.ts +42 -0
- package/dist/api/autoNotes.d.ts.map +1 -0
- package/dist/api/autoNotes.js +70 -0
- package/dist/api/benefits.d.ts +14 -3
- package/dist/api/benefits.d.ts.map +1 -1
- package/dist/api/benefits.js +24 -5
- package/dist/api/carriers.d.ts +68 -0
- package/dist/api/carriers.d.ts.map +1 -0
- package/dist/api/carriers.js +107 -0
- package/dist/api/chartModules.d.ts +1 -1
- package/dist/api/chartModules.d.ts.map +1 -1
- package/dist/api/chartModules.js +4 -4
- package/dist/api/claimPayments.d.ts +93 -0
- package/dist/api/claimPayments.d.ts.map +1 -0
- package/dist/api/claimPayments.js +163 -0
- package/dist/api/claimProcs.d.ts +42 -2
- package/dist/api/claimProcs.d.ts.map +1 -1
- package/dist/api/claimProcs.js +65 -2
- package/dist/api/claimTrackings.d.ts +44 -0
- package/dist/api/claimTrackings.d.ts.map +1 -0
- package/dist/api/claimTrackings.js +70 -0
- package/dist/api/claims.d.ts +33 -0
- package/dist/api/claims.d.ts.map +1 -1
- package/dist/api/claims.js +60 -6
- package/dist/api/clinics.d.ts +47 -0
- package/dist/api/clinics.d.ts.map +1 -0
- package/dist/api/clinics.js +70 -0
- package/dist/api/clockEvents.d.ts +33 -0
- package/dist/api/clockEvents.d.ts.map +1 -0
- package/dist/api/clockEvents.js +42 -0
- package/dist/api/codeGroups.d.ts +64 -0
- package/dist/api/codeGroups.d.ts.map +1 -0
- package/dist/api/codeGroups.js +84 -0
- package/dist/api/commlogs.d.ts +14 -2
- package/dist/api/commlogs.d.ts.map +1 -1
- package/dist/api/commlogs.js +11 -4
- package/dist/api/computers.d.ts +25 -0
- package/dist/api/computers.d.ts.map +1 -0
- package/dist/api/computers.js +29 -0
- package/dist/api/covCats.d.ts +58 -0
- package/dist/api/covCats.d.ts.map +1 -0
- package/dist/api/covCats.js +78 -0
- package/dist/api/covSpans.d.ts +60 -0
- package/dist/api/covSpans.d.ts.map +1 -0
- package/dist/api/covSpans.js +91 -0
- package/dist/api/definitions.d.ts +19 -3
- package/dist/api/definitions.d.ts.map +1 -1
- package/dist/api/definitions.js +26 -2
- package/dist/api/discountPlanSubs.js +3 -3
- package/dist/api/discountPlans.d.ts +4 -1
- package/dist/api/discountPlans.d.ts.map +1 -1
- package/dist/api/discountPlans.js +9 -3
- package/dist/api/diseaseDefs.d.ts +35 -0
- package/dist/api/diseaseDefs.d.ts.map +1 -0
- package/dist/api/diseaseDefs.js +49 -0
- package/dist/api/diseases.d.ts +4 -1
- package/dist/api/diseases.d.ts.map +1 -1
- package/dist/api/diseases.js +6 -3
- package/dist/api/documents.d.ts +137 -0
- package/dist/api/documents.d.ts.map +1 -0
- package/dist/api/documents.js +235 -0
- package/dist/api/eTrans.d.ts +20 -0
- package/dist/api/eTrans.d.ts.map +1 -0
- package/dist/api/eTrans.js +36 -0
- package/dist/api/eTransMessageTexts.d.ts +15 -0
- package/dist/api/eTransMessageTexts.d.ts.map +1 -0
- package/dist/api/eTransMessageTexts.js +22 -0
- package/dist/api/eTranss.d.ts +22 -0
- package/dist/api/eTranss.d.ts.map +1 -0
- package/dist/api/eTranss.js +29 -0
- package/dist/api/ehrPatients.d.ts +29 -0
- package/dist/api/ehrPatients.d.ts.map +1 -0
- package/dist/api/ehrPatients.js +42 -0
- package/dist/api/employees.d.ts +66 -0
- package/dist/api/employees.d.ts.map +1 -0
- package/dist/api/employees.js +86 -0
- package/dist/api/employers.d.ts +53 -0
- package/dist/api/employers.d.ts.map +1 -0
- package/dist/api/employers.js +81 -0
- package/dist/api/eobAttaches.d.ts +56 -0
- package/dist/api/eobAttaches.d.ts.map +1 -0
- package/dist/api/eobAttaches.js +96 -0
- package/dist/api/events.d.ts +26 -0
- package/dist/api/events.d.ts.map +1 -0
- package/dist/api/events.js +26 -0
- package/dist/api/familyModules.d.ts +12 -2
- package/dist/api/familyModules.d.ts.map +1 -1
- package/dist/api/familyModules.js +9 -4
- package/dist/api/feeScheds.d.ts +8 -2
- package/dist/api/feeScheds.d.ts.map +1 -1
- package/dist/api/feeScheds.js +14 -2
- package/dist/api/fees.d.ts +41 -3
- package/dist/api/fees.d.ts.map +1 -1
- package/dist/api/fees.js +58 -2
- package/dist/api/histAppointments.d.ts +29 -0
- package/dist/api/histAppointments.d.ts.map +1 -0
- package/dist/api/histAppointments.js +33 -0
- package/dist/api/index.d.ts +89 -13
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/index.js +180 -28
- package/dist/api/insPlans.d.ts +11 -4
- package/dist/api/insPlans.d.ts.map +1 -1
- package/dist/api/insPlans.js +17 -7
- package/dist/api/insSubs.d.ts +13 -5
- package/dist/api/insSubs.d.ts.map +1 -1
- package/dist/api/insSubs.js +19 -8
- package/dist/api/insVerifies.d.ts +9 -6
- package/dist/api/insVerifies.d.ts.map +1 -1
- package/dist/api/insVerifies.js +15 -9
- package/dist/api/labCases.d.ts +22 -7
- package/dist/api/labCases.d.ts.map +1 -1
- package/dist/api/labCases.js +34 -11
- package/dist/api/labTurnarounds.d.ts +52 -0
- package/dist/api/labTurnarounds.d.ts.map +1 -0
- package/dist/api/labTurnarounds.js +78 -0
- package/dist/api/laboratories.d.ts +71 -0
- package/dist/api/laboratories.d.ts.map +1 -0
- package/dist/api/laboratories.js +91 -0
- package/dist/api/medicationPats.d.ts +5 -2
- package/dist/api/medicationPats.d.ts.map +1 -1
- package/dist/api/medicationPats.js +11 -5
- package/dist/api/medications.d.ts +37 -0
- package/dist/api/medications.d.ts.map +1 -0
- package/dist/api/medications.js +46 -0
- package/dist/api/operatories.d.ts +4 -3
- package/dist/api/operatories.d.ts.map +1 -1
- package/dist/api/operatories.js +8 -4
- package/dist/api/patFieldDefs.d.ts +57 -0
- package/dist/api/patFieldDefs.d.ts.map +1 -0
- package/dist/api/patFieldDefs.js +83 -0
- package/dist/api/patFields.d.ts +11 -6
- package/dist/api/patFields.d.ts.map +1 -1
- package/dist/api/patFields.js +23 -14
- package/dist/api/patPlans.d.ts +13 -6
- package/dist/api/patPlans.d.ts.map +1 -1
- package/dist/api/patPlans.js +18 -8
- package/dist/api/patientNotes.d.ts +48 -0
- package/dist/api/patientNotes.d.ts.map +1 -0
- package/dist/api/patientNotes.js +70 -0
- package/dist/api/patientRaces.d.ts +21 -0
- package/dist/api/patientRaces.d.ts.map +1 -0
- package/dist/api/patientRaces.js +28 -0
- package/dist/api/patients.d.ts +6 -3
- package/dist/api/patients.d.ts.map +1 -1
- package/dist/api/patients.js +15 -6
- package/dist/api/payPlanCharges.d.ts +4 -0
- package/dist/api/payPlanCharges.d.ts.map +1 -1
- package/dist/api/payPlanCharges.js +4 -0
- package/dist/api/payPlans.d.ts +10 -1
- package/dist/api/payPlans.d.ts.map +1 -1
- package/dist/api/payPlans.js +17 -18
- package/dist/api/paySplits.d.ts +12 -7
- package/dist/api/paySplits.d.ts.map +1 -1
- package/dist/api/paySplits.js +14 -6
- package/dist/api/payments.d.ts +18 -3
- package/dist/api/payments.d.ts.map +1 -1
- package/dist/api/payments.js +30 -4
- package/dist/api/perioExams.d.ts +67 -0
- package/dist/api/perioExams.d.ts.map +1 -0
- package/dist/api/perioExams.js +104 -0
- package/dist/api/perioMeasures.d.ts +74 -0
- package/dist/api/perioMeasures.d.ts.map +1 -0
- package/dist/api/perioMeasures.js +118 -0
- package/dist/api/pharmacies.d.ts +29 -0
- package/dist/api/pharmacies.d.ts.map +1 -0
- package/dist/api/pharmacies.js +38 -0
- package/dist/api/popups.d.ts +42 -0
- package/dist/api/popups.d.ts.map +1 -0
- package/dist/api/popups.js +71 -0
- package/dist/api/preferences.d.ts +31 -0
- package/dist/api/preferences.d.ts.map +1 -0
- package/dist/api/preferences.js +46 -0
- package/dist/api/procNotes.d.ts +5 -2
- package/dist/api/procNotes.d.ts.map +1 -1
- package/dist/api/procNotes.js +9 -3
- package/dist/api/procTPs.d.ts +6 -3
- package/dist/api/procTPs.d.ts.map +1 -1
- package/dist/api/procTPs.js +10 -4
- package/dist/api/procedureCodes.d.ts +9 -7
- package/dist/api/procedureCodes.d.ts.map +1 -1
- package/dist/api/procedureCodes.js +13 -8
- package/dist/api/procedureLog.d.ts +5 -2
- package/dist/api/procedureLog.d.ts.map +1 -1
- package/dist/api/procedureLog.js +15 -6
- package/dist/api/providers.d.ts +4 -1
- package/dist/api/providers.d.ts.map +1 -1
- package/dist/api/providers.js +10 -4
- package/dist/api/queries.d.ts +24 -1
- package/dist/api/queries.d.ts.map +1 -1
- package/dist/api/queries.js +35 -0
- package/dist/api/quickPasteCats.d.ts +24 -0
- package/dist/api/quickPasteCats.d.ts.map +1 -0
- package/dist/api/quickPasteCats.js +33 -0
- package/dist/api/quickPasteNotes.d.ts +27 -0
- package/dist/api/quickPasteNotes.d.ts.map +1 -0
- package/dist/api/quickPasteNotes.js +36 -0
- package/dist/api/recallTypes.d.ts +31 -0
- package/dist/api/recallTypes.d.ts.map +1 -0
- package/dist/api/recallTypes.js +40 -0
- package/dist/api/recalls.d.ts +20 -4
- package/dist/api/recalls.d.ts.map +1 -1
- package/dist/api/recalls.js +26 -14
- package/dist/api/refAttaches.d.ts +6 -3
- package/dist/api/refAttaches.d.ts.map +1 -1
- package/dist/api/refAttaches.js +11 -5
- package/dist/api/referrals.d.ts +4 -1
- package/dist/api/referrals.d.ts.map +1 -1
- package/dist/api/referrals.js +10 -4
- package/dist/api/reports.d.ts +34 -0
- package/dist/api/reports.d.ts.map +1 -0
- package/dist/api/reports.js +40 -0
- package/dist/api/rxPats.d.ts +27 -0
- package/dist/api/rxPats.d.ts.map +1 -0
- package/dist/api/rxPats.js +41 -0
- package/dist/api/scheduleOps.d.ts +20 -0
- package/dist/api/scheduleOps.d.ts.map +1 -0
- package/dist/api/scheduleOps.js +30 -0
- package/dist/api/schedules.d.ts +23 -2
- package/dist/api/schedules.d.ts.map +1 -1
- package/dist/api/schedules.js +31 -2
- package/dist/api/security.d.ts +25 -0
- package/dist/api/security.d.ts.map +1 -0
- package/dist/api/security.js +29 -0
- package/dist/api/securityLogs.d.ts +5 -2
- package/dist/api/securityLogs.d.ts.map +1 -1
- package/dist/api/securityLogs.js +8 -2
- package/dist/api/sheetDefs.d.ts +27 -0
- package/dist/api/sheetDefs.d.ts.map +1 -0
- package/dist/api/sheetDefs.js +36 -0
- package/dist/api/sheetFields.d.ts +38 -0
- package/dist/api/sheetFields.d.ts.map +1 -0
- package/dist/api/sheetFields.js +53 -0
- package/dist/api/sheets.d.ts +47 -0
- package/dist/api/sheets.d.ts.map +1 -0
- package/dist/api/sheets.js +64 -0
- package/dist/api/signalODs.d.ts +23 -0
- package/dist/api/signalODs.d.ts.map +1 -0
- package/dist/api/signalODs.js +30 -0
- package/dist/api/statements.d.ts +48 -0
- package/dist/api/statements.d.ts.map +1 -0
- package/dist/api/statements.js +72 -0
- package/dist/api/subscriptions.d.ts +67 -0
- package/dist/api/subscriptions.d.ts.map +1 -0
- package/dist/api/subscriptions.js +93 -0
- package/dist/api/substitutionLinks.d.ts +51 -0
- package/dist/api/substitutionLinks.d.ts.map +1 -0
- package/dist/api/substitutionLinks.js +74 -0
- package/dist/api/taskLists.d.ts +20 -0
- package/dist/api/taskLists.d.ts.map +1 -0
- package/dist/api/taskLists.js +24 -0
- package/dist/api/taskNotes.d.ts +50 -0
- package/dist/api/taskNotes.d.ts.map +1 -0
- package/dist/api/taskNotes.js +81 -0
- package/dist/api/tasks.d.ts +69 -0
- package/dist/api/tasks.d.ts.map +1 -0
- package/dist/api/tasks.js +89 -0
- package/dist/api/toothInitials.d.ts +39 -0
- package/dist/api/toothInitials.d.ts.map +1 -0
- package/dist/api/toothInitials.js +64 -0
- package/dist/api/treatplanattaches.d.ts +5 -2
- package/dist/api/treatplanattaches.d.ts.map +1 -1
- package/dist/api/treatplanattaches.js +10 -4
- package/dist/api/treatplans.d.ts +15 -1
- package/dist/api/treatplans.d.ts.map +1 -1
- package/dist/api/treatplans.js +26 -4
- package/dist/api/userGroupAttaches.d.ts +20 -0
- package/dist/api/userGroupAttaches.d.ts.map +1 -0
- package/dist/api/userGroupAttaches.js +30 -0
- package/dist/api/userGroups.d.ts +20 -0
- package/dist/api/userGroups.d.ts.map +1 -0
- package/dist/api/userGroups.js +29 -0
- package/dist/api/userODs.d.ts +49 -0
- package/dist/api/userODs.d.ts.map +1 -0
- package/dist/api/userODs.js +64 -0
- package/dist/openDental.d.ts +624 -115
- package/dist/openDental.d.ts.map +1 -1
- package/dist/openDental.js +800 -291
- package/dist/types/DiscountPlanTypes.d.ts +3 -0
- package/dist/types/DiscountPlanTypes.d.ts.map +1 -1
- package/dist/types/adjustmentTypes.d.ts +3 -0
- package/dist/types/adjustmentTypes.d.ts.map +1 -1
- package/dist/types/allergyDefTypes.d.ts +25 -0
- package/dist/types/allergyDefTypes.d.ts.map +1 -0
- package/dist/types/allergyTypes.d.ts +3 -0
- package/dist/types/allergyTypes.d.ts.map +1 -1
- package/dist/types/{appoinmentTypesType.d.ts → appointmentTypeTypes.d.ts} +1 -1
- package/dist/types/appointmentTypeTypes.d.ts.map +1 -0
- package/dist/types/appointmentTypeTypes.js +2 -0
- package/dist/types/appointmentTypes.d.ts +19 -0
- package/dist/types/appointmentTypes.d.ts.map +1 -1
- package/dist/types/apptFieldDefTypes.d.ts +25 -0
- package/dist/types/apptFieldDefTypes.d.ts.map +1 -0
- package/dist/types/apptFieldDefTypes.js +2 -0
- package/dist/types/apptFieldTypes.d.ts +34 -0
- package/dist/types/apptFieldTypes.d.ts.map +1 -0
- package/dist/types/apptFieldTypes.js +2 -0
- package/dist/types/asapCommTypes.d.ts +63 -0
- package/dist/types/asapCommTypes.d.ts.map +1 -0
- package/dist/types/asapCommTypes.js +2 -0
- package/dist/types/autoNoteControlTypes.d.ts +27 -0
- package/dist/types/autoNoteControlTypes.d.ts.map +1 -0
- package/dist/types/autoNoteControlTypes.js +2 -0
- package/dist/types/autoNoteTypes.d.ts +33 -0
- package/dist/types/autoNoteTypes.d.ts.map +1 -0
- package/dist/types/autoNoteTypes.js +2 -0
- package/dist/types/benefitTypes.d.ts +6 -0
- package/dist/types/benefitTypes.d.ts.map +1 -1
- package/dist/types/carrierTypes.d.ts +45 -0
- package/dist/types/carrierTypes.d.ts.map +1 -0
- package/dist/types/carrierTypes.js +2 -0
- package/dist/types/claimPaymentTypes.d.ts +72 -0
- package/dist/types/claimPaymentTypes.d.ts.map +1 -0
- package/dist/types/claimPaymentTypes.js +2 -0
- package/dist/types/claimProcTypes.d.ts +3 -0
- package/dist/types/claimProcTypes.d.ts.map +1 -1
- package/dist/types/claimTrackingTypes.d.ts +37 -0
- package/dist/types/claimTrackingTypes.d.ts.map +1 -0
- package/dist/types/claimTrackingTypes.js +2 -0
- package/dist/types/claimTypes.d.ts +3 -0
- package/dist/types/claimTypes.d.ts.map +1 -1
- package/dist/types/clinicTypes.d.ts +45 -0
- package/dist/types/clinicTypes.d.ts.map +1 -0
- package/dist/types/clinicTypes.js +2 -0
- package/dist/types/clockEventTypes.d.ts +52 -0
- package/dist/types/clockEventTypes.d.ts.map +1 -0
- package/dist/types/clockEventTypes.js +2 -0
- package/dist/types/codeGroupTypes.d.ts +67 -0
- package/dist/types/codeGroupTypes.d.ts.map +1 -0
- package/dist/types/codeGroupTypes.js +2 -0
- package/dist/types/computerTypes.d.ts +10 -0
- package/dist/types/computerTypes.d.ts.map +1 -0
- package/dist/types/computerTypes.js +2 -0
- package/dist/types/covCatTypes.d.ts +53 -0
- package/dist/types/covCatTypes.d.ts.map +1 -0
- package/dist/types/covCatTypes.js +2 -0
- package/dist/types/covSpanTypes.d.ts +52 -0
- package/dist/types/covSpanTypes.d.ts.map +1 -0
- package/dist/types/covSpanTypes.js +2 -0
- package/dist/types/definitionTypes.d.ts +12 -0
- package/dist/types/definitionTypes.d.ts.map +1 -1
- package/dist/types/discountPlanSubTypes.d.ts +5 -1
- package/dist/types/discountPlanSubTypes.d.ts.map +1 -1
- package/dist/types/diseaseDefTypes.d.ts +33 -0
- package/dist/types/diseaseDefTypes.d.ts.map +1 -0
- package/dist/types/diseaseDefTypes.js +2 -0
- package/dist/types/diseaseTypes.d.ts +3 -0
- package/dist/types/diseaseTypes.d.ts.map +1 -1
- package/dist/types/documentTypes.d.ts +191 -0
- package/dist/types/documentTypes.d.ts.map +1 -0
- package/dist/types/documentTypes.js +2 -0
- package/dist/types/eTransMessageTextTypes.d.ts +9 -0
- package/dist/types/eTransMessageTextTypes.d.ts.map +1 -0
- package/dist/types/eTransMessageTextTypes.js +2 -0
- package/dist/types/eTransTypes.d.ts +15 -0
- package/dist/types/eTransTypes.d.ts.map +1 -0
- package/dist/types/eTransTypes.js +2 -0
- package/dist/types/eTranssTypes.d.ts +46 -0
- package/dist/types/eTranssTypes.d.ts.map +1 -0
- package/dist/types/eTranssTypes.js +2 -0
- package/dist/types/ehrPatientTypes.d.ts +34 -0
- package/dist/types/ehrPatientTypes.d.ts.map +1 -0
- package/dist/types/ehrPatientTypes.js +2 -0
- package/dist/types/employeeTypes.d.ts +88 -0
- package/dist/types/employeeTypes.d.ts.map +1 -0
- package/dist/types/employeeTypes.js +2 -0
- package/dist/types/employerTypes.d.ts +38 -0
- package/dist/types/employerTypes.d.ts.map +1 -0
- package/dist/types/employerTypes.js +2 -0
- package/dist/types/eobAttachTypes.d.ts +62 -0
- package/dist/types/eobAttachTypes.d.ts.map +1 -0
- package/dist/types/eobAttachTypes.js +2 -0
- package/dist/types/eventTypes.d.ts +52 -0
- package/dist/types/eventTypes.d.ts.map +1 -0
- package/dist/types/eventTypes.js +2 -0
- package/dist/types/feeTypes.d.ts +3 -0
- package/dist/types/feeTypes.d.ts.map +1 -1
- package/dist/types/histAppointmentTypes.d.ts +77 -0
- package/dist/types/histAppointmentTypes.d.ts.map +1 -0
- package/dist/types/histAppointmentTypes.js +2 -0
- package/dist/types/insPlanTypes.d.ts +4 -1
- package/dist/types/insPlanTypes.d.ts.map +1 -1
- package/dist/types/insSubTypes.d.ts +4 -1
- package/dist/types/insSubTypes.d.ts.map +1 -1
- package/dist/types/insVerifiesTypes.d.ts +3 -0
- package/dist/types/insVerifiesTypes.d.ts.map +1 -1
- package/dist/types/labCaseTypes.d.ts +4 -0
- package/dist/types/labCaseTypes.d.ts.map +1 -1
- package/dist/types/labTurnaroundTypes.d.ts +55 -0
- package/dist/types/labTurnaroundTypes.d.ts.map +1 -0
- package/dist/types/labTurnaroundTypes.js +2 -0
- package/dist/types/laboratoryTypes.d.ts +80 -0
- package/dist/types/laboratoryTypes.d.ts.map +1 -0
- package/dist/types/laboratoryTypes.js +2 -0
- package/dist/types/medicationPatTypes.d.ts +3 -0
- package/dist/types/medicationPatTypes.d.ts.map +1 -1
- package/dist/types/medicationTypes.d.ts +28 -0
- package/dist/types/medicationTypes.d.ts.map +1 -0
- package/dist/types/medicationTypes.js +2 -0
- package/dist/types/operatoryTypes.d.ts +5 -2
- package/dist/types/operatoryTypes.d.ts.map +1 -1
- package/dist/types/patFieldDefTypes.d.ts +64 -0
- package/dist/types/patFieldDefTypes.d.ts.map +1 -0
- package/dist/types/patFieldDefTypes.js +2 -0
- package/dist/types/patFieldTypes.d.ts +4 -0
- package/dist/types/patFieldTypes.d.ts.map +1 -1
- package/dist/types/patPlanTypes.d.ts +3 -0
- package/dist/types/patPlanTypes.d.ts.map +1 -1
- package/dist/types/patientNoteTypes.d.ts +32 -0
- package/dist/types/patientNoteTypes.d.ts.map +1 -0
- package/dist/types/patientNoteTypes.js +2 -0
- package/dist/types/patientRaceTypes.d.ts +25 -0
- package/dist/types/patientRaceTypes.d.ts.map +1 -0
- package/dist/types/patientRaceTypes.js +2 -0
- package/dist/types/patientTypes.d.ts +7 -1
- package/dist/types/patientTypes.d.ts.map +1 -1
- package/dist/types/payPlanChargeTypes.d.ts +4 -0
- package/dist/types/payPlanChargeTypes.d.ts.map +1 -1
- package/dist/types/paySplitTypes.d.ts +3 -0
- package/dist/types/paySplitTypes.d.ts.map +1 -1
- package/dist/types/paymentTypes.d.ts +11 -0
- package/dist/types/paymentTypes.d.ts.map +1 -1
- package/dist/types/perioExamTypes.d.ts +54 -0
- package/dist/types/perioExamTypes.d.ts.map +1 -0
- package/dist/types/perioExamTypes.js +2 -0
- package/dist/types/perioMeasureTypes.d.ts +80 -0
- package/dist/types/perioMeasureTypes.d.ts.map +1 -0
- package/dist/types/perioMeasureTypes.js +2 -0
- package/dist/types/pharmacyTypes.d.ts +18 -0
- package/dist/types/pharmacyTypes.d.ts.map +1 -0
- package/dist/types/pharmacyTypes.js +2 -0
- package/dist/types/popupTypes.d.ts +55 -0
- package/dist/types/popupTypes.d.ts.map +1 -0
- package/dist/types/popupTypes.js +2 -0
- package/dist/types/preferenceTypes.d.ts +32 -0
- package/dist/types/preferenceTypes.d.ts.map +1 -0
- package/dist/types/preferenceTypes.js +2 -0
- package/dist/types/procNoteTypes.d.ts +3 -0
- package/dist/types/procNoteTypes.d.ts.map +1 -1
- package/dist/types/procTPTypes.d.ts +3 -0
- package/dist/types/procTPTypes.d.ts.map +1 -1
- package/dist/types/procedureCodeTypes.d.ts +3 -0
- package/dist/types/procedureCodeTypes.d.ts.map +1 -1
- package/dist/types/procedurelogTypes.d.ts +7 -0
- package/dist/types/procedurelogTypes.d.ts.map +1 -1
- package/dist/types/providerTypes.d.ts +3 -0
- package/dist/types/providerTypes.d.ts.map +1 -1
- package/dist/types/queryTypes.d.ts +10 -0
- package/dist/types/queryTypes.d.ts.map +1 -1
- package/dist/types/quickPasteCatTypes.d.ts +23 -0
- package/dist/types/quickPasteCatTypes.d.ts.map +1 -0
- package/dist/types/quickPasteCatTypes.js +2 -0
- package/dist/types/quickPasteNoteTypes.d.ts +26 -0
- package/dist/types/quickPasteNoteTypes.d.ts.map +1 -0
- package/dist/types/quickPasteNoteTypes.js +2 -0
- package/dist/types/recallTypeTypes.d.ts +13 -0
- package/dist/types/recallTypeTypes.d.ts.map +1 -0
- package/dist/types/recallTypeTypes.js +2 -0
- package/dist/types/recallTypes.d.ts +6 -3
- package/dist/types/recallTypes.d.ts.map +1 -1
- package/dist/types/refAttachTypes.d.ts +3 -0
- package/dist/types/refAttachTypes.d.ts.map +1 -1
- package/dist/types/referralTypes.d.ts +7 -4
- package/dist/types/referralTypes.d.ts.map +1 -1
- package/dist/types/reportTypes.d.ts +56 -0
- package/dist/types/reportTypes.d.ts.map +1 -0
- package/dist/types/reportTypes.js +2 -0
- package/dist/types/rxPatTypes.d.ts +43 -0
- package/dist/types/rxPatTypes.d.ts.map +1 -0
- package/dist/types/rxPatTypes.js +2 -0
- package/dist/types/scheduleOpTypes.d.ts +22 -0
- package/dist/types/scheduleOpTypes.d.ts.map +1 -0
- package/dist/types/scheduleOpTypes.js +2 -0
- package/dist/types/scheduleTypes.d.ts +17 -0
- package/dist/types/scheduleTypes.d.ts.map +1 -1
- package/dist/types/securityLogTypes.d.ts +3 -0
- package/dist/types/securityLogTypes.d.ts.map +1 -1
- package/dist/types/securityTypes.d.ts +13 -0
- package/dist/types/securityTypes.d.ts.map +1 -0
- package/dist/types/securityTypes.js +2 -0
- package/dist/types/sheetDefTypes.d.ts +22 -0
- package/dist/types/sheetDefTypes.d.ts.map +1 -0
- package/dist/types/sheetDefTypes.js +2 -0
- package/dist/types/sheetFieldTypes.d.ts +48 -0
- package/dist/types/sheetFieldTypes.d.ts.map +1 -0
- package/dist/types/sheetFieldTypes.js +2 -0
- package/dist/types/sheetTypes.d.ts +62 -0
- package/dist/types/sheetTypes.d.ts.map +1 -0
- package/dist/types/sheetTypes.js +2 -0
- package/dist/types/signalODTypes.d.ts +48 -0
- package/dist/types/signalODTypes.d.ts.map +1 -0
- package/dist/types/signalODTypes.js +2 -0
- package/dist/types/statementTypes.d.ts +60 -0
- package/dist/types/statementTypes.d.ts.map +1 -0
- package/dist/types/statementTypes.js +2 -0
- package/dist/types/subscriptionTypes.d.ts +99 -0
- package/dist/types/subscriptionTypes.d.ts.map +1 -0
- package/dist/types/subscriptionTypes.js +2 -0
- package/dist/types/substitutionLinkTypes.d.ts +46 -0
- package/dist/types/substitutionLinkTypes.d.ts.map +1 -0
- package/dist/types/substitutionLinkTypes.js +2 -0
- package/dist/types/taskListTypes.d.ts +67 -0
- package/dist/types/taskListTypes.d.ts.map +1 -0
- package/dist/types/taskListTypes.js +2 -0
- package/dist/types/taskNoteTypes.d.ts +42 -0
- package/dist/types/taskNoteTypes.d.ts.map +1 -0
- package/dist/types/taskNoteTypes.js +2 -0
- package/dist/types/taskTypes.d.ts +153 -0
- package/dist/types/taskTypes.d.ts.map +1 -0
- package/dist/types/taskTypes.js +2 -0
- package/dist/types/toothInitialTypes.d.ts +44 -0
- package/dist/types/toothInitialTypes.d.ts.map +1 -0
- package/dist/types/toothInitialTypes.js +2 -0
- package/dist/types/treatPlanAttachTypes.d.ts +3 -0
- package/dist/types/treatPlanAttachTypes.d.ts.map +1 -1
- package/dist/types/treatPlanTypes.d.ts +4 -0
- package/dist/types/treatPlanTypes.d.ts.map +1 -1
- package/dist/types/userGroupAttachTypes.d.ts +22 -0
- package/dist/types/userGroupAttachTypes.d.ts.map +1 -0
- package/dist/types/userGroupAttachTypes.js +2 -0
- package/dist/types/userGroupTypes.d.ts +21 -0
- package/dist/types/userGroupTypes.d.ts.map +1 -0
- package/dist/types/userGroupTypes.js +2 -0
- package/dist/types/userODTypes.d.ts +97 -0
- package/dist/types/userODTypes.d.ts.map +1 -0
- package/dist/types/userODTypes.js +2 -0
- package/dist/utils/errorHandler.d.ts +5 -0
- package/dist/utils/errorHandler.d.ts.map +1 -1
- package/dist/utils/errorHandler.js +11 -0
- package/dist/utils/httpClient.d.ts +24 -6
- package/dist/utils/httpClient.d.ts.map +1 -1
- package/dist/utils/httpClient.js +28 -24
- package/docs/Open Dental 2026-04-22/api-url-list.md +110 -0
- package/docs/Open Dental 2026-04-22/apiaccountmodules.md +116 -0
- package/docs/Open Dental 2026-04-22/apiadjustments.md +133 -0
- package/docs/Open Dental 2026-04-22/apiallergies.md +132 -0
- package/docs/Open Dental 2026-04-22/apiallergydefs.md +74 -0
- package/docs/Open Dental 2026-04-22/apiappointments.md +510 -0
- package/docs/Open Dental 2026-04-22/apiappointmenttypes.md +86 -0
- package/docs/Open Dental 2026-04-22/apiapptfielddefs.md +130 -0
- package/docs/Open Dental 2026-04-22/apiapptfields.md +147 -0
- package/docs/Open Dental 2026-04-22/apiasapcomms.md +141 -0
- package/docs/Open Dental 2026-04-22/apiautonotecontrols.md +111 -0
- package/docs/Open Dental 2026-04-22/apiautonotes.md +103 -0
- package/docs/Open Dental 2026-04-22/apibenefits.md +515 -0
- package/docs/Open Dental 2026-04-22/apicarriers.md +150 -0
- package/docs/Open Dental 2026-04-22/apichartmodules.md +135 -0
- package/docs/Open Dental 2026-04-22/apiclaimpayments.md +206 -0
- package/docs/Open Dental 2026-04-22/apiclaimprocs.md +256 -0
- package/docs/Open Dental 2026-04-22/apiclaims.md +339 -0
- package/docs/Open Dental 2026-04-22/apiclaimtrackings.md +110 -0
- package/docs/Open Dental 2026-04-22/apiclinics.md +95 -0
- package/docs/Open Dental 2026-04-22/apiclockevents.md +98 -0
- package/docs/Open Dental 2026-04-22/apicodegroups.md +140 -0
- package/docs/Open Dental 2026-04-22/apicommlogs.md +161 -0
- package/docs/Open Dental 2026-04-22/apicomputers.md +39 -0
- package/docs/Open Dental 2026-04-22/apicovcats.md +139 -0
- package/docs/Open Dental 2026-04-22/apicovspans.md +140 -0
- package/docs/Open Dental 2026-04-22/apidefinitions.md +90 -0
- package/docs/Open Dental 2026-04-22/apidiscountplans.md +154 -0
- package/docs/Open Dental 2026-04-22/apidiscountplansubs.md +125 -0
- package/docs/Open Dental 2026-04-22/apidiseasedefs.md +88 -0
- package/docs/Open Dental 2026-04-22/apidiseases.md +168 -0
- package/docs/Open Dental 2026-04-22/apidocuments.md +319 -0
- package/docs/Open Dental 2026-04-22/apiehrpatients.md +87 -0
- package/docs/Open Dental 2026-04-22/apiemployees.md +145 -0
- package/docs/Open Dental 2026-04-22/apiemployers.md +129 -0
- package/docs/Open Dental 2026-04-22/apieobattaches.md +132 -0
- package/docs/Open Dental 2026-04-22/apietrans.md +44 -0
- package/docs/Open Dental 2026-04-22/apietransmessagetexts.md +56 -0
- package/docs/Open Dental 2026-04-22/apietranss.md +79 -0
- package/docs/Open Dental 2026-04-22/apievents.md +96 -0
- package/docs/Open Dental 2026-04-22/apifamilymodules.md +108 -0
- package/docs/Open Dental 2026-04-22/apifees.md +146 -0
- package/docs/Open Dental 2026-04-22/apifeescheds.md +116 -0
- package/docs/Open Dental 2026-04-22/apihistappointments.md +121 -0
- package/docs/Open Dental 2026-04-22/apiimplementation.md +128 -0
- package/docs/Open Dental 2026-04-22/apiinsplans.md +236 -0
- package/docs/Open Dental 2026-04-22/apiinssubs.md +171 -0
- package/docs/Open Dental 2026-04-22/apiinsverifies.md +123 -0
- package/docs/Open Dental 2026-04-22/apilabcases.md +174 -0
- package/docs/Open Dental 2026-04-22/apilaboratories.md +147 -0
- package/docs/Open Dental 2026-04-22/apilabturnarounds.md +128 -0
- package/docs/Open Dental 2026-04-22/apimedicationpats.md +170 -0
- package/docs/Open Dental 2026-04-22/apimedications.md +74 -0
- package/docs/Open Dental 2026-04-22/apioperatories.md +78 -0
- package/docs/Open Dental 2026-04-22/apipatfielddefs.md +139 -0
- package/docs/Open Dental 2026-04-22/apipatfields.md +166 -0
- package/docs/Open Dental 2026-04-22/apipatientnotes.md +102 -0
- package/docs/Open Dental 2026-04-22/apipatientraces.md +51 -0
- package/docs/Open Dental 2026-04-22/apipatients.md +346 -0
- package/docs/Open Dental 2026-04-22/apipatplans.md +147 -0
- package/docs/Open Dental 2026-04-22/apipayments.md +236 -0
- package/docs/Open Dental 2026-04-22/apipayplancharges.md +59 -0
- package/docs/Open Dental 2026-04-22/apipayplans.md +256 -0
- package/docs/Open Dental 2026-04-22/apipaysplits.md +112 -0
- package/docs/Open Dental 2026-04-22/apiperioexams.md +155 -0
- package/docs/Open Dental 2026-04-22/apiperiomeasures.md +162 -0
- package/docs/Open Dental 2026-04-22/apipharmacies.md +78 -0
- package/docs/Open Dental 2026-04-22/apipopups.md +127 -0
- package/docs/Open Dental 2026-04-22/apipreferences.md +47 -0
- package/docs/Open Dental 2026-04-22/apiprocedurecodes.md +260 -0
- package/docs/Open Dental 2026-04-22/apiprocedurelogs.md +477 -0
- package/docs/Open Dental 2026-04-22/apiprocnotes.md +86 -0
- package/docs/Open Dental 2026-04-22/apiproctps.md +141 -0
- package/docs/Open Dental 2026-04-22/apiproviders.md +189 -0
- package/docs/Open Dental 2026-04-22/apiqueries.md +74 -0
- package/docs/Open Dental 2026-04-22/apiquickpastecats.md +130 -0
- package/docs/Open Dental 2026-04-22/apiquickpastenotes.md +75 -0
- package/docs/Open Dental 2026-04-22/apirecalls.md +239 -0
- package/docs/Open Dental 2026-04-22/apirecalltypes.md +65 -0
- package/docs/Open Dental 2026-04-22/apirefattaches.md +179 -0
- package/docs/Open Dental 2026-04-22/apireferrals.md +198 -0
- package/docs/Open Dental 2026-04-22/apireports.md +85 -0
- package/docs/Open Dental 2026-04-22/apirxpats.md +113 -0
- package/docs/Open Dental 2026-04-22/apischeduleops.md +58 -0
- package/docs/Open Dental 2026-04-22/apischedules.md +106 -0
- package/docs/Open Dental 2026-04-22/apisecurity.md +53 -0
- package/docs/Open Dental 2026-04-22/apisecuritylogs.md +59 -0
- package/docs/Open Dental 2026-04-22/apisheetdefs.md +118 -0
- package/docs/Open Dental 2026-04-22/apisheetfields.md +140 -0
- package/docs/Open Dental 2026-04-22/apisheets.md +156 -0
- package/docs/Open Dental 2026-04-22/apisignalods.md +118 -0
- package/docs/Open Dental 2026-04-22/apispecification.md +47 -0
- package/docs/Open Dental 2026-04-22/apistatements.md +160 -0
- package/docs/Open Dental 2026-04-22/apisubscriptions.md +133 -0
- package/docs/Open Dental 2026-04-22/apisubstitutionlinks.md +143 -0
- package/docs/Open Dental 2026-04-22/apitasklists.md +89 -0
- package/docs/Open Dental 2026-04-22/apitasknotes.md +130 -0
- package/docs/Open Dental 2026-04-22/apitasks.md +192 -0
- package/docs/Open Dental 2026-04-22/apitoothinitials.md +119 -0
- package/docs/Open Dental 2026-04-22/apitreatplanattaches.md +111 -0
- package/docs/Open Dental 2026-04-22/apitreatplans.md +201 -0
- package/docs/Open Dental 2026-04-22/apiusergroupattaches.md +57 -0
- package/docs/Open Dental 2026-04-22/apiusergroups.md +56 -0
- package/docs/Open Dental 2026-04-22/apiuserods.md +128 -0
- package/docs/Open Dental 2026-04-22/context/Open Dental _ Benefits Guide.md +294 -0
- package/docs/Open Dental 2026-04-22/context/OpenDental_DB_Documentation_v26-1.xml +20118 -0
- package/docs/Open Dental 2026-04-22/context/sitemap.xml +4617 -0
- package/package.json +8 -7
- package/release.sh +3 -5
- package/tsconfig.test.json +8 -0
- package/__tests__/example.test.ts +0 -6
- package/dist/types/appoinmentTypesType.d.ts.map +0 -1
- package/src/api/accountModules.ts +0 -61
- package/src/api/adjustments.ts +0 -126
- package/src/api/allergies.ts +0 -114
- package/src/api/appointmentTypes.ts +0 -21
- package/src/api/appointments.ts +0 -343
- package/src/api/benefits.ts +0 -155
- package/src/api/chartModules.ts +0 -53
- package/src/api/claimProcs.ts +0 -117
- package/src/api/claims.ts +0 -173
- package/src/api/commlogs.ts +0 -63
- package/src/api/definitions.ts +0 -35
- package/src/api/discountPlanSubs.ts +0 -106
- package/src/api/discountPlans.ts +0 -159
- package/src/api/diseases.ts +0 -130
- package/src/api/familyModules.ts +0 -29
- package/src/api/feeScheds.ts +0 -30
- package/src/api/fees.ts +0 -43
- package/src/api/index.ts +0 -25
- package/src/api/insPlans.ts +0 -158
- package/src/api/insSubs.ts +0 -155
- package/src/api/insVerifies.ts +0 -85
- package/src/api/labCases.ts +0 -183
- package/src/api/medicationPats.ts +0 -120
- package/src/api/operatories.ts +0 -46
- package/src/api/patFields.ts +0 -112
- package/src/api/patPlans.ts +0 -113
- package/src/api/patients.ts +0 -254
- package/src/api/payPlanCharges.ts +0 -49
- package/src/api/payPlans.ts +0 -274
- package/src/api/paySplits.ts +0 -56
- package/src/api/payments.ts +0 -86
- package/src/api/procNotes.ts +0 -67
- package/src/api/procTPs.ts +0 -112
- package/src/api/procedureCodes.ts +0 -45
- package/src/api/procedureLog.ts +0 -377
- package/src/api/providers.ts +0 -175
- package/src/api/queries.ts +0 -43
- package/src/api/recalls.ts +0 -148
- package/src/api/refAttaches.ts +0 -142
- package/src/api/referrals.ts +0 -222
- package/src/api/schedules.ts +0 -64
- package/src/api/securityLogs.ts +0 -32
- package/src/api/treatplanattaches.ts +0 -67
- package/src/api/treatplans.ts +0 -96
- package/src/index.ts +0 -2
- package/src/openDental.ts +0 -506
- package/src/transformerTypes/visitTypes.ts +0 -87
- package/src/transformers/index.ts +0 -4
- package/src/transformers/visit.ts +0 -83
- package/src/types/DiscountPlanTypes.ts +0 -70
- package/src/types/accountModuleTypes.ts +0 -46
- package/src/types/adjustmentTypes.ts +0 -63
- package/src/types/allergyTypes.ts +0 -48
- package/src/types/appoinmentTypesType.ts +0 -16
- package/src/types/appointmentTypes.ts +0 -256
- package/src/types/benefitTypes.ts +0 -70
- package/src/types/chartModuleTypes.ts +0 -65
- package/src/types/claimProcTypes.ts +0 -99
- package/src/types/claimTypes.ts +0 -227
- package/src/types/commlogTypes.ts +0 -28
- package/src/types/definitionTypes.ts +0 -24
- package/src/types/discountPlanSubTypes.ts +0 -45
- package/src/types/diseaseTypes.ts +0 -50
- package/src/types/familyModuleTypes.ts +0 -33
- package/src/types/feeSchedsTypes.ts +0 -38
- package/src/types/feeTypes.ts +0 -49
- package/src/types/insPlanTypes.ts +0 -72
- package/src/types/insSubTypes.ts +0 -65
- package/src/types/insVerifiesTypes.ts +0 -38
- package/src/types/labCaseTypes.ts +0 -71
- package/src/types/medicationPatTypes.ts +0 -50
- package/src/types/operatoryTypes.ts +0 -24
- package/src/types/patFieldTypes.ts +0 -24
- package/src/types/patPlanTypes.ts +0 -55
- package/src/types/patientTypes.ts +0 -236
- package/src/types/payPlanChargeTypes.ts +0 -77
- package/src/types/payPlanTypes.ts +0 -171
- package/src/types/paySplitTypes.ts +0 -44
- package/src/types/paymentTypes.ts +0 -69
- package/src/types/procNoteTypes.ts +0 -38
- package/src/types/procTPTypes.ts +0 -79
- package/src/types/procedureCodeTypes.ts +0 -48
- package/src/types/procedurelogTypes.ts +0 -184
- package/src/types/providerTypes.ts +0 -73
- package/src/types/queryTypes.ts +0 -17
- package/src/types/recallTypes.ts +0 -102
- package/src/types/refAttachTypes.ts +0 -63
- package/src/types/referralTypes.ts +0 -102
- package/src/types/scheduleTypes.ts +0 -32
- package/src/types/securityLogTypes.ts +0 -24
- package/src/types/treatPlanAttachTypes.ts +0 -39
- package/src/types/treatPlanTypes.ts +0 -75
- package/src/utils/errorHandler.ts +0 -0
- package/src/utils/httpClient.ts +0 -111
- package/tsconfig.json +0 -16
- /package/dist/types/{appoinmentTypesType.js → allergyDefTypes.js} +0 -0
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
// src/api/payPlanCharges.ts
|
|
2
|
-
import HttpClient from "../utils/httpClient";
|
|
3
|
-
import { PayPlanCharge } from "../types/payPlanChargeTypes";
|
|
4
|
-
|
|
5
|
-
/** Utility to remove undefined fields from objects (for API payloads) */
|
|
6
|
-
const clean = (obj: Record<string, any>): Record<string, any> => {
|
|
7
|
-
return Object.fromEntries(
|
|
8
|
-
Object.entries(obj).filter(([_, v]) => v !== undefined)
|
|
9
|
-
);
|
|
10
|
-
};
|
|
11
|
-
|
|
12
|
-
export default class PayPlanCharges {
|
|
13
|
-
private httpClient: HttpClient;
|
|
14
|
-
|
|
15
|
-
constructor(httpClient: HttpClient) {
|
|
16
|
-
this.httpClient = httpClient;
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* Fetch all payment plan charges for a specified payment plan.
|
|
21
|
-
* Mirrors GET /payplancharges
|
|
22
|
-
* Added in version 23.2.28
|
|
23
|
-
*
|
|
24
|
-
* @see https://www.opendental.com/site/apipayplancharges.html
|
|
25
|
-
* @param params - Query parameters: { PayPlanNum: number } (required)
|
|
26
|
-
*/
|
|
27
|
-
public async getPayPlanCharges(
|
|
28
|
-
params: { PayPlanNum: number }
|
|
29
|
-
): Promise<PayPlanCharge[]> {
|
|
30
|
-
// Validate required parameter
|
|
31
|
-
if (!params || typeof params !== "object") {
|
|
32
|
-
throw new Error(
|
|
33
|
-
"Invalid parameters: getPayPlanCharges requires a params object."
|
|
34
|
-
);
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
if (!params.PayPlanNum || typeof params.PayPlanNum !== "number") {
|
|
38
|
-
throw new Error(
|
|
39
|
-
"Invalid parameter: PayPlanNum is required and must be a number."
|
|
40
|
-
);
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
const query = clean({
|
|
44
|
-
PayPlanNum: params.PayPlanNum,
|
|
45
|
-
});
|
|
46
|
-
|
|
47
|
-
return this.httpClient.get<PayPlanCharge[]>("/payplancharges", query);
|
|
48
|
-
}
|
|
49
|
-
}
|
package/src/api/payPlans.ts
DELETED
|
@@ -1,274 +0,0 @@
|
|
|
1
|
-
// src/api/payPlans.ts
|
|
2
|
-
import HttpClient from "../utils/httpClient";
|
|
3
|
-
import {
|
|
4
|
-
PayPlan,
|
|
5
|
-
GetPayPlanByIdParams,
|
|
6
|
-
CreateDynamicPayPlanParams,
|
|
7
|
-
CreatePayPlanParams,
|
|
8
|
-
ClosePayPlanParams,
|
|
9
|
-
UpdateDynamicPayPlanParams,
|
|
10
|
-
} from "../types/payPlanTypes";
|
|
11
|
-
|
|
12
|
-
/** Utility to remove undefined fields from objects (for API payloads) */
|
|
13
|
-
const clean = (obj: Record<string, any>): Record<string, any> => {
|
|
14
|
-
return Object.fromEntries(
|
|
15
|
-
Object.entries(obj).filter(([_, v]) => v !== undefined)
|
|
16
|
-
);
|
|
17
|
-
};
|
|
18
|
-
|
|
19
|
-
export default class PayPlans {
|
|
20
|
-
private httpClient: HttpClient;
|
|
21
|
-
|
|
22
|
-
constructor(httpClient: HttpClient) {
|
|
23
|
-
this.httpClient = httpClient;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* Fetch multiple payment plans with filtering by PatNum or Guarantor.
|
|
28
|
-
* Mirrors GET /payplans
|
|
29
|
-
* @see https://www.opendental.com/site/apipayplans.html
|
|
30
|
-
* @param params - Query parameters: { PatNum: number } OR { Guarantor: number } (mutually exclusive, one required)
|
|
31
|
-
*/
|
|
32
|
-
public async getPayPlans(params: { PatNum: number; Guarantor?: never } | { Guarantor: number; PatNum?: never }): Promise<PayPlan[]> {
|
|
33
|
-
// API requires either PatNum OR Guarantor, not both
|
|
34
|
-
if ('PatNum' in params && 'Guarantor' in params && params.PatNum && params.Guarantor) {
|
|
35
|
-
throw new Error(
|
|
36
|
-
"Invalid parameters: PatNum and Guarantor are mutually exclusive. Provide only one."
|
|
37
|
-
);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
if (!('PatNum' in params) && !('Guarantor' in params)) {
|
|
41
|
-
throw new Error(
|
|
42
|
-
"Invalid parameters: Either PatNum or Guarantor is required."
|
|
43
|
-
);
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
const query = clean({
|
|
47
|
-
PatNum: 'PatNum' in params ? params.PatNum : undefined,
|
|
48
|
-
Guarantor: 'Guarantor' in params ? params.Guarantor : undefined,
|
|
49
|
-
});
|
|
50
|
-
|
|
51
|
-
return this.httpClient.get<PayPlan[]>("/payplans", query);
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
/**
|
|
55
|
-
* Fetch a single payment plan by PayPlanNum.
|
|
56
|
-
* Mirrors GET /payplans/{PayPlanNum}
|
|
57
|
-
* Added in version 24.4.30
|
|
58
|
-
*/
|
|
59
|
-
public async getPayPlan({
|
|
60
|
-
PayPlanNum,
|
|
61
|
-
}: GetPayPlanByIdParams): Promise<PayPlan> {
|
|
62
|
-
if (!PayPlanNum || typeof PayPlanNum !== "number") {
|
|
63
|
-
throw new Error("Invalid parameter: PayPlanNum must be a valid number.");
|
|
64
|
-
}
|
|
65
|
-
return this.httpClient.get<PayPlan>(`/payplans/${PayPlanNum}`);
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* Create a new dynamic payment plan.
|
|
70
|
-
* Mirrors POST /payplans/Dynamic
|
|
71
|
-
* Added in version 22.2.22
|
|
72
|
-
*
|
|
73
|
-
* Required:
|
|
74
|
-
* - PatNum
|
|
75
|
-
* - PayAmt OR NumberOfPayments
|
|
76
|
-
* - procNums and/or adjNums (at least one must have items)
|
|
77
|
-
*
|
|
78
|
-
* Note: If APR > 0, IsLocked may be required to be true (depending on preferences)
|
|
79
|
-
*/
|
|
80
|
-
public async createDynamicPayPlan(
|
|
81
|
-
data: CreateDynamicPayPlanParams
|
|
82
|
-
): Promise<PayPlan> {
|
|
83
|
-
// Validate required fields
|
|
84
|
-
if (!data || typeof data !== "object") {
|
|
85
|
-
throw new Error(
|
|
86
|
-
"Invalid payload: createDynamicPayPlan requires a request body."
|
|
87
|
-
);
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
if (!data.PatNum || typeof data.PatNum !== "number") {
|
|
91
|
-
throw new Error(
|
|
92
|
-
"Invalid payload: PatNum is required and must be a number."
|
|
93
|
-
);
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
// Either PayAmt OR NumberOfPayments is required
|
|
97
|
-
if (!data.PayAmt && !data.NumberOfPayments) {
|
|
98
|
-
throw new Error(
|
|
99
|
-
"Invalid payload: Either PayAmt or NumberOfPayments is required."
|
|
100
|
-
);
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
// At least one of procNums or adjNums must be provided and non-empty
|
|
104
|
-
const hasProcNums = Array.isArray(data.procNums) && data.procNums.length > 0;
|
|
105
|
-
const hasAdjNums = Array.isArray(data.adjNums) && data.adjNums.length > 0;
|
|
106
|
-
|
|
107
|
-
if (!hasProcNums && !hasAdjNums) {
|
|
108
|
-
throw new Error(
|
|
109
|
-
"Invalid payload: At least one of procNums or adjNums must be a non-empty array."
|
|
110
|
-
);
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
// Validate APR and IsLocked relationship
|
|
114
|
-
if (data.APR && data.APR > 0 && data.IsLocked === false) {
|
|
115
|
-
console.warn(
|
|
116
|
-
"Warning: When APR > 0, IsLocked may need to be true depending on Open Dental preferences."
|
|
117
|
-
);
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
const payload = clean({
|
|
121
|
-
PatNum: data.PatNum,
|
|
122
|
-
PayAmt: data.PayAmt,
|
|
123
|
-
NumberOfPayments: data.NumberOfPayments,
|
|
124
|
-
procNums: data.procNums,
|
|
125
|
-
adjNums: data.adjNums,
|
|
126
|
-
Guarantor: data.Guarantor,
|
|
127
|
-
PayPlanDate: data.PayPlanDate,
|
|
128
|
-
APR: data.APR,
|
|
129
|
-
DownPayment: data.DownPayment,
|
|
130
|
-
Note: data.Note,
|
|
131
|
-
PlanCategory: data.PlanCategory,
|
|
132
|
-
ChargeFrequency: data.ChargeFrequency,
|
|
133
|
-
DatePayPlanStart: data.DatePayPlanStart,
|
|
134
|
-
DateInterestStart: data.DateInterestStart,
|
|
135
|
-
IsLocked: data.IsLocked,
|
|
136
|
-
DynamicPayPlanTPOption: data.DynamicPayPlanTPOption,
|
|
137
|
-
});
|
|
138
|
-
|
|
139
|
-
return this.httpClient.post<PayPlan>("/payplans/Dynamic", payload);
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
* Create a patient payment plan (DEPRECATED as of 23.3.1).
|
|
144
|
-
* Mirrors POST /payplans
|
|
145
|
-
* Added in version 22.4.39, deprecated in 23.3.1
|
|
146
|
-
*
|
|
147
|
-
* @deprecated Use createDynamicPayPlan instead. This endpoint returns 410 Gone in newer versions.
|
|
148
|
-
*
|
|
149
|
-
* Required:
|
|
150
|
-
* - PatNum
|
|
151
|
-
* - useEstBalance OR principalAmount
|
|
152
|
-
* - PayAmt OR NumberOfPayments
|
|
153
|
-
*/
|
|
154
|
-
public async createPayPlan(data: CreatePayPlanParams): Promise<PayPlan> {
|
|
155
|
-
console.warn(
|
|
156
|
-
"Warning: createPayPlan is deprecated as of version 23.3.1. Use createDynamicPayPlan instead."
|
|
157
|
-
);
|
|
158
|
-
|
|
159
|
-
// Validate required fields
|
|
160
|
-
if (!data || typeof data !== "object") {
|
|
161
|
-
throw new Error(
|
|
162
|
-
"Invalid payload: createPayPlan requires a request body."
|
|
163
|
-
);
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
if (!data.PatNum || typeof data.PatNum !== "number") {
|
|
167
|
-
throw new Error(
|
|
168
|
-
"Invalid payload: PatNum is required and must be a number."
|
|
169
|
-
);
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
// Either useEstBalance OR principalAmount is required
|
|
173
|
-
if (
|
|
174
|
-
data.useEstBalance === undefined &&
|
|
175
|
-
data.principalAmount === undefined
|
|
176
|
-
) {
|
|
177
|
-
throw new Error(
|
|
178
|
-
"Invalid payload: Either useEstBalance or principalAmount is required."
|
|
179
|
-
);
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
// Either PayAmt OR NumberOfPayments is required
|
|
183
|
-
if (!data.PayAmt && !data.NumberOfPayments) {
|
|
184
|
-
throw new Error(
|
|
185
|
-
"Invalid payload: Either PayAmt or NumberOfPayments is required."
|
|
186
|
-
);
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
const payload = clean({
|
|
190
|
-
PatNum: data.PatNum,
|
|
191
|
-
useEstBalance: data.useEstBalance,
|
|
192
|
-
principalAmount: data.principalAmount,
|
|
193
|
-
PayAmt: data.PayAmt,
|
|
194
|
-
NumberOfPayments: data.NumberOfPayments,
|
|
195
|
-
Guarantor: data.Guarantor,
|
|
196
|
-
PayPlanDate: data.PayPlanDate,
|
|
197
|
-
APR: data.APR,
|
|
198
|
-
DownPayment: data.DownPayment,
|
|
199
|
-
Note: data.Note,
|
|
200
|
-
PlanCategory: data.PlanCategory,
|
|
201
|
-
ChargeFrequency: data.ChargeFrequency,
|
|
202
|
-
DatePayPlanStart: data.DatePayPlanStart,
|
|
203
|
-
DateInterestStart: data.DateInterestStart,
|
|
204
|
-
});
|
|
205
|
-
|
|
206
|
-
return this.httpClient.post<PayPlan>("/payplans", payload);
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* Close a payment plan and charge any outstanding interest.
|
|
211
|
-
* Mirrors PUT /payplans/{PayPlanNum}/Close
|
|
212
|
-
* Added in version 22.4.39
|
|
213
|
-
*/
|
|
214
|
-
public async closePayPlan({
|
|
215
|
-
PayPlanNum,
|
|
216
|
-
}: ClosePayPlanParams): Promise<PayPlan> {
|
|
217
|
-
if (!PayPlanNum || typeof PayPlanNum !== "number") {
|
|
218
|
-
throw new Error(
|
|
219
|
-
"Invalid parameter: PayPlanNum is required and must be a number."
|
|
220
|
-
);
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
return this.httpClient.put<PayPlan>(
|
|
224
|
-
`/payplans/${PayPlanNum}/Close`,
|
|
225
|
-
{}
|
|
226
|
-
);
|
|
227
|
-
}
|
|
228
|
-
|
|
229
|
-
/**
|
|
230
|
-
* Update an existing dynamic payment plan.
|
|
231
|
-
* Mirrors PUT /payplans/{PayPlanNum}/Dynamic
|
|
232
|
-
* Added in version 25.3.31
|
|
233
|
-
*
|
|
234
|
-
* All fields except PayPlanNum are optional; send only what you intend to change.
|
|
235
|
-
*/
|
|
236
|
-
public async updateDynamicPayPlan(
|
|
237
|
-
data: UpdateDynamicPayPlanParams
|
|
238
|
-
): Promise<PayPlan> {
|
|
239
|
-
if (!data?.PayPlanNum || typeof data.PayPlanNum !== "number") {
|
|
240
|
-
throw new Error(
|
|
241
|
-
"Invalid payload: PayPlanNum is required and must be a number."
|
|
242
|
-
);
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
// Validate APR and IsLocked relationship
|
|
246
|
-
if (data.APR && data.APR > 0 && data.IsLocked === false) {
|
|
247
|
-
console.warn(
|
|
248
|
-
"Warning: When APR > 0, IsLocked may need to be true depending on Open Dental preferences."
|
|
249
|
-
);
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
const { PayPlanNum, ...updateFields } = data;
|
|
253
|
-
|
|
254
|
-
const payload = clean({
|
|
255
|
-
PayAmt: updateFields.PayAmt,
|
|
256
|
-
NumberOfPayments: updateFields.NumberOfPayments,
|
|
257
|
-
Guarantor: updateFields.Guarantor,
|
|
258
|
-
PayPlanDate: updateFields.PayPlanDate,
|
|
259
|
-
APR: updateFields.APR,
|
|
260
|
-
Note: updateFields.Note,
|
|
261
|
-
PlanCategory: updateFields.PlanCategory,
|
|
262
|
-
ChargeFrequency: updateFields.ChargeFrequency,
|
|
263
|
-
DatePayPlanStart: updateFields.DatePayPlanStart,
|
|
264
|
-
DateInterestStart: updateFields.DateInterestStart,
|
|
265
|
-
IsLocked: updateFields.IsLocked,
|
|
266
|
-
SheetDefNum: updateFields.SheetDefNum,
|
|
267
|
-
});
|
|
268
|
-
|
|
269
|
-
return this.httpClient.put<PayPlan>(
|
|
270
|
-
`/payplans/${PayPlanNum}/Dynamic`,
|
|
271
|
-
payload
|
|
272
|
-
);
|
|
273
|
-
}
|
|
274
|
-
}
|
package/src/api/paySplits.ts
DELETED
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
import HttpClient from "../utils/httpClient";
|
|
2
|
-
import {
|
|
3
|
-
PaySplit,
|
|
4
|
-
GetPaySplitsParams,
|
|
5
|
-
UpdatePaySplitsParams
|
|
6
|
-
} from "../types/paySplitTypes";
|
|
7
|
-
|
|
8
|
-
export default class PaySplits {
|
|
9
|
-
private httpClient: HttpClient;
|
|
10
|
-
|
|
11
|
-
constructor(httpClient: HttpClient) {
|
|
12
|
-
this.httpClient = httpClient;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* Fetch multiple payments with optional filtering and pagination.
|
|
17
|
-
* @param {Object} params - The parameters for filtering and pagination.
|
|
18
|
-
* @param {number} [params.PatNum] - Optional. Get all PaySplits for a single patient.
|
|
19
|
-
* @param {number} [params.PayNum] - Optional. Get all PaySplits for a single payment.
|
|
20
|
-
* @param {number} [params.ProcNum] - Optional. Get all PaySplits attached to a specific procedure.
|
|
21
|
-
* @param {number} [params.Offset] - Optional. Pagination offset for results.
|
|
22
|
-
* @returns {Promise<PaySplits[]>} - A list of paysplits.
|
|
23
|
-
*/
|
|
24
|
-
public async getPaySplits({
|
|
25
|
-
PatNum,
|
|
26
|
-
PayNum,
|
|
27
|
-
ProcNum,
|
|
28
|
-
Offset,
|
|
29
|
-
}: GetPaySplitsParams = {}): Promise<PaySplits[]> {
|
|
30
|
-
const params = {
|
|
31
|
-
PatNum,
|
|
32
|
-
PayNum,
|
|
33
|
-
ProcNum,
|
|
34
|
-
Offset,
|
|
35
|
-
};
|
|
36
|
-
|
|
37
|
-
return this.httpClient.get<PaySplits[]>("/paysplits", params);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* Update a paysplit.
|
|
42
|
-
* @param {Object} data - Data for the updated paysplit.
|
|
43
|
-
* @param {number} data.SplitNum - Required in the URL.
|
|
44
|
-
* @param {number} [data.ProvNum] - FK to provider.ProvNum. This field can always be updated when the AllowPrepayProvider preference is enabled. Without this preference, ProvNum can only be updated for paysplits that do not have an UnearnedType.
|
|
45
|
-
* @param {number} [data.ClinicNum] - FK to clinic.ClinicNum.
|
|
46
|
-
* @returns {Promise<PaySplits>} - The updated paysplit.
|
|
47
|
-
* @throws {Error} - If required fields are missing.
|
|
48
|
-
*/
|
|
49
|
-
public async updatePaySplit(data: UpdatePaySplitsParams): Promise<PaySplits> {
|
|
50
|
-
if (!data.SplitNum) {
|
|
51
|
-
throw new Error("SplitNum is required.");
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
return this.httpClient.put<PaySplits>(`/paysplits/${data.SplitNum}`, data);
|
|
55
|
-
}
|
|
56
|
-
}
|
package/src/api/payments.ts
DELETED
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
import HttpClient from "../utils/httpClient";
|
|
2
|
-
import {
|
|
3
|
-
Payment,
|
|
4
|
-
GetPaymentsParams,
|
|
5
|
-
CreatePaymentParams,
|
|
6
|
-
UpdatePaymentParams,
|
|
7
|
-
} from "../types/paymentTypes";
|
|
8
|
-
|
|
9
|
-
export default class Payments {
|
|
10
|
-
private httpClient: HttpClient;
|
|
11
|
-
|
|
12
|
-
constructor(httpClient: HttpClient) {
|
|
13
|
-
this.httpClient = httpClient;
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Fetch multiple payments with optional filtering and pagination.
|
|
18
|
-
* @param {Object} params - The parameters for filtering and pagination.
|
|
19
|
-
* @param {number} [params.PayType] - Filter by PayType, definition.DefNum where definition.Category=10.
|
|
20
|
-
* @param {number} [params.PatNum] - FK to patient.PatNum.
|
|
21
|
-
* @param {string} [params.DateEntry] - String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
|
|
22
|
-
* @param {number} [params.Offset] - Pagination offset for results.
|
|
23
|
-
* @returns {Promise<Payment[]>} - A list of payments.
|
|
24
|
-
*/
|
|
25
|
-
public async getPayments({
|
|
26
|
-
PayType,
|
|
27
|
-
PatNum,
|
|
28
|
-
DateEntry,
|
|
29
|
-
Offset,
|
|
30
|
-
}: GetPaymentsParams = {}): Promise<Payment[]> {
|
|
31
|
-
const params = {
|
|
32
|
-
PayType,
|
|
33
|
-
PatNum,
|
|
34
|
-
DateEntry,
|
|
35
|
-
Offset,
|
|
36
|
-
};
|
|
37
|
-
|
|
38
|
-
return this.httpClient.get<Payment[]>("/payments", params);
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* Create a payment.
|
|
43
|
-
* @param {Object} data - Data for the new payment.
|
|
44
|
-
* @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
|
|
45
|
-
* @param {number} data.PatNum - Required: FK to Patient
|
|
46
|
-
* @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
|
|
47
|
-
* @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
|
|
48
|
-
* @param {string} [data.CheckNum] - Optional.
|
|
49
|
-
* @param {string} [data.PayNote] - Optional.
|
|
50
|
-
* @param {string} [data.BankBranch] - Optional.
|
|
51
|
-
* @param {string} [data.ClinicNum] - Optional: Defaults to patient.ClinicNum
|
|
52
|
-
* @param {"true" | "false"} [data.isPatientPreferred="false"] - Optional. When entering a payment through Open Dental directly, there is a checkbox for this option. This API field allows the same functionality. It causes the splits to go to the patient instead of being split among family members on a FIFO basis. Default "false".
|
|
53
|
-
* @param {"true" | "false"} [data.isPrepayment="false"] - Optional. Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
|
|
54
|
-
* @param {number[]} [data.procNums=[]] - Optional. An array of ProcNums, in [1,2,3] format to apply this Payment to. Procedures are paid by Procedure.ProcDate on a FIFO basis. Procedures not in the Patient's family will be silently ignored. Ignored if isPrepayment is set to "true". Default is an empty array.
|
|
55
|
-
* @param {number} [data.payPlanNum=0] - Optional. FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
|
|
56
|
-
* @returns {Promise<Payment>} - The created payment.
|
|
57
|
-
* @throws {Error} - If required fields are missing.
|
|
58
|
-
*/
|
|
59
|
-
public async createPayment(data: CreatePaymentParams): Promise<Payment> {
|
|
60
|
-
if (!data.PayAmt || !data.PatNum) {
|
|
61
|
-
throw new Error("PayAmt and PatNum are required.");
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
return this.httpClient.post<Payment>("/payments", data);
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
/**
|
|
68
|
-
* Update a payment.
|
|
69
|
-
* @param {Object} data - Data for the new payment.
|
|
70
|
-
* @param {string} data.PayNum - Required: PK of Payment to update.
|
|
71
|
-
* @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
|
|
72
|
-
* @param {string} [data.CheckNum] - Optional.
|
|
73
|
-
* @param {string} [data.PayNote] - Optional.
|
|
74
|
-
* @param {string} [data.BankBranch] - Optional.
|
|
75
|
-
* @param {"OnlineProcessed" | "OnlinePending"} [data.ProcessStatus] - Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
|
|
76
|
-
* @returns {Promise<Payment>} - The updated payment.
|
|
77
|
-
* @throws {Error} - If required fields are missing.
|
|
78
|
-
*/
|
|
79
|
-
public async updatePayment(data: UpdatePaymentParams): Promise<Payment> {
|
|
80
|
-
if (!data.PayNum) {
|
|
81
|
-
throw new Error("PayNum is required.");
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
return this.httpClient.put<Payment>(`/payments/${data.PayNum}`, data);
|
|
85
|
-
}
|
|
86
|
-
}
|
package/src/api/procNotes.ts
DELETED
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
import HttpClient from "../utils/httpClient";
|
|
2
|
-
import {
|
|
3
|
-
ProcNote,
|
|
4
|
-
GetProcNotesParams,
|
|
5
|
-
CreateProcNoteParams,
|
|
6
|
-
} from "../types/procNoteTypes";
|
|
7
|
-
|
|
8
|
-
export default class ProcNotes {
|
|
9
|
-
private httpClient: HttpClient;
|
|
10
|
-
|
|
11
|
-
constructor(httpClient: HttpClient) {
|
|
12
|
-
this.httpClient = httpClient;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* Fetch multiple ProcNotes with optional filtering and pagination.
|
|
17
|
-
* @param {Object} params - The parameters for filtering and pagination.
|
|
18
|
-
* @param {number} [params.PatNum] - Optional. FK to patient.PatNum.
|
|
19
|
-
* @param {number} [params.ProcNum] - Optional. FK to procedure.ProcNum.
|
|
20
|
-
* @param {number} [params.Offset] - Optional. Pagination offset for results.
|
|
21
|
-
* @returns {Promise<ProcNote[]>} - A list of ProcNotes.
|
|
22
|
-
*/
|
|
23
|
-
public async getProcNotes({
|
|
24
|
-
PatNum,
|
|
25
|
-
ProcNum,
|
|
26
|
-
Offset,
|
|
27
|
-
}: GetProcNotesParams = {}): Promise<ProcNote[]> {
|
|
28
|
-
const params = {
|
|
29
|
-
PatNum,
|
|
30
|
-
ProcNum,
|
|
31
|
-
Offset,
|
|
32
|
-
};
|
|
33
|
-
|
|
34
|
-
return this.httpClient.get<ProcNote[]>("/procnotes", params);
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* Creates a ProcNote
|
|
39
|
-
* @param {Object} data - The details of ProcNote to create.
|
|
40
|
-
* @param {number} data.PatNum - Required. FK to patient.PatNum.
|
|
41
|
-
* @param {number} data.ProcNum - Required. ProcNum of the procedure.
|
|
42
|
-
* @param {string} data.Note - Required. The actual note.
|
|
43
|
-
* @param {"true" | "false"} [data.isSigned] - Optional. Either "true" or "false". If "true", will digitally sign the procnote. Default "false".
|
|
44
|
-
* @param {"true" | "false"} [data.doAppendNote] - Optional. Either "true" or "false". If "true", will prepend the Note field with the most recent procnote.Note value followed by two newlines. Default "false".
|
|
45
|
-
* @returns {Promise<ProcNote>} - The created refattaches.
|
|
46
|
-
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
47
|
-
*/
|
|
48
|
-
public async createProcNote({
|
|
49
|
-
PatNum,
|
|
50
|
-
ProcNum,
|
|
51
|
-
Note,
|
|
52
|
-
isSigned,
|
|
53
|
-
doAppendNote,
|
|
54
|
-
} : CreateProcNoteParams): Promise<ProcNote> {
|
|
55
|
-
if (!PatNum || !ProcNum || !Note) {
|
|
56
|
-
throw new Error("Invalid data: PatNum, ProcNum, and Note are required.");
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
return this.httpClient.post<ProcNote>("/procnotes", {
|
|
60
|
-
PatNum,
|
|
61
|
-
ProcNum,
|
|
62
|
-
Note,
|
|
63
|
-
isSigned,
|
|
64
|
-
doAppendNote,
|
|
65
|
-
});
|
|
66
|
-
}
|
|
67
|
-
}
|
package/src/api/procTPs.ts
DELETED
|
@@ -1,112 +0,0 @@
|
|
|
1
|
-
import HttpClient from "../utils/httpClient";
|
|
2
|
-
import {
|
|
3
|
-
ProcTP,
|
|
4
|
-
GetProcTPsParams,
|
|
5
|
-
updateProcTPParams,
|
|
6
|
-
} from "../types/procTPTypes";
|
|
7
|
-
|
|
8
|
-
export default class procTPs {
|
|
9
|
-
private httpClient: HttpClient;
|
|
10
|
-
|
|
11
|
-
constructor(httpClient: HttpClient) {
|
|
12
|
-
this.httpClient = httpClient;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* Get a list of ProcTPs by the TreatPlanNum. Before calling this method, use TreatPlans GET to find the TreatPlanNum of an existing TreatPlan.
|
|
17
|
-
* @param {Object} params - The parameters for filtering and pagination.
|
|
18
|
-
* @param {number} params.TreatPlanNum - Required. FK to TreatPlan.TreatPlanNum.
|
|
19
|
-
* @param {number} [params.Offset] - Optional. Pagination offset for results.
|
|
20
|
-
* @returns {Promise<ProcTP[]>} - A list of procTPs.
|
|
21
|
-
*/
|
|
22
|
-
public async getProcTPs({
|
|
23
|
-
TreatPlanNum,
|
|
24
|
-
Offset,
|
|
25
|
-
}: GetProcTPsParams = {}): Promise<ProcTP[]> {
|
|
26
|
-
const params = {
|
|
27
|
-
TreatPlanNum,
|
|
28
|
-
Offset,
|
|
29
|
-
};
|
|
30
|
-
|
|
31
|
-
return this.httpClient.get<ProcTP[]>("/proctps", params);
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* Update an existing procedure log entry.
|
|
36
|
-
* @param {Object} data - The updated details of the ProcTP.
|
|
37
|
-
* @param {number} data.ProcTPNum - Required: The unique identifier of the procTP to update.
|
|
38
|
-
* @param {number} [data.Priority] - Optional: definition.DefNum where definition.Category=20.
|
|
39
|
-
* @param {string} [data.ToothNumTP] - Optional: Updated tooth number.
|
|
40
|
-
* @param {Surf} [data.Surf] - Optional: Tooth surface or treatment area. Options include:
|
|
41
|
-
* - "B/F" (Buccal/Facial)
|
|
42
|
-
* - "V" (Vestibular)
|
|
43
|
-
* - "M" (Mesial)
|
|
44
|
-
* - "O/I" (Occlusal/Incisal)
|
|
45
|
-
* - "D" (Distal)
|
|
46
|
-
* - "L" (Lingual)
|
|
47
|
-
* - "UL" (Upper Left Quadrant)
|
|
48
|
-
* - "UR" (Upper Right Quadrant)
|
|
49
|
-
* - "LR" (Lower Right Quadrant)
|
|
50
|
-
* - "LL" (Lower Left Quadrant)
|
|
51
|
-
* - "1" (Sextant 1)
|
|
52
|
-
* - "2" (Sextant 2)
|
|
53
|
-
* - "3" (Sextant 3)
|
|
54
|
-
* - "4" (Sextant 4)
|
|
55
|
-
* - "5" (Sextant 5)
|
|
56
|
-
* - "6" (Sextant 6)
|
|
57
|
-
* - "U" (Upper Arch)
|
|
58
|
-
* - "L" (Lower Arch)
|
|
59
|
-
* @param {string} [data.ProcCode] - Optional: Updated procedure code (D code).
|
|
60
|
-
* @param {string} [data.Descript] - Optional: Description of procedure.
|
|
61
|
-
* @param {number} [data.FeeAmt] - Optional: The fee charged to the patient.
|
|
62
|
-
* @param {number} [data.PriInsAmt] - Optional: The amount primary insurance is expected to pay.
|
|
63
|
-
* @param {number} [data.SecInsAmt] - Optional: The amount secondary insurance is expected to pay.
|
|
64
|
-
* @param {number} [data.PatAmt] - Optional: The amount the patient is expected to pay.
|
|
65
|
-
* @param {number} [data.Discount] - Optional: The amount of discount. Used for PPOs and procedure level discounts.
|
|
66
|
-
* @param {string} [data.Prognosis] - Optional: Text for prognosis definition.
|
|
67
|
-
* @param {string} [data.Dx] - Optional: Updated diagnosis code.
|
|
68
|
-
* @param {string} [data.ProcAbbr] - Optional: The procedure code abbreviation.
|
|
69
|
-
* @param {number} [data.FeeAllowed] - Optional: Description of procedure.
|
|
70
|
-
* @returns {Promise<ProcTP>} - The updated ProcTP.
|
|
71
|
-
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
72
|
-
*/
|
|
73
|
-
public async updateProcTP(
|
|
74
|
-
{
|
|
75
|
-
ProcTPNum,
|
|
76
|
-
Priority,
|
|
77
|
-
ToothNumTP,
|
|
78
|
-
Surf,
|
|
79
|
-
ProcCode,
|
|
80
|
-
Descript,
|
|
81
|
-
FeeAmt,
|
|
82
|
-
PriInsAmt,
|
|
83
|
-
SecInsAmt,
|
|
84
|
-
PatAmt,
|
|
85
|
-
Discount,
|
|
86
|
-
Prognosis,
|
|
87
|
-
Dx,
|
|
88
|
-
ProcAbbr,
|
|
89
|
-
}: updateProcTPParams
|
|
90
|
-
): Promise<ProcTP> {
|
|
91
|
-
if (!ProcTPNum || typeof ProcTPNum !== "number") {
|
|
92
|
-
throw new Error("Invalid parameter: ProcTPNum must be a valid number.");
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
return this.httpClient.put<ProcTP>(`/proctps/${ProcTPNum}`, {
|
|
96
|
-
Priority,
|
|
97
|
-
ToothNumTP,
|
|
98
|
-
Surf,
|
|
99
|
-
ProcCode,
|
|
100
|
-
Descript,
|
|
101
|
-
FeeAmt,
|
|
102
|
-
PriInsAmt,
|
|
103
|
-
SecInsAmt,
|
|
104
|
-
PatAmt,
|
|
105
|
-
Discount,
|
|
106
|
-
Prognosis,
|
|
107
|
-
Dx,
|
|
108
|
-
ProcAbbr,
|
|
109
|
-
});
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
}
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
import HttpClient from "../utils/httpClient";
|
|
2
|
-
import {
|
|
3
|
-
ProcedureCode,
|
|
4
|
-
GetProcedureCodeParams,
|
|
5
|
-
} from "../types/procedureCodeTypes";
|
|
6
|
-
|
|
7
|
-
export default class ProcedureCodes {
|
|
8
|
-
private httpClient: HttpClient;
|
|
9
|
-
|
|
10
|
-
constructor(httpClient: HttpClient) {
|
|
11
|
-
this.httpClient = httpClient;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* Fetch a single inssub by its ID.
|
|
16
|
-
* @param {number} CodeNum - The unique identifier for the inssub.
|
|
17
|
-
* @returns {Promise<ProcedureCode>} - The inssub object.
|
|
18
|
-
* @throws {Error} - If `InsSubNum` is not provided.
|
|
19
|
-
*/
|
|
20
|
-
public async getProcedureCode(CodeNum: number): Promise<ProcedureCode> {
|
|
21
|
-
if (!CodeNum) {
|
|
22
|
-
throw new Error("CodeNum is required.");
|
|
23
|
-
}
|
|
24
|
-
return this.httpClient.get<ProcedureCode>(`/procedurecodes/${CodeNum}`);
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* Fetch multiple inssubs with optional filtering and pagination.
|
|
29
|
-
* @param {Object} params - The parameters for filtering and pagination.
|
|
30
|
-
* @param {string} [params.DateTStamp] - String in "yyyy-MM-dd HH:mm:ss" format. Get ProcedureCodes altered on and after the specified date and time.
|
|
31
|
-
* @param {number} [params.Offset] - Pagination offset for results.
|
|
32
|
-
* @returns {Promise<ProcedureCode[]>} - A list of inssubs.
|
|
33
|
-
*/
|
|
34
|
-
public async getProcedureCodes({
|
|
35
|
-
DateTStamp,
|
|
36
|
-
Offset,
|
|
37
|
-
}: GetProcedureCodeParams = {}): Promise<ProcedureCode[]> {
|
|
38
|
-
const params = {
|
|
39
|
-
DateTStamp,
|
|
40
|
-
Offset,
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
return this.httpClient.get<ProcedureCode[]>("/procedurecodes", params);
|
|
44
|
-
}
|
|
45
|
-
}
|