Billing Account Overview
Author:
Fluent Commerce
Changed on:
13 Dec 2023
Overview
The Billing account entity represents financial operations. Billing accounts are responsible for orchestrating all invoices and invoice adjustments (Credit & Debit memos). Additionally, Billing Accounts also manages all associated downstream outcomes including payments, invoice notifications, and ERP integrations.
Billing Account configuration contains:
- Billing Account List page
- Billing Account details page
Key points
- Billing Account List page
- Billing Account details page
Billing Account List page
The Billing Account List page displays all created billing accounts. A billing account contains all information required for billing and is specific to a customer.
Layout
To search for and view billing account details the Mystique SDK filter component should be used. The Filter component should perform the search based on the following filtering criteria:
- (Billing Account) Ref
- Type
- Status
- (Billing account) Name
- Created On
- Updated On
Billing Account table displays information in the following columns:
- (Billing Account) Name: The name of the billing account.
- Status: The status of the billing account.
- Type: The type of the billing account.
- Ref: The unique reference of the billing account.
(Billing Account) Name is a link to go to the Billing Account Details page. Clicking (Billing Account) Name opens the Billing Account Details page.
Billing Account details page
The detail view of a billing account displays more detailed information about a billing account.
Layout
Breadcrumbs
- Back to Account List: Link navigating back to the Billing Account list page.
Details Tab
The details tab provides a detailed overview of the selected billing account and contains:
- Summary card
- Credit Memos table
Summary card
The Summary card displays a brief summary of the billing account. This summary includes the following information:
- Billing Account Type: The type of billing account.
- Billing Account Status: The current status of the billing account.
- Billing Account Name: The billing account name.
- Customer Ref: The customer reference from the retailer.
Credit Memos table
The Credit Memos table displays the following information:
- Ref: This is a unique reference number that is associated with the credit memo. Link, which navigates to the Credit Memo Details page
- Amount: The credit memo amount.
- Status: The current status of the credit memo
- Type: The type of credit memo.
- Order: The unique reference number that is associated with the order.
- Issue Date: Displays the date and time.
Attributes Tab
The Attributes tab displays all attributes associated with the selected billing account. Attributes are custom pieces of information that retailers can associate with a billing account. The attributes section is optional and consists of fields:
- Name: This displays the name of the attribute associated with the billing account.
- Type: This displays the type of attribute associated with the billing account.
- Value: This displays the value of the attribute.
Activity Tab
The activity of a billing account is recorded in the Activity tab. This tab displays all historical activities that have occurred during the billing account lifecycle.
The Credit Memos Details page
The detail view of a credit memo displays more detailed information about a credit memo. A credit memo can be selected by clicking the Credit Memo ref on the billing account details page.
The detail view consists of the following tabs:
- Details
- Attributes
- Activity
Layout
Breadcrumbs
- Back to Billing Account: Link navigating back to the Billing Account Details page.
Details Tab
The details tab provides a detailed overview of the selected credit memo and is made up of:
- Summary card
- Credit Memo Items table
Summary card
The Summary card displays a brief summary of the credit memo. This summary includes the following information.
- Credit Memo Type: The type of credit memo.
- Credit Memo Status: The current status of the credit memo.
Credit Memo Items table
The Credit Memo Items table displays the following information:
- Ref: This is a unique reference number that is associated with the credit memo item.
- Type: The type of credit memo item.
- Description: The description of credit memo item.
Attributes Tab
The Attributes tab displays all attributes associated with the selected credit memo. Attributes are custom pieces of information that retailers can associate with a credit memo. The attributes section is optional and consists of fields:
- Name: This displays the name of the attribute associated with the credit memo.
- Type: This displays the type of attribute associated with the credit memo.
- Value: This displays the value of the attribute.
Activity Tab
The activity of a billing account is recorded in the Activity tab. This tab displays all historical activities that have occurred during the credit memo lifecycle.
The paging control is placed at the bottom of the tables. It includes the following:
- Label “Rows per page” and a dropdown list right to the label, which is populated with the values: 10, 25, 100 (100 is selected by default);
- Label in the format: Showing - ;
- “<” and “>” icons to navigate to the previous/next pages;
- “<” / “>” icon should be disabled if a user is on the first/last page respectively;
- Pagination should be displayed if more than a set number of entries are available. If there are no entries at all or the number of entries is less than the set number of entries - pagination should not be visible.
Learn more about how to Configure OMS
