diff --git a/.gitlab-ci-modules.yml b/.gitlab-ci-modules.yml index 45d7dc7b99..183730062a 100644 --- a/.gitlab-ci-modules.yml +++ b/.gitlab-ci-modules.yml @@ -836,6 +836,23 @@ test-modules-account_stock_eu-postgresql: PACKAGE: modules/account_stock_eu TAG_PATTERN: '/^account_stock_eu-.*/' +check-doc-modules-account_stock_eu_excise: + extends: .check-doc + variables: + PACKAGE: modules/account_stock_eu_excise + +test-modules-account_stock_eu_excise-sqlite: + extends: .test-sqlite + variables: + PACKAGE: modules/account_stock_eu_excise + TAG_PATTERN: '/^account_stock_eu_excise-.*/' + +test-modules-account_stock_eu_excise-postgresql: + extends: .test-postgresql + variables: + PACKAGE: modules/account_stock_eu_excise + TAG_PATTERN: '/^account_stock_eu_excise-.*/' + check-doc-modules-account_stock_landed_cost: extends: .check-doc variables: diff --git a/doc/account.rst b/doc/account.rst index 3ac79b093a..b873a1fd38 100644 --- a/doc/account.rst +++ b/doc/account.rst @@ -152,6 +152,9 @@ Accounting :doc:`Stock European ` Common stock European requirements. +:doc:`Stock European Excise ` + Common European requirements for excise products. + :doc:`Stock Landed Cost ` Allocate landed cost. diff --git a/modules/account_stock_eu_excise/CHANGELOG b/modules/account_stock_eu_excise/CHANGELOG new file mode 100644 index 0000000000..e69de29bb2 diff --git a/modules/account_stock_eu_excise/COPYRIGHT b/modules/account_stock_eu_excise/COPYRIGHT new file mode 100644 index 0000000000..b45d4833fd --- /dev/null +++ b/modules/account_stock_eu_excise/COPYRIGHT @@ -0,0 +1,15 @@ +Copyright (C) 2023 B2CK SRL +Copyright (C) 2023 Cédric Krier + +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 . diff --git a/modules/account_stock_eu_excise/LICENSE b/modules/account_stock_eu_excise/LICENSE new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/modules/account_stock_eu_excise/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/modules/account_stock_eu_excise/README.rst b/modules/account_stock_eu_excise/README.rst new file mode 120000 index 0000000000..176d9c2695 --- /dev/null +++ b/modules/account_stock_eu_excise/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/modules/account_stock_eu_excise/__init__.py b/modules/account_stock_eu_excise/__init__.py new file mode 100644 index 0000000000..4effdfa4a2 --- /dev/null +++ b/modules/account_stock_eu_excise/__init__.py @@ -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. diff --git a/modules/account_stock_eu_excise/account_stock_eu.py b/modules/account_stock_eu_excise/account_stock_eu.py new file mode 100644 index 0000000000..8e44d9dc0a --- /dev/null +++ b/modules/account_stock_eu_excise/account_stock_eu.py @@ -0,0 +1,858 @@ +# 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 datetime as dt +from collections import defaultdict +from decimal import Decimal + +from dateutil.relativedelta import relativedelta +from simpleeval import simple_eval +from sql import Literal, Null, Union, With +from sql.aggregate import Sum +from sql.conditionals import Case +from sql.operators import Exists + +from trytond.i18n import gettext +from trytond.model import ( + DeactivableMixin, MatchMixin, ModelSQL, ModelView, fields) +from trytond.pool import Pool, PoolMeta +from trytond.pyson import Bool, Eval, Id, If +from trytond.tools import cursor_dict, decistmt +from trytond.tools.decimal_ import DecimalNull +from trytond.transaction import Transaction + +from .exceptions import FormulaError + + +class ExciseTax(DeactivableMixin, ModelSQL, ModelView): + __name__ = 'account.stock.eu.excise.tax' + _rec_name = 'code' + + code = fields.Char("Code", required=True) + description = fields.Char("Description", translate=True) + country = fields.Many2One('country.country', "Country", required=True) + + quantity = fields.Selection([ + ('measurement_volume', "Volume Measurements"), + ('measurement_weight', "Weight Measurements"), + ], "Quantity", required=True, + help="Define which quantity to use for excise declaration.") + uom = fields.Many2One('product.uom', "UoM", required=True, + domain=[ + If(Eval('quantity') == 'measurement_volume', + ('category', '=', Id('product', 'uom_cat_volume')), + ()), + If(Eval('quantity') == 'measurement_weight', + ('category', '=', Id('product', 'uom_cat_weight')), + ()), + ], + help="The Unit of Measure for excise declaration.") + currency = fields.Many2One( + 'currency.currency', "Currency", + states={ + 'required': Bool(Eval('tax_rates', [])), + }) + tax_rates = fields.One2Many( + 'account.stock.eu.excise.tax.rate', 'excise_tax', "Tax Rates", + states={ + 'readonly': ~Eval('currency'), + }) + + @fields.depends('quantity', 'uom') + def on_change_quantity(self): + pool = Pool() + ModelData = pool.get('ir.model.data') + if self.uom: + if self.quantity == 'measurement_volume': + volume_id = ModelData.get_id('product', 'uom_cat_volume') + if self.uom.category.id != volume_id: + self.uom = None + elif self.quantity == 'measurement_weight': + weight_id = ModelData.get_id('product', 'uom_cat_weight') + if self.uom.category.id != weight_id: + self.uom = None + + def convert_quantity(self, product, quantity): + pool = Pool() + UoM = pool.get('product.uom') + + if self.quantity == 'measurement_volume': + if product.default_uom.category == self.uom.category: + return UoM.compute_qty( + product.default_uom, quantity, self.uom) + elif product.volume is not None: + quantity = quantity * product.volume + return UoM.compute_qty( + product.volume_uom, quantity, self.uom) + elif self.quantity == 'measurement_weight': + if product.default_uom.category == self.uom.category: + return UoM.compute_qty( + product.default_uom, quantity, self.uom) + elif product.weight is not None: + quantity = quantity * product.weight + return UoM.compute_qty(product.weight_uom, quantity, self.uom) + + def get_tax_rate(self, pattern): + for tax_rate in self.tax_rates: + if tax_rate.match(pattern): + return tax_rate + + +class ExciseTaxRate(MatchMixin, ModelSQL, ModelView): + __name__ = 'account.stock.eu.excise.tax.rate' + + excise_tax = fields.Many2One( + 'account.stock.eu.excise.tax', "Excise Tax", required=True) + start_date = fields.Date( + "Start Date", + domain=['OR', + ('start_date', '<=', If(Eval('end_date'), + Eval('end_date', dt.date.max), dt.date.max)), + ('start_date', '=', None), + ]) + end_date = fields.Date('End Date', + domain=['OR', + ('end_date', '>=', If(Eval('start_date'), + Eval('start_date', dt.date.min), dt.date.min)), + ('end_date', '=', None), + ]) + formula = fields.Char( + "Formula", required=True, + help=("A python expression that will be evaluated with:\n" + "-quantity: the quantity of product")) + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.add('excise_tax') + cls._order.insert(0, ('start_date', 'ASC')) + cls._order.insert(1, ('end_date', 'ASC')) + + @classmethod + def order_start_date(cls, tables): + table, _ = tables[None] + return [table.start_date == Null, table.start_date] + + @classmethod + def order_end_date(cls, tables): + table, _ = tables[None] + return [table.end_date == Null, table.end_date] + + @classmethod + def validate_fields(cls, rates, field_names=None): + super().validate_fields(rates, field_names=field_names) + cls.check_formula(rates, field_names=field_names) + + @classmethod + def check_formula(cls, rates, field_names): + if field_names and not (field_names & {'excise_tax', 'formula'}): + return + for rate in rates: + rate.compute(None, 0) + + def match(self, pattern): + if 'date' in pattern: + pattern = pattern.copy() + if date := pattern.pop('date'): + start = self.start_date or dt.date.min + end = self.end_date or dt.date.max + if not (start <= date <= end): + return False + return super().match(pattern) + + def _compute_context(self, product, quantity): + if product: + quantity = self.excise_tax.convert_quantity(product, quantity) + quantity = Decimal(str(quantity)) + return { + 'names': { + 'quantity': ( + quantity if quantity is not None else DecimalNull()), + }, + } + + def compute(self, product, quantity, unit=None): + pool = Pool() + UoM = pool.get('product.uom') + if unit: + quantity = UoM.compute_qty( + unit, quantity, product.default_uom, round=False) + context = self._compute_context(product, quantity) + context.setdefault('functions', {})['Decimal'] = Decimal + try: + value = simple_eval(decistmt(self.formula), **context) + if isinstance(value, DecimalNull): + value = None + if value is not None: + if not isinstance(value, Decimal): + raise ValueError(f"{value!r} is not a Decimal") + value = self.excise_tax.currency.round(value) + return value + except Exception as exception: + raise FormulaError(gettext( + 'account_stock_eu_excise.msg_invalid_formula', + formula=self.formula, + tax_rate=self.rec_name, + exception=exception)) from exception + + +class ExciseDeclarationContext(ModelView): + __name__ = 'account.stock.eu.excise.declaration.context' + + company = fields.Many2One('company.company', "Company", required=True) + warehouse = fields.Many2One( + 'stock.location', "Warehouse", required=True, + domain=[ + ('type', '=', 'warehouse'), + ('eu_excise_numbers', 'where', [ + ('company', '=', Eval('company', -1)), + ]), + ]) + from_date = fields.Date( + "From Date", required=True, + domain=[ + ('from_date', '<=', Eval('to_date', None)), + ]) + to_date = fields.Date( + "To Date", required=True, + domain=[ + ('to_date', '>=', Eval('from_date', None)), + ]) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @classmethod + def default_warehouse(cls): + pool = Pool() + Location = pool.get('stock.location') + context = Transaction().context + if 'warehouse' in context: + return context.get('warehouse') + company_id = context.get('company') + warehouses = Location.search([ + ('type', '=', 'warehouse'), + ('eu_excise_numbers', 'where', [ + ('company', '=', company_id), + ]), + ], limit=2) + if len(warehouses) == 1: + warehouse, = warehouses + return warehouse.id + + @classmethod + def default_from_date(cls): + pool = Pool() + Date = pool.get('ir.date') + context = Transaction().context + today = Date.today() + return context.get( + 'from_date', today + relativedelta(months=-1, day=1)) + + @classmethod + def default_to_date(cls): + pool = Pool() + Date = pool.get('ir.date') + context = Transaction().context + today = Date.today() + return context.get( + 'to_date', today + relativedelta(months=-1, day=31)) + + +class ExciseDeclaration(ModelSQL, ModelView): + __name__ = 'account.stock.eu.excise.declaration' + + company = fields.Many2One('company.company', "Company") + eu_excise_tax = fields.Many2One( + 'account.stock.eu.excise.tax', "Excise Tax") + unit = fields.Many2One('product.uom', "Unit") + products = fields.One2Many( + 'account.stock.eu.excise.declaration.product', 'eu_excise_tax', + "Products", + context={ + 'company': Eval('company', -1), + }, + depends=['company']) + start_quantity = fields.Function( + fields.Float("Start Quantity", digits='unit'), + '_sum_products') + input_production = fields.Function( + fields.Float("Input Production", digits='unit'), + '_sum_products') + input_duty_suspension = fields.Function( + fields.Float("Input Duty Suspension", digits='unit'), + '_sum_products') + input_replacement = fields.Function( + fields.Float("Input Replacement", digits='unit'), + '_sum_products') + input_other = fields.Function( + fields.Float("Input Other", digits='unit'), + '_sum_products') + input_total = fields.Function( + fields.Float("Input Total", digits='unit'), + '_sum_products') + output_with_duty = fields.Function( + fields.Float("Output with Duty", digits='unit'), + '_sum_products') + output_production = fields.Function( + fields.Float("Output Production", digits='unit'), + '_sum_products') + output_duty_suspension = fields.Function( + fields.Float("Output Duty Suspension", digits='unit'), + '_sum_products') + output_duty_free = fields.Function( + fields.Float("Output Duty Free", digits='unit'), + '_sum_products') + output_other = fields.Function( + fields.Float("Output Other", digits='unit'), + '_sum_products') + output_total = fields.Function( + fields.Float("Output Total", digits='unit'), + '_sum_products') + end_quantity = fields.Function( + fields.Float("End Quantity", digits='unit'), + '_sum_products') + + @classmethod + def __setup__(cls): + super().__setup__() + cls._order.insert(0, ('eu_excise_tax', 'ASC')) + + @classmethod + def table_query(cls): + pool = Pool() + ExciseTax = pool.get('account.stock.eu.excise.tax') + Product_ExciseTax = pool.get('product-account.stock.eu.excise.tax') + Location = pool.get('stock.location') + + excise_tax = ExciseTax.__table__() + product_excise_tax = Product_ExciseTax.__table__() + + context = Transaction().context + country = None + if warehouse := context.get('warehouse'): + warehouse = Location(warehouse) + if warehouse.address and warehouse.address.country: + country = warehouse.address.country.id + + return excise_tax.select( + excise_tax.id.as_('id'), + *cls._columns(excise_tax), + where=Exists(product_excise_tax.select( + product_excise_tax.id, + where=product_excise_tax.excise_tax == excise_tax.id)) + & (excise_tax.country == country)) + + @classmethod + def _columns(cls, excise_tax): + context = Transaction().context + return [ + Literal(context.get('company')).as_('company'), + excise_tax.id.as_('eu_excise_tax'), + excise_tax.uom.as_('unit'), + ] + + def _sum_products(self, names): + total = defaultdict(float) + for product in self.products: + assert self.unit == product.unit + for name in names: + total[name] += getattr(product, name) or 0 + return total + + def get_rec_name(self, name): + return self.eu_excise_tax.rec_name + + +class ExciseDeclarationProduct(ModelSQL, ModelView): + __name__ = 'account.stock.eu.excise.declaration.product' + + company = fields.Many2One('company.company', "Company") + product = fields.Many2One( + 'product.product', "Product", + context={ + 'company': Eval('company', -1), + }, + depends=['company']) + eu_excise_code = fields.Many2One('product.eu.excise_code', "Excise Code") + eu_excise_tax = fields.Many2One( + 'account.stock.eu.excise.tax', "Excise Tax") + unit = fields.Many2One('product.uom', "Unit") + start_quantity = fields.Function( + fields.Float("Start Quantity", digits='unit'), + 'get_quantity') + input_production = fields.Function( + fields.Float("Input Production", digits='unit'), + 'get_input') + input_duty_suspension = fields.Function( + fields.Float("Input Duty Suspension", digits='unit'), + 'get_input') + input_replacement = fields.Function( + fields.Float("Input Replacement", digits='unit'), + 'get_input') + input_other = fields.Function( + fields.Float("Input Other", digits='unit'), + 'get_input') + input_total = fields.Function( + fields.Float("Input Total", digits='unit'), + 'get_input') + output_with_duty = fields.Function( + fields.Float("Output with Duty", digits='unit'), + 'get_output') + output_production = fields.Function( + fields.Float("Output Production", digits='unit'), + 'get_output') + output_duty_suspension = fields.Function( + fields.Float("Output Duty Suspension", digits='unit'), + 'get_output') + output_duty_free = fields.Function( + fields.Float("Output Duty Free", digits='unit'), + 'get_output') + output_other = fields.Function( + fields.Float("Output Other", digits='unit'), + 'get_output') + output_total = fields.Function( + fields.Float("Output Total", digits='unit'), + 'get_output') + end_quantity = fields.Function( + fields.Float("End Quantity", digits='unit'), + 'get_quantity') + + @classmethod + def __setup__(cls): + super().__setup__() + cls._order.insert(0, ('product', 'ASC')) + + @classmethod + def table_query(cls): + from_item, tables = cls._joins() + return from_item.select( + *cls._columns(tables), + where=cls._where(tables)) + + @classmethod + def _joins(cls): + pool = Pool() + Product = pool.get('product.product') + ProductTemplate = pool.get('product.template') + Location = pool.get('stock.location') + Product_ExciseTax = pool.get('product-account.stock.eu.excise.tax') + ExciseTax = pool.get('account.stock.eu.excise.tax') + + context = Transaction().context + country = None + if warehouse := context.get('warehouse'): + warehouse = Location(warehouse) + if warehouse.address and warehouse.address.country: + country = warehouse.address.country.id + + tables = {} + tables['product'] = product = Product.__table__() + tables['template'] = template = ProductTemplate.__table__() + product_excise_tax = Product_ExciseTax.__table__() + tables['product_excise_tax'] = product_excise_tax + tables['excise_tax'] = excise_tax = ExciseTax.__table__() + return ( + product + .join(template, + condition=product.template == template.id) + .join(product_excise_tax, + condition=(template.id == product_excise_tax.template) + & (product_excise_tax.country == country)) + .join(excise_tax, + condition=product_excise_tax.excise_tax == excise_tax.id), + tables) + + @classmethod + def _columns(cls, tables): + context = Transaction().context + product = tables['product'] + template = tables['template'] + excise_tax = tables['excise_tax'] + return [ + product.id.as_('id'), + Literal(context.get('company')).as_('company'), + product.id.as_('product'), + template.eu_excise_code.as_('eu_excise_code'), + excise_tax.id.as_('eu_excise_tax'), + excise_tax.uom.as_('unit'), + ] + + @classmethod + def _where(cls, tables): + pool = Pool() + Company = pool.get('company.company') + Location = pool.get('stock.location') + + context = Transaction().context + product = tables['product'] + template = tables['template'] + + is_excise_product = Literal(False) + if warehouse := context.get('warehouse'): + warehouse = Location(warehouse) + if company := context.get('company'): + company = Company(company) + if excise_number := warehouse.get_eu_excise_number(company): + is_excise_product = ( + excise_number.is_excise_product_sql( + product, template)) + + return (template.eu_excise_code != Null) & is_excise_product + + @classmethod + def get_quantity(cls, declarations, name): + pool = Pool() + Product = pool.get('product.product') + transaction = Transaction() + context = transaction.context + quantities = defaultdict(type(None)) + if name == 'start_quantity': + stock_date_end = context.get('from_date') + if not stock_date_end: + stock_date_end = dt.date.min + else: + try: + stock_date_end -= dt.timedelta(days=1) + except OverflowError: + pass + elif name == 'end_quantity': + stock_date_end = context.get('to_date') + if not stock_date_end: + stock_date_end = dt.date.max + else: + return quantities + with transaction.set_context( + stock_date_end=stock_date_end, + locations=[context.get('warehouse', -1)]): + products = Product.browse(declarations) + for declaration, product in zip(declarations, products): + if excise_tax := declaration.eu_excise_tax: + name = excise_tax.quantity + quantities[declaration.id] = excise_tax.convert_quantity( + product, product.quantity) + return quantities + + @classmethod + def get_input(cls, declarations, names): + pool = Pool() + Location = pool.get('stock.location') + Move = pool.get('stock.move') + transaction = Transaction() + context = transaction.context + cursor = transaction.connection.cursor() + + move = Move.__table__() + location = Location.__table__() + quantities = defaultdict(lambda: defaultdict(float)) + id2declaration = {d.id: d for d in declarations} + + warehouse = With('id', query=Location.search([ + ('parent', 'child_of', [context.get('warehouse', -1)]), + ], order=[], query=True)) + + where = move.state == 'done' + where &= move.company == context.get('company', -1) + where &= move.effective_date >= context.get('from_date') + where &= move.effective_date <= context.get('to_date') + where &= (~move.from_location.in_( + warehouse.select(warehouse.id)) + & move.to_location.in_( + warehouse.select(warehouse.id))) + + quantity = move.internal_quantity + columns = cls._input_columns(quantity, move, location) + others = columns[0].expression # total + for qty in columns[1:]: + others -= qty.expression + columns.append(others.as_('input_other')) + query = (move + .join(location, + condition=move.from_location == location.id) + .select( + move.product.as_('id'), + *columns, + group_by=[move.product], + with_=warehouse)) + declaration_ids = [s.id for s in declarations] + query.where = where & fields.SQL_OPERATORS['in']( + move.product, declaration_ids) + cursor.execute(*query) + for values in cursor_dict(cursor): + declaration = id2declaration[values['id']] + for name in names: + if qty := values[name]: + quantities[name][values['id']] = ( + declaration.eu_excise_tax.convert_quantity( + declaration.product, qty)) + return quantities + + @classmethod + def _input_columns(cls, quantity, move, location): + return [ + Sum(quantity).as_('input_total'), + Sum(Case( + (location.type == 'production', quantity), + else_=0)).as_('input_production'), + Sum(Case( + (~location.type.in_(['production', 'lost_found']) + & (move.eu_excise_duty != Null), + quantity), + else_=0)).as_('input_duty_suspension'), + Sum(Case( + (~location.type.in_(['production', 'lost_found']) + & (move.eu_excise_duty == Null), + quantity), + else_=0)).as_('input_replacement'), + ] + + @classmethod + def get_output(cls, declarations, names): + pool = Pool() + Location = pool.get('stock.location') + Move = pool.get('stock.move') + transaction = Transaction() + context = transaction.context + cursor = transaction.connection.cursor() + + move = Move.__table__() + location = Location.__table__() + quantities = defaultdict(lambda: defaultdict(float)) + id2declaration = {d.id: d for d in declarations} + + warehouse = With('id', query=Location.search([ + ('parent', 'child_of', [context.get('warehouse', -1)]), + ], order=[], query=True)) + + where = move.state == 'done' + where &= move.company == context.get('company', -1) + where &= move.effective_date >= context.get('from_date') + where &= move.effective_date <= context.get('to_date') + where &= (move.from_location.in_( + warehouse.select(warehouse.id)) + & ~move.to_location.in_( + warehouse.select(warehouse.id))) + + quantity = move.internal_quantity + columns = cls._output_columns(quantity, move, location) + others = columns[0].expression # total + for qty in columns[1:]: + others -= qty.expression + columns.append(others.as_('output_other')) + query = (move + .join(location, + condition=move.to_location == location.id) + .select( + move.product.as_('id'), + *columns, + group_by=[move.product], + with_=warehouse)) + declaration_ids = [s.id for s in declarations] + query.where = where & fields.SQL_OPERATORS['in']( + move.product, declaration_ids) + cursor.execute(*query) + for values in cursor_dict(cursor): + declaration = id2declaration[values['id']] + for name in names: + if qty := values[name]: + quantities[name][values['id']] = ( + declaration.eu_excise_tax.convert_quantity( + declaration.product, qty)) + return quantities + + @classmethod + def _output_columns(cls, quantity, move, location): + return [ + Sum(quantity).as_('output_total'), + Sum(Case( + (~location.type.in_(['production', 'lost_found']) + & (move.eu_excise_duty == Null), + quantity), + else_=0)).as_('output_with_duty'), + Sum(Case( + (location.type == 'production', quantity), + else_=0)).as_('output_production'), + Sum(Case( + (~location.type.in_(['production', 'lost_found']) + & (move.eu_excise_duty == 'suspension'), + quantity), + else_=0)).as_('output_duty_suspension'), + Sum(Case( + (~location.type.in_(['production', 'lost_found']) + & (move.eu_excise_duty == 'free'), + quantity), + else_=0)).as_('output_duty_free'), + ] + + def get_rec_name(self, name): + return self.product.rec_name + + +class ExciseDeclarationProductLine(ModelSQL, ModelView): + __name__ = 'account.stock.eu.excise.declaration.product.line' + + company = fields.Many2One('company.company', "Company") + product = fields.Many2One( + 'product.product', "Product", + context={ + 'company': Eval('company', -1), + }, + depends=['company']) + eu_excise_code = fields.Function( + fields.Many2One('product.eu.excise_code', "Excise Code"), + 'on_change_with_eu_excise_code') + eu_excise_tax = fields.Function( + fields.Many2One('account.stock.eu.excise.tax', "Excise Tax"), + 'on_change_with_eu_excise_tax') + unit = fields.Function( + fields.Many2One('product.uom', "Unit"), + 'on_change_with_unit') + date = fields.Date("Date") + move = fields.Many2One('stock.move', "Move") + location = fields.Many2One('stock.location', "Location") + origin = fields.Reference("Origin", selection='get_origin') + document = fields.Function( + fields.Reference("Document", selection='get_documents'), + 'get_document') + internal_quantity = fields.Float("Internal Quantity") + quantity = fields.Function( + fields.Float("Quantity", digits='unit'), 'get_quantity') + duty = fields.Selection([ + (None, ""), + ('suspension', "Suspension"), + ('free', "Free"), + ], "Duty") + direction = fields.Selection([ + ('input', "Input"), + ('output', "Output"), + ], "Direction") + + @classmethod + def __setup__(cls): + super().__setup__() + cls._order.insert(0, ('date', 'ASC')) + + @classmethod + def table_query(cls): + pool = Pool() + Move = pool.get('stock.move') + Location = pool.get('stock.location') + context = Transaction().context + + move = Move.__table__() + + warehouse = With('id', query=Location.search([ + ('parent', 'child_of', [context.get('warehouse', -1)]), + ], order=[], query=True)) + + where = move.state == 'done' + where &= move.company == context.get('company', -1) + where &= move.effective_date >= context.get('from_date') + where &= move.effective_date <= context.get('to_date') + return Union(move + .select( + move.id.as_('id'), + *cls._columns(move), + Literal('input').as_('direction'), + move.from_location.as_('location'), + where=where + & (~move.from_location.in_( + warehouse.select(warehouse.id)) + & move.to_location.in_( + warehouse.select(warehouse.id)))) + | move + .select( + move.id.as_('id'), + *cls._columns(move, -1), + Literal('output').as_('direction'), + move.to_location.as_('location'), + where=where + & (move.from_location.in_( + warehouse.select(warehouse.id)) + & ~move.to_location.in_( + warehouse.select(warehouse.id)))), + with_=warehouse) + + @classmethod + def _columns(cls, move, sign=1): + return [ + move.company.as_('company'), + move.product.as_('product'), + move.effective_date.as_('date'), + move.id.as_('move'), + move.origin.as_('origin'), + (Literal(sign) * move.internal_quantity).as_('internal_quantity'), + move.eu_excise_duty.as_('duty'), + ] + + @fields.depends('product') + def on_change_with_eu_excise_code(self, name=None): + if self.product: + return self.product.eu_excise_code + + @fields.depends('product') + def on_change_with_eu_excise_tax(self, name=None): + pool = Pool() + Location = pool.get('stock.location') + context = Transaction().context + if self.product: + country = None + if warehouse := context.get('warehouse'): + warehouse = Location(warehouse) + if warehouse.address and warehouse.address.country: + country = warehouse.address.country + return self.product.get_eu_excise_tax(country) + + @fields.depends('eu_excise_tax') + def on_change_with_unit(self, name=None): + if self.eu_excise_tax: + return self.eu_excise_tax.uom + + @classmethod + def get_origin(cls): + pool = Pool() + Move = pool.get('stock.move') + return Move.get_origin() + + @classmethod + def _get_document_models(cls): + pool = Pool() + Move = pool.get('stock.move') + return [m for m, _ in Move.get_shipment() if m] + ['stock.inventory'] + + @classmethod + def get_documents(cls): + pool = Pool() + Model = pool.get('ir.model') + get_name = Model.get_name + models = cls._get_document_models() + return [(None, '')] + [(m, get_name(m)) for m in models] + + def get_document(self, name): + pool = Pool() + InventoryLine = pool.get('stock.inventory.line') + if self.move: + if self.move.shipment: + return str(self.move.shipment) + elif isinstance(self.move.origin, InventoryLine): + return str(self.move.origin.inventory) + + def get_quantity(self, name): + if self.eu_excise_tax: + return self.eu_excise_tax.convert_quantity( + self.product, self.internal_quantity) + + +class ExciseDeclarationProductLine_Production(metaclass=PoolMeta): + __name__ = 'account.stock.eu.excise.declaration.product.line' + + @classmethod + def _get_document_models(cls): + return super()._get_document_models() + ['production'] + + def get_document(self, name): + document = super().get_document(name) + if self.move and self.move.production: + document = str(self.move.production) + return document diff --git a/modules/account_stock_eu_excise/account_stock_eu.xml b/modules/account_stock_eu_excise/account_stock_eu.xml new file mode 100644 index 0000000000..64aa81a0d7 --- /dev/null +++ b/modules/account_stock_eu_excise/account_stock_eu.xml @@ -0,0 +1,310 @@ + + + + + + account.stock.eu.excise.tax + form + account_stock_eu_excise_tax_form + + + + account.stock.eu.excise.tax + tree + account_stock_eu_excise_tax_list + + + + Excise Taxes + account.stock.eu.excise.tax + + + + + + + + + + + + + + + + account.stock.eu.excise.tax + + + + + + + account.stock.eu.excise.tax + + + + + + + + + account.stock.eu.excise.tax.rate + form + account_stock_eu_excise_tax_rate_form + + + + account.stock.eu.excise.tax.rate + tree + account_stock_eu_excise_tax_rate_list + + + + account.stock.eu.excise.declaration.context + form + account_stock_eu_excise_declaration_context_form + + + + account.stock.eu.excise.declaration + tree + account_stock_eu_excise_declaration_list + + + + account.stock.eu.excise.declaration + form + account_stock_eu_excise_declaration_form + + + + Excise Declarations + account.stock.eu.excise.declaration + account.stock.eu.excise.declaration.context + + + + + + + + + + + + + + + + account.stock.eu.excise.declaration + + + + + + + + account.stock.eu.excise.declaration + + + + + + + + + User in companies + account.stock.eu.excise.declaration + + + + + + + + + account.stock.eu.excise.declaration.product + tree + account_stock_eu_excise_declaration_product_list + + + + account.stock.eu.excise.declaration.product + form + account_stock_eu_excise_declaration_product_form + + + + Excise Declaration Products + account.stock.eu.excise.declaration.product + account.stock.eu.excise.declaration.context + + + + + + + + + + + + + + form_relate + account.stock.eu.excise.declaration,-1 + + + + + + + account.stock.eu.excise.declaration.product + + + + + + + + account.stock.eu.excise.declaration.product + + + + + + + + + User in companies + account.stock.eu.excise.declaration.product + + + + + + + + + account.stock.eu.excise.declaration.product.line + tree + account_stock_eu_excise_declaration_product_line_list + + + + Excise Declaration Product Lines + account.stock.eu.excise.declaration.product.line + account.stock.eu.excise.declaration.context + + + + + + + + + All + + + + + Input Production + + + + + + Input Duty Suspension + + + + + + Input Replacement + + + + + + Input Other + + + + + + Output Production + + + + + + Output Duty Suspension + + + + + + Output Duty Free + + + + + + Output with Duty + + + + + + Output Other + + + + + + form_relate + account.stock.eu.excise.declaration.product,-1 + + + + + account.stock.eu.excise.declaration.product.line + + + + + + + + account.stock.eu.excise.declaration.product.line + + + + + + + + + User in companies + account.stock.eu.excise.declaration.product.line + + + + + + + + diff --git a/modules/account_stock_eu_excise/doc/conf.py b/modules/account_stock_eu_excise/doc/conf.py new file mode 100644 index 0000000000..0926808fe2 --- /dev/null +++ b/modules/account_stock_eu_excise/doc/conf.py @@ -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(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/account_stock_eu_excise/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 diff --git a/modules/account_stock_eu_excise/doc/design.rst b/modules/account_stock_eu_excise/doc/design.rst new file mode 100644 index 0000000000..caa5dcc087 --- /dev/null +++ b/modules/account_stock_eu_excise/doc/design.rst @@ -0,0 +1,162 @@ +****** +Design +****** + +The *Account Stock EU Excise Module* introduces and extends the following +concepts: + +.. _model-account.stock.eu.excise.tax: + +Excise Tax +========== + +The excise tax defines the rates and the `unit ` to +calculate the duties per `country `. + +.. seealso:: + + The excise taxes can be found by opening the main menu item: + + |Financial --> Configuration --> Taxes --> Excise Taxes|__ + + .. |Financial --> Configuration --> Taxes --> Excise Taxes| replace:: :menuselection:`Financial --> Configuration --> Taxes --> Excise Taxes` + __ https://demo.tryton.org/model/account.stock.eu.excise.tax + +.. _model-account.stock.eu.excise.declaration: + +Excise Declaration +================== + +The *Excise Declaration* shows the quantities of input and output per `Excise +Tax ` for a `Warehouse +` over a period. + +.. seealso:: + + The excise declarations can be opened using the main menu item: + + |Financial --> Reporting --> Excise Declarations|__ + + .. |Financial --> Reporting --> Excise Declarations| replace:: :menuselection:`Financial --> Reporting --> Excise Declarations` + __ https://demo.tryton.org/model/account.stock.eu.excise.declaration + +.. _model-account.stock.eu.excise.declaration.product: + +Excise Declaration Product +========================== + +The *Excise Declaration Product* shows the same quantities as the `Excise +Declaration ` but per `Product +`. + +.. seealso:: + + The excise declaration products can be opened using the main menu item: + + |Financial --> Reporting --> Excise Declaration Products|__ + + .. |Financial --> Reporting --> Excise Declaration Products| replace:: :menuselection:`Financial --> Reporting --> Excise Declaration Products` + __ https://demo.tryton.org/model/account.stock.eu.excise.declaration.product + +.. _model-account.stock.eu.excise.declaration.product.line: + +Excise Declaration Product Lines +================================ + +The *Excise Declaration Product Lines* shows the `stock moves +` used to calculate the quantities for the related +`Excise Declaration Product +`. + +.. seealso:: + + The excise declaration product lines can be opened from the link on the + `Excise Declaration Product + `. + +.. _model-party.identifier: + +Party Identifier +================ + +The party identifier with an excise number type is extended to specify the +excise codes for which it is authorised. + +.. seealso:: + + The `Party Identifier ` concept is introduced + by the :doc:`Party Module `. + +.. _concept-product: + +Product +======= + +When the *Account Stock EU Excise Module* is activated, the product gains new +properties to specifying the `Excise Code ` and +the `Excise Taxes ` applicable to +the goods per `country `. + +.. seealso:: + + The `Product ` concept is introduced by the + :doc:`Product Module `. + +.. _model-product.eu.excise_code: + +Excise Code +=========== + +The excise code stores the codes from the `System for Exchange of Excise Data +`_. + +.. seealso:: + + A list of excise codes can be found by opening the main menu item: + + |Products --> Configuration --> Excise Codes|__ + + .. |Products --> Configuration --> Excise Codes| replace:: :menuselection:`Products --> Configuration --> Excise Codes` + __ https://demo.tryton.org/model/product.eu.excise_code + + +.. _concept-stock.location.warehouse: + +Warehouse +========= + +When the *Account Stock EU Excise Module* is activated, the warehouse gains a +property that stores the `Excise Numbers ` per `Company +`. + +.. seealso:: + + The `Warehouse ` concept is + introduced by the :doc:`Stock Module `. + +.. _concept-stock.shipment: + +Shipment +======== + +When the *Account Stock EU Excise Module* is activated, the shipments gain new +properties that stores information for the excise duties like the `Excise +Number ` of the other party. + +.. seealso:: + + The `Shipment ` concept is introduced by the + :doc:`Stock Module `. + +.. _model-stock.move: + +Stock Move +========== + +When the *Account Stock EU Excise Module* is activated, the stock move stores +the type of excise duty that applies. + +.. seealso:: + + The `Stock Move ` concept is introduced by the + :doc:`Stock Module `. diff --git a/modules/account_stock_eu_excise/doc/index.rst b/modules/account_stock_eu_excise/doc/index.rst new file mode 100644 index 0000000000..37c00e415c --- /dev/null +++ b/modules/account_stock_eu_excise/doc/index.rst @@ -0,0 +1,13 @@ +############################## +Account Stock EU Excise Module +############################## + +The *Account Stock EU Excise Module* is used to generate the `excise duties +`_ declaration +for European countries. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/account_stock_eu_excise/doc/releases.rst b/modules/account_stock_eu_excise/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_stock_eu_excise/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_stock_eu_excise/doc/requirements-doc.txt b/modules/account_stock_eu_excise/doc/requirements-doc.txt new file mode 100644 index 0000000000..06b8565f6b --- /dev/null +++ b/modules/account_stock_eu_excise/doc/requirements-doc.txt @@ -0,0 +1,3 @@ +build +sphinx_book_theme +sphinx_copybutton diff --git a/modules/account_stock_eu_excise/exceptions.py b/modules/account_stock_eu_excise/exceptions.py new file mode 100644 index 0000000000..801fcd7bf7 --- /dev/null +++ b/modules/account_stock_eu_excise/exceptions.py @@ -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.model.exceptions import ValidationError + + +class FormulaError(ValidationError): + pass diff --git a/modules/account_stock_eu_excise/icons/LICENSE b/modules/account_stock_eu_excise/icons/LICENSE new file mode 100644 index 0000000000..7a4a3ea242 --- /dev/null +++ b/modules/account_stock_eu_excise/icons/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/modules/account_stock_eu_excise/message.xml b/modules/account_stock_eu_excise/message.xml new file mode 100644 index 0000000000..d3d038f120 --- /dev/null +++ b/modules/account_stock_eu_excise/message.xml @@ -0,0 +1,16 @@ + + + + + + Only one excise number is allowed for a warehouse per company. + + + Only one excise tax per country can be applied to a product. + + + Invalid formula "%(formula)s" in excise tax rate "%(tax_rate)s" with exception "%(exception)s". + + + diff --git a/modules/account_stock_eu_excise/party.py b/modules/account_stock_eu_excise/party.py new file mode 100644 index 0000000000..dc1e940d4c --- /dev/null +++ b/modules/account_stock_eu_excise/party.py @@ -0,0 +1,67 @@ +# 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 sql import Literal + +from trytond.model import ModelSQL, fields +from trytond.pool import PoolMeta +from trytond.pyson import Eval + +IDENTIFIER_TYPES = [ + ('eu_excise', "European Excise Number"), + ('fr_excise', "French Excise Number"), + ] + +EXCISE_IDENTIFIER_TYPES = list(dict(IDENTIFIER_TYPES).keys()) + + +class Configuration(metaclass=PoolMeta): + __name__ = 'party.configuration' + + @classmethod + def __setup__(cls): + super().__setup__() + cls.identifier_types.selection.extend(IDENTIFIER_TYPES) + + +class Address(metaclass=PoolMeta): + __name__ = 'party.address' + + @classmethod + def _type_identifiers(cls): + return super()._type_identifiers() | set(EXCISE_IDENTIFIER_TYPES) + + +class Identifier(metaclass=PoolMeta): + __name__ = 'party.identifier' + + eu_excise_codes = fields.Many2Many( + 'party.identifier-product.eu.excise_code', + 'identifier', 'excise_code', "Excise Codes", + states={ + 'invisible': ~Eval('type').in_(EXCISE_IDENTIFIER_TYPES), + }, + help="Authorized codes for the excise number.") + + @classmethod + def _type_addresses(cls): + return super()._type_addresses() | set(EXCISE_IDENTIFIER_TYPES) + + def is_excise_product(self, product): + return product.eu_excise_code in self.eu_excise_codes + + def is_excise_product_sql(self, product, template): + if self.eu_excise_codes: + return template.eu_excise_code.in_( + [c.id for c in self.eu_excise_codes]) + else: + return Literal(False) + + +class Identifier_EUExciseCode(ModelSQL): + __name__ = 'party.identifier-product.eu.excise_code' + + identifier = fields.Many2One( + 'party.identifier', "Identifier", required=True, ondelete='CASCADE') + excise_code = fields.Many2One( + 'product.eu.excise_code', "Excise Code", required=True) diff --git a/modules/account_stock_eu_excise/party.xml b/modules/account_stock_eu_excise/party.xml new file mode 100644 index 0000000000..564f3c10bd --- /dev/null +++ b/modules/account_stock_eu_excise/party.xml @@ -0,0 +1,12 @@ + + + + + + party.identifier + + party_identifier_form + + + diff --git a/modules/account_stock_eu_excise/product.py b/modules/account_stock_eu_excise/product.py new file mode 100644 index 0000000000..ca38a9c0ba --- /dev/null +++ b/modules/account_stock_eu_excise/product.py @@ -0,0 +1,107 @@ +# 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.model import DeactivableMixin, ModelSQL, ModelView, Unique, fields +from trytond.pool import PoolMeta +from trytond.pyson import Bool, Eval, If + + +class Template(metaclass=PoolMeta): + __name__ = 'product.template' + + eu_excise_code = fields.Many2One( + 'product.eu.excise_code', "Excise Code", + states={ + 'invisible': Eval('type') != 'goods', + }) + eu_excise_taxes = fields.One2Many( + 'product-account.stock.eu.excise.tax', 'template', "Excise Tax", + states={ + 'invisible': ( + (Eval('type') != 'goods') + | ~Eval('eu_excise_code')), + }) + + def get_eu_excise_tax(self, country): + for line in self.eu_excise_taxes: + if line.country == country: + return line.excise_tax + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('//page[@id="eu_excise"]', 'states', { + 'invisible': Eval('type') != 'goods', + }), + ] + + +class Product(metaclass=PoolMeta): + __name__ = 'product.product' + + def get_eu_excise_tax(self, country): + return self.template.get_eu_excise_tax(country) + + +class EUExciseCode(DeactivableMixin, ModelSQL, ModelView): + __name__ = 'product.eu.excise_code' + _rec_name = 'code' + + code = fields.Char( + "Code", required=True, + help="The code from the System for Exchange of Excise Data") + description = fields.Char('Description', translate=True) + + @classmethod + def __setup__(cls): + cls.code.search_unaccented = False + super().__setup__() + cls._order.insert(0, ('code', 'ASC')) + + +class Product_EUExciseTax(ModelSQL, ModelView): + __name__ = 'product-account.stock.eu.excise.tax' + + template = fields.Many2One( + 'product.template', "Product", required=True, ondelete='CASCADE') + excise_tax = fields.Many2One( + 'account.stock.eu.excise.tax', "Tax", required=True, + domain=[ + If(Eval('country'), + ('country', '=', Eval('country', -1)), + ()), + ]) + country = fields.Many2One( + 'country.country', "Country", required=True, + states={ + 'readonly': Bool(Eval('excise_tax')), + }) + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.add('template') + t = cls.__table__() + cls._sql_constraints += [ + ('template_country_unique', Unique(t, t.template, t.country), + 'account_stock_eu_excise.' + 'msg_excise_tax_template_country_unique'), + ] + cls._order.insert(0, ('country', None)) + + @fields.depends('excise_tax') + def on_change_excise_tax(self): + if self.excise_tax: + self.country = self.excise_tax.country + + @fields.depends('excise_tax') + def on_change_with_country(self, name=None): + if self.excise_tax: + return self.excise_tax.country + + def get_rec_name(self, name): + return self.excise_tax.rec_name + + @classmethod + def search_rec_name(cls, name, clause): + return [('excise_tax.rec_name', *clause[1:])] diff --git a/modules/account_stock_eu_excise/product.xml b/modules/account_stock_eu_excise/product.xml new file mode 100644 index 0000000000..39993fe775 --- /dev/null +++ b/modules/account_stock_eu_excise/product.xml @@ -0,0 +1,88 @@ + + + + + + product.template + + product_template_form + + + + product.template + eu_excise_code + + + + + product.template + eu_excise_code + + + + + + + product.eu.excise_code + form + product_eu_excise_code_form + + + + product.eu.excise_code + tree + product_eu_excise_code_list + + + + Excise Codes + product.eu.excise_code + + + + + + + + + + + + + + + + product.eu.excise_code + + + + + + + product.eu.excise_code + + + + + + + + + product-account.stock.eu.excise.tax + tree + + product-account_stock_eu_excise_tax_list + + + + product-account.stock.eu.excise.tax + form + product-account_stock_eu_excise_tax_form + + + diff --git a/modules/account_stock_eu_excise/pyproject.toml b/modules/account_stock_eu_excise/pyproject.toml new file mode 100644 index 0000000000..493035b762 --- /dev/null +++ b/modules/account_stock_eu_excise/pyproject.toml @@ -0,0 +1,65 @@ +[build-system] +requires = ['hatchling >= 1', 'hatch-tryton'] +build-backend = 'hatchling.build' + +[project] +name = 'trytond_account_stock_eu_excise' +dynamic = ['version', 'dependencies', 'optional-dependencies', 'authors', 'readme'] +requires-python = '>=3.10' +maintainers = [ + {name = "Tryton", email = "foundation@tryton.org"}, + ] +description = "European excise for Tryton" +license = 'GPL-3.0-or-later' +license-files = ['LICENSE', 'icons/LICENSE', 'COPYRIGHT'] +keywords = ["tryton", "account", "stock", "european", "excise"] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Environment :: Plugins", + "Framework :: Tryton", + "Topic :: Office/Business", + "Topic :: Office/Business :: Financial :: Accounting", + "Topic :: Software Development :: Libraries :: Python Modules", + ] + +[project.entry-points.'trytond.modules'] +account_stock_eu_excise = 'trytond.modules.account_stock_eu_excise' + +[project.urls] +homepage = "https://www.tryton.org/" +documentation = "https://docs.tryton.org/modules-account-stock-eu-excise/" +changelog = "https://docs.tryton.org/modules-account-stock-eu-excise/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/account_stock_eu_excise" + +[tool.hatch.metadata.hooks.tryton] +dependencies = [ + 'python-dateutil', + 'python-sql', + 'python-stdnum >= 2.2', + 'simpleeval', + ] +copyright = 'COPYRIGHT' +readme = 'README.rst' + +[tool.hatch.metadata.hooks.tryton.tryton-optional-dependencies] +test = ['proteus'] diff --git a/modules/account_stock_eu_excise/stock.py b/modules/account_stock_eu_excise/stock.py new file mode 100644 index 0000000000..0e97e670b8 --- /dev/null +++ b/modules/account_stock_eu_excise/stock.py @@ -0,0 +1,312 @@ +# 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.model import ModelSQL, ModelView, Unique, fields +from trytond.pool import Pool, PoolMeta +from trytond.pyson import Eval, If +from trytond.transaction import Transaction + +from .party import EXCISE_IDENTIFIER_TYPES, IDENTIFIER_TYPES + + +class Location(metaclass=PoolMeta): + __name__ = 'stock.location' + + eu_excise_numbers = fields.One2Many( + 'stock.location.eu_excise_number', + 'warehouse', "Excise Number", + states={ + 'invisible': Eval('type') != 'warehouse', + }) + + def get_eu_excise_number(self, company): + for excise_number in self.eu_excise_numbers: + if excise_number.company == company: + return excise_number.eu_excise_number + + +class WarehouseEUExciseNumber(ModelSQL, ModelView): + __name__ = 'stock.location.eu_excise_number' + + company = fields.Many2One( + 'company.company', "Company", required=True, ondelete='CASCADE') + warehouse = fields.Many2One( + 'stock.location', "Warehouse", required=True, ondelete='CASCADE', + domain=[ + ('type', '=', 'warehouse'), + ], + context={ + 'company': Eval('company', -1), + }, + depends=['company']) + eu_excise_number = fields.Many2One( + 'party.identifier', "Excise Number", required=True, + domain=[ + ('type', 'in', EXCISE_IDENTIFIER_TYPES), + ('party', '=', Eval('company_party', -1)), + ('address', '=', Eval('warehouse_address', -1)), + ]) + company_party = fields.Function( + fields.Many2One( + 'party.party', "Company Party", + context={ + 'company': Eval('company', -1), + }, + depends={'company'}), + 'on_change_with_company_party') + warehouse_address = fields.Function( + fields.Many2One('party.address', "Warehouse Address"), + 'on_change_with_warehouse_address') + + @classmethod + def __setup__(cls): + super().__setup__() + t = cls.__table__() + cls.__access__.add('warehouse') + cls._sql_constraints += [ + ('warehouse_company_unique', + Unique(t, t.warehouse, t.company), + 'account_stock_eu_excise.msg_warehouse_excise_company_unique'), + ] + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @fields.depends('company') + def on_change_with_company_party(self, name=None): + return self.company.party if self.company else None + + @fields.depends('warehouse', '_parent_warehouse.address') + def on_change_with_warehouse_address(self, name=None): + return self.warehouse.address if self.warehouse else None + + +class ShipmentEUExciseMixin: + __slots__ = () + + warehouse_eu_excise_number = fields.Function( + fields.Many2One('party.identifier', "Warehouse Excise Number"), + 'on_change_with_warehouse_eu_excise_number') + eu_excise_number = fields.Many2One( + 'party.identifier', "Excise Number", + domain=[ + ('type', 'in', Eval('eu_excise_types', [])), + ('party', '=', Eval('eu_excise_party', -1)), + ], + states={ + 'invisible': ( + ~Eval('warehouse_eu_excise_number') + | ~Eval('has_eu_excise_goods')), + }) + eu_excise_types = fields.Function( + fields.MultiSelection(IDENTIFIER_TYPES, "Excise Types"), + 'on_change_with_eu_excise_types') + eu_excise_party = fields.Function( + fields.Many2One( + 'party.party', "Excise Party", + context={ + 'company': Eval('company', -1), + }, + depends=['company']), + 'on_change_with_eu_excise_party') + has_eu_excise_goods = fields.Function( + fields.Boolean("Has Excise Goods"), + 'on_change_with_has_eu_excise_goods') + + @fields.depends('warehouse', 'company') + def on_change_with_warehouse_eu_excise_number(self, name=None): + if self.warehouse: + return self.warehouse.get_eu_excise_number(self.company) + + @fields.depends('warehouse_eu_excise_number') + def on_change_with_eu_excise_types(self, name=None): + types = set() + if self.warehouse_eu_excise_number: + types.add('eu_excise') + types.add(self.warehouse_eu_excise_number.type) + return list(types) + + def on_change_with_eu_excise_party(self, name=None): + raise NotImplementedError + + @fields.depends(methods=['eu_excise_moves']) + def on_change_with_has_eu_excise_goods(self, name=None): + if self.warehouse_eu_excise_number: + excise_number = self.warehouse_eu_excise_number + for move in self.eu_excise_moves: + if (move.product + and excise_number.is_excise_product(move.product)): + return True + return False + + @property + def eu_excise_moves(self): + "The moves on which the excise duty may apply" + raise NotImplementedError + + @classmethod + def on_modification(cls, mode, shipments, field_names=None): + super().on_modification(mode, shipments, field_names=field_names) + cls._sync_eu_excise_duty(shipments) + + @classmethod + def _sync_eu_excise_duty(cls, shipments): + pool = Pool() + Move = pool.get('stock.move') + moves = [] + for shipment in shipments: + warehouse_excise_number = shipment.warehouse_eu_excise_number + excise_number = shipment.eu_excise_number + for move in shipment.eu_excise_moves: + excise_duty = None + if warehouse_excise_number and excise_number: + if (warehouse_excise_number.is_excise_product(move.product) + and excise_number.is_excise_product(move.product)): + # TODO: free + excise_duty = 'suspension' + if move.eu_excise_duty != excise_duty: + move.eu_excise_duty = excise_duty + moves.append(move) + Move.save(moves) + + +class ShipmentIn(ShipmentEUExciseMixin, metaclass=PoolMeta): + __name__ = 'stock.shipment.in' + + @fields.depends('supplier') + def on_change_with_eu_excise_party(self, name=None): + return self.supplier + + @property + @fields.depends('incoming_moves') + def eu_excise_moves(self): + return self.incoming_moves + + +class ShipmentInReturn(ShipmentEUExciseMixin, metaclass=PoolMeta): + __name__ = 'stock.shipment.in.return' + + @classmethod + def __setup__(cls): + super().__setup__() + cls.eu_excise_number.domain = [ + cls.eu_excise_number.domain, + ('address', '=', Eval('delivery_address', -1)), + ] + + @fields.depends('supplier') + def on_change_with_eu_excise_party(self, name=None): + return self.supplier + + @property + @fields.depends('moves') + def eu_excise_moves(self): + return self.moves + + +class ShipmentOut(ShipmentEUExciseMixin, metaclass=PoolMeta): + __name__ = 'stock.shipment.out' + + @classmethod + def __setup__(cls): + super().__setup__() + cls.eu_excise_number.domain = [ + cls.eu_excise_number.domain, + ('address', '=', Eval('delivery_address', -1)), + ] + + @fields.depends('customer') + def on_change_with_eu_excise_party(self, name=None): + return self.customer + + @property + @fields.depends('outgoing_moves') + def eu_excise_moves(self): + return self.outgoing_moves + + +class ShipmentOutReturn(ShipmentEUExciseMixin, metaclass=PoolMeta): + __name__ = 'stock.shipment.out.return' + + @fields.depends('customer') + def on_change_with_eu_excise_party(self, name=None): + return self.customer + + @property + @fields.depends('incoming_moves') + def eu_excise_moves(self): + return self.incoming_moves + + +class ShipmentInternal(metaclass=PoolMeta): + __name__ = 'stock.shipment.internal' + + @classmethod + def on_modification(cls, mode, shipments, field_names=None): + super().on_modification(mode, shipments, field_names=field_names) + cls._sync_eu_excise_duty(shipments) + + @classmethod + def _sync_eu_excise_duty(cls, shipments): + pool = Pool() + Move = pool.get('stock.move') + moves = [] + for shipment in shipments: + if (shipment.from_location.warehouse + == shipment.to_location.warehouse): + continue + if from_warehouse := shipment.from_location.warehouse: + from_excise_number = from_warehouse.get_eu_excise_number( + shipment.company) + else: + from_excise_number = None + if to_warehouse := shipment.to_location.warehouse: + to_excise_number = to_warehouse.get_eu_excise_number( + shipment.company) + else: + to_excise_number = None + for move in shipment.moves: + excise_duty = None + if (from_excise_number and to_excise_number + and from_excise_number != to_excise_number): + if (from_excise_number.is_excise_product(move.product) + and to_excise_number.is_excise_product( + move.product)): + # TODO: free + excise_duty = 'suspension' + if move.eu_excise_duty != excise_duty: + move.eu_excise_duty = excise_duty + moves.append(move) + Move.save(moves) + + +class Move(metaclass=PoolMeta): + __name__ = 'stock.move' + + eu_excise_duty = fields.Selection([ + (None, ""), + ('suspension', "Suspension"), + ('free', "Free"), + ], "Excise Duty", readonly=True, + domain=[If(~Eval('eu_excise_duty_applicable', False), + ('eu_excise_duty', '=', None), + ()), + ], + states={ + 'invisible': ~Eval('eu_excise_duty_applicable'), + }) + eu_excise_duty_applicable = fields.Function( + fields.Boolean("Excise Duty Applicable"), + 'on_change_with_eu_excise_duty_applicable') + + @fields.depends('from_location', 'to_location', 'company') + def on_change_with_eu_excise_duty_applicable(self, name=None): + if not self.from_location or not self.to_location: + return False + if self.from_location.warehouse == self.to_location.warehouse: + return False + if (self.from_location.type not in {'storage', 'view'} + and self.to_location.type not in {'storage', 'view'}): + return False + return True diff --git a/modules/account_stock_eu_excise/stock.xml b/modules/account_stock_eu_excise/stock.xml new file mode 100644 index 0000000000..adaa944e17 --- /dev/null +++ b/modules/account_stock_eu_excise/stock.xml @@ -0,0 +1,48 @@ + + + + + + stock.location + + stock_location_form + + + + stock.location.eu_excise_number + form + stock_location_eu_excise_number_form + + + + stock.location.eu_excise_number + tree + stock_location_eu_excise_number_list + + + + stock.shipment.in + + stock_shipment_in_form + + + + stock.shipment.in.return + + stock_shipment_in_return_form + + + + stock.shipment.out + + stock_shipment_out_form + + + + stock.shipment.out.return + + stock_shipment_out_return_form + + + diff --git a/modules/account_stock_eu_excise/tests/__init__.py b/modules/account_stock_eu_excise/tests/__init__.py new file mode 100644 index 0000000000..4effdfa4a2 --- /dev/null +++ b/modules/account_stock_eu_excise/tests/__init__.py @@ -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. diff --git a/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise.rst b/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise.rst new file mode 100644 index 0000000000..0019a05bf8 --- /dev/null +++ b/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise.rst @@ -0,0 +1,101 @@ +================================ +Account Stock EU Excise Scenario +================================ + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model + >>> from trytond.modules.company.tests.tools import create_company, get_company + >>> from trytond.tests.tools import activate_modules, assertEqual + +Activate modules:: + + >>> config = activate_modules('account_stock_eu_excise') + + >>> ExciseCode = Model.get('product.eu.excise_code') + >>> Location = Model.get('stock.location') + >>> Party = Model.get('party.party') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> ShipmentIn = Model.get('stock.shipment.in') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Setup tax warehouse:: + + >>> excise_code = ExciseCode(code='W200') + >>> excise_code.save() + + >>> company_party = company.party + >>> excise_number = company_party.identifiers.new(type='eu_excise') + >>> excise_number.address, = company_party.addresses + >>> excise_number.code = "LU00000987ABC" + >>> excise_number.eu_excise_codes.append(ExciseCode(excise_code.id)) + >>> company_party.save() + >>> excise_number, = company_party.identifiers + + >>> warehouse, = Location.find([('code', '=', 'WH')]) + >>> warehouse.address, = company_party.addresses + >>> wh_excise_number = warehouse.eu_excise_numbers.new() + >>> wh_excise_number.eu_excise_number = excise_number + >>> warehouse.save() + +Create supplier:: + + >>> supplier = Party(name="Supplier") + >>> supplier.save() + >>> supplier_excise_number = supplier.identifiers.new(type='eu_excise') + >>> supplier_excise_number.address, = supplier.addresses + >>> supplier_excise_number.code = "LU00000987DEF" + >>> supplier_excise_number.eu_excise_codes.append(ExciseCode(excise_code.id)) + >>> supplier.save() + >>> supplier_excise_number, = supplier.identifiers + +Create product:: + + >>> liter, = ProductUom.find([('name', '=', "Liter")]) + + >>> template = ProductTemplate() + >>> template.name = "Wine" + >>> template.default_uom = liter + >>> template.type = 'goods' + >>> template.list_price = Decimal('20.0000') + >>> template.eu_excise_code = excise_code + >>> template.save() + >>> product, = template.products + +Create a shipment without duty suspension:: + + >>> shipment = ShipmentIn() + >>> shipment.supplier = supplier + >>> assertEqual(shipment.warehouse_eu_excise_number, excise_number) + >>> bool(shipment.has_eu_excise_goods) + False + >>> move = shipment.incoming_moves.new() + >>> move.product = product + >>> move.quantity = 10 + >>> move.from_location = shipment.supplier_location + >>> move.to_location = shipment.warehouse_input + >>> move.unit_price = Decimal('10.0000') + >>> move.currency = company.currency + >>> bool(shipment.has_eu_excise_goods) + True + >>> shipment.save() + >>> move, = shipment.incoming_moves + >>> move.eu_excise_duty + +Change for duty suspension:: + + >>> shipment.eu_excise_types + ('eu_excise',) + >>> assertEqual(shipment.eu_excise_party, supplier) + >>> shipment.eu_excise_number = supplier_excise_number + >>> shipment.save() + >>> move, = shipment.incoming_moves + >>> move.eu_excise_duty + 'suspension' diff --git a/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise_declaration.rst b/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise_declaration.rst new file mode 100644 index 0000000000..f66f0c9c46 --- /dev/null +++ b/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise_declaration.rst @@ -0,0 +1,303 @@ +============================================ +Account Stock EU Excise Declaration Scenario +============================================ + +Imports:: + + >>> import datetime as dt + >>> from decimal import Decimal + + >>> from proteus import Model + >>> from trytond.modules.company.tests.tools import create_company, get_company + >>> from trytond.tests.tools import activate_modules, assertEqual + + >>> today = dt.date.today() + +Activate modules:: + + >>> config = activate_modules( + ... ['account_stock_eu_excise', 'production', 'product_measurements']) + + >>> Country = Model.get('country.country') + >>> ExciseCode = Model.get('product.eu.excise_code') + >>> ExciseTax = Model.get('account.stock.eu.excise.tax') + >>> ExciseDeclaration = Model.get( + ... 'account.stock.eu.excise.declaration') + >>> ExciseDeclarationProductLine = Model.get( + ... 'account.stock.eu.excise.declaration.product.line') + >>> Inventory = Model.get('stock.inventory') + >>> Location = Model.get('stock.location') + >>> Party = Model.get('party.party') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> Production = Model.get('production') + >>> ShipmentIn = Model.get('stock.shipment.in') + >>> ShipmentOut = Model.get('stock.shipment.out') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Get units:: + + >>> unit, = ProductUom.find([('name', '=', "Unit")]) + >>> liter, = ProductUom.find([('name', '=', "Liter")]) + >>> kg, = ProductUom.find([('name', '=', "Kilogram")]) + + +Setup tax warehouse:: + + >>> excise_code = ExciseCode(code='W200') + >>> excise_code.save() + + >>> france = Country(code='FR', name='France') + >>> france.save() + >>> excise_tax = ExciseTax(code='TAX') + >>> excise_tax.quantity = 'measurement_volume' + >>> excise_tax.uom = liter + >>> excise_tax.country = france + >>> excise_tax.save() + + >>> company_party = company.party + >>> company_address, = company_party.addresses + >>> company_address.country = france + >>> company_address.save() + >>> excise_number = company_party.identifiers.new(type='eu_excise') + >>> excise_number.address = company_address + >>> excise_number.code = "LU00000987ABC" + >>> excise_number.eu_excise_codes.append(ExciseCode(excise_code.id)) + >>> company_party.save() + >>> excise_number, = company_party.identifiers + + >>> warehouse, = Location.find([('code', '=', 'WH')]) + >>> warehouse.address = company_address + >>> wh_excise_number = warehouse.eu_excise_numbers.new() + >>> wh_excise_number.eu_excise_number = excise_number + >>> warehouse.save() + +Create party:: + + >>> party = Party(name="Supplier") + >>> party.save() + >>> party_excise_number = party.identifiers.new(type='eu_excise') + >>> party_excise_number.address, = party.addresses + >>> party_excise_number.code = "LU00000987DEF" + >>> party_excise_number.eu_excise_codes.append(ExciseCode(excise_code.id)) + >>> party.save() + >>> party_excise_number, = party.identifiers + +Create product:: + + >>> template = ProductTemplate() + >>> template.name = "Wine" + >>> template.default_uom = unit + >>> template.volume = 2 + >>> template.volume_uom = liter + >>> template.weight = 1.5 + >>> template.weight_uom = kg + >>> template.type = 'goods' + >>> template.list_price = Decimal('20.0000') + >>> template.eu_excise_code = excise_code + >>> _ = template.eu_excise_taxes.new(excise_tax=excise_tax) + >>> template.save() + >>> product, = template.products + +Receive 10 products without duty suspension:: + + >>> shipment = ShipmentIn() + >>> shipment.supplier = party + >>> move = shipment.incoming_moves.new() + >>> move.product = product + >>> move.quantity = 10 + >>> move.from_location = shipment.supplier_location + >>> move.to_location = shipment.warehouse_input + >>> move.unit_price = Decimal('10.0000') + >>> move.currency = company.currency + >>> shipment.click('receive') + >>> shipment.click('do') + >>> shipment.state + 'done' + +Receive 5 products with duty suspension:: + + >>> shipment = ShipmentIn() + >>> shipment.supplier = party + >>> shipment.eu_excise_number = party_excise_number + >>> move = shipment.incoming_moves.new() + >>> move.product = product + >>> move.quantity = 5 + >>> move.from_location = shipment.supplier_location + >>> move.to_location = shipment.warehouse_input + >>> move.unit_price = Decimal('10.0000') + >>> move.currency = company.currency + >>> shipment.click('receive') + >>> shipment.click('do') + >>> shipment.state + 'done' + +Ship 3 products without duty suspension:: + + >>> shipment = ShipmentOut() + >>> shipment.customer = party + >>> move = shipment.outgoing_moves.new() + >>> move.product = product + >>> move.quantity = 4 + >>> move.from_location = shipment.warehouse_output + >>> move.to_location = shipment.customer_location + >>> move.unit_price = Decimal('20.0000') + >>> move.currency = company.currency + >>> shipment.click('wait') + >>> shipment.click('assign_try') + >>> shipment.click('pick') + >>> shipment.click('pack') + >>> shipment.click('ship') + >>> shipment.click('do') + >>> shipment.state + 'done' + +Ship 2 products with duty suspension:: + + >>> shipment = ShipmentOut() + >>> shipment.customer = party + >>> shipment.eu_excise_number = party_excise_number + >>> move = shipment.outgoing_moves.new() + >>> move.product = product + >>> move.quantity = 3 + >>> move.from_location = shipment.warehouse_output + >>> move.to_location = shipment.customer_location + >>> move.unit_price = Decimal('20.0000') + >>> move.currency = company.currency + >>> shipment.click('wait') + >>> shipment.click('assign_try') + >>> shipment.click('pick') + >>> shipment.click('pack') + >>> shipment.click('ship') + >>> shipment.click('do') + >>> shipment.state + 'done' + +Use 2 product for production and get 1:: + + >>> production = Production() + >>> move = production.inputs.new() + >>> move.product = product + >>> move.quantity = 2 + >>> move.from_location = production.warehouse.storage_location + >>> move.to_location = production.location + >>> move = production.outputs.new() + >>> move.product = product + >>> move.quantity = 1 + >>> move.from_location = production.location + >>> move.to_location = production.warehouse.storage_location + >>> move.unit_price = Decimal('20.0000') + >>> move.currency = company.currency + >>> production.click('wait') + >>> production.click('assign_try') + >>> production.click('run') + >>> production.click('do') + >>> production.state + 'done' + +Lost 1 product:: + + >>> inventory = Inventory() + >>> inventory.location = warehouse.storage_location + >>> inventory.empty_quantity = 'keep' + >>> line = inventory.lines.new() + >>> line.product = product + >>> line.quantity = 6 + >>> inventory.click('confirm') + >>> inventory.state + 'done' + +Check excise declaration in volume:: + + >>> with config.set_context( + ... warehouse=warehouse.id, + ... from_date=today - dt.timedelta(days=1), + ... to_date=today): + ... declaration, = ExciseDeclaration.find( + ... [('eu_excise_tax', '=', excise_tax.id)]) + ... declaration_product_lines = ExciseDeclarationProductLine.find( + ... [('product', '=', product.id)]) + + >>> assertEqual(declaration.unit, liter) + + >>> declaration_product, = declaration.products + >>> assertEqual(declaration_product.unit, liter) + + >>> declaration.start_quantity + 0.0 + >>> declaration.input_production + 2.0 + >>> declaration.input_duty_suspension + 10.0 + >>> declaration.input_replacement + 20.0 + >>> declaration.input_other + 0.0 + >>> declaration.input_total + 32.0 + >>> declaration.output_with_duty + 8.0 + >>> declaration.output_production + 4.0 + >>> declaration.output_duty_suspension + 6.0 + >>> declaration.output_duty_free + 0.0 + >>> declaration.output_other + 2.0 + >>> declaration.end_quantity + 12.0 + + >>> assertEqual({l.date for l in declaration_product_lines}, {today}) + >>> assertEqual({l.unit for l in declaration_product_lines}, {liter}) + >>> sorted((l.quantity, l.duty) for l in declaration_product_lines) + [(-8.0, None), (-6.0, 'suspension'), (-4.0, None), (-2.0, None), (2.0, None), (10.0, 'suspension'), (20.0, None)] + +Check excise declaration product in weight:: + + >>> excise_tax.quantity = 'measurement_weight' + >>> excise_tax.uom = kg + >>> excise_tax.save() + + >>> declaration.reload() + >>> for l in declaration_product_lines: + ... l.reload() + + >>> assertEqual(declaration.unit, kg) + + >>> declaration_product, = declaration.products + >>> assertEqual(declaration_product.unit, kg) + + >>> declaration.start_quantity + 0.0 + >>> declaration.input_production + 1.5 + >>> declaration.input_duty_suspension + 7.5 + >>> declaration.input_replacement + 15.0 + >>> declaration.input_other + 0.0 + >>> declaration.input_total + 24.0 + >>> declaration.output_with_duty + 6.0 + >>> declaration.output_production + 3.0 + >>> declaration.output_duty_suspension + 4.5 + >>> declaration.output_duty_free + 0.0 + >>> declaration.output_other + 1.5 + >>> declaration.end_quantity + 9.0 + + >>> assertEqual({l.date for l in declaration_product_lines}, {today}) + >>> assertEqual({l.unit for l in declaration_product_lines}, {kg}) + >>> sorted((l.quantity, l.duty) for l in declaration_product_lines) + [(-6.0, None), (-4.5, 'suspension'), (-3.0, None), (-1.5, None), (1.5, None), (7.5, 'suspension'), (15.0, None)] diff --git a/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise_shipment_internal.rst b/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise_shipment_internal.rst new file mode 100644 index 0000000000..d075fe199b --- /dev/null +++ b/modules/account_stock_eu_excise/tests/scenario_account_stock_eu_excise_shipment_internal.rst @@ -0,0 +1,101 @@ +================================================== +Account Stock EU Excise Shipment Internal Scenario +================================================== + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model + >>> from trytond.modules.company.tests.tools import create_company, get_company + >>> from trytond.tests.tools import activate_modules + +Activate modules:: + + >>> config = activate_modules('account_stock_eu_excise') + + >>> ExciseCode = Model.get('product.eu.excise_code') + >>> Location = Model.get('stock.location') + >>> Party = Model.get('party.party') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> ShipmentInternal = Model.get('stock.shipment.internal') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Setup tax warehouses:: + + >>> excise_code = ExciseCode(code='W200') + >>> excise_code.save() + + >>> company_party = company.party + >>> _ = company_party.addresses.new() + >>> company_party.save() + >>> address1, address2 = company_party.addresses + >>> excise_number = company_party.identifiers.new(type='eu_excise') + >>> excise_number.address = address1 + >>> excise_number.code = "LU00000987ABC" + >>> excise_number.eu_excise_codes.append(ExciseCode(excise_code.id)) + >>> excise_number = company_party.identifiers.new(type='eu_excise') + >>> excise_number.address = address2 + >>> excise_number.code = "LU00000987DEF" + >>> excise_number.eu_excise_codes.append(ExciseCode(excise_code.id)) + >>> company_party.save() + >>> excise_number1, excise_number2 = company_party.identifiers + + >>> warehouse1, = Location.find([('code', '=', 'WH')]) + >>> warehouse2, = warehouse1.duplicate() + + >>> warehouse1.address = address1 + >>> wh_excise_number = warehouse1.eu_excise_numbers.new() + >>> wh_excise_number.eu_excise_number = excise_number1 + >>> warehouse1.save() + + >>> warehouse2.address = address2 + >>> wh_excise_number = warehouse2.eu_excise_numbers.new() + >>> wh_excise_number.eu_excise_number = excise_number2 + >>> warehouse2.save() + +Create product:: + + >>> liter, = ProductUom.find([('name', '=', "Liter")]) + + >>> template = ProductTemplate() + >>> template.name = "Wine" + >>> template.default_uom = liter + >>> template.type = 'goods' + >>> template.list_price = Decimal('20.0000') + >>> template.eu_excise_code = excise_code + >>> template.save() + >>> product, = template.products + +Create a internal shipment without duty suspension:: + + >>> shipment = ShipmentInternal() + >>> shipment.from_location = warehouse1.storage_location + >>> shipment.to_location = warehouse1.output_location + >>> move = shipment.moves.new() + >>> move.product = product + >>> move.quantity = 10 + >>> move.from_location = shipment.from_location + >>> move.to_location = shipment.to_location + >>> shipment.save() + >>> any(m.eu_excise_duty for m in shipment.moves) + False + +Change duty suspension:: + + >>> shipment = ShipmentInternal() + >>> shipment.from_location = warehouse1.storage_location + >>> shipment.to_location = warehouse2.storage_location + >>> move = shipment.moves.new() + >>> move.product = product + >>> move.quantity = 10 + >>> move.from_location = shipment.from_location + >>> move.to_location = shipment.to_location + >>> shipment.save() + >>> [m.eu_excise_duty for m in shipment.moves] + ['suspension'] diff --git a/modules/account_stock_eu_excise/tests/test_module.py b/modules/account_stock_eu_excise/tests/test_module.py new file mode 100644 index 0000000000..bc59f95b00 --- /dev/null +++ b/modules/account_stock_eu_excise/tests/test_module.py @@ -0,0 +1,14 @@ +# 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.modules.company.tests import CompanyTestMixin +from trytond.tests.test_tryton import ModuleTestCase + + +class AccountStockEuExciseTestCase(CompanyTestMixin, ModuleTestCase): + "Test Account Stock Eu Excise module" + module = 'account_stock_eu_excise' + extras = ['product_measurements', 'production'] + + +del ModuleTestCase diff --git a/modules/account_stock_eu_excise/tests/test_scenario.py b/modules/account_stock_eu_excise/tests/test_scenario.py new file mode 100644 index 0000000000..dc1d23e7e5 --- /dev/null +++ b/modules/account_stock_eu_excise/tests/test_scenario.py @@ -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) diff --git a/modules/account_stock_eu_excise/tox.ini b/modules/account_stock_eu_excise/tox.ini new file mode 100644 index 0000000000..0a338b6534 --- /dev/null +++ b/modules/account_stock_eu_excise/tox.ini @@ -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.account_stock_eu_excise --omit=*/tests/* -m xmlrunner discover -s trytond.modules.account_stock_eu_excise {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] >= 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 diff --git a/modules/account_stock_eu_excise/tryton.cfg b/modules/account_stock_eu_excise/tryton.cfg new file mode 100644 index 0000000000..983fab7d5b --- /dev/null +++ b/modules/account_stock_eu_excise/tryton.cfg @@ -0,0 +1,50 @@ +[tryton] +version=7.9.0 +depends: + account + account_product + company + country + currency + ir + party + product + product_measurements + stock +extras_depend: + production +xml: + party.xml + product.xml + stock.xml + account_stock_eu.xml + message.xml + +[register] +model: + party.Configuration + party.Address + party.Identifier + party.Identifier_EUExciseCode + product.Template + product.Product + product.EUExciseCode + product.Product_EUExciseTax + stock.Location + stock.WarehouseEUExciseNumber + stock.ShipmentIn + stock.ShipmentInReturn + stock.ShipmentOut + stock.ShipmentOutReturn + stock.ShipmentInternal + stock.Move + account_stock_eu.ExciseTax + account_stock_eu.ExciseTaxRate + account_stock_eu.ExciseDeclarationContext + account_stock_eu.ExciseDeclaration + account_stock_eu.ExciseDeclarationProduct + account_stock_eu.ExciseDeclarationProductLine + +[register production] +model: + account_stock_eu.ExciseDeclarationProductLine_Production diff --git a/modules/account_stock_eu_excise/view/account_stock_eu_excise_declaration_context_form.xml b/modules/account_stock_eu_excise/view/account_stock_eu_excise_declaration_context_form.xml new file mode 100644 index 0000000000..247f422db1 --- /dev/null +++ b/modules/account_stock_eu_excise/view/account_stock_eu_excise_declaration_context_form.xml @@ -0,0 +1,14 @@ + + +
+