diff --git a/foundation/www/docs/assets/img/subscription/__init__.py b/foundation/www/docs/assets/img/subscription/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/foundation/www/docs/assets/img/subscription/_sidebar.json b/foundation/www/docs/assets/img/subscription/_sidebar.json new file mode 100644 index 00000000..88f5aab5 --- /dev/null +++ b/foundation/www/docs/assets/img/subscription/_sidebar.json @@ -0,0 +1,22 @@ +[ + { + "route": "/docs", + "title": "Docs Home" + }, + { + "route": "/docs/user", + "title": "User Guide" + }, + { + "route": "/docs/current/api", + "title": "Server API" + }, + { + "route": "/docs/current/models", + "title": "Models (Reference)" + }, + { + "route": "https://github.com/frappe/erpnext/tree/develop/erpnext/docs", + "title": "Improve Docs" + } +] \ No newline at end of file diff --git a/foundation/www/docs/assets/img/subscription/subscription.gif b/foundation/www/docs/assets/img/subscription/subscription.gif new file mode 100644 index 00000000..68488053 Binary files /dev/null and b/foundation/www/docs/assets/img/subscription/subscription.gif differ diff --git a/foundation/www/docs/assets/img/subscription/subscription.png b/foundation/www/docs/assets/img/subscription/subscription.png new file mode 100644 index 00000000..8b2cdc30 Binary files /dev/null and b/foundation/www/docs/assets/img/subscription/subscription.png differ diff --git a/foundation/www/docs/current/api/accounts/erpnext.accounts.general_ledger.html b/foundation/www/docs/current/api/accounts/erpnext.accounts.general_ledger.html index e3ece185..eb043229 100644 --- a/foundation/www/docs/current/api/accounts/erpnext.accounts.general_ledger.html +++ b/foundation/www/docs/current/api/accounts/erpnext.accounts.general_ledger.html @@ -3,7 +3,7 @@
No docs
-diff --git a/foundation/www/docs/current/api/controllers/erpnext.controllers.buying_controller.html b/foundation/www/docs/current/api/controllers/erpnext.controllers.buying_controller.html index ae35df08..c35c3ba6 100644 --- a/foundation/www/docs/current/api/controllers/erpnext.controllers.buying_controller.html +++ b/foundation/www/docs/current/api/controllers/erpnext.controllers.buying_controller.html @@ -3,7 +3,7 @@
- - - erpnext.controllers.recurring_document.assign_task_to_owner - (doc, doctype, msg, users) -
-No docs
-- - - erpnext.controllers.recurring_document.convert_to_recurring - (doc, posting_date) -
-No docs
-- - - erpnext.controllers.recurring_document.create_recurring_documents - () -
-No docs
-- - - erpnext.controllers.recurring_document.get_next_date - (dt, mcount, day=None) -
-No docs
-- - - erpnext.controllers.recurring_document.make_new_document - (reference_doc, date_field, posting_date) -
-No docs
-- - - erpnext.controllers.recurring_document.manage_recurring_documents - (doctype, next_date=None, commit=True) -
- Create recurring documents on specific date by copying the original one
- and notify the concerned people
-
-- - - erpnext.controllers.recurring_document.notify_errors - (doc, doctype, party, owner) -
-No docs
-- - - erpnext.controllers.recurring_document.send_notification - (new_rv) -
-Notify concerned persons about recurring document generation
-- - - erpnext.controllers.recurring_document.set_next_date - (doc, posting_date) -
-Set next date on which recurring document will be created
-- - - erpnext.controllers.recurring_document.validate_notification_email_id - (doc) -
-No docs
-- - - erpnext.controllers.recurring_document.validate_recurring_document - (doc) -
-No docs
-- - - erpnext.controllers.recurring_document.validate_recurring_next_date - (doc) -
-No docs
-No docs
+Get List of transactions like Invoices, Orders
No docs
8.10.2
+ 8.11.1
subscription_sectionsubscriptionamended_fromsubscription_sectionsubscriptionamended_fromtitleprint_formatprint_format_for_onlineapply_discountcustomer_detailsoffline_pos_sectionprint_formatcustomer_groupsection_break_19write_off_accountwrite_off_cost_centeraccount_for_change_amounttaxes_and_chargescolumn_break_23income_accountexpense_accountcost_center| Sr | +Fieldname | +Type | +Label | +Options | +
|---|---|---|---|---|
| 1 | +is_online |
+ + Check | ++ Online + + | ++ |
Inherits from frappe.model.document.Document + +
recurring_invoicesubscription_sectionsubscriptionrecurring_invoiceis_recurringrecurring_typefrom_dateto_datesubmit_on_creationnotify_by_emailrepeat_on_day_of_monthend_datecolumn_break_82next_daterecurring_idnotification_email_addressrecurring_print_formatNo docs
recurring_invoicesubscription_sectionsubscriptionrecurring_invoicecolumn_break11is_recurringrecurring_idrecurring_typerepeat_on_day_of_monthend_datesubmit_on_creationnotify_by_emailnotification_email_addressrecurring_print_formatcolumn_break12from_dateto_datenext_dateagainst_income_accountNo docs
recurring_ordersubscription_sectionsubscriptionrecurring_ordercolumn_breakis_recurringrecurring_idrecurring_typerepeat_on_day_of_monthend_datesubmit_on_creationnotify_by_emailnotification_email_addressrecurring_print_formatcolumn_break83from_dateto_datenext_datesubscription_sectionsubscriptionmore_infostatuscolumn_break_57is_subcontractedreferenceopportunity+ + + validate_uom_is_interger + (self) +
+No docs
+qtyqtyuomuomstock_qtystock_qtyconversion_factorstock_uomstock_uomconversion_factorrate_amount_sectionrate- See "Rate Of Materials Based On" in Costing Section
-currency-
amountcolumn_break_21amountcurrency+
base_amountsection_break_18scrapqty_consumed_per_unitsubscription_sectionsubscriptionmore_infocampaignsourceorder_lost_reasoncolumn_break4statusenq_detsupplier_quotationopportunity+ + + on_recurring + (self, reference_doc, subscription_doc) +
+No docs
+diff --git a/foundation/www/docs/current/models/selling/quotation_item.html b/foundation/www/docs/current/models/selling/quotation_item.html index 5ce7c08c..fed41c8c 100644 --- a/foundation/www/docs/current/models/selling/quotation_item.html +++ b/foundation/www/docs/current/models/selling/quotation_item.html @@ -9,7 +9,7 @@
recurring_ordersubscription_sectionsubscriptionrecurring_ordersettingsis_recurringrecurring_idrecurring_typerepeat_on_day_of_monthend_datesubmit_on_creationnotify_by_emailnotification_email_addressrecurring_print_formatcolumn_break83from_dateto_datenext_dateNo docs
subscription_sectionsubscriptionsales_team_section_breaksales_partnercolumn_break7commission_ratetotal_commissionsection_break1sales_teamTable Name: tabSubscription
| Sr | +Fieldname | +Type | +Label | +Options | +
|---|---|---|---|---|
| 1 | +section_break_1 |
+ + Section Break | ++ + + | ++ |
| 2 | +naming_series |
+ + Select | ++ Series + + | +
+ SUB-+ |
+
| 3 | +reference_doctype |
+ + Link | ++ Reference Doctype + + | ++ + + + +DocType + + + + | +
| 4 | +reference_document |
+ + Dynamic Link | ++ Reference Document + + | +
+ reference_doctype+ |
+
| 5 | +disabled |
+ + Check | ++ Disabled + + | ++ |
| 6 | +submit_on_creation |
+ + Check | ++ Submit on Creation + + | ++ |
| 7 | +column_break_5 |
+ + Column Break | ++ + + | ++ |
| 8 | +start_date |
+ + Date | ++ Start Date + + | ++ |
| 9 | +end_date |
+ + Date | ++ End Date + + | ++ |
| 10 | +next_schedule_date |
+ + Date | ++ Next Schedule Date + + | ++ |
| 11 | +frequency_detail |
+ + Section Break | ++ + + | ++ |
| 12 | +frequency |
+ + Select | ++ Frequency + + | +
+ +Daily +Weekly +Monthly +Quarterly +Half-yearly +Yearly+ |
+
| 13 | +column_break_12 |
+ + Column Break | ++ + + | ++ |
| 14 | +repeat_on_day |
+ + Int | ++ Repeat on Day + + | ++ |
| 15 | +notification |
+ + Section Break | ++ Notification + + | ++ |
| 16 | +notify_by_email |
+ + Check | ++ Notify by Email + + | ++ |
| 17 | +column_break_17 |
+ + Column Break | ++ + + | ++ |
| 18 | +recipients |
+ + Small Text | ++ Recipients + + | ++ |
| 19 | +print_format |
+ + Link | ++ Print Format + + | ++ + + + +Print Format + + + + | +
| 20 | +section_break_16 |
+ + Section Break | ++ + + | ++ |
| 21 | +status |
+ + Select | ++ Status + + | +
+ +Draft +Submitted +Cancelled +Completed+ |
+
| 22 | +amended_from |
+ + Link | ++ Amended From + + | ++ + + + +Subscription + + + + | +
Inherits from frappe.model.document.Document + +
+ + + before_submit + (self) +
+No docs
++ + + on_submit + (self) +
+No docs
++ + + on_update_after_submit + (self) +
+No docs
++ + + set_next_schedule_date + (self) +
+No docs
++ + + update_status + (self) +
+No docs
++ + + update_subscription_id + (self) +
+No docs
++ + + validate + (self) +
+No docs
++ + + validate_dates + (self) +
+No docs
++ + + validate_email_id + (self) +
+No docs
++ + + validate_next_schedule_date + (self) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.assign_task_to_owner + (doc, doctype, msg, users) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.create_documents + (data, schedule_date) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.get_next_date + (dt, mcount, day=None) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.get_next_schedule_date + (start_date, frequency, repeat_on_day) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.get_subscription_entries + (date) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.make_new_document + (args, schedule_date) +
+No docs
+Public API
+ /api/method/erpnext.subscription.doctype.subscription.subscription.make_subscription
+
+ + + erpnext.subscription.doctype.subscription.subscription.make_subscription + (doctype, docname) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.make_subscription_entry + (date=None) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.notify_error_to_user + (data) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.notify_errors + (doc, doctype, party, owner) +
+No docs
++ + + erpnext.subscription.doctype.subscription.subscription.send_notification + (new_rv, print_format=Standard, recipients=None) +
+Notify concerned persons about recurring document generation
++ + + erpnext.subscription.doctype.subscription.subscription.update_doc + (new_document, reference_doc, args, schedule_date) +
+No docs
+
+
+#### Scenario
+
+Subscription for your hosted ERPNext account requires yearly renewal. We use Sales Invoice for generating proforma invoices. To automate proforma invoicing for renewal, we set original Sales Invoice on the subscription form. Recurring proforma invoice is created automatically just before customer's account is about to expire, and requires renewal. This recurring Proforma Invoice is also emailed automatically to the customer.
+
+To set the subscription for the sales invoice
+Goto Subscription > select base doctype "Sales Invoice" > select base docname "Invoice No" > Save
+
+
+
+**From Date and To Date**: This defines contract period with the customer.
+
+**Repeat on Day**: If frequency is set as Monthly, then it will be day of the month on which recurring invoice will be generated.
+
+**Notify By Email**: If you want to notify the user about auto recurring invoice.
+
+**Print Format**: Select a print format to define document view which should be emailed to customer.
+
+**Disabled**: It will stop to make auto recurring documents against the subscription
\ No newline at end of file
diff --git a/foundation/www/docs/user/manual/en/subscription/index.txt b/foundation/www/docs/user/manual/en/subscription/index.txt
new file mode 100644
index 00000000..e69de29b