Manage disbursement on project
This commit is contained in:
Cédric Krier
@@ -2113,6 +2113,23 @@ test-modules-project-postgresql:
|
||||
PACKAGE: modules/project
|
||||
TAG_PATTERN: '/^project-.*/'
|
||||
|
||||
check-doc-modules-project_disbursement:
|
||||
extends: .check-doc
|
||||
variables:
|
||||
PACKAGE: modules/project_disbursement
|
||||
|
||||
test-modules-project_disbursement-sqlite:
|
||||
extends: .test-sqlite
|
||||
variables:
|
||||
PACKAGE: modules/project_disbursement
|
||||
TAG_PATTERN: '/^project_disbursement-.*/'
|
||||
|
||||
test-modules-project_disbursement-postgresql:
|
||||
extends: .test-postgresql
|
||||
variables:
|
||||
PACKAGE: modules/project_disbursement
|
||||
TAG_PATTERN: '/^project_disbursement-.*/'
|
||||
|
||||
check-doc-modules-project_invoice:
|
||||
extends: .check-doc
|
||||
variables:
|
||||
|
||||
@@ -8,6 +8,9 @@ Project
|
||||
:doc:`Project <project:index>`
|
||||
Fundamentals for project management.
|
||||
|
||||
:doc:`Disbursement <project_disbursement:index>`
|
||||
Pay and invoice disbursements for projects.
|
||||
|
||||
:doc:`Invoice <project_invoice:index>`
|
||||
Invoice projects.
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
Copyright (C) 2026 Cédric Krier <cedric.krier@b2ck.com>
|
||||
Copyright (C) 2026 B2CK SRL
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
@@ -0,0 +1,674 @@
|
||||
GNU 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.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU 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
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
+1
@@ -0,0 +1 @@
|
||||
doc/index.rst
|
||||
@@ -0,0 +1,2 @@
|
||||
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
# this repository contains the full copyright notices and license terms.
|
||||
@@ -0,0 +1,160 @@
|
||||
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
# this repository contains the full copyright notices and license terms.
|
||||
|
||||
from functools import wraps
|
||||
|
||||
from trytond.model import ModelView, Workflow, fields
|
||||
from trytond.pool import Pool, PoolMeta
|
||||
from trytond.pyson import Eval, If
|
||||
from trytond.transaction import Transaction
|
||||
|
||||
|
||||
class Configuration(metaclass=PoolMeta):
|
||||
__name__ = 'account.configuration'
|
||||
|
||||
default_account_disbursement = fields.MultiValue(fields.Many2One(
|
||||
'account.account', "Default Account Disbursement",
|
||||
domain=[
|
||||
('closed', '!=', True),
|
||||
('company', '=', Eval('context', {}).get('company', -1)),
|
||||
]))
|
||||
|
||||
@classmethod
|
||||
def multivalue_model(cls, field):
|
||||
pool = Pool()
|
||||
if field == 'default_account_disbursement':
|
||||
return pool.get('account.configuration.default_account')
|
||||
return super().multivalue_model(field)
|
||||
|
||||
|
||||
class ConfigurationDefaultAccount(metaclass=PoolMeta):
|
||||
__name__ = 'account.configuration.default_account'
|
||||
|
||||
default_account_disbursement = fields.Many2One(
|
||||
'account.account', "Default Account Disbursement",
|
||||
domain=[
|
||||
('closed', '!=', True),
|
||||
('company', '=', Eval('company', -1)),
|
||||
])
|
||||
|
||||
|
||||
def AccountTypeMixin(template=False):
|
||||
|
||||
class Mixin:
|
||||
__slots__ = ()
|
||||
disbursement = fields.Boolean(
|
||||
"Disbursement",
|
||||
domain=[
|
||||
If(Eval('statement') != 'balance',
|
||||
('disbursement', '=', False), ()),
|
||||
],
|
||||
states={
|
||||
'invisible': (Eval('statement') != 'balance'),
|
||||
})
|
||||
|
||||
if not template:
|
||||
for fname in dir(Mixin):
|
||||
field = getattr(Mixin, fname)
|
||||
if not isinstance(field, fields.Field):
|
||||
continue
|
||||
field.states['editable'] = (
|
||||
~Eval('template', None) | Eval('template_override', False))
|
||||
return Mixin
|
||||
|
||||
|
||||
class AccountTypeTemplate(AccountTypeMixin(template=True), metaclass=PoolMeta):
|
||||
__name__ = 'account.account.type.template'
|
||||
|
||||
def _get_type_value(self, type=None):
|
||||
values = super()._get_type_value(type=type)
|
||||
if not type or type.disbursement != self.disbursement:
|
||||
values['disbursement'] = self.disbursement
|
||||
return values
|
||||
|
||||
|
||||
class AccountType(AccountTypeMixin(), metaclass=PoolMeta):
|
||||
__name__ = 'account.account.type'
|
||||
|
||||
|
||||
def process_disbursement(func):
|
||||
@wraps(func)
|
||||
def wrapper(cls, payments):
|
||||
pool = Pool()
|
||||
Disbursement = pool.get('project.disbursement')
|
||||
transaction = Transaction()
|
||||
context = transaction.context
|
||||
|
||||
func(cls, payments)
|
||||
|
||||
to_process = set()
|
||||
for payment in payments:
|
||||
if (isinstance(payment.origin, Disbursement)
|
||||
and payment.origin.id >= 0):
|
||||
to_process.add(payment.origin)
|
||||
if to_process:
|
||||
with transaction.set_context(
|
||||
queue_batch=context.get('queue_batch', True)):
|
||||
Disbursement.__queue__.process(to_process)
|
||||
return wrapper
|
||||
|
||||
|
||||
class Payment(metaclass=PoolMeta):
|
||||
__name__ = 'account.payment'
|
||||
|
||||
@classmethod
|
||||
def _get_origin(cls):
|
||||
return [*super()._get_origin(), 'project.disbursement']
|
||||
|
||||
@classmethod
|
||||
@ModelView.button
|
||||
@Workflow.transition('succeeded')
|
||||
@process_disbursement
|
||||
def succeed(cls, payments):
|
||||
super().succeed(payments)
|
||||
|
||||
@classmethod
|
||||
@ModelView.button
|
||||
@Workflow.transition('failed')
|
||||
@process_disbursement
|
||||
def fail(cls, payments):
|
||||
super().fail(payments)
|
||||
|
||||
|
||||
class StatementLine(metaclass=PoolMeta):
|
||||
__name__ = 'account.statement.line'
|
||||
|
||||
@fields.depends(methods=['payment'])
|
||||
def on_change_related_to(self):
|
||||
pool = Pool()
|
||||
Disbursement = pool.get('project.disbursement')
|
||||
super().on_change_related_to()
|
||||
if self.payment:
|
||||
if isinstance(self.payment.origin, Disbursement):
|
||||
disbursement = self.payment.origin
|
||||
self.account = disbursement.account
|
||||
|
||||
|
||||
class InvoiceLine(metaclass=PoolMeta):
|
||||
__name__ = 'account.invoice.line'
|
||||
|
||||
@classmethod
|
||||
def _account_domain(cls, type_):
|
||||
domain = super()._account_domain(type_)
|
||||
if type_ == 'out':
|
||||
domain.append(('type.disbursement', '=', True))
|
||||
return domain
|
||||
|
||||
@classmethod
|
||||
def _get_origin(cls):
|
||||
return [*super()._get_origin(), 'project.disbursement']
|
||||
|
||||
def get_move_lines(self):
|
||||
pool = Pool()
|
||||
Disbursement = pool.get('project.disbursement')
|
||||
lines = super().get_move_lines()
|
||||
if isinstance(self.origin, Disbursement) and self.origin.id >= 0:
|
||||
disbursement = self.origin
|
||||
for line in lines:
|
||||
if line.account.party_required:
|
||||
line.party = disbursement.payee
|
||||
return lines
|
||||
@@ -0,0 +1,24 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<tryton>
|
||||
<data>
|
||||
<record model="ir.ui.view" id="account_configuration_view_form">
|
||||
<field name="model">account.configuration</field>
|
||||
<field name="inherit" ref="account.configuration_view_form"/>
|
||||
<field name="name">account_configuration_form</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="account_type_template_view_form">
|
||||
<field name="model">account.account.type.template</field>
|
||||
<field name="inherit" ref="account.account_type_template_view_form"/>
|
||||
<field name="name">account_type_form</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="account_type_view_form">
|
||||
<field name="model">account.account.type</field>
|
||||
<field name="inherit" ref="account.account_type_view_form"/>
|
||||
<field name="name">account_type_form</field>
|
||||
</record>
|
||||
</data>
|
||||
</tryton>
|
||||
@@ -0,0 +1,111 @@
|
||||
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
# this repository contains the full copyright notices and license terms.
|
||||
|
||||
import os
|
||||
|
||||
base_url = os.environ.get('DOC_BASE_URL')
|
||||
if base_url:
|
||||
modules_url = base_url + '/modules-{module}/'
|
||||
trytond_url = base_url + '/server/'
|
||||
else:
|
||||
modules_url = (
|
||||
'https://docs.tryton.org/{series}/modules-{module}/')
|
||||
trytond_url = 'https://docs.tryton.org/{series}/server/'
|
||||
|
||||
|
||||
def get_info():
|
||||
import configparser
|
||||
import json
|
||||
import subprocess
|
||||
|
||||
module_dir = os.path.dirname(os.path.dirname(__file__))
|
||||
|
||||
config = configparser.ConfigParser()
|
||||
config.read_file(open(os.path.join(module_dir, 'tryton.cfg')))
|
||||
info = dict(config.items('tryton'))
|
||||
|
||||
metadata_cmd = 'python3 -m build -qq --metadata'
|
||||
if os.environ.get('DOC_NO_ISOLATION'):
|
||||
metadata_cmd += ' --no-isolation'
|
||||
metadata = subprocess.check_output(
|
||||
metadata_cmd, shell=True, encoding='utf-8', cwd=module_dir).strip()
|
||||
metadata = json.loads(metadata)
|
||||
info['name'] = metadata['name']
|
||||
info['description'] = metadata['summary']
|
||||
major_version, minor_version, _ = metadata['version'].split('.', 2)
|
||||
major_version = int(major_version)
|
||||
minor_version = int(minor_version)
|
||||
if minor_version % 2:
|
||||
info['series'] = 'latest'
|
||||
info['branch'] = 'branch/default'
|
||||
else:
|
||||
info['series'] = '.'.join(metadata['version'].split('.', 2)[:2])
|
||||
info['branch'] = 'branch/' + info['series']
|
||||
|
||||
for key in {'depends', 'extras_depend'}:
|
||||
info[key] = info.get(key, '').strip().splitlines()
|
||||
info['modules'] = set(info['depends'] + info['extras_depend'])
|
||||
info['modules'] -= {'ir', 'res'}
|
||||
|
||||
return info
|
||||
|
||||
|
||||
info = get_info()
|
||||
|
||||
html_theme = 'sphinx_book_theme'
|
||||
html_theme_options = {
|
||||
'logo': {
|
||||
'alt_text': "Tryton Documentation",
|
||||
'image_light': 'https://docs.tryton.org/logo-light.svg',
|
||||
'image_dark': 'https://docs.tryton.org/logo-dark.svg',
|
||||
'link': base_url,
|
||||
},
|
||||
'home_page_in_toc': True,
|
||||
'repository_provider': 'gitlab',
|
||||
'repository_url': 'https://code.tryton.org/tryton',
|
||||
'repository_branch': info['branch'],
|
||||
'use_source_button': True,
|
||||
'use_edit_page_button': True,
|
||||
'use_repository_button': True,
|
||||
'use_download_button': False,
|
||||
'path_to_docs': 'modules/project_disbursement/doc',
|
||||
}
|
||||
html_title = info['description']
|
||||
master_doc = 'index'
|
||||
project = info['name']
|
||||
release = version = info['series']
|
||||
default_role = 'ref'
|
||||
highlight_language = 'none'
|
||||
exclude_patterns = ['**/*.inc.rst']
|
||||
extensions = [
|
||||
'sphinx_copybutton',
|
||||
'sphinx.ext.intersphinx',
|
||||
]
|
||||
intersphinx_mapping = {
|
||||
'trytond': (trytond_url.format(series=version), None),
|
||||
}
|
||||
intersphinx_mapping.update({
|
||||
m: (modules_url.format(
|
||||
module=m.replace('_', '-'), series=version), None)
|
||||
for m in info['modules']
|
||||
})
|
||||
linkcheck_ignore = [r'/.*', r'https://demo.tryton.org/*']
|
||||
linkcheck_request_headers = {
|
||||
'User-Agent': (
|
||||
'TrytonBot/0.0 (https://www.tryton.org/foundation) '
|
||||
'sphinx-linkcheck/0.0'),
|
||||
'Accept-Encoding': 'gzip',
|
||||
}
|
||||
linkcheck_workers = 1
|
||||
|
||||
try:
|
||||
with open(os.path.join(
|
||||
os.path.dirname(__file__),
|
||||
'linkcheck_ignore.json'), 'r') as f:
|
||||
import json
|
||||
linkcheck_ignore.extend(json.load(f))
|
||||
del json
|
||||
except FileNotFoundError:
|
||||
pass
|
||||
|
||||
del get_info, info, base_url, modules_url, trytond_url
|
||||
@@ -0,0 +1,99 @@
|
||||
******
|
||||
Design
|
||||
******
|
||||
|
||||
The *Project Disbursement Module* introduce some new concepts and extends some
|
||||
existing concepts:
|
||||
|
||||
.. _model-account.configuration:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
The *Project Configuration* gains new settings to configure the behavior of the
|
||||
disbursement.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Project Configuration <project:model-project.configuration>` concept is
|
||||
introduced by the :doc:`Project Module <project:index>`.
|
||||
|
||||
.. _model-project.work:
|
||||
|
||||
Work Effort
|
||||
===========
|
||||
|
||||
The *Work Effort* gains new properties to book `Disbursement
|
||||
<model-project.disbursement>`.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Workf Effort <project:model-project.work>` concept is introduced by the
|
||||
:doc:`Project Module <project:index>`.
|
||||
|
||||
.. _concept-project.work.project:
|
||||
|
||||
Project
|
||||
-------
|
||||
|
||||
The *Project* concept gains new properties to setup the `Account
|
||||
<account:model-account.account>` and `Payment Journal
|
||||
<account_payment:model-account.payment.journal>` for their `Disbursement
|
||||
<model-project.disbursement>`.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Project <project:concept-project.work.project>` concept is introduced
|
||||
by the :doc:`Project Module <project:index>`.
|
||||
|
||||
.. _model-project.disbursement:
|
||||
|
||||
Disbursement
|
||||
============
|
||||
|
||||
The *Disbursement* concept is used to manage payment made on behalf of the
|
||||
`Party <party:model-party.party>` of the `Work Effort
|
||||
<project:model-project.work>`.
|
||||
Each disbursement, at any time, can be in one of several different states.
|
||||
A disbursement progresses through these states unitl it is either
|
||||
:guilabel:`Paid` or :guilabel:`Cancelled`.
|
||||
`Payments <account_payment:model-account.payment>` are created when the
|
||||
disbursement is validated.
|
||||
Once a disbursement is paid, it is included in the invoice generated for the
|
||||
`Project <project:concept-project.work.project>`.
|
||||
|
||||
.. seealso::
|
||||
|
||||
Disbursements are found by opening the main menu item:
|
||||
|
||||
|Projects --> Disbursements|__
|
||||
|
||||
.. |Projects --> Disbursements| replace:: :menuselection:`Projects --> Disbursements`
|
||||
__ https://demo.tryton.org/model/project.disbursement
|
||||
|
||||
|
||||
Account Configuration
|
||||
=====================
|
||||
|
||||
When the *Project Disbursement Module* is activated, the *Account
|
||||
Configuration* gains new properties such as the default account for
|
||||
disbursement.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Account Configuration <account:model-account.configuration>` concept is
|
||||
introduced by the :doc:`Account Module <account:index>`.
|
||||
|
||||
.. _model-account.account.type:
|
||||
|
||||
Account Type
|
||||
============
|
||||
|
||||
When the *Project Disbursement Module* is activated, the *Account Type* gains a
|
||||
new property that indicates if any `Accounts <account:model-account.account>`
|
||||
of this type can be used for disbursement.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Account Type <account:model-account.account.type>` concept is
|
||||
introduced by the :doc:`Account Module <account:index>`.
|
||||
@@ -0,0 +1,12 @@
|
||||
###########################
|
||||
Project Disbursement Module
|
||||
###########################
|
||||
|
||||
The *Project Disbursement Module* provides support for paying and invoicing
|
||||
disbursements per project.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
design
|
||||
releases
|
||||
@@ -0,0 +1,7 @@
|
||||
.. _releases-index:
|
||||
|
||||
=============
|
||||
Release notes
|
||||
=============
|
||||
|
||||
.. include:: ../CHANGELOG
|
||||
@@ -0,0 +1,3 @@
|
||||
build
|
||||
sphinx_book_theme
|
||||
sphinx_copybutton
|
||||
@@ -0,0 +1,8 @@
|
||||
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
# this repository contains the full copyright notices and license terms.
|
||||
|
||||
from trytond.exceptions import UserError
|
||||
|
||||
|
||||
class DisbursementError(UserError):
|
||||
pass
|
||||
@@ -0,0 +1,10 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<tryton>
|
||||
<data grouped="1">
|
||||
<record model="ir.message" id="msg_disbursement_cancel_payment">
|
||||
<field name="text">To cancel disbursement "%(disbursement)s", you must fail the payment "%(payment)s".</field>
|
||||
</record>
|
||||
</data>
|
||||
</tryton>
|
||||
@@ -0,0 +1,447 @@
|
||||
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
# this repository contains the full copyright notices and license terms.
|
||||
|
||||
from decimal import Decimal
|
||||
|
||||
from sql.operators import Abs
|
||||
|
||||
from trytond.i18n import gettext
|
||||
from trytond.model import (
|
||||
MatchMixin, ModelSQL, ModelView, Workflow, fields, sequence_ordered)
|
||||
from trytond.modules.company.model import (
|
||||
employee_field, reset_employee, set_employee)
|
||||
from trytond.modules.currency.fields import Monetary
|
||||
from trytond.pool import Pool, PoolMeta
|
||||
from trytond.pyson import Bool, Eval, Id
|
||||
from trytond.transaction import Transaction
|
||||
|
||||
from .exceptions import DisbursementError
|
||||
|
||||
_disbursment_sequence = fields.Many2One(
|
||||
'ir.sequence', "Disbursement Sequence", required=True,
|
||||
domain=[
|
||||
('sequence_type', '=',
|
||||
Id('project_disbursement', 'sequence_type_disbursement')),
|
||||
],
|
||||
help="Used to generate the disbursement number.")
|
||||
|
||||
|
||||
class Configuration(metaclass=PoolMeta):
|
||||
__name__ = 'project.configuration'
|
||||
|
||||
disbursement_sequence = fields.MultiValue(_disbursment_sequence)
|
||||
|
||||
@classmethod
|
||||
def multivalue_model(cls, field):
|
||||
pool = Pool()
|
||||
if field == 'disbursement_sequence':
|
||||
return pool.get('project.configuration.sequence')
|
||||
return super().multivalue_model(field)
|
||||
|
||||
@classmethod
|
||||
def default_disbursement_sequence(cls, **pattern):
|
||||
pool = Pool()
|
||||
ModelData = pool.get('ir.model.data')
|
||||
try:
|
||||
return ModelData.get_id(
|
||||
'project_disbursement', 'sequence_disbursement')
|
||||
except KeyError:
|
||||
return None
|
||||
|
||||
|
||||
class ConfigurationSequence(metaclass=PoolMeta):
|
||||
__name__ = 'project.configuration.sequence'
|
||||
|
||||
disbursement_sequence = _disbursment_sequence
|
||||
|
||||
|
||||
class Work(metaclass=PoolMeta):
|
||||
__name__ = 'project.work'
|
||||
|
||||
account_disbursement = fields.Many2One(
|
||||
'account.account', "Account Disbursement",
|
||||
domain=[
|
||||
('closed', '!=', True),
|
||||
('company', '=', Eval('company', -1)),
|
||||
],
|
||||
states={
|
||||
'invisible': Eval('type') != 'project',
|
||||
},
|
||||
help="Leave empty for the default account.")
|
||||
disbursement_journals = fields.One2Many(
|
||||
'project.disbursement.journal', 'work', "Disbursement Journals",
|
||||
states={
|
||||
'invisible': Eval('type') != 'project',
|
||||
})
|
||||
disbursements = fields.One2Many(
|
||||
'project.disbursement', 'work', "Disbursements",
|
||||
domain=[
|
||||
('company', '=', Eval('company', -1)),
|
||||
],
|
||||
states={
|
||||
'editable': Bool(Eval('company', None)),
|
||||
})
|
||||
|
||||
@classmethod
|
||||
def __setup__(cls):
|
||||
super().__setup__()
|
||||
cls.company.states['editable'] &= ~Eval('disbursements', [])
|
||||
|
||||
@classmethod
|
||||
def _get_amount_to_invoice(cls, works):
|
||||
pool = Pool()
|
||||
Currency = pool.get('currency.currency')
|
||||
amounts = super()._get_amount_to_invoice(works)
|
||||
for work in works:
|
||||
for disbursement in work.disbursements:
|
||||
if disbursement.state == 'paid':
|
||||
amounts[work.id] += Currency.compute(
|
||||
disbursement.currency, disbursement.amount_to_invoice,
|
||||
work.company.currency)
|
||||
return amounts
|
||||
|
||||
def _get_lines_to_invoice(self):
|
||||
lines = super()._get_lines_to_invoice()
|
||||
for disbursement in self.disbursements:
|
||||
if disbursement.state == 'paid' and disbursement.amount_to_invoice:
|
||||
lines.append({
|
||||
'product': None,
|
||||
'account': disbursement.account,
|
||||
'quantity': 1,
|
||||
'unit': None,
|
||||
'unit_price': disbursement.amount_to_invoice,
|
||||
'origin': disbursement,
|
||||
'origins': [],
|
||||
'description': disbursement.description,
|
||||
})
|
||||
return lines
|
||||
|
||||
def _group_lines_to_invoice_key(self, line):
|
||||
return super()._group_lines_to_invoice_key(line) + (
|
||||
('account', line.get('account')),
|
||||
('origin', line.get('origin')),
|
||||
)
|
||||
|
||||
|
||||
class OpenInvoice(metaclass=PoolMeta):
|
||||
__name__ = 'project.open_invoice'
|
||||
|
||||
def do_open_(self, action):
|
||||
works = self.model.search([
|
||||
('parent', 'child_of', list(map(int, self.records))),
|
||||
])
|
||||
action, data = super().do_open_(action)
|
||||
invoice_ids = set(data.get('res_id', []))
|
||||
for work in works:
|
||||
for disbursement in work.disbursements:
|
||||
for invoice_line in disbursement.invoice_lines:
|
||||
if invoice_line.invoice:
|
||||
invoice_ids.add(invoice_line.invoice.id)
|
||||
data['res_id'] = list(invoice_ids)
|
||||
return action, data
|
||||
|
||||
|
||||
class Disbursement(Workflow, ModelSQL, ModelView):
|
||||
__name__ = 'project.disbursement'
|
||||
_rec_name = 'number'
|
||||
|
||||
_states = {
|
||||
'readonly': Eval('state') != 'draft',
|
||||
}
|
||||
|
||||
number = fields.Char("Number", readonly=True)
|
||||
work = fields.Many2One(
|
||||
'project.work', "Work", required=True,
|
||||
domain=[
|
||||
('company', '=', Eval('company', -1)),
|
||||
],
|
||||
states={
|
||||
'readonly': _states['readonly'],
|
||||
'editable': Bool(Eval('company', None)),
|
||||
})
|
||||
company = fields.Many2One(
|
||||
'company.company', "Company", required=True, states=_states)
|
||||
description = fields.Char("Description", states=_states)
|
||||
|
||||
reference = fields.Char("Reference", states=_states)
|
||||
reference_type = fields.Selection(
|
||||
'get_reference_types', "Reference Type", states=_states)
|
||||
|
||||
payee = fields.Many2One(
|
||||
'party.party', "Payee", required=True, states=_states)
|
||||
payment_date = fields.Date("Date", required=True, states=_states)
|
||||
|
||||
currency = fields.Many2One(
|
||||
'currency.currency', "Currency",
|
||||
required=True, states=_states)
|
||||
amount = Monetary(
|
||||
"Amount", currency='currency', digits='currency',
|
||||
required=True, states=_states,
|
||||
domain=[
|
||||
('amount', '>', 0),
|
||||
])
|
||||
|
||||
attachments = fields.One2Many(
|
||||
'ir.attachment', 'resource', "Attachments",
|
||||
filter=[
|
||||
('type', '=', 'data'),
|
||||
])
|
||||
|
||||
payments = fields.One2Many(
|
||||
'account.payment', 'origin', "Payments", readonly=True,
|
||||
domain=[
|
||||
('kind', '=', 'payable'),
|
||||
])
|
||||
invoice_lines = fields.One2Many(
|
||||
'account.invoice.line', 'origin', "Invoice Lines", readonly=True)
|
||||
|
||||
validated_by = employee_field(
|
||||
"Validated By",
|
||||
states=['validated', 'paid', 'cancelled'])
|
||||
|
||||
state = fields.Selection([
|
||||
('draft', "Draft"),
|
||||
('validated', "Validated"),
|
||||
('paid', "Paid"),
|
||||
('cancelled', "Cancelled"),
|
||||
], "State", readonly=True, required=True, sort=False)
|
||||
|
||||
@classmethod
|
||||
def __setup__(cls):
|
||||
super().__setup__()
|
||||
cls._transitions |= {
|
||||
('draft', 'validated'),
|
||||
('draft', 'cancelled'),
|
||||
('validated', 'validated'),
|
||||
('validated', 'paid'),
|
||||
('validated', 'cancelled'),
|
||||
('paid', 'validated'),
|
||||
('cancelled', 'draft'),
|
||||
}
|
||||
cls._buttons.update(
|
||||
draft={
|
||||
'invisible': Eval('state') != 'cancelled',
|
||||
'depends': ['state'],
|
||||
},
|
||||
validate_disbursement={
|
||||
'invisible': Eval('state') != 'draft',
|
||||
'depends': ['state'],
|
||||
},
|
||||
process={
|
||||
'invisible': ~Eval('state').in_(['validated', 'paid']),
|
||||
'depends': ['state'],
|
||||
},
|
||||
cancel={
|
||||
'invisible': ~Eval('state').in_(['draft', 'validated']),
|
||||
'depends': ['state'],
|
||||
})
|
||||
|
||||
@classmethod
|
||||
def default_company(cls):
|
||||
return Transaction().context.get('company')
|
||||
|
||||
@fields.depends('company', 'currency')
|
||||
def on_change_company(self):
|
||||
if self.company and not self.currency:
|
||||
self.currency = self.company.currency
|
||||
|
||||
@fields.depends('reference', 'reference_type')
|
||||
def on_change_with_reference(self):
|
||||
pool = Pool()
|
||||
Payment = pool.get('account.payment')
|
||||
if (reference := self.reference) and (type := self.reference_type):
|
||||
reference = getattr(
|
||||
Payment, f'_format_reference_{type}')(reference)
|
||||
return reference
|
||||
|
||||
@classmethod
|
||||
def get_reference_types(cls):
|
||||
pool = Pool()
|
||||
Payment = pool.get('account.payment')
|
||||
return Payment.fields_get(
|
||||
['reference_type'])['reference_type']['selection']
|
||||
|
||||
@classmethod
|
||||
def order_amount(cls, tables):
|
||||
context = Transaction().context
|
||||
column = cls.amount.sql_column(tables, cls)
|
||||
if isinstance(context.get('amount_order'), Decimal):
|
||||
return [Abs(column - abs(context['amount_order']))]
|
||||
else:
|
||||
return [column]
|
||||
|
||||
@classmethod
|
||||
def default_state(cls):
|
||||
return 'draft'
|
||||
|
||||
@classmethod
|
||||
def _number_sequence(cls, **pattern):
|
||||
pool = Pool()
|
||||
Configuration = pool.get('project.configuration')
|
||||
config = Configuration(1)
|
||||
return config.get_multivalue('disbursement_sequence', **pattern)
|
||||
|
||||
@classmethod
|
||||
def preprocess_values(cls, mode, values):
|
||||
values = super().preprocess_values(mode, values)
|
||||
if mode == 'create':
|
||||
if not values.get('number'):
|
||||
if sequence := cls._number_sequence():
|
||||
values['number'] = sequence.get()
|
||||
return values
|
||||
|
||||
@classmethod
|
||||
def copy(cls, disbursements, default=None):
|
||||
default = default.copy() if default is not None else {}
|
||||
default.setdefault('number')
|
||||
return super().copy(disbursements, default=default)
|
||||
|
||||
@classmethod
|
||||
@ModelView.button
|
||||
@Workflow.transition('draft')
|
||||
@reset_employee('validated_by')
|
||||
def draft(cls, disbursements):
|
||||
pass
|
||||
|
||||
@classmethod
|
||||
@ModelView.button
|
||||
@Workflow.transition('validated')
|
||||
@set_employee('validated_by')
|
||||
def validate_disbursement(cls, disbursements):
|
||||
pool = Pool()
|
||||
Payment = pool.get('account.payment')
|
||||
payments = []
|
||||
for disbursement in disbursements:
|
||||
if payment := disbursement._get_payment():
|
||||
payments.append(payment)
|
||||
Payment.save(payments)
|
||||
|
||||
def _get_payment(self):
|
||||
pool = Pool()
|
||||
Payment = pool.get('account.payment')
|
||||
amount = self.amount
|
||||
for payment in self.payments:
|
||||
if payment.state != 'failed':
|
||||
amount -= payment.amount
|
||||
if amount > 0:
|
||||
return Payment(
|
||||
company=self.company,
|
||||
journal=self._get_journal(),
|
||||
kind='payable',
|
||||
party=self.payee,
|
||||
date=self.payment_date,
|
||||
amount=amount,
|
||||
origin=self,
|
||||
)
|
||||
|
||||
def _get_journal(self, pattern=None):
|
||||
pattern = pattern.copy() if pattern is not None else {}
|
||||
pattern['currency'] = self.currency.id
|
||||
work = self.work
|
||||
while work:
|
||||
if work.type == 'project':
|
||||
for disbursement_journal in work.disbursement_journals:
|
||||
if disbursement_journal.match(pattern):
|
||||
return disbursement_journal.journal
|
||||
work = work.parent
|
||||
|
||||
@property
|
||||
def account(self):
|
||||
pool = Pool()
|
||||
Configuration = pool.get('account.configuration')
|
||||
work = self.work
|
||||
while work:
|
||||
if work.type == 'project':
|
||||
if work.account_disbursement:
|
||||
return work.account_disbursement
|
||||
work = work.parent
|
||||
configuration = Configuration(1)
|
||||
return configuration.get_multivalue(
|
||||
'default_account_disbursement',
|
||||
company=self.company.id)
|
||||
|
||||
@property
|
||||
def is_paid(self):
|
||||
amount_paid = sum(
|
||||
p.amount for p in self.payments if p.state == 'succeeded')
|
||||
return self.amount <= amount_paid
|
||||
|
||||
@classmethod
|
||||
@ModelView.button
|
||||
def process(cls, disbursements):
|
||||
cls.lock(disbursements)
|
||||
paid, validated = [], []
|
||||
for disbursement in disbursements:
|
||||
if disbursement.is_paid and disbursement.state != 'paid':
|
||||
paid.append(disbursement)
|
||||
elif disbursement.state in {'validated', 'paid'}:
|
||||
validated.append(disbursement)
|
||||
if paid:
|
||||
cls.paid(paid)
|
||||
if validated:
|
||||
cls.validate_disbursement(validated)
|
||||
|
||||
@classmethod
|
||||
@Workflow.transition('paid')
|
||||
def paid(cls, disbursements):
|
||||
pass
|
||||
|
||||
@property
|
||||
def amount_to_invoice(self):
|
||||
amount = self.amount
|
||||
for line in self.invoice_lines:
|
||||
if not line.invoice or line.invoice.state != 'cancelled':
|
||||
amount -= line.amount
|
||||
return max(amount, 0)
|
||||
|
||||
@classmethod
|
||||
@ModelView.button
|
||||
@Workflow.transition('cancelled')
|
||||
def cancel(cls, disbursements):
|
||||
pool = Pool()
|
||||
Payment = pool.get('account.payment')
|
||||
to_delete = []
|
||||
for disbursement in disbursements:
|
||||
for payment in disbursement.payments:
|
||||
if payment.state not in {'draft', 'submitted'}:
|
||||
raise DisbursementError(gettext(
|
||||
'project_disbursement'
|
||||
'.msg_disbursement_cancel_payment',
|
||||
disbursement=disbursement.rec_name,
|
||||
payment=payment.rec_name))
|
||||
elif payment.state == 'failed':
|
||||
continue
|
||||
else:
|
||||
to_delete.append(payment)
|
||||
if to_delete:
|
||||
Payment.draft(to_delete)
|
||||
Payment.delete(to_delete)
|
||||
|
||||
|
||||
class DisbursementJournal(
|
||||
sequence_ordered(), MatchMixin, ModelSQL, ModelView):
|
||||
__name__ = 'project.disbursement.journal'
|
||||
|
||||
work = fields.Many2One(
|
||||
'project.work', "Work", required=True,
|
||||
domain=[
|
||||
('type', '=', 'project'),
|
||||
])
|
||||
currency = fields.Many2One('currency.currency', "Currency", required=True)
|
||||
journal = fields.Many2One(
|
||||
'account.payment.journal', "Journal", required=True,
|
||||
domain=[
|
||||
('company', '=', Eval('company', -1)),
|
||||
])
|
||||
company = fields.Function(fields.Many2One(
|
||||
'company.company', "Company"),
|
||||
'on_change_with_company')
|
||||
|
||||
@classmethod
|
||||
def __setup__(cls):
|
||||
super().__setup__()
|
||||
cls.__access__.add('work')
|
||||
|
||||
@fields.depends('work', '_parent_work.company')
|
||||
def on_change_with_company(self, name=None):
|
||||
return self.work.company if self.work else None
|
||||
@@ -0,0 +1,145 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<tryton>
|
||||
<data>
|
||||
<record model="res.group" id="group_project_disbursement">
|
||||
<field name="name">Project Disbursement</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="project_configuration_view_form">
|
||||
<field name="model">project.configuration</field>
|
||||
<field name="inherit" ref="project.project_configuration_view_form"/>
|
||||
<field name="name">project_configuration_form</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.sequence.type" id="sequence_type_disbursement">
|
||||
<field name="name">Project Disbursement</field>
|
||||
</record>
|
||||
<record model="ir.sequence.type-res.group" id="sequence_type_disbursement_group_project_admin">
|
||||
<field name="sequence_type" ref="sequence_type_disbursement"/>
|
||||
<field name="group" ref="project.group_project_admin"/>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="project_work_view_form">
|
||||
<field name="model">project.work</field>
|
||||
<field name="inherit" ref="project.work_view_form"/>
|
||||
<field name="name">project_work_form</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="project_disbursement_view_form">
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="type">form</field>
|
||||
<field name="name">project_disbursement_form</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="project_disbursement_view_list">
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="type">tree</field>
|
||||
<field name="name">project_disbursement_list</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.action.act_window" id="act_project_disbursement_form">
|
||||
<field name="name">Disbursements</field>
|
||||
<field name="res_model">project.disbursement</field>
|
||||
</record>
|
||||
<record model="ir.action.act_window.view" id="act_project_disbursement_form_view1">
|
||||
<field name="sequence" eval="10"/>
|
||||
<field name="view" ref="project_disbursement_view_list"/>
|
||||
<field name="act_window" ref="act_project_disbursement_form"/>
|
||||
</record>
|
||||
<record model="ir.action.act_window.view" id="act_project_disbursement_form_view2">
|
||||
<field name="sequence" eval="20"/>
|
||||
<field name="view" ref="project_disbursement_view_form"/>
|
||||
<field name="act_window" ref="act_project_disbursement_form"/>
|
||||
</record>
|
||||
<menuitem
|
||||
parent="project.menu_project"
|
||||
action="act_project_disbursement_form"
|
||||
sequence="30"
|
||||
id="menu_project_disbursement_form"/>
|
||||
|
||||
<record model="ir.rule.group" id="rule_group_project_disbursement_companies">
|
||||
<field name="name">User in companies</field>
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="global_p" eval="True"/>
|
||||
</record>
|
||||
<record model="ir.rule" id="rule_project_disbursement_companies">
|
||||
<field
|
||||
name="domain"
|
||||
eval="[('company', 'in', Eval('companies', []))]"
|
||||
pyson="1"/>
|
||||
<field name="rule_group" ref="rule_group_project_disbursement_companies"/>
|
||||
</record>
|
||||
|
||||
<record model="ir.model.access" id="access_project_disbursement">
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="perm_read" eval="True"/>
|
||||
<field name="perm_write" eval="False"/>
|
||||
<field name="perm_create" eval="False"/>
|
||||
<field name="perm_delete" eval="False"/>
|
||||
</record>
|
||||
<record model="ir.model.access" id="access_project_disbursement_disbursement">
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="group" ref="group_project_disbursement"/>
|
||||
<field name="perm_read" eval="True"/>
|
||||
<field name="perm_write" eval="True"/>
|
||||
<field name="perm_create" eval="True"/>
|
||||
<field name="perm_delete" eval="True"/>
|
||||
</record>
|
||||
|
||||
<record model="ir.model.button" id="project_disbursement_draft_button">
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="name">draft</field>
|
||||
<field name="string">Draft</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.model.button" id="project_disbursement_validate_button">
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="name">validate_disbursement</field>
|
||||
<field name="string">Validate</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.model.button" id="project_disbursement_process_button">
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="name">process</field>
|
||||
<field name="string">Process</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.model.button" id="project_disbursement_cancel_button">
|
||||
<field name="model">project.disbursement</field>
|
||||
<field name="name">cancel</field>
|
||||
<field name="string">Cancel</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="project_disbursement_journal_view_form">
|
||||
<field name="model">project.disbursement.journal</field>
|
||||
<field name="type">form</field>
|
||||
<field name="name">project_disbursement_journal_form</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="project_disbursement_journal_view_list">
|
||||
<field name="model">project.disbursement.journal</field>
|
||||
<field name="type">tree</field>
|
||||
<field name="priority" eval="10"/>
|
||||
<field name="name">project_disbursement_journal_list</field>
|
||||
</record>
|
||||
|
||||
<record model="ir.ui.view" id="project_disbursement_journal_view_list_sequence">
|
||||
<field name="model">project.disbursement.journal</field>
|
||||
<field name="type">tree</field>
|
||||
<field name="priority" eval="20"/>
|
||||
<field name="name">project_disbursement_journal_list_sequence</field>
|
||||
</record>
|
||||
</data>
|
||||
<data noupdate="1">
|
||||
<record model="ir.sequence" id="sequence_disbursement">
|
||||
<field name="name">Disbursement</field>
|
||||
<field name="sequence_type" ref="sequence_type_disbursement"/>
|
||||
</record>
|
||||
|
||||
<record model="project.configuration.sequence" id="project.project_configuration_sequence">
|
||||
<field name="disbursement_sequence" ref="sequence_disbursement"/>
|
||||
</record>
|
||||
</data>
|
||||
</tryton>
|
||||
@@ -0,0 +1,59 @@
|
||||
[build-system]
|
||||
requires = ['hatchling >= 1', 'hatch-tryton']
|
||||
build-backend = 'hatchling.build'
|
||||
|
||||
[project]
|
||||
name = 'trytond_project_disbursement'
|
||||
dynamic = ['version', 'dependencies', 'optional-dependencies', 'authors', 'readme']
|
||||
requires-python = '>=3.10'
|
||||
maintainers = [
|
||||
{name = "Tryton", email = "foundation@tryton.org"},
|
||||
]
|
||||
description = "Projects disbursement for Tryton"
|
||||
license = 'GPL-3.0-or-later'
|
||||
license-files = ['LICENSE', 'icons/LICENSE', 'COPYRIGHT']
|
||||
keywords = ["tryton", "project", "disbursement", "invoice"]
|
||||
classifiers = [
|
||||
"Development Status :: 5 - Production/Stable",
|
||||
"Environment :: Plugins",
|
||||
"Framework :: Tryton",
|
||||
"Topic :: Office/Business",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
]
|
||||
|
||||
[project.entry-points.'trytond.modules']
|
||||
project_disbursement = 'trytond.modules.project_disbursement'
|
||||
|
||||
[project.urls]
|
||||
homepage = "https://www.tryton.org/"
|
||||
documentation = "https://docs.tryton.org/modules-project-disbursement/"
|
||||
changelog = "https://docs.tryton.org/modules-project-disbursement/releases.html"
|
||||
forum = "https://www.tryton.org/forum"
|
||||
issues = "https://bugs.tryton.org/tryton"
|
||||
repository = "https://code.tryton.org/tryton"
|
||||
funding = "https://www.tryton.org/donate"
|
||||
|
||||
[tool.hatch.build]
|
||||
include = [
|
||||
'**/tryton.cfg',
|
||||
'**/*.py',
|
||||
'**/*.xml',
|
||||
'view/**/*.xml',
|
||||
'locale/**/*.po',
|
||||
'**/*.fodt',
|
||||
'icons/**/*.svg',
|
||||
'tests/**/*.rst',
|
||||
'tests/**/*.json',
|
||||
]
|
||||
exclude = ['doc']
|
||||
|
||||
[tool.hatch.build.targets.wheel.sources]
|
||||
"" = "trytond/modules/project_disbursement"
|
||||
|
||||
[tool.hatch.metadata.hooks.tryton]
|
||||
dependencies = ['python-sql']
|
||||
copyright = 'COPYRIGHT'
|
||||
readme = 'README.rst'
|
||||
|
||||
[tool.hatch.metadata.hooks.tryton.tryton-optional-dependencies]
|
||||
test = ['proteus']
|
||||
@@ -0,0 +1,2 @@
|
||||
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
# this repository contains the full copyright notices and license terms.
|
||||
@@ -0,0 +1,197 @@
|
||||
=============================
|
||||
Project Disbursement Scenario
|
||||
=============================
|
||||
|
||||
Imports::
|
||||
|
||||
>>> import datetime as dt
|
||||
>>> from decimal import Decimal
|
||||
|
||||
>>> from proteus import Model
|
||||
>>> from trytond.modules.account.tests.tools import (
|
||||
... create_chart, create_fiscalyear, get_accounts)
|
||||
>>> from trytond.modules.account_invoice.tests.tools import (
|
||||
... set_fiscalyear_invoice_sequences)
|
||||
>>> from trytond.modules.company.tests.tools import create_company
|
||||
>>> from trytond.tests.tools import activate_modules, assertEqual
|
||||
|
||||
>>> today = dt.date.today()
|
||||
|
||||
Activate modules::
|
||||
|
||||
>>> config = activate_modules('project_disbursement', create_company, create_chart)
|
||||
|
||||
>>> Account = Model.get('account.account')
|
||||
>>> AccountJournal = Model.get('account.journal')
|
||||
>>> Disbursement = Model.get('project.disbursement')
|
||||
>>> Invoice = Model.get('account.invoice')
|
||||
>>> Party = Model.get('party.party')
|
||||
>>> PaymentJournal = Model.get('account.payment.journal')
|
||||
>>> Statement = Model.get('account.statement')
|
||||
>>> StatementJournal = Model.get('account.statement.journal')
|
||||
>>> Work = Model.get('project.work')
|
||||
|
||||
Create fiscal year::
|
||||
|
||||
>>> fiscalyear = set_fiscalyear_invoice_sequences(
|
||||
... create_fiscalyear(today=today))
|
||||
>>> fiscalyear.click('create_period')
|
||||
|
||||
Get accounts::
|
||||
|
||||
>>> accounts = get_accounts()
|
||||
>>> account_disbursement, = Account.find([('code', '=', '1.2.3')])
|
||||
>>> account_disbursement_type = account_disbursement.type
|
||||
>>> account_disbursement_type.template_override = True
|
||||
>>> account_disbursement_type.disbursement = True
|
||||
>>> account_disbursement_type.save()
|
||||
|
||||
Create payment journal::
|
||||
|
||||
>>> payment_journal = PaymentJournal(name='Manual', process_method='manual')
|
||||
>>> payment_journal.save()
|
||||
|
||||
Create statement journal::
|
||||
|
||||
>>> account_journal, = AccountJournal.find([('code', '=', 'STA')], limit=1)
|
||||
>>> statement_journal = StatementJournal(
|
||||
... name="Statement",
|
||||
... journal=account_journal,
|
||||
... validation='amount',
|
||||
... account=accounts['cash'])
|
||||
>>> statement_journal.save()
|
||||
|
||||
Create parties::
|
||||
|
||||
>>> customer = Party(name="Customer")
|
||||
>>> customer.save()
|
||||
>>> supplier = Party(name="Supplier")
|
||||
>>> supplier.save()
|
||||
|
||||
Create a project with a task::
|
||||
|
||||
>>> project = Work(type='project')
|
||||
>>> project.name = "Project"
|
||||
>>> project.party = customer
|
||||
>>> project.project_invoice_method = 'effort'
|
||||
>>> project.account_disbursement = account_disbursement
|
||||
>>> disbursement_journal = project.disbursement_journals.new()
|
||||
>>> disbursement_journal.currency = project.company.currency
|
||||
>>> disbursement_journal.journal = payment_journal
|
||||
>>> task = project.children.new()
|
||||
>>> task.name = "Task"
|
||||
>>> project.save()
|
||||
>>> task, = project.children
|
||||
|
||||
Add and validate a disbursement to the task::
|
||||
|
||||
>>> disbursement = Disbursement()
|
||||
>>> disbursement.work = task
|
||||
>>> disbursement.payee = supplier
|
||||
>>> disbursement.amount = Decimal('100.00')
|
||||
>>> disbursement.payment_date = today
|
||||
>>> disbursement.click('validate_disbursement')
|
||||
>>> disbursement.state
|
||||
'validated'
|
||||
|
||||
Pay partially the disbursement::
|
||||
|
||||
>>> payment, = disbursement.payments
|
||||
>>> payment.amount
|
||||
Decimal('100.00')
|
||||
>>> payment.amount = Decimal('50.00')
|
||||
>>> payment.click('submit')
|
||||
>>> payment.state
|
||||
'submitted'
|
||||
>>> payment.click('approve')
|
||||
>>> payment.state
|
||||
'approved'
|
||||
>>> process_payment = payment.click('process_wizard')
|
||||
>>> payment.state
|
||||
'processing'
|
||||
>>> payment.click('succeed')
|
||||
>>> payment.state
|
||||
'succeeded'
|
||||
|
||||
>>> disbursement.reload()
|
||||
>>> len(disbursement.payments)
|
||||
2
|
||||
|
||||
Fail the remaining disbursement::
|
||||
|
||||
>>> payment, = [p for p in disbursement.payments if p.state == 'draft']
|
||||
>>> payment.click('submit')
|
||||
>>> payment.click('approve')
|
||||
>>> process_payment = payment.click('process_wizard')
|
||||
>>> payment.click('fail')
|
||||
>>> payment.state
|
||||
'failed'
|
||||
|
||||
>>> disbursement.reload()
|
||||
>>> len(disbursement.payments)
|
||||
3
|
||||
|
||||
Pay totally the disbursement::
|
||||
|
||||
>>> payment, = [p for p in disbursement.payments if p.state == 'draft']
|
||||
>>> payment.click('submit')
|
||||
>>> payment.click('approve')
|
||||
>>> process_payment = payment.click('process_wizard')
|
||||
>>> payment.click('succeed')
|
||||
>>> payment.state
|
||||
'succeeded'
|
||||
|
||||
>>> disbursement.reload()
|
||||
>>> len(disbursement.payments)
|
||||
3
|
||||
|
||||
Create and validate a statement for the payments::
|
||||
|
||||
>>> payments = [p for p in disbursement.payments if p.state == 'succeeded']
|
||||
|
||||
>>> statement = Statement(
|
||||
... name="001",
|
||||
... journal=statement_journal,
|
||||
... total_amount=Decimal('-100.00'))
|
||||
>>> line = statement.lines.new()
|
||||
>>> line.date = today
|
||||
>>> line.amount = Decimal('-50.00')
|
||||
>>> line.related_to = payments[0]
|
||||
>>> assertEqual(line.party, supplier)
|
||||
>>> assertEqual(line.account, account_disbursement)
|
||||
>>> line = statement.lines.new()
|
||||
>>> line.date = today
|
||||
>>> line.amount = Decimal('-50.00')
|
||||
>>> line.related_to = payments[1]
|
||||
>>> statement.click('validate_statement')
|
||||
>>> statement.state
|
||||
'validated'
|
||||
|
||||
>>> account_disbursement.reload()
|
||||
>>> account_disbursement.balance
|
||||
Decimal('100.00')
|
||||
|
||||
Check disbursement is paid::
|
||||
|
||||
>>> disbursement.reload()
|
||||
>>> disbursement.state
|
||||
'paid'
|
||||
|
||||
>>> project.reload()
|
||||
>>> project.amount_to_invoice
|
||||
Decimal('100.00')
|
||||
|
||||
Invoice the project::
|
||||
|
||||
>>> project.click('invoice')
|
||||
>>> project.amount_to_invoice
|
||||
Decimal('0.00')
|
||||
|
||||
>>> invoice, = Invoice.find([])
|
||||
>>> invoice.click('post')
|
||||
>>> invoice.state
|
||||
'posted'
|
||||
|
||||
>>> account_disbursement.reload()
|
||||
>>> account_disbursement.balance
|
||||
Decimal('0.00')
|
||||
@@ -0,0 +1,11 @@
|
||||
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
# this repository contains the full copyright notices and license terms.
|
||||
from trytond.tests.test_tryton import ModuleTestCase
|
||||
|
||||
|
||||
class ProjectDisbursementTestCase(ModuleTestCase):
|
||||
"Test Project Disbursement module"
|
||||
module = 'project_disbursement'
|
||||
|
||||
|
||||
del ModuleTestCase
|
||||
@@ -0,0 +1,8 @@
|
||||
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
# this repository contains the full copyright notices and license terms.
|
||||
|
||||
from trytond.tests.test_tryton import load_doc_tests
|
||||
|
||||
|
||||
def load_tests(*args, **kwargs):
|
||||
return load_doc_tests(__name__, __file__, *args, **kwargs)
|
||||
@@ -0,0 +1,24 @@
|
||||
[tox]
|
||||
envlist = {py310,py311,py312,py313,py314}-{sqlite,postgresql}
|
||||
|
||||
[testenv]
|
||||
changedir = {env_site_packages_dir}
|
||||
extras = test
|
||||
commands =
|
||||
coverage run --rcfile={toxinidir}/tox.ini --source=trytond.modules.project_disbursement --omit=*/tests/* -m xmlrunner discover -s trytond.modules.project_disbursement {posargs}
|
||||
commands_post =
|
||||
coverage report --rcfile={toxinidir}/tox.ini
|
||||
coverage xml --rcfile={toxinidir}/tox.ini -o {package_root}/coverage.xml
|
||||
deps =
|
||||
coverage
|
||||
unittest-xml-reporting
|
||||
postgresql: psycopg[pool,binary] >= 3
|
||||
passenv = *
|
||||
setenv =
|
||||
sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://}
|
||||
postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://}
|
||||
sqlite: DB_NAME={env:DB_NAME::memory:}
|
||||
postgresql: DB_NAME={env:DB_NAME:test}
|
||||
|
||||
[coverage:run]
|
||||
relative_files = true
|
||||
@@ -0,0 +1,36 @@
|
||||
[tryton]
|
||||
version=8.1.0
|
||||
depends:
|
||||
account
|
||||
account_payment
|
||||
account_statement
|
||||
company
|
||||
currency
|
||||
ir
|
||||
party
|
||||
project
|
||||
project_invoice
|
||||
xml:
|
||||
account.xml
|
||||
project.xml
|
||||
message.xml
|
||||
|
||||
[register]
|
||||
model:
|
||||
account.Configuration
|
||||
account.ConfigurationDefaultAccount
|
||||
account.AccountTypeTemplate
|
||||
account.AccountType
|
||||
account.Payment
|
||||
account.StatementLine
|
||||
account.InvoiceLine
|
||||
project.Configuration
|
||||
project.ConfigurationSequence
|
||||
project.Work
|
||||
project.Disbursement
|
||||
project.DisbursementJournal
|
||||
|
||||
wizard:
|
||||
project.OpenInvoice
|
||||
|
||||
report:
|
||||
@@ -0,0 +1,11 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<data>
|
||||
<xpath expr="/form" position="inside">
|
||||
<separator id="project_disbursement" string="Project Disbursement" colspan="4"/>
|
||||
<label name="default_account_disbursement"/>
|
||||
<field name="default_account_disbursement"/>
|
||||
<newline/>
|
||||
</xpath>
|
||||
</data>
|
||||
@@ -0,0 +1,9 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<data>
|
||||
<xpath expr="//group[@id='checkboxes']" position="inside">
|
||||
<label name="disbursement"/>
|
||||
<field name="disbursement" xexpand="0" width="25"/>
|
||||
</xpath>
|
||||
</data>
|
||||
@@ -0,0 +1,9 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<data>
|
||||
<xpath expr="//field[@name='work_sequence']" position="after">
|
||||
<label name="disbursement_sequence"/>
|
||||
<field name="disbursement_sequence"/>
|
||||
</xpath>
|
||||
</data>
|
||||
@@ -0,0 +1,58 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<form>
|
||||
<label name="payee"/>
|
||||
<field name="payee"/>
|
||||
<label name="number"/>
|
||||
<field name="number"/>
|
||||
|
||||
<label name="reference"/>
|
||||
<field name="reference"/>
|
||||
<label name="reference_type"/>
|
||||
<field name="reference_type"/>
|
||||
|
||||
<label name="description"/>
|
||||
<field name="description" colspan="3"/>
|
||||
|
||||
<label name="work"/>
|
||||
<field name="work" colspan="3"/>
|
||||
|
||||
<label name="amount"/>
|
||||
<field name="amount"/>
|
||||
<label name="currency"/>
|
||||
<field name="currency"/>
|
||||
|
||||
<label name="payment_date"/>
|
||||
<field name="payment_date"/>
|
||||
|
||||
<notebook>
|
||||
<page name="attachments">
|
||||
<field name="attachments" colspan="4"/>
|
||||
</page>
|
||||
<page name="payments">
|
||||
<field name="payments" colspan="4"/>
|
||||
</page>
|
||||
<page name="invoice_lines">
|
||||
<field name="invoice_lines" colspan="4"/>
|
||||
</page>
|
||||
<page string="Other Info" id="info">
|
||||
<label name="company"/>
|
||||
<field name="company"/>
|
||||
<newline/>
|
||||
|
||||
<label name="validated_by"/>
|
||||
<field name="validated_by"/>
|
||||
</page>
|
||||
</notebook>
|
||||
|
||||
|
||||
<label name="state"/>
|
||||
<field name="state"/>
|
||||
<group col="-1" colspan="2" id="buttons">
|
||||
<button name="cancel" icon="tryton-cancel"/>
|
||||
<button name="draft" icon="tryton-back"/>
|
||||
<button name="validate_disbursement" icon="tryton-forward"/>
|
||||
<button name="process" icon="tryton-refresh"/>
|
||||
</group>
|
||||
</form>
|
||||
@@ -0,0 +1,14 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<form>
|
||||
<label name="work"/>
|
||||
<field name="work"/>
|
||||
<label name="sequence"/>
|
||||
<field name="sequence"/>
|
||||
|
||||
<label name="currency"/>
|
||||
<field name="currency"/>
|
||||
<label name="journal"/>
|
||||
<field name="journal" widget="selection"/>
|
||||
</form>
|
||||
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<tree>
|
||||
<field name="work" expand="1"/>
|
||||
<field name="currency" optional="0"/>
|
||||
<field name="journal" expand="1"/>
|
||||
</tree>
|
||||
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<tree sequence="sequence">
|
||||
<field name="work" expand="1"/>
|
||||
<field name="currency" optional="0"/>
|
||||
<field name="journal" expand="1"/>
|
||||
</tree>
|
||||
@@ -0,0 +1,13 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<tree>
|
||||
<field name="company" optional="1"/>
|
||||
<field name="number" expand="1"/>
|
||||
<field name="work" expand="1"/>
|
||||
<field name="payee" expand="2"/>
|
||||
<field name="reference" expand="1"/>
|
||||
<field name="payment_date" optional="1"/>
|
||||
<field name="amount" optional="0"/>
|
||||
<field name="state"/>
|
||||
</tree>
|
||||
@@ -0,0 +1,15 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||
this repository contains the full copyright notices and license terms. -->
|
||||
<data>
|
||||
<xpath expr="//notebook" position="inside">
|
||||
<page name="disbursements">
|
||||
<label name="account_disbursement"/>
|
||||
<field name="account_disbursement"/>
|
||||
|
||||
<field name="disbursement_journals" colspan="4" view_ids="project_disbursement.project_disbursement_journal_view_list_sequence"/>
|
||||
|
||||
<field name="disbursements" colspan="4"/>
|
||||
</page>
|
||||
</xpath>
|
||||
</data>
|
||||
Reference in New Issue
Block a user