| Name | juntagrico-billing JSON |
| Version |
1.6.0
JSON |
| download |
| home_page | None |
| Summary | Send and manage bills in juntagrico. |
| upload_time | 2024-05-14 08:39:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# juntagrico-billing
[](https://github.com/juntagrico/juntagrico-billing/actions/workflows/juntagrico-ci.yml)
[](https://codeclimate.com/github/juntagrico/juntagrico-billing/maintainability)
[](https://codeclimate.com/github/juntagrico/juntagrico-billing/test_coverage)
[](https://github.com/juntagrico/juntagrico-billing)
[](https://github.com/juntagrico/juntagrico-billing)
This is an extension for juntagrico. You can find more information about juntagrico here
(https://github.com/juntagrico/juntagrico).
It provides the following features for juntagrico:
* creating managing bills (invoices) for juntagrico subscriptions
* display of bills as HTML or PDF
* support for swiss qr bill with reference number
* manage payments for bills
* reading camt.054 payment files (in connection with qr bills and refnumer)
* bookkeeping export covering bills and payments
## Installation
Install juntagrico-billing via pip
`pip install juntagrico-billing`
or add it to your main django projects `requirements.txt`:
`juntagrico-billing`
You may also install from github source (or add it to `requirements.txt`):
`pip install git+https://github.com/juntagrico/juntagrico-billing.git`
In your `juntagrico.settings.py` add `juntagrico_billing` somewhere **above** `juntagrico`:
```python
INSTALLED_APPS = (
'juntagrico_billing',
'juntagrico',
...
```
In your urls.py you also need to add the new pattern:
```python
urlpatterns = [
...
path('',include('juntagrico_billing.urls')),
]
```
As the billing app introduces its own database tables, you need to apply migrations after installing.
Execute `python manage.py migrate` in your main django project.
## Configuration
Set these in your `settings.py` to modify `juntagrico-billing`
### BILLS_USERMENU
Set to True to add "bills" to the user menu.
default value: False
### DUEDATE_NOTICE_URL
Set the url of a page that explains the due date policy of your bills, if you have any.
default value: ''
## Create settings object
`juntagrico-billing` uses a singleton `Settings` object to store some setting.
You need to create this settings object once in django admin.
- Log in to juntagrico and go to the admin UI at `https://<my juntagrico site>/admin`.
- You should see in admin a new section for juntagrico_billing
- Add a new Settings object
- You need to specify a debtors account, just specify any digit code (e.g. `1100`)
- A default paymenttype is mandatory too. You may create one directly from the settings dialog:
- Save your settings object. There must be only one settings object.
## Create a business year
Billing is done on the base of a business-year. A business-year denotes the time period for creating bills.
Usually this will correspond to a calendar year (1.1 - 31.1 of a year). It is possible to use different timespans though.
Business-years should be consecutive.
Business years are managed in django admin UI.
- Log in to `/admin` and create a new businessyear object
## Billing
Billing is based on the activation and deactivation dates of subscriptions (and extrasubscriptions) in juntagrico.
At any time you may create all needed invoices (bills) for a certain business-year.
In juntagrico you should see the `Bills and Bookkeeping` Menu, if you are assigned bookkeeping rights.
Go to `Bills` and choose the desired business-year.
Switch to the `Generate bills` tab. The amount of pending bills for the businessyear should then be displayed.
This may take some time depending on the number of subscriptions and members in your system.
Pressing the `Generate` button will create these bills.
They may be viewed afterwards on the `all` tab of the bills list.
### Modifying or adding bills
There are two modes to view an existing bill object:
- admin view of the bill. click on the first column of a bill row to open the bill in django admin.
- user view of the bill. click on the last columdn of a bill row to open the bill as the user will see it.
If a bill created via `Generate` is incorrect, proceed as follows:
- delete the bill in the django admin UI
- correct the subscription settings
- in most cases this will involve adjusting the activation or deactivation date of the subscription / extrasubscription
- re-create the bill by going to the `Generate bills` tab on the `Bills` list.
- if you only modified one subscription, it should say `1 pending bill`
- click on `Generate` to re-create the bill based on the modified settings
The same procedure applies if a new subscription or subscription part (extrasubscription) is added after bills for a business-year have been generated.
If there already is a bill for the same member and you want the additional parts to appear on the same bill, you may delete the existing bill and regenerate it like described above.
Deleting a bill is only possible if there are no payments on it.
If you add parts without deleting an existing bill, then a new bill will be added for the member.
### Adding custom items to a bill
In addition to subscription and extrasubscription parts, a bill may also contain custom items.
Custom items may be used for stuff like
- correcting overpaid bills
- adding special credit for a certain member (work instead of paying)
- adding additional contributions (solidarity contributions)
For each kind of custom item you need to define a custom Bill item type in django admin:
You need to specify a description and a booking account for the custom item type.
You may then add custom item types on a bill in the django admin view of the bill:
## Bookkeeping Export
TBD
Raw data
{
"_id": null,
"home_page": null,
"name": "juntagrico-billing",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "juntagrico <python@juntagrico.org>",
"download_url": "https://files.pythonhosted.org/packages/c9/0b/05a1860231a47084652add422d3038a1877a4c8ebc8c9075855db349f811/juntagrico_billing-1.6.0.tar.gz",
"platform": null,
"description": "# juntagrico-billing\n\n\n[](https://github.com/juntagrico/juntagrico-billing/actions/workflows/juntagrico-ci.yml)\n[](https://codeclimate.com/github/juntagrico/juntagrico-billing/maintainability)\n[](https://codeclimate.com/github/juntagrico/juntagrico-billing/test_coverage)\n[](https://github.com/juntagrico/juntagrico-billing)\n[](https://github.com/juntagrico/juntagrico-billing)\n\nThis is an extension for juntagrico. You can find more information about juntagrico here\n(https://github.com/juntagrico/juntagrico).\n\nIt provides the following features for juntagrico:\n* creating managing bills (invoices) for juntagrico subscriptions\n* display of bills as HTML or PDF\n* support for swiss qr bill with reference number\n* manage payments for bills\n* reading camt.054 payment files (in connection with qr bills and refnumer)\n* bookkeeping export covering bills and payments\n\n## Installation\n\nInstall juntagrico-billing via pip\n`pip install juntagrico-billing`\n\nor add it to your main django projects `requirements.txt`:\n`juntagrico-billing`\n\nYou may also install from github source (or add it to `requirements.txt`):\n`pip install git+https://github.com/juntagrico/juntagrico-billing.git`\n\nIn your `juntagrico.settings.py` add `juntagrico_billing` somewhere **above** `juntagrico`:\n```python\nINSTALLED_APPS = (\n 'juntagrico_billing',\n 'juntagrico',\n ...\n```\n\nIn your urls.py you also need to add the new pattern:\n```python\nurlpatterns = [\n ...\n path('',include('juntagrico_billing.urls')),\n]\n```\n\nAs the billing app introduces its own database tables, you need to apply migrations after installing.\nExecute `python manage.py migrate` in your main django project.\n\n## Configuration\n\nSet these in your `settings.py` to modify `juntagrico-billing`\n\n### BILLS_USERMENU\n Set to True to add \"bills\" to the user menu.\n\n default value: False\n\n### DUEDATE_NOTICE_URL\n Set the url of a page that explains the due date policy of your bills, if you have any.\n\n default value: ''\n\n## Create settings object\n\n`juntagrico-billing` uses a singleton `Settings` object to store some setting.\nYou need to create this settings object once in django admin.\n\n- Log in to juntagrico and go to the admin UI at `https://<my juntagrico site>/admin`.\n- You should see in admin a new section for juntagrico_billing\n \n- Add a new Settings object\n \n \n \n- You need to specify a debtors account, just specify any digit code (e.g. `1100`)\n- A default paymenttype is mandatory too. You may create one directly from the settings dialog:\n \n- Save your settings object. There must be only one settings object.\n\n## Create a business year\n\nBilling is done on the base of a business-year. A business-year denotes the time period for creating bills.\nUsually this will correspond to a calendar year (1.1 - 31.1 of a year). It is possible to use different timespans though.\nBusiness-years should be consecutive.\n\nBusiness years are managed in django admin UI. \n\n- Log in to `/admin` and create a new businessyear object\n \n\n\n## Billing\n\nBilling is based on the activation and deactivation dates of subscriptions (and extrasubscriptions) in juntagrico.\nAt any time you may create all needed invoices (bills) for a certain business-year.\n\nIn juntagrico you should see the `Bills and Bookkeeping` Menu, if you are assigned bookkeeping rights.\n\nGo to `Bills` and choose the desired business-year.\nSwitch to the `Generate bills` tab. The amount of pending bills for the businessyear should then be displayed.\nThis may take some time depending on the number of subscriptions and members in your system.\n\n\nPressing the `Generate` button will create these bills.\nThey may be viewed afterwards on the `all` tab of the bills list.\n\n\n### Modifying or adding bills\n\nThere are two modes to view an existing bill object:\n- admin view of the bill. click on the first column of a bill row to open the bill in django admin.\n- user view of the bill. click on the last columdn of a bill row to open the bill as the user will see it.\n\nIf a bill created via `Generate` is incorrect, proceed as follows:\n- delete the bill in the django admin UI\n- correct the subscription settings\n - in most cases this will involve adjusting the activation or deactivation date of the subscription / extrasubscription\n- re-create the bill by going to the `Generate bills` tab on the `Bills` list.\n - if you only modified one subscription, it should say `1 pending bill`\n - click on `Generate` to re-create the bill based on the modified settings\n\nThe same procedure applies if a new subscription or subscription part (extrasubscription) is added after bills for a business-year have been generated.\nIf there already is a bill for the same member and you want the additional parts to appear on the same bill, you may delete the existing bill and regenerate it like described above.\nDeleting a bill is only possible if there are no payments on it.\nIf you add parts without deleting an existing bill, then a new bill will be added for the member.\n\n### Adding custom items to a bill\n\nIn addition to subscription and extrasubscription parts, a bill may also contain custom items.\nCustom items may be used for stuff like\n- correcting overpaid bills\n- adding special credit for a certain member (work instead of paying)\n- adding additional contributions (solidarity contributions)\n\nFor each kind of custom item you need to define a custom Bill item type in django admin:\n\n\nYou need to specify a description and a booking account for the custom item type.\n\nYou may then add custom item types on a bill in the django admin view of the bill:\n\n\n## Bookkeeping Export\nTBD\n",
"bugtrack_url": null,
"license": "GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, \"this License\" refers to version 3 of the GNU Lesser General Public License, and the \"GNU GPL\" refers to version 3 of the GNU General Public License. \"The Library\" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An \"Application\" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A \"Combined Work\" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the \"Linked Version\". The \"Minimal Corresponding Source\" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The \"Corresponding Application Code\" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License \"or any later version\" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. ",
"summary": "Send and manage bills in juntagrico.",
"version": "1.6.0",
"project_urls": {
"Homepage": "https://www.juntagrico.org",
"Issues": "https://github.com/juntagrico/juntagrico-billing/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93bd11836af44747358a7c4022227aee23e55c6a072f9a0ff0937c3b11589e4f",
"md5": "bebddf0e19e11413ccf6711fe02e923c",
"sha256": "a0834a40b4865b36e332701ab210eb1e5f8eda27c2ac2257cba4aeb71ac05eee"
},
"downloads": -1,
"filename": "juntagrico_billing-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bebddf0e19e11413ccf6711fe02e923c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 68158,
"upload_time": "2024-05-14T08:39:10",
"upload_time_iso_8601": "2024-05-14T08:39:10.388608Z",
"url": "https://files.pythonhosted.org/packages/93/bd/11836af44747358a7c4022227aee23e55c6a072f9a0ff0937c3b11589e4f/juntagrico_billing-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c90b05a1860231a47084652add422d3038a1877a4c8ebc8c9075855db349f811",
"md5": "9b122e9bd860b16ed81e8ac4106df99c",
"sha256": "1d3fd984bc1ad5ca723215fec06dbc5267154eaf45ac3100c3568bea0cdd1f99"
},
"downloads": -1,
"filename": "juntagrico_billing-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "9b122e9bd860b16ed81e8ac4106df99c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 52880,
"upload_time": "2024-05-14T08:39:12",
"upload_time_iso_8601": "2024-05-14T08:39:12.192468Z",
"url": "https://files.pythonhosted.org/packages/c9/0b/05a1860231a47084652add422d3038a1877a4c8ebc8c9075855db349f811/juntagrico_billing-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-14 08:39:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "juntagrico",
"github_project": "juntagrico-billing",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "juntagrico-billing"
}
