README

ERP maintenance — maintenance schedules and visits for the Laravel ERP ecosystem.

This package is the maintenance module of an ERPNext-native rebuild. It owns the maintenance documents: maintenance schedules (with their planned items and the generated dated visit rows) and maintenance visits (with their per-line service purposes). The customer, the serviced item and its serial number are referenced as dynamic links (party_type/party_id, item_code, serial_no), so the package depends only on jeffersongoncalves/laravel-erp-core — there is no hard dependency on the selling, stock or CRM modules.

Features

• Maintenance schedules — A submittable document that plans recurring maintenance for a customer. Each schedule item declares an item, a start date, a periodicity (Weekly, Monthly, Quarterly, Yearly) and a number of visits; submitting the schedule expands those into concrete dated visit rows.
• Maintenance visits — A submittable record of a service call with a type (Scheduled, Unscheduled, Breakdown) and a completion status (Pending, Partially Completed, Fully Completed). Each visit line (purpose) records the item, serial number, the work done and the service person; the overall completion status is recomputed from those lines.
• Submittable documents — Schedules and visits use the core IsSubmittable lifecycle (draft → submitted → cancelled) with naming series and company scoping.
• Customizable Models — Override any model via config (ModelResolver pattern).
• Translations — English and Brazilian Portuguese.

Compatibility

Installation

composer require jeffersongoncalves/laravel-erp-maintenance

Publish and run the migrations (the core package migrations must be published too):

php artisan vendor:publish --tag="erp-core-migrations"
php artisan vendor:publish --tag="erp-maintenance-migrations"
php artisan migrate

Publish the config (optional):

php artisan vendor:publish --tag="erp-maintenance-config"

Generating Visits

A maintenance schedule plans recurring work through its items. Submitting the schedule (or calling MaintenanceScheduleService::generateSchedule() directly) expands each item into no_of_visits dated rows in maintenance_schedule_details, stepping from the item's start_date by its periodicity (Weekly = +1 week, Monthly = +1 month, Quarterly = +3 months, Yearly = +1 year).

Dynamic Links

Maintenance documents reference the customer through party_type + party_id and the serviced item through a plain item_code (and optional serial_no) string. This keeps the maintenance module decoupled from the selling, stock and CRM packages while still allowing those records to be resolved at the application layer.

Database Tables

All tables use the configured prefix shared across the ERP ecosystem (default: erp_): maintenance_schedules, maintenance_schedule_items, maintenance_schedule_details, maintenance_visits, maintenance_visit_purposes.

Testing

composer test

License

The MIT License (MIT). Please see License File for more information.