/
CL
clinicos
/
PawthosX.Business.API | v1
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 9h ago · Updated 1d ago
View markdown
clinicos
PawthosX.Business.API | v1
patch
Update mutable fields (description) on a referral document
v2
latest
OpenAPI 3.1.1
2026-08-07
854
993
2.4 MB
AdminS3
2
ApiKeys
7
Appointments
21
AppointmentTypes
10
BillableItems
5
Breeds
5
BulkClientExport
2
BulkPatientExport
2
CareQueue
2
CaseMilestones
6
Cases
5
ChatExport
1
ClientAppInvite
3
ClientExport
3
Clients
5
ClinicConfig
29
ClinicSettings
2
Clocking
6
Compliance
1
ConsentDocuments
2
DeaBooks
9
DeaExport
2
DiagnosisTerms
1
DiscountCodes
7
Drafts
7
EdgePrinters
3
EdgePrintJobs
2
EmailVerification
2
Estimates
25
ExamTemplates
5
Expenses
6
Featurebase
2
Flowboard
10
GroupCodes
5
GroupVisits
6
Health
1
HomeAgain
4
IntegrationCredentials
15
InternalPrescribing
1
InternalWidget
1
Inventory
23
InventoryApprovals
5
InventoryLocations
7
Invoices
24
JourneyMilestones
6
Kiosk
4
LabPanels
5
Labs
16
LocationClosures
4
Locations
11
Logos
7
MedicationRequests
7
MentorMetrics
5
Metrics
31
NpsAnalytics
3
Partners
6
PatientGroups
9
PatientMasses
6
PatientProblems
4
PatientRecordExport
3
Patients
20
Payments
19
PaymentTokens
5
Pharmacies
5
Phones
2
PriceRules
6
Printers
6
PrintJobs
4
PtoRequests
6
PublicNps
2
PublicPriceList
5
PublicQuestionnaires
2
PublicSmsConsent
2
PurchaseOrders
11
QiEvents
9
QuestionnaireResponses
6
Questionnaires
10
RabiesTags
10
RdvmPortal
22
Recordings
7
RecurringExpenses
5
ReferralMessages
2
Referrals
20
get
Get a list of referrals with optional filters
post
/Referrals
get
Get referral statistics
get
Get a specific referral by ID with full details
put
/Referrals/{id}
put
/Referrals/{id}/status
post
Approve a pending RDVM referral - creates Patient/Client from pending info or links to existing
post
Reject a pending RDVM referral - sets status to Cancelled and removes schedule item
get
Get messages for a specific referral
post
/Referrals/{id}/messages
get
Get all documents for a referral
post
Upload a document to a referral
delete
Delete a document
patch
Update mutable fields (description) on a referral document
get
Download a document
post
Share patient records with the RDVM by generating a PDF export
get
Get all RDVM users (referring veterinarians) who have registered for portal access
post
Approve an RDVM user's portal access request
post
Reject an RDVM user's portal access request
put
Update an RDVM user's permissions and access settings
Reminders
14
Reports
2
RetailItems
11
Roles
6
RoomDayAssignments
3
RxGovernance
25
SavedReports
5
ScheduleItems
10
ServiceCatalog
5
Shifts
5
ShiftSwaps
8
SlotConfigurations
6
SmsConsent
9
Species
5
Subscriptions
8
SurgicalRecords
6
TagAssignments
4
Tags
5
TelnyxCallControl
1
Templates
10
TenantKnowledge
4
TimeEntries
5
Transparency
3
Users
11
Vaccinations
9
VaccineAdministration
3
VaccineCertificateRecords
6
VaccineCertificates
2
VaccineTypes
5
Vendors
6
Vitals
2
VitalTypes
6
Widget
17
WidgetChatbot
4
WorkItemRules
5
WorkTasks
13
Referrals
Update mutable fields (description) on a referral document
patch
/Referrals/{id}/documents/{documentId}
Path parameters
id
string
required
documentId
string
required
Request body
UpdateReferralDocumentRequest
required
description
string
nullable
Response
OK
ReferralDocumentDto
required
id
string
referralId
string
documentType
string
fileName
string
description
string
nullable
fileUrl
string
nullable
fileSizeBytes
union
mimeType
string
nullable
uploadedById
string
uploadedBy
ReferralUserSummaryDto
uploadedAt
string
date-time
isSent
boolean
sentAt
string
date-time
nullable
createdAt
string
date-time