slapos_accounting: Add Manual accounting Scenario test

master/bt5/slapos_accounting/TestTemplateItem/portal_components/test.erp5.testSlapOSERP5ManualAccountingScenario.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2024 Nexedi SA and Contributors. All Rights Reserved.
+#
+##############################################################################
+
+from erp5.component.test.testSlapOSERP5VirtualMasterScenario import TestSlapOSVirtualMasterScenarioMixin
+from erp5.component.test.SlapOSTestCaseMixin import PinnedDateTime
+from DateTime import DateTime
+
+
+class TestSlapOSManualAccountingScenario(TestSlapOSVirtualMasterScenarioMixin):
+
+  def bootstrapManualAccountingTest(self):
+    currency, _, _, sale_person = self.bootstrapVirtualMasterTest()
+    self.tic()
+
+    self.logout()
+    # lets join as slapos administrator, which will manager the project
+    accountant_reference = 'accountant-%s' % self.generateNewId()
+    self.joinSlapOS(self.web_site, accountant_reference)
+
+    self.login()
+    accountant_person = self.portal.portal_catalog.getResultValue(
+      portal_type="ERP5 Login",
+      reference=accountant_reference).getParentValue()
+    self.tic()
+
+    self.login(sale_person.getUserId())
+
+    assignment = accountant_person.newContent(
+      portal_type='Assignment',
+      group='company',
+      function='accounting/manager'
+    )
+    self.assertEqual(assignment.checkConsistency(), [])
+    assignment.open()
+
+    self.tic()
+    self.logout()
+
+    self.login(accountant_person.getUserId())
+
+    accountant_organisation = self.portal.organisation_module.newContent(
+      portal_type="Organisation",
+      title="test-accountant-%s" % self.generateNewId(),
+      # required to generate accounting report
+      price_currency_value=currency,
+      # required to calculate the vat
+      group='company',
+      vat_code='MYVATCODE',
+      default_address_region='europe/west/france'
+    )
+    bank_account = accountant_organisation.newContent(
+      portal_type="Bank Account",
+      title="test_bank_account_%s" % self.generateNewId(),
+      price_currency_value=currency
+    )
+
+    bank_account.validate()
+    accountant_organisation.validate()
+
+    self.portal.bank_reconciliation_module.newContent(
+      title="Bank Reconciliation for %s" % accountant_organisation.getTitle(),
+      portal_type="Bank Reconciliation",
+      source_section_value=accountant_organisation,
+      source_payment_value=bank_account,
+    ).open()
+
+    return accountant_person, accountant_organisation, \
+      bank_account, currency
+
+  def groupAndAssertLineList(self, entity, line_list):
+    # Emulate the Grouping fast input
+    grouped_line_list = entity.AccountingTransaction_guessGroupedLines(
+      accounting_transaction_line_uid_list=[i.getUid() for i in line_list])
+
+    self.assertNotEqual(grouped_line_list, None)
+    self.assertEqual(len(grouped_line_list), len(line_list))
+
+    expected_reference = line_list[0].getGroupingReference()
+    expected_date = line_list[0].getGroupingDate()
+    
+    for line in line_list:
+      self.assertNotEqual(line.getGroupingReference(), None)
+      self.assertEqual(line.getGroupingReference(), expected_reference)
+      self.assertNotEqual(line.getGroupingDate(), None)
+      self.assertEqual(line.getGroupingDate(), expected_date)
+
+  def stopAndAssertTransaction(self, transaction):
+    # Ensure consistency
+    self.assertEqual(transaction.checkConsistency(), [])
+    # Post to general ledger
+    self.portal.portal_workflow.doActionFor(transaction, 'stop_action')
+    self.tic()
+    self.assertEqual(transaction.getSimulationState(), 'stopped')
+
+
+  def test_purchase_invoice_transaction(self, provider_as_organisation=False):
+    """
+    Accountant creates a Purchase Invoice Transaction and group it with a
+    Payment Transaction.
+    """
+    with PinnedDateTime(self, DateTime('2020/05/19')):
+      accountant_person, accountant_organisation, bank_account, currency = \
+        self.bootstrapManualAccountingTest()
+    
+    self.login(accountant_person.getUserId())
+
+    # Accountant can create one account for Hosting
+    account = self.portal.account_module.newContent(
+      portal_type='Account',
+      reference='626000',
+      title='Hosting for %s' % accountant_person.getTitle(),
+      account_type='expense',
+      financial_section='expense',
+      gap_list=['ias/ifrs/6/60/600', 'fr/pcg/6/62/626']
+    )
+    account.validate()
+
+    if provider_as_organisation:
+      # Accountaint can create a hosting provider
+      provider = self.portal.organisation_module.newContent(
+        portal_type='Organisation',
+        title='Service Provider for %s' % accountant_person.getTitle(),
+      )
+    else:
+      provider = self.portal.person_module.newContent(
+        portal_type='Person',
+        title='Service Provider for %s' % accountant_person.getTitle())
+
+    # Create a simple Purchase Invoice Transaction
+    transaction = self.portal.accounting_module.newContent(
+      title='Purchase for %s' % accountant_person.getTitle(),
+      portal_type="Purchase Invoice Transaction",
+      # Dates are required for rset source/destination reference
+      start_date=DateTime() - 1,
+      stop_date=DateTime() - 1,
+      resource_value=currency,
+      source_section_value=provider,
+      destination_section_value=accountant_organisation
+    )
+
+    total_amount = 9876.30
+    tax_amount = total_amount * 0.12
+    transaction.newContent(
+      portal_type='Purchase Invoice Transaction Line',
+      quantity=total_amount - tax_amount,
+      destination=account.getRelativeUrl()
+    )
+    transaction.newContent(
+      portal_type='Purchase Invoice Transaction Line',
+      quantity=tax_amount,
+      destination='account_module/refundable_vat'
+    )
+    purchase_payable_line = transaction.newContent(
+      portal_type='Purchase Invoice Transaction Line',
+      quantity=-total_amount,  # Negative value
+      destination='account_module/payable'
+    )
+
+    self.tic()
+    self.stopAndAssertTransaction(transaction)
+    
+    # Time to pay
+    payment = self.portal.accounting_module.newContent(
+      title='Payment for %s' % accountant_person.getTitle(),
+      portal_type="Payment Transaction",
+      # Dates are required for rset source/destination reference
+      start_date=DateTime(),
+      stop_date=DateTime(),
+      resource_value=currency,
+      source_section_value=accountant_organisation,
+      destination_section_value=provider,
+      source_payment_value=bank_account
+    )
+
+    self.tic()
+
+    # Initial payment has 3 lines by default.
+    self.assertEqual(len(payment.objectValues()), 3, payment.getRelativeUrl())
+    # for testing sake, we re-add payble later
+    payment.manage_delObjects(ids=['receivable', 'payable'])
+    payment.bank.edit(
+      source="account_module/bank",
+      aggregate=bank_account.getSourcePaymentRelated(
+        portal_type='Bank Reconciliation'
+      ),
+      quantity=total_amount
+    )
+
+    payable_line = payment.newContent(
+      portal_type='Accounting Transaction Line',
+      quantity=-total_amount,
+      source="account_module/payable"
+    )
+    self.tic()
+    self.stopAndAssertTransaction(payment)
+
+    # No automatic grouping until here
+    self.assertEqual(payable_line.getGroupingReference(), None)
+
+    self.groupAndAssertLineList(
+      provider, [payable_line, purchase_payable_line])
+
+  def test_purchase_invoice_transaction_organisation(self):
+    self.test_purchase_invoice_transaction(provider_as_organisation=False)
+
+  # def test_balance_transaction(self):
+  #  Do fake balance for 2023 ?
+
+  def test_accounting_transaction(self, customer_as_organisation=False):
+    """ Basic scenario for accountant create an Accounting transaction
+        to rembourse a customer (person by default)
+    """
+    with PinnedDateTime(self, DateTime('2020/05/19')):
+      accountant_person, accountant_organisation, bank_account, currency = \
+        self.bootstrapManualAccountingTest()
+    
+    self.login(accountant_person.getUserId())
+
+    # Accountant can create one account for Remboursement of a customer
+    account = self.portal.account_module.newContent(
+      portal_type='Account',
+      reference='628000',
+      title='Remboursement for %s' % accountant_person.getTitle(),
+      account_type='expense',
+      financial_section='expense',
+      gap_list=['ias/ifrs/6/60/600', 'fr/pcg/6/62/628']
+    )
+    account.validate()
+
+    if not customer_as_organisation:
+      customer = self.portal.organisation_module.newContent(
+        portal_type='Organisation',
+        title='Customer for remboursement for %s' % accountant_person.getTitle()
+      )
+    else:
+      customer = self.portal.person_module.newContent(
+        portal_type='Person',
+        title='Customer for remboursement for %s' % accountant_person.getTitle()
+      )
+
+    # Create a simple Accounting Transaction
+    transaction = self.portal.accounting_module.newContent(
+      title='Remboursement for %s' % accountant_person.getTitle(),
+      portal_type="Accounting Transaction",
+      # Dates are required for rset source/destination reference
+      start_date=DateTime() - 1,
+      stop_date=DateTime() - 1,
+      resource_value=currency,
+      source_section_value=customer,
+      destination_section_value=accountant_organisation
+    )
+
+    total_amount = 100.30
+    transaction.newContent(
+      portal_type='Accounting Transaction Line',
+      quantity=total_amount,
+      destination=account.getRelativeUrl()
+    )
+    accounting_payable_line = transaction.newContent(
+      portal_type='Accounting Transaction Line',
+      quantity=-total_amount,  # Negative value
+      destination='account_module/payable'
+    )
+
+    self.tic()
+    self.stopAndAssertTransaction(transaction)
+
+    # Time to pay
+    payment = self.portal.accounting_module.newContent(
+      title='Payment Rembourse for %s' % accountant_person.getTitle(),
+      portal_type="Payment Transaction",
+      # Dates are required for set source/destination reference
+      start_date=DateTime(),
+      stop_date=DateTime(),
+      resource_value=currency,
+      source_section_value=accountant_organisation,
+      destination_section_value=customer,
+      source_payment_value=bank_account
+    )
+
+    self.tic()
+    # Initial payment has 3 lines by default.
+    self.assertEqual(len(payment.objectValues()), 3, payment.getRelativeUrl())
+    # for testing sake, we re-add payble later
+    payment.manage_delObjects(ids=['receivable', 'payable'])
+    payment.bank.edit(
+      source="account_module/bank",
+      aggregate=bank_account.getSourcePaymentRelated(
+        portal_type='Bank Reconciliation'
+      ),
+      quantity=total_amount
+    )
+    payable_line = payment.newContent(
+      portal_type='Accounting Transaction Line',
+      quantity=-total_amount,
+      source="account_module/payable"
+    )
+    self.tic()
+    self.stopAndAssertTransaction(payment)
+
+    # No automatic grouping until here
+    self.assertEqual(payable_line.getGroupingReference(), None)
+
+    self.groupAndAssertLineList(
+      customer, [payable_line, accounting_payable_line])
+
+  def test_accounting_transaction_organisation(self):
+    """ Basic scenario for accountant create an Accounting transaction
+        to rembourse a customer (organisation)
+    """
+    return self.test_accounting_transaction(customer_as_organisation=True)
+
+  def test_sale_invoice_transaction(self, customer_as_organisation=False):
+    """ Basic scenario for accountant create an Sale invoice transaction
+        to sell services for a customer (person by default)
+    """
+    with PinnedDateTime(self, DateTime('2020/05/19')):
+      accountant_person, accountant_organisation, bank_account, currency = \
+        self.bootstrapManualAccountingTest()
+
+    # Create required trade condition for manual accounting.
+    self.login()
+    business_process_module = self.portal.business_process_module
+    trade_condition = self.portal.sale_trade_condition_module.newContent(
+      portal_type='Sale Trade Condition',
+      trade_condition_type='default',
+      reference='manual_accounting_for_%s' % accountant_organisation.getReference(),
+      specialise_value=business_process_module.slapos_manual_accounting_business_process
+    )
+
+    self.assertEqual(trade_condition.checkConsistency(), [])
+
+    self.login(accountant_person.getUserId())
+
+    # Accountant can create one account for Remboursement of a customer
+    account = self.portal.account_module.newContent(
+      portal_type='Account',
+      reference='628000',
+      title='Service Provisioning for %s' % accountant_person.getTitle(),
+      account_type='income',
+      financial_section='income',
+      gap_list=['ias/ifrs/7/70', 'fr/pcg/7/70/706']
+    )
+    account.validate()
+
+    if customer_as_organisation:
+      # Accountaint can create a hosting provider
+      customer = self.portal.organisation_module.newContent(
+        portal_type='Organisation',
+        title='Customer Org. for %s' % accountant_person.getTitle(),
+
+        # Required for issue an Sale Invoice Transaction
+        vat_code='MYVATCODE',
+        default_address_region='europe/west/france'
+      )
+    else:
+      customer = self.portal.person_module.newContent(
+        portal_type='Person',
+        title='Customer Person for %s' % accountant_person.getTitle(),
+        default_address_region='europe/west/france')
+
+    # Create a simple Accounting Transaction
+    transaction = self.portal.accounting_module.newContent(
+      title='Service Provisioning for %s' % accountant_person.getTitle(),
+      portal_type="Sale Invoice Transaction",
+      # Dates are required for rset source/destination reference
+      start_date=DateTime() - 1,
+      stop_date=DateTime() - 1,
+      resource_value=currency,
+      price_currency_value=currency,
+      destination_section_value=customer,
+      source_section_value=accountant_organisation,
+      specialise_value=trade_condition
+    )
+
+    total_amount = 9876.30
+    tax_amount = total_amount * 0.12
+    transaction.income.edit(
+      quantity=total_amount - tax_amount,
+      source=account.getRelativeUrl()
+    )
+    transaction.collected_vat.edit(
+      quantity=tax_amount,
+      source='account_module/coll_vat'
+    )
+    transaction.receivable.edit(
+      quantity=-total_amount,  # Negative value
+      source='account_module/receivable'
+    )
+    self.tic()
+    self.stopAndAssertTransaction(transaction)
+
+    # Time to pay
+    payment = self.portal.accounting_module.newContent(
+      title='Payment for %s' % accountant_person.getTitle(),
+      portal_type="Payment Transaction",
+      # Dates are required for set source/destination reference
+      start_date=DateTime(),
+      stop_date=DateTime(),
+      resource_value=currency,
+      source_section_value=accountant_organisation,
+      destination_section_value=customer,
+      source_payment_value=bank_account
+    )
+
+    self.tic()
+    # Initial payment has 3 lines by default.
+    self.assertEqual(len(payment.objectValues()), 3, payment.getRelativeUrl())
+    # for testing sake, we re-add payble later
+    payment.manage_delObjects(ids=['receivable', 'payable'])
+    payment.bank.edit(
+      source="account_module/bank",
+      aggregate=bank_account.getSourcePaymentRelated(
+        portal_type='Bank Reconciliation'
+      ),
+      quantity=-total_amount
+    )
+    receivable_line = payment.newContent(
+      portal_type='Accounting Transaction Line',
+      quantity=total_amount,
+      source="account_module/receivable"
+    )
+    self.tic()
+    self.stopAndAssertTransaction(payment)
+
+    # No automatic grouping until here
+    self.assertEqual(receivable_line.getGroupingReference(), None)
+
+    self.groupAndAssertLineList(
+      customer, [receivable_line, transaction.receivable])
+  
+  def test_sale_invoice_transaction_organisation(self):
+    """ Basic scenario for accountant create an Sale invoice transaction
+        to sell services for a customer (Organisation)
+    """
+    self.test_sale_invoice_transaction(customer_as_organisation=True)
+
+

master/bt5/slapos_accounting/TestTemplateItem/portal_components/test.erp5.testSlapOSERP5ManualAccountingScenario.xml

+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="Test Component" module="erp5.portal_type"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>default_reference</string> </key>
+            <value> <string>testSlapOSERP5ManualAccountingScenario</string> </value>
+        </item>
+        <item>
+            <key> <string>default_source_reference</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>description</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>test.erp5.testSlapOSERP5ManualAccountingScenario</string> </value>
+        </item>
+        <item>
+            <key> <string>portal_type</string> </key>
+            <value> <string>Test Component</string> </value>
+        </item>
+        <item>
+            <key> <string>sid</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_error_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_warning_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>version</string> </key>
+            <value> <string>erp5</string> </value>
+        </item>
+        <item>
+            <key> <string>workflow_history</string> </key>
+            <value>
+              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="2" aka="AAAAAAAAAAI=">
+    <pickle>
+      <global name="PersistentMapping" module="Persistence.mapping"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>data</string> </key>
+            <value>
+              <dictionary>
+                <item>
+                    <key> <string>component_validation_workflow</string> </key>
+                    <value>
+                      <persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
+                    </value>
+                </item>
+              </dictionary>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="3" aka="AAAAAAAAAAM=">
+    <pickle>
+      <global name="WorkflowHistoryList" module="Products.ERP5Type.Workflow"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>_log</string> </key>
+            <value>
+              <list>
+                <dictionary>
+                  <item>
+                      <key> <string>action</string> </key>
+                      <value> <string>validate</string> </value>
+                  </item>
+                  <item>
+                      <key> <string>validation_state</string> </key>
+                      <value> <string>validated</string> </value>
+                  </item>
+                </dictionary>
+              </list>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>

master/bt5/slapos_accounting/bt/template_test_id_list

@@ -6,5 +6,6 @@ test.erp5.testSlapOSAccountingRule
 test.erp5.testSlapOSAccountingSkins
 test.erp5.testSlapOSConsumptionSkins
 test.erp5.testSlapOSERP5AccountingScenario
+test.erp5.testSlapOSERP5ManualAccountingScenario
 test.erp5.testSlapOSEntityCreatePayment
 test.erp5.testSlapOSSaleSupply
\ No newline at end of file