Skip to content

Commit c5a7989

Browse files
authored
Merge pull request #118 from neilt/contacts-from-git-wiki
Move contact older info from GitHub wiki to book and note in the wiki article that it is only a historical document that this point.
2 parents 8ee7715 + 7ed3e29 commit c5a7989

File tree

2 files changed

+76
-25
lines changed

2 files changed

+76
-25
lines changed

ledgersmb-book.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
% \label{fig:first-user-user-default-data}
3535
% \end{longtable}
3636
%
37-
% Remakrs or notes should be formatted as follows:
37+
% Remarks or notes should be formatted as follows:
3838
% \begin{quote}
3939
% \textbf{Remark} Note that the \gls{rfq} entry screen contains prices; this is misleading
4040
% at least: the printed output to be sent to the vendor does not. The fact that this screen
@@ -275,7 +275,7 @@ \section*{Comments and questions}
275275

276276
\section*{Acknowledgments}
277277
\label{sec-acknowledgements}
278-
\addcontentsline{toc}{section}{Acknowledgements}
278+
\addcontentsline{toc}{section}{Acknowledgments}
279279

280280
H{\aa}vard S{\o}rli for his efforts to help develop the original book outline.\\
281281
~ \\

part-processes.tex

Lines changed: 74 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,59 @@ \section{Introduction}
4141
The contact entity itself is used - albeit not as customer or vendor - in the context of
4242
credit risk management (See \charef{cha-credit-risk-management}).
4343

44+
\section{Contacts}
45+
\label{sec-business-processes-customers-and-vendors-contacts}
46+
47+
In \lsmb, a "Contact" is either a person, a company or a robot.
48+
49+
The person, company or robot has a uniquely corresponding entity, where it is assigned an \texttt{entity\_class} such as Vendor, Customer, Employee, Robot. This class is a marker only. It has no bearing on what the Contact is able to do, so, for example, a Contact marked as "Employee" can also act as a vendor who we purchase from and a customer who we sell things to.
50+
51+
The entity may be further extended such that it becomes:
52+
53+
A \lsmb user, by linking with the users table. The schema allows the Contact to link with multiple \lsmb users (so a person may have one username they use for general accounting and another they use for administrative functions), though the UI does not currently support this. A user belongs only to a single Contact entity.
54+
55+
An employee, by linking with \texttt{entity\_employee}. This is a 1:1 relationship. Table \texttt{entity\_employee} is used to extend the entity. Note that employee has start and end dates, but there is no provision for multiple employments, such as when an employee leaves and is later re-employed by the company.
56+
57+
The Contact entity may have multiple \texttt{entity\_credit\_accounts} associated, which can be classed as either "Vendor or "Customer". These do affect what a Contact is able to do. For example, to act as a vendor who we purchase from, the Contact must have an \texttt{entity\_credit\_account} of class "Vendor". For us to be able to raise a sales invoice to the Contact, it must have an \newline\texttt{entity\_credit\_account} of class "Customer".
58+
59+
A Contact may have multiple \texttt{entity\_credit\_accounts} of each class, for example it may have multiple "Customer" accounts corresponding with different divisions of a single company to be invoiced separately.
60+
61+
The \texttt{entity\_credit\_account} may optionally be assigned a business type.
62+
63+
A Contact may be known by multiple names through the \texttt{entity\_other\_name} table, though this is not yet supported in the UI.
64+
65+
Multiple notes, locations (being addresses) or contact elements (being a single telephone number, e-mail address, social media handle or similar) may be associated with either the overall Contact, or individual \texttt{entity\_credit\_accounts}.
66+
67+
An summary outline of the related database tables is as follows:
68+
% We don't use box characters because they are not supported by LaTeXML
69+
\begin{verbatim}
70+
company -|
71+
robot -|--entity
72+
person -| |
73+
|--users
74+
|--entity_employee
75+
|--entity_other_name
76+
|--entity_note
77+
|--entity_to_contact
78+
|--entity_to_location
79+
|-- location
80+
|--entity_credit_account
81+
|-- eca_to_location
82+
|-- location
83+
|--eca_to_contact
84+
|--eca_note
85+
|--person
86+
|--business
87+
\end{verbatim}
88+
89+
\section{Contact Search}
90+
\label{sec-business-processes-customers-contact-search}
91+
\index{contact search}
92+
93+
The \lsmb UI provides a Contact Search screen at \menupath{Main Menu \ma Contacts \ma Search}.
94+
95+
Each filled-in field tightens the filter criteria. Clicking 'Search' without filling any fields in returns a list of all Contacts.
96+
4497
\section{Creating customers and vendors}
4598
\label{sec-business-processes-creating-customers-and-vendors}
4699

@@ -55,50 +108,49 @@ \section{Creating customers and vendors}
55108
\subsection{Creating a Company}
56109
\label{subsec-business-processes-customer-creating-company}
57110

58-
To create a company navigate to Main Menu \ma Contacts \ma Add Contact \ma Company Tab.
111+
To create a company navigate to \menupath{Main Menu \ma Contacts \ma Add Entity \ma Company Tab}.
59112

60113
The company tab has the following fields:
61114

62115
\begin{description}
63-
\item [Control code] Code to uniquely identify this entity. This is usually generated by clicking on \texttt{Generate Control Code} button. It is also generated automatically when clicking the \texttt{Save} button.
64-
\item [Class] The type of entity; \gls{vendor}\index{vendor}, \gls{customer}\index{customer}, etc. Required, but defaults to a known value so it needs to be checked.
65-
\item [Name] Legal name of the company. Required.
66-
\item [Country] Country of incorporation. Required, but defaults to a known value so it needs to be checked.
116+
\item [Control code] Code to uniquely identify this entity. This is usually generated by clicking on \texttt{Generate Control Code} button. It is also generated automatically when clicking the \texttt{Save} button.\index{control code}
117+
\item [Name] Legal name of the company. **Required.**
118+
\item [Country] Country of incorporation. **Required**, but defaults to a known value so it needs to be checked.
67119
\item [Tax number/SSN] Tax (VAT/Sales tax) number of the company.
68120
\item [Sales Tax ID] The sales tax reporting number.
69121
\item [License Number] The company operating license number.
70122
\end{description}
71123

72124
The \texttt{Generate Control Code} button generates a new control code upon
73125
user request when the user is entering a company which isn't yet known
74-
in the system in any other role.
126+
in the system.
75127

76128
The \texttt{Retrieve} button is discussed in \secref{sec-business-processes-customers-to-vendors}.
77129

78-
The \texttt{Save} button creates the account.
130+
The \texttt{Save} button creates the company.
79131

80132
\subsection{Creating a customer account}
81133
\label{subsec-business-processes-customers-creating-account}
134+
\index{customer}
82135

83-
When a contact of class ``Customer'' or ``Vendor'' has been created,
84-
accounts of that type can be added. The account entry screen lists the
136+
When a company has been created then ``Customer'' or ``Vendor''
137+
Credit Account can be added. The Credit Accounts entry screen lists the
85138
following fields\footnote{To simplify the interface if they're unused, some fields
86139
are not shown in case their selection lists are empty}:
87140

88141
\begin{description}
89142
\item [Class] Either a \gls{customer} or \gls{vendor}
90143
\item [Number] Number to identify this account among all other accounts in the company; when left empty, the system will generate one when you click ``Save New''
91144
\item [Description] Textual representation of the account, usually a name
92-
\item [Pay To] @@@TODO
145+
\item [Pay To] If printed checks are used, then this line is the Pay To line on the check
93146
\item [Starting Date] Date from which the account is valid
94147
\item [End date] Date until which the account is valid, or empty if there's no known end date
95148
\item [Threshold] Minimum amount for invoices to be sent out
96149
\item [Credit limit] Maximum amount of open invoices and orders allowed for the account, see \charef{cha-credit-risk-management}
97150
\item [Payment Terms] Number of days within which invoices have to be paid
98151
\item [Discount (conditions)] Percentage discount the account is entitled to when payment is within the given number of days
99-
\item [Discount (account)] Account used to post discounts as calculated based on discount conditions
100-
\item [AR] For customers, the Receivables G/L Account used to post created sales invoices on
101-
\item [AP] For vendors the Payables G/L Account used as default to post received purchase order invoices on
152+
\item [Account] Account used to post discounts as calculated based on discount conditions
153+
\item [AR or AP] For customers, the Receivables G/L Account (AR) used to post created sales invoices on. For vendors, the Payables G/L Account (AP) used as default to post received purchase order invoices on. Only one of AP or AR is shown.
102154
\item [Payment] Which bank account to use when receiving or paying funds
103155
\item [Currency] The default currency to be used with the \gls{customer} or vendor
104156
\item [Language] The language parameter is used to select templates for communication with the customer
@@ -108,17 +160,16 @@ \subsection{Creating a customer account}
108160

109161
\subsection{Creating a vendor account}
110162
\label{subsec-business-processes-vendors-creating-account}
163+
\index{vendor}
111164

112-
Generally the only difference between creating a \gls{customer} account and a \gls{vendor} account is the Class and the use of AP or AR G/L accounts. See \secref{subsec-business-processes-customers-creating-account} for setting up a customer account.
165+
The only difference between creating a \gls{customer} account and a \gls{vendor} account is the Class and the selection of AP or AR G/L accounts. See \secref{subsec-business-processes-customers-creating-account} for setting up a customer account.
113166

114167
\section{Multiple customers within one company}
115168
\label{sec-business-processes-customer-multiple-per-company}
116169

117170
\section{Creating vendors from customers}
118171
\label{sec-business-processes-customers-to-vendors}
119172

120-
% \section{}
121-
122173
\section{Maintaining contact information}
123174
\label{sec-business-processes-customers-contact-information}
124175

@@ -129,7 +180,7 @@ \chapter{Quotations from Vendors and for Customers}
129180
\section{Creating Quotations and RFQs}
130181
\label{sec-business-processes-quotations-creation}
131182

132-
% ### Proze with explanation missing
183+
The RFQ entry screen is located at \menupath{Main Menu \ma Quotations \ma RFQ}.
133184

134185
\begin{figure}[h]
135186
\centering
@@ -147,21 +198,21 @@ \section{Creating Quotations and RFQs}
147198
The listing below describes the meaning of the per \gls{rfq} fields presented in the screen.
148199

149200
\begin{description}
150-
\item [Vendor (Customer)] Name of the company the quotation is requested from (issued to)
201+
\item [Vendor (Customer)] Name of the company the quotation is requested from (issued to). **Required**
151202
\item [Currency] Currency for the intended transaction
152-
\item [Shipping point] Address to ship to ??? % ### TODO check with Chris
153-
\item [Ship via] Shipping method ??? % ### TODO check with Chris
203+
\item [Shipping point] The address the quoted material will be shipped from
204+
\item [Ship via] The expected shipping method to use in the quote
154205
\item [RFQ number] The number of the document (automatically generated when left empty)
155-
\item [Quotation date] Date the document is issued
156-
\item [Required by] Date of the intended delivery of the goods and services requested ??? % ###
206+
\item [Quotation date] Date the RFQ document is issued
207+
\item [Required by] Date of the intended delivery of the goods and services requested
157208
\item [Notes] Notes to be included on the printed RFQ document sent to the vendor
158209
\item [Internal notes] Notes to be kept internal to the company - not disclosed through the RFQ document
159210
\end{description}
160211

161212
The following per item fields are listed.
162213

163214
\begin{description}
164-
\item [Item] Order number of the item
215+
\item [Item] Number of the item in the RFQ
165216
\item [Number] Part number of the item to be ordered
166217
\item [Description] Description or name of the item to be ordered
167218
\item [Qty] The number of items to be ordered

0 commit comments

Comments
 (0)