---
title: Magento_CompanyCredit
source_repo: magento2b2b
release: 1.2.0
github_path: app/code/Magento/CompanyCredit/README.md
last_modified_at: '2020-05-08 16:01:36 -0500'
content: "## Overview\n\nThe Magento_CompanyCredit module adds the \"Payment on Account\"
  payment method for B2B companies. It also allows the credit history to be viewed
  from both Admin and the storefront. \n\nWith the Magento_Company Credit module\n-
  a customer can pay orders with Payment on Account method (or in credit);\n- an admin
  user can manage credit and credit settings for a company (in the admin panel);\n-
  merchants and customers can track credit history, and specifically: credit allocation,
  order placement, credit reimbursement, credit change (amount, currency or possibility
  to exceed credit limit).\n\nThe company credit functionality is available for company
  users only.\n \n## Installation details\n \nThe module has a dependency on the Magento_Company
  module, which must be installed and enabled first. The module does not create any
  backward incompatible changes. The CompanyCredit module can be deactivated and uninstalled
  at any time. \n \n## Structure\n \n[Learn about a typical file structure for a Magento
  2 module](http://devdocs.magento.com/guides/v2.2/extension-dev-guide/build/module-file-structure.html).\n
  \n## Extensibility\n \nExtension developers can interact with the Magento_CompanyCredit
  module. For more information about the Magento extension mechanism, see [Magento
  plug-ins](http://devdocs.magento.com/guides/v2.2/extension-dev-guide/plugins.html).\n
  \n[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.2/extension-dev-guide/depend-inj.html)
  enables you to override the functionality of the Magento_CompanyCredit module.\n\n[Payment
  method configuration](http://devdocs.magento.com/guides/v2.2/payments-integrations/base-integration/payment-option-config.html)
  will allow you additional configuration to extend module functionality.\n\n### Layouts\n
  \nYou can extend and override layouts in the `Magento\\CompanyCredit\\view\\adminhtml\\layout`
  and `Magento\\CompanyCredit\\view\\frontend\\layout` directories.\n\nFor more information
  about layouts, see the [Layout documentation](http://devdocs.magento.com/guides/v2.2/frontend-dev-guide/layouts/layout-overview.html).\n
  \n### UI components\n\nThe following directories contain extensible UI components:
  \n\n* `Magento\\CompanyCredit\\view\\adminhtml\\ui_component` -  company form, company
  listing, history listing\n\n* `Magento\\CompanyCredit\\view\\frontend\\ui_component`
  - balance history listing\n\nFor more information, see [UI Listing/Grid Component](http://devdocs.magento.com/guides/v2.2/ui-components/ui-listing-grid.html)
  and [UI Form Component](http://devdocs.magento.com/guides/v2.2/ui_comp_guide/components/ui-form.html)\n\n##
  Additional information\n \nYou can track [backward incompatible changes made in
  a Magento B2b mainline after the Magento 2.2 release](http://devdocs.magento.com/guides/v2.2/release-notes/changes/b2b_changes.html).\n"
