For support support@leadrat.com

Builder CRM - Post Sales API

Leadrat
Zones
- Get zone by ID
- Update a zone
- Get zones with pagination
- Create a new zone
- Search zones
- Get all zones as list
- Get zones by project
Zone Plans
- Get zone plan by ID
- Update a zone plan
- Get zone plans with pagination
- Create a new zone plan
- Search zone plans
- Get all zone plans as list
Villas
- Get villa by ID
- Update a villa
- Get villas with pagination
- Create a new villa
- Search villas
- Batch save villas
- Get villas by zone
- Get all villas as list
- Get villas by project
- Delete all villas by zone
Project Access
- Get user's project access
- Update user's project access
- Get users with access to a project
- Assign user to project
- Remove user from project
User Management
- Get user details
- Update an existing user
- Delete a user
- Toggle user status
- Assign or remove a custom role
- List all users (paginated)
- Create a new user
- Verify OTP for User
- Resend OTP for User
- Invite user
- Bulk Upload Users
- Search users
- Download User Bulk Upload Template
- List all users
Units
- Get unit by ID
- Update an existing unit
- Update unit amenities
- Get units with pagination
- Create a new unit
- Search units with filters
- Batch save units
- Batch save units with hierarchy
- Get unit booking details
- Get all units as list
- Get all units for a project
- Delete all units in a project
- Get units by floor
- Get booked units
- Delete all units by tower
Towers
- Get tower by ID
- Update a tower
- Update tower amenities
- Get towers with pagination
- Create a new tower
- Search towers
- Get tower hierarchy
- Get all towers as list
- Get booked towers
- Get towers by project
Tenant Configuration
- Get tenant configuration
- Update tenant configuration
- Get next number
TDS Configuration Module
- Get a TDS record by ID
- Update an existing TDS record
- Get all TDS records with pagination
- Create a new TDS record
- Get common Indian TDS defaults
- Get all active TDS records
Taxes
- Get tax by ID
- Update an existing tax
- Delete a tax
- Get all active taxes
- Create a new tax
- Get default taxes
Subscription Management
- Update subscription
- Get subscription by builder
- Get my subscription
Subscription Plans
- Update a subscription plan
- List all subscription plans
- Create a subscription plan
Roles & Permissions
- Get role
- Update role
- Delete role
- List roles
- Create role
- List all available permissions
Reminder Schedules
- Get reminder schedule by ID
- Update reminder schedule
- Get reminder schedules with pagination
- Create reminder schedule
- Search reminder schedules
- Get all reminder schedules as list
Receipts
- Get receipt by ID
- Update a receipt
- Get receipts with pagination
- Create a receipt
- Send receipt notification
- Reverse a receipt
- Search receipts
- Get receipt ledger
- Download receipt PDF
- Get all receipts as list
- Get all receipts for a demand
Project Stakeholders
- Get all stakeholders for a project
- Replace all stakeholders for a project
- Add a single stakeholder to a project
- Get channel partners for a project
- Get brokers for a project
- Get banks for a project
Projects
- Get project by ID
- Update an existing project
- Update project amenities
- Get projects with pagination
- Create a new project
- Upload projects from Excel file (Direct)
- Upload projects from Excel file
- Confirm and save projects from JSON data
- Search projects with filters
- Get project audit trail
- Download project upload template
- Get project summary
- Get project statistics
- Get projects with towers for milestones
- Get all projects as list
- Get booked projects
Project Wizard
- Update draft project
- Step 3b: Add zones to project
- Step 4b: Save villas (Batch)
- Step 4: Save units (Hierarchical)
- Step 3a: Add towers to project
- Step 6: Publish project
- Step 1: Create draft project
- Get project structure (Step 3 load)
Payment Plans
- Get payment plan by ID
- Update payment plan
- Batch create payment plans for a tower
- Batch create payment plans for a project
- Get payment plans with pagination
- Create a payment plan
- Search payment plans
- Get payment plans by tower
- Get payment plans by project
- Get payment plan statistics
- Get all payment plans as list
- Get payment plans by project or tower
Payment Plan Lines
- Get payment plan line by ID
- Update payment plan line
- Get payment plan lines with pagination
- Create a payment plan line
- Search payment plan lines
- Get all payment plan lines as list
Notification Logs
- Get notification log by ID
- Update notification log
- Get notification logs with pagination
- Create notification log
- Search notification logs
- Get notification summary
- Get all notification logs as list
- Get notifications by status
- Get notifications for a specific reference
- Get notifications by reference type
- Get notifications for a specific recipient
- Get notifications by recipient type
- Get notifications within a date range
- Get notifications by channel
Milestones
- Get milestone by ID
- Update a milestone
- Delete milestone
- Mark milestone as complete
- Reorder milestones
- Batch save milestones
- Get milestones with pagination
- Create a milestone
- Search milestones
- Get milestones by tower
- Get milestones by project
- Preview milestone completion
- Get milestones as template
- Get milestone statistics
- Get all milestones as list
Handover Checklist Template
- Get template by ID
- Update template and its items
- Delete template and its items
- Unarchive a template
- Archive a template
- List templates with card stats (category + search filter)
- Create a new checklist template
- Clone an existing checklist template
- Assign template to a unit's active handover case
- Assign template to a handover case
Handover Documents
- Update document metadata
- Verify document
- Record file upload reference
- Get all documents for a case
- Get per-category progress map
- Get documents by category
- Get summary alert banners
Handover Case
- Get handover case by ID
- Update core handover case details
- Soft delete a handover case
- Change checklist template
- Advance case to next stage
- Update sale deed and registration details
- Update NRI compliance tracking fields
- List all handover cases (paginated)
- Create a new handover case
- Send possession reminder to buyer
- Schedule handover and offer possession
- Schedule NRI video possession
- Upload or update NRI compliance document item
- Search handover cases
- Batch possession offer-letter hook
- Calculate estimated stamp duty
- Get Sale Deed & Registration timeline
- Get dashboard summary for a case
- Get case by booking ID
Handover Snags
- Get a single snag by ID
- Update a snag's editable fields
- Waive a snag
- Mark snag as resolved
- Mark snag as in progress
- Record buyer sign-off for a specific snag resolution
- Assign snag to a staff member
- Get all snags for a case
- Log a new snag item
- Get snag statistics breakdown
- Search snags in a case
- Get only open (unresolved) snags
- Filter snags by status
Handover Checklist
- Update checklist item
- Mark item as incomplete
- Mark item (keys/cards) as physically handed over
- Attach a handover document to checklist item
- Detach a handover document from checklist item
- Get documents attached to a checklist item
- Create and attach a document to a checklist item
- Sign possession receipt
- Add custom checklist item
- Get key-handover checklist
Generated Documents
- Get generated document by ID
- Update generated document
- Update document status
- Mark document as signed
- Get generated documents with pagination
- Generate a document
- Search generated documents
- Get all generated documents as list
- Get documents by booking
- Get documents by booking grouped by phase
Dynamic Forms
- Get form by ID
- Update form
- Delete form
- Get forms with pagination
- Create form
- Submit form data
- Search form submissions
- Search forms
- Update submission status
- Get submissions for a form with pagination
- Get submissions for a form as list
- Get form submission by ID
- Get all forms as list
Floors
- Get floor by ID
- Update a floor
- Delete floor and its units
- Update floor amenities
- Get floors with pagination
- Create a new floor
- Search floors
- Get booked floors
- Get floors by tower
- Get floors by project
- Get all floors as list
Floor Rise Charge
- Update slabs for an active floor rise configuration
- Deactivate the current floor rise configuration
- Create a new floor rise configuration version
- Get active floor rise config for a tower
Floor Plans
- Get floor plan by ID
- Update a floor plan
- Get floor plans with pagination
- Create a new floor plan
- Search floor plans
- Get all floor plans as list
Financing Details
- Get financing detail by ID
- Update financing detail
- Get financing details with pagination
- Create financing detail
- Search financing details
- Get all financing details as list
Document Templates
- Get document template by ID
- Update document template
- Get templates with pagination
- Create a document template
- Search templates
- Get available template variables
- Get all templates as list
Demands
- Get demand by ID
- Update a demand
- Get demands with pagination
- Create a new demand
- Send demand notification
- Search demands
- Generate demands manually
- Get demand ledger
- Download demand PDF
- Get demand statistics
- Get all demands as list
Demand Splits
- Get demand split by ID
- Update demand split
- Get demand splits with pagination
- Create a demand split
- Search demand splits
- Get splits by demand ID
- Get all demand splits as list
Commissions
- Get commission by ID
- Update a commission
- Update commission status
- List commissions (paginated)
- Create a new commission
- Send commission notification
- search_1
- Get commission ledger
- Download commission PDF
- List commissions by status
- Get commission KPIs
- List commissions by partner type
- List commissions for a booking
Commission Settings
- Get commission settings for current tenant
- Create or update commission settings
Commission Payouts
- Mark a commission payout as paid (after bank transfer/cheque)
- Cancel a commission payout
- Approve a commission payout (finance team action)
- Send commission payout notification
- Record a partial commission payment
- List all commission payouts
- Get a commission payout by ID
- Get commission payout ledger
- Download commission payout PDF
- Get commission payout KPIs
- List all payouts pending finance approval
- List all paid payouts
- List all payouts for a specific commission
- List all payouts for a specific booking
- List all approved payouts
Charge Templates
- Get charge template by ID
- Update a charge template
- Delete a template
- Get all active templates
- Create a charge template
- Get default templates
Channel Partners
- Get channel partner by ID
- Update channel partner
- Get channel partners with pagination
- Add a new channel partner
- Bulk Upload Channel Partners
- Search channel partners
- Download Excel Template
- Get all channel partners as list
Buyers
- Get buyer by ID
- Update an existing buyer
- Get buyers with pagination
- Create a new buyer
- Upload KYC document
- Search buyers with filters
- Get all buyers as list
Builders
- Get builder by ID
- Update builder
- Update Builder Plan
- Get builders with pagination
- Register a new builder
- Search builders
- Onboard a new builder
- Get Builder Logo
- Get all builders as list
- List all builders with details (Admin)
Brokers
- Get broker by ID
- Update a broker
- Get all brokers (paged)
- Create a new broker
- Bulk Upload Brokers
- Search brokers
- Download Excel Template
- Get all brokers
Bookings
- Get booking by ID
- Update an existing booking
- Confirm a booking
- Get bookings with pagination
- Create a new booking
- Search bookings with filters
- Get booking ledger
- Get booking audit trail
- Get unit price breakdown
- Get all bookings as list
Banks
- Get bank by ID
- Update bank
- Get banks with pagination
- Add a new bank
- Bulk Upload Banks
- Search banks
- Download Excel Template
- Get all banks as list
Amenities
- Get amenity by ID
- Update an amenity
- Delete an amenity
- Get amenities with pagination
- Create a new amenity
- Get all amenities as list
Vault
- Upload a file
- Download a file
Authentication
- Tenant Signup
- Verify OTP
- Send OTP
- Get current user
- Get current user with specific builder context
Reports - Revenue
- Send revenue report
- Send general ledger report
- Get revenue report
- Download revenue report
- Get general ledger report
- Download general ledger report
Reports - Inventory
- Send unit status report
- Send inventory report
- Send inventory report by project
- Get inventory report
- Get unit status report
- Download unit status report
- Get inventory report by project
- Download inventory report by project
- Download inventory report
Reports - Dashboard
- Send dashboard report
- Download dashboard report
- Get dashboard metrics
Reports - Buyer
- Send buyer report
- Send buyer report by project
- Get buyer report
- Get buyer report by project
- Download buyer report by project
- Download buyer report
Reports - Booking
- Send booking report
- Send booking report by project
- Get booking report
- Get booking report by project
- Download booking report by project
- Download booking report
Project Assets
- Get project images
- Upload project image
- Batch upload project images
- Get project brochures
- Upload project brochure
- Batch upload project brochures
- Get all project assets
- Delete asset
notification-controller
- sendTestEmail
Configuration
- Save configuration
- Get specific enum values
- Add or update an enum value
- Get all enum values
- Get available enum types
- Get configurable enum types
- Delete an enum value
Document Generation
- Generate document for booking
- Download generated document
Audit Trail
- Search audit trail
- Get audit trail
- Get unique users
- Get unique entities
- Get complete filtered audit trail
Accounting
- Post a journal entry
- Reverse a journal entry
- List all ledger accounts
- Create or update ledger account
- Get journal entry by ID
- Find journal entry by reference
- Get customer outstanding
- Get ledger account constants
- Get ledger account by code
- Get account balance
scalar-documentation-controller
- scalarUi
Project Statistics
- Get project statistics
Booking Statistics
- Get booking statistics by project
- Get global booking statistics
Platform Dashboard
- Get platform stats
- Get dashboard KPIs
- Get high priority builders
Handover List
- Get paginated handover cases
- Get Handover List page KPI card stats
- Get full handover list (non-pageable)
Handover Snag Board
- Get global snag board
Handover Analytics
- Get global handover summary statistics
- Get Sale Deed & Registration Kanban board
- Get paginated Possession Status table rows
- Get DLP and warranty widget data
- Get dashboard overview (KPI cards + DLP widget)
NRI Compliance
- Get paginated NRI Remote Possession table rows
- Get NRI drawer detail for a case
- Get NRI summary counts
Document Configuration
- Get document phases and types
Audit
- Get Snapshots
- Get Shadows
- Get Changes
Schemas
- ZoneDto
- ZonePlanDto
- VillaDto
- ProjectAccessRequest
- ProjectAccessDto
- ErrorResponseDto
- UserRequest
- UserDto
- AssignRoleRequest
- AmenityCollectionDto
- AmenityDto
- UnitDto
- TowerDto
- TenantConfiguration
- TdsDto
- TaxDto
- SubscriptionUpdateRequest
- Subscription
- SubscriptionPlanDto
- RoleRequest
- RoleResponse
- ReminderScheduleDto
- DemandBreakdownItem
- DemandDto
- DemandSplitDto
- ReceiptDto
- ProjectStakeholderDto
- Address
- Coordinate
- ProjectDto
- EmbeddedMilestoneDto
- PaymentPlanDto
- PaymentPlanLineDto
- NotificationLogDto
- MilestoneDto
- HandoverChecklistTemplateDto
- HandoverChecklistTemplateItemDto
- HandoverDocumentDto
- HandoverCaseDto
- SnagItemDto
- UpdateRegistrationRequest
- UpdateNriComplianceRequest
- HandoverChecklistUpdateDto
- HandoverChecklistItemDto
- GeneratedDocumentDto
- FormDto
- JsonNode
- FloorDto
- FloorRiseSlabDto
- FloorRiseConfigDto
- FloorPlanDto
- FinancingDetailDto
- DocumentTemplateDto
- BrokerDto
- ChannelPartnerDto
- CommissionDto
- CommissionSettingsDto
- CommissionPayoutDto
- ChargeTemplateDto
- BuyerDto
- KycDocument
- BuilderDto
- BuilderPlanUpdateRequest
- BankDto
- BookingDto
- BookingLineItem
- LoanDetails
- AmenityMasterDto
- SearchResource
- PageZoneDto
- PageableObject
- SortObject
- PageZonePlanDto
- PageVillaDto
- FileReference
- Pageable
- PageUserDto
- Page
- UnitHierarchyRequest
- TenantSignupRequest
- BuilderResponse
- VerifyOtpRequest
- SendOtpRequest
- ReportSendRequest
- PageReminderScheduleDto
- ProjectAssignmentRequest
- ProjectAssetDto
- ZoneBatchRequest
- VillaBatchRequest
- TowerBatchRequest
- ProjectBulkUploadDataDto
- PagePaymentPlanDto
- PagePaymentPlanLineDto
- PageNotificationLogDto
- HandoverDocumentUploadRequest
- ScheduleHandoverRequest
- ScheduleVideoPossessionRequest
- UpsertNriComplianceItemRequest
- NriComplianceItemDto
- CreateChecklistItemDocumentRequest
- SignPossessionReceiptRequest
- BatchOfferLettersRequest
- BatchOfferLettersResponse
- FormSubmissionDto
- PageFormSubmissionDto
- PageFormDto
- ManualDemandRequest
- Configuration
- EnumConfigDto
- RecordPaymentRequest
- BuilderOnboardingRequest
- DocumentGenerationRequestDto
- LedgerEntryRequest
- PostJournalRequest
- JournalEntryDto
- LedgerEntryDto
- LedgerAccountDto
- FloorWithUnitsDto
- TowerHierarchyDto
- PageTdsDto
- RevenueReportDto
- ReportDownloadUrlResponse
- InventoryByProjectDto
- InventoryReportDto
- GeneralLedgerEntryDto
- BookingReportDto
- BuyerReportDto
- BuyerReportResponseDto
- DemandReceiptReportDto
- ProjectStatisticsDto
- BookingStatisticsDto
- ProjectStructureDto
- FloorUnitCountDto
- ProjectSummaryDto
- TowerSummaryDto
- ProjectStatsDto
- ProjectMilestoneViewDto
- PlatformDashboardStats
- KpiDashboardStats
- HighPriorityBuildersResponse
- PaymentPlanStatisticsDto
- NotificationLogSummaryDto
- MilestoneCompletionPreviewDto
- ProjectedCommissionDto
- ProjectedDemandDto
- MilestoneStatisticsDto
- BuilderDetails
- MeResponse
- SubscriptionDetails
- UserDetails
- HandoverStatsDto
- HandoverListRowDto
- StampDutyCalculationDto
- SnagStatisticsDto
- RegistrationTimelineDto
- AlertBannerDto
- CategoryProgressDto
- ChecklistItemSummaryDto
- HandoverDashboardDto
- HandoverSummaryStatsDto
- RegistrationKanbanCardDto
- RegistrationKanbanColumnDto
- NriComplianceDetailDto
- NriComplianceSummaryDto
- DlpWarrantyCoverageDto
- DlpWarrantySummaryDto
- HandoverOverviewDto
- TemplateVariable
- DemandStatisticsDto
- ChartDataDto
- DashboardReportDto
- MilestoneCompletionDto
- PendingActionDto
- ProjectDistributionDto
- QuickStatsDto
- RecentBookingDto
- UpcomingDemandDto
- EnumDto
- CommissionKpiDto
- KpiMetricDto
- CommissionPayoutKpiDto
- PageBuilderResponse
- PageBrokerDto
- DocumentPhaseConfigDto
- DocumentTemplateInfoDto
- DocumentTypeConfigDto
- UnitPriceBreakdownDto
- UnitPriceBreakdownLineItemDto
- AuditTrail

ScheduleVideoPossessionRequest

{
    "scheduledAt": "2019-08-24T14:15:22.123Z",
    "scheduledBy": "string",
    "notes": "string"
}