Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs-developer/30-guides/api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,17 @@ Swagger UI in a browser:
| `/docs/hrm` | HRM module only |
| `/docs/support-ticket` | Support Ticket module only |
| `/docs/taskly` | Project (Taskly) module only |
| `/docs/timesheet` | Timesheet module only |
| `/docs/quotation` | Quotation module only |
| `/docs/account` | Accounting module only (routes under `api/accounting`) |
| `/docs/restaurant` | Restaurant module only |
| `/docs/real-estate` | Real Estate module only |
| `/docs/recruitment` | Recruitment module only |

The combined `/docs/api` page is the one to use for a full picture. The
per-module pages exist only for the modules that ship an API today (HRM,
Support Ticket, Taskly) and are handy when you are working inside a single
Support Ticket, Taskly, Timesheet, Quotation, Accounting, Restaurant, Real
Estate, and Recruitment) and are handy when you are working inside a single
package. More appear as other modules gain API routes.

## Using the spec
Expand Down
24 changes: 23 additions & 1 deletion docs-developer/50-reference/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Accounting module for the Zerp ERP platform

**Module version:** 5

**Classes documented:** 146
**Classes documented:** 151

## Models

Expand Down Expand Up @@ -191,6 +191,28 @@ HTTP controller - actions: index, store, update, destroy.

HTTP controller - actions: index, store, getOutstandingInvoices, updateStatus, destroy.

## API Controllers

### `ChartOfAccountApiController`

HTTP controller - actions: index, store, show, update, destroy.

### `CustomerPaymentApiController`

HTTP controller - actions: index, show, destroy.

### `DashboardApiController`

HTTP controller - actions: index.

### `JournalEntryApiController`

HTTP controller - actions: index, show.

### `VendorPaymentApiController`

HTTP controller - actions: index, show, destroy.

## Events

### `ApproveCreditNote`
Expand Down
14 changes: 7 additions & 7 deletions docs-developer/50-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Auto-generated class reference for all `zerp/*` packages. Regenerate with `npm r

| Package | Description | Classes |
|---|---|---|
| [zerp/account](./account) | Accounting module for the Zerp ERP platform | 146 |
| [zerp/account](./account) | Accounting module for the Zerp ERP platform | 151 |
| [zerp/aiassistant](./aiassistant) | AI-powered assistant module for the Zerp ERP platform | 9 |
| [zerp/budget-planner](./budget-planner) | Budget planning module for the Zerp ERP platform | 39 |
| [zerp/calendar](./calendar) | Calendar and scheduling module for the Zerp ERP platform | 32 |
Expand All @@ -23,21 +23,21 @@ Auto-generated class reference for all `zerp/*` packages. Regenerate with `npm r
| [zerp/jitsi](./jitsi) | Jitsi Meet integration module for the Zerp ERP platform | 15 |
| [zerp/landing-page](./landing-page) | Landing page, CMS, and marketplace module for the Zerp ERP platform | 19 |
| [zerp/lead](./lead) | CRM and lead management module for the Zerp ERP platform | 162 |
| [zerp/example-package](./package-template) | Description for example-package package | 11 |
| [zerp/example-package](./package-template) | Starter template for a Zerp module: copy it, rename ExamplePackage, and build. | 12 |
| [zerp/paypal](./paypal) | PayPal payment gateway integration module for the Zerp ERP platform | 12 |
| [zerp/performance](./performance) | Employee performance review module for the Zerp ERP platform | 69 |
| [zerp/pos](./pos) | Point of Sale module for the Zerp ERP platform | 14 |
| [zerp/product-service](./product-service) | Product and service catalog module for the Zerp ERP platform | 37 |
| [zerp/quotation](./quotation) | Sales quotation module for the Zerp ERP platform | 20 |
| [zerp/real-estate](./real-estate) | Real Estate Brokerage module for Zerp - property/listing management and viewings | 22 |
| [zerp/recruitment](./recruitment) | Recruitment and hiring module for the Zerp ERP platform | 149 |
| [zerp/restaurant](./restaurant) | Restaurant management module for Zerp - menu, orders and kitchen | 51 |
| [zerp/quotation](./quotation) | Sales quotation module for the Zerp ERP platform | 22 |
| [zerp/real-estate](./real-estate) | Real Estate Brokerage module for Zerp - property/listing management and viewings | 25 |
| [zerp/recruitment](./recruitment) | Recruitment and hiring module for the Zerp ERP platform | 153 |
| [zerp/restaurant](./restaurant) | Restaurant management module for Zerp - menu, orders and kitchen | 56 |
| [zerp/slack](./slack) | Slack notification integration module for the Zerp ERP platform | 92 |
| [zerp/stripe](./stripe) | Stripe payment gateway integration module for the Zerp ERP platform | 12 |
| [zerp/support-ticket](./support-ticket) | Support ticket and helpdesk module for the Zerp ERP platform | 104 |
| [zerp/taskly](./taskly) | Project management module for the Zerp ERP platform | 72 |
| [zerp/telegram](./telegram) | Telegram notification integration module for the Zerp ERP platform | 90 |
| [zerp/timesheet](./timesheet) | Employee timesheet tracking module for the Zerp ERP platform | 15 |
| [zerp/timesheet](./timesheet) | Employee timesheet tracking module for the Zerp ERP platform | 17 |
| [zerp/training](./training) | Employee training management module for the Zerp ERP platform | 42 |
| [zerp/twilio](./twilio) | Twilio SMS integration module for the Zerp ERP platform | 88 |
| [zerp/webhook](./webhook) | Webhook management module for the Zerp ERP platform | 10 |
Expand Down
10 changes: 8 additions & 2 deletions docs-developer/50-reference/package-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebar_position: 15

# `zerp/example-package`

Description for example-package package
Starter template for a Zerp module: copy it, rename ExamplePackage, and build.

**Module version:** 1

**Classes documented:** 11
**Classes documented:** 12

## Models

Expand All @@ -27,6 +27,12 @@ HTTP controller - actions: index.

HTTP controller - actions: index, store, update, destroy.

## API Controllers

### `ExamplePackageItemApiController`

HTTP controller - actions: index.

## Requests

### `StoreExamplePackageItemRequest`
Expand Down
12 changes: 11 additions & 1 deletion docs-developer/50-reference/quotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Sales quotation module for the Zerp ERP platform

**Module version:** 5

**Classes documented:** 20
**Classes documented:** 22

## Models

Expand All @@ -31,6 +31,16 @@ Eloquent model - 5 fillable fields, relations: item.

HTTP controller - actions: index, create, store, show, edit, update, destroy, sent, approve, reject, print, createRevision, duplicate, convertToInvoice, getWarehouseProducts.

## API Controllers

### `DashboardApiController`

HTTP controller - actions: index.

### `QuotationApiController`

HTTP controller - actions: index, store, show, update, destroy, sent, approve, reject.

## Events

### `AcceptSalesQuotation`
Expand Down
16 changes: 15 additions & 1 deletion docs-developer/50-reference/real-estate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Real Estate Brokerage module for Zerp - property/listing management and viewings

**Module version:** 1

**Classes documented:** 22
**Classes documented:** 25

## Models

Expand Down Expand Up @@ -55,6 +55,20 @@ HTTP controller - actions: index, store, update, destroy.

HTTP controller - actions: index, store, update, destroy.

## API Controllers

### `DashboardApiController`

HTTP controller - actions: index.

### `PropertyApiController`

HTTP controller - actions: index, store, show, update, destroy.

### `PropertyViewingApiController`

HTTP controller - actions: index, store, show, update, destroy.

## Requests

### `StorePropertyRequest`
Expand Down
20 changes: 19 additions & 1 deletion docs-developer/50-reference/recruitment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Recruitment and hiring module for the Zerp ERP platform

**Module version:** 5

**Classes documented:** 149
**Classes documented:** 153

## Models

Expand Down Expand Up @@ -159,6 +159,24 @@ HTTP controller - actions: index, store, update, destroy.

HTTP controller - actions: index, update, aboutCompany, updateAboutCompany, applicationTips, updateApplicationTips, whatHappensNext, updateWhatHappensNext, needHelp, updateNeedHelp, trackingFaq, updateTrackingFaq, offerLetterTemplate, updateOfferLetterTemplate, getPlaceholders, dashboardWelcomeCard, updateDashboardWelcomeCard.

## API Controllers

### `CandidateApiController`

HTTP controller - actions: index, store, show, update, destroy.

### `DashboardApiController`

HTTP controller - actions: index.

### `InterviewApiController`

HTTP controller - actions: index, store, show, update, destroy.

### `JobPostingApiController`

HTTP controller - actions: index, store, show, update, destroy.

## Events

### `ConvertOfferToEmployee`
Expand Down
24 changes: 23 additions & 1 deletion docs-developer/50-reference/restaurant.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Restaurant management module for Zerp - menu, orders and kitchen

**Module version:** 1

**Classes documented:** 51
**Classes documented:** 56

## Models

Expand Down Expand Up @@ -111,6 +111,28 @@ HTTP controller - actions: index, store, update, destroy, seat, cancel, noShow.

HTTP controller - actions: store, update, destroy, setStatus, assignWaiter, position, merge, split.

## API Controllers

### `DashboardApiController`

HTTP controller - actions: index.

### `KitchenTicketApiController`

HTTP controller - actions: index, updateStatus.

### `MenuItemApiController`

HTTP controller - actions: index, store, show, update, destroy.

### `OrderApiController`

HTTP controller - actions: index, store, show, update, destroy.

### `RestaurantTableApiController`

HTTP controller - actions: index, store, show, update, destroy.

## Requests

### `SettleOrderRequest`
Expand Down
12 changes: 11 additions & 1 deletion docs-developer/50-reference/timesheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Employee timesheet tracking module for the Zerp ERP platform

**Module version:** 5

**Classes documented:** 15
**Classes documented:** 17

## Models

Expand All @@ -27,6 +27,16 @@ Eloquent model - 0 fillable fields.

HTTP controller - actions: index, store, update, destroy, getAttendanceHours, fetchAttendanceHours, getRemainingHours.

## API Controllers

### `DashboardApiController`

HTTP controller - actions: index.

### `TimesheetApiController`

HTTP controller - actions: index, store, show, update, destroy.

## Events

### `CreateTimesheet`
Expand Down
Loading