Master (Configuration) Data Integration
Download Enterprise Integration Guide
LeaseAccelerator classifies the configuration data (master data) into three “classes”. Members of each class are of the same “nature” so they “share” the same attributes. Each member of a certain class may have one or more “roles” when allowed. A member of a class may have a parent or its own role or another role whenever allowed.
For example, the “People class” is used to store information of all humans dealing with LeaseAccelerator though each member may have different role(s) such as: system user, asset user, asset owner, etc., but since they are all “human” they are included under the “People” class and they share common attributes such as e-mail address, telephone number, etc.
1 - Companies Class:
The “Companies” class defines those entities that are part of your leasing program. Each “company” however may perform one or more role(s) or function(s) – if applicable. Companies class include lessees, funders, business entities, business units, vendors, and cost centers.
2 – People Class:
Many people participate in your leasing program and have different roles. These people may or may not be users of the system. LeaseAccelerator has a dedicated class for “people” to capture information about these people so that they can receive notifications or other information important to their function. Examples of the roles that people may play and therefore need to be configured in the system are: Asset Owners, Asset Users, Order Administrators, Analysts, Finance Approvers, etc.
3 – Addresses Class:
Addresses are specific significant locations in your organization. These addresses can be workplaces, physical location of leased equipment, a shipped to address or the physical location of real estate.
Companies class integration
The “Companies” class defines those entities that are a part of your leasing program. Each “company” however may perform one or more role(s) or function(s) – if applicable. Companies class include:
Lessees: The legal party to the agreement who are leasing the equipment or renting the real estate
Funders: Also referred to as lessors: they provide the cash to finance the equipment purchase through a lease agreement
Entity: Organization you consider to be the Lessee (may be different than actual Lessee)
Business Units (SBU): An internal reporting group
Vendors: Various other parties such as the equipment manufacturer or supplier, an assignee, or an organization to whom you pay an initial direct cost to or receive a lease incentive from
All members of Companies class share the same attributes (see Data Mapping for details).
Adding and updating companies process flow
Process Step ID |
Process Step Description |
Phase |
|---|---|---|
100 |
Start |
Source system user |
200 |
Capture Companies data and prepare payload |
Source system user |
300 |
Invoke LeaseAccelerator AddUpdateCompany API with payload |
Middleware |
400 |
Receive & validate payload |
LeaseAccelerator |
500 |
Valid? |
LeaseAccelerator |
550 |
Prepare error response with error payload |
LeaseAccelerator |
600 |
Middleware |
|
700 |
Stop |
Middleware |
800 |
Add /Update Companies details |
LeaseAccelerator |
900 |
Update source with success |
Middleware |
1000 |
Stop |
Middleware |
Companies class data mapping
Field Name |
Description |
Format |
Req’d System Import |
Req’d Acctg |
|
|---|---|---|---|---|---|
1 |
CompanyRoleType |
This is a description of the function that this company plays within your leasing program. |
See Data Validation List |
Y |
Y |
2 |
CompanyName |
Name of the entity which you want to use within the system. This may or may not be the official legal name of the entity. This may be a subsidiary of a larger organization. |
Alphanumeric (150) |
Y |
Y |
3 |
ParentCompanyName |
The highest organization within a company’s legal structure. |
Alphanumeric (150) |
N |
N |
4 |
URL |
Website Address |
Alphanumeric (512) |
N |
N |
5 |
AddressLine1 |
Street Address |
Alphanumeric (250) |
N |
N |
6 |
AddressLine2 |
Additional address information such as floor or suite. |
Alphanumeric (250) |
N |
N |
7 |
City |
City used by postal service. This may not be the more common name used in conversation. |
Alphanumeric (100) |
N |
N |
8 |
StateProvince |
Postal Abbreviation |
Alphanumeric (4) |
N |
N |
9 |
Country |
Name |
See Data Validation List |
N |
N |
10 |
PostalCode |
Zip Code or other Postal code |
Alphanumeric (16) |
N |
N |
11 |
ContactName |
First Name, Last Name of Primary Contact |
Alphanumeric (150) |
N |
N |
12 |
Phone |
Telephone number |
Numeric (32) |
N |
N |
13 |
Email address for POC |
Alphanumeric (150) |
N |
N |
|
14 |
LedgerCode |
The code per Chart of Accounts associated with the participant company, if appropriate. |
Alphanumeric (32) |
N |
Y |
People class integration
LeaseAccelerator has a dedicated class for “people” to capture information about people who may have specific roles whether they are system users or not.
LeaseAccelerator supports the following classes of people:
Asset Owners: Employees who have fiduciary responsibility for the maintenance and use of the assets. These employees are typically management level and are financially responsible for the equipment.
Asset Users: Employees who have custodial responsibility for the leased assets. These employees may be management or staff level. These employees’ work locations are typically at the equipment’s physical location or in the same area.
Order Administrators: Employees who have “procurement” responsibility for the leased assets, shepherding the administrative process in your organization to finance the acquisition of equipment and securing its delivery to the asset user.
Analysts: Employees responsible for generating the Lease vs. Buy.
Finance Approvers: Employees typically responsible for approving the lease transaction and may be the responsible party signing the lease documents. These employees are typically management or executive level and are an escalation step for notifications regarding End-of-Term.
Sourcing contacts: Employees responsible for initiating and creating an RFP, reviewing the proposals and awarding to a Funder/Lessor.
Please note that a person may be listed multiple times if their role types are different, but the company and address information for that person must be identical. Do not list a person multiple times with the same role type and different companies.
Adding and updating people process flow
Process Step ID |
Process Step Description |
Phase |
|---|---|---|
100 |
Start |
Source system user |
200 |
Capture People data and prepare payload |
Source system user |
300 |
Invoke LeaseAcceleratorAddUpdatePerson API with payload |
Middleware |
400 |
Receive & validate payload |
LeaseAccelerator |
500 |
Valid? |
LeaseAccelerator |
550 |
Prepare error response with error payload |
LeaseAccelerator |
600 |
Receive error payload & inform caller |
Middleware |
700 |
Stop |
Middleware |
800 |
Add /Update People details |
LeaseAccelerator |
900 |
Update source with success |
Middleware |
1000 |
Stop |
Middleware |
People class data mapping
People operations have no accounting effect.
# |
Field Name |
Description |
Validation / Valid Values |
Format |
Required |
|---|---|---|---|---|---|
A |
Full Name |
First name, Last name |
Alphanumeric (150) |
Y |
|
B |
Person Role Type |
The function that a person plays within your leasing program. |
See Data Validation List |
See Data Validation List |
Y |
C |
Company Name |
Employee’s Entity or Business Unit (typically governed by your company’s internal method to commonly reference the organization that an employee is part of). |
Must exactly match a value on Companies tab where Company Role Type = Lessee, Entity, Funder, Vendor, or SBU. |
Alphanumeric (150) |
Y |
D |
Address Line 1 |
Street Address |
If blank, data from corresponding Company Name on Companies tab will be applied. |
Alphanumeric (250) |
N |
E |
Address Line 2 |
Additional address information such as floor or suite. |
If blank, data from corresponding Company Name on Companies tab will be applied. |
Alphanumeric (250) |
N |
F |
City |
City used by postal service. This may not be the more common name used in conversation. |
If blank, data from corresponding Company Name on Companies tab will be applied. Required for LeaseAccelerator users. Defined on LeaseAccelerator Users tab. |
Alphanumeric (100) |
Y |
G |
State Province |
Postal Abbreviation |
If blank, data from corresponding Company Name on Companies tab will be applied. |
Alphanumeric (4) |
N |
H |
Country |
Postal Abbreviation |
If blank, data from corresponding Company Name on Companies tab will be applied. Required for LeaseAccelerator users. Defined on LeaseAccelerator Users tab. |
Dropdown |
Y |
| I | Postal Code | Zip Code or other Postal code | If blank, data from corresponding Company Name on Companies tab will be applied. | Alphanumeric (16) | N |
| K | Phone | Telephone number | Numeric (32) | N | |
| L | Email* | Email address for POC | Valid email address format. Must include @xxx. | Alphanumeric (150) | Y |
| M | Is User* | Field to define whether this person is a defined user within LeaseAccelerator. By selecting Yes, this person will be provisioned as a user upon import and their username will be everything before the @ sign of their email address. | Yes or No | Dropdown | Y |
Addresses class integration
Addresses are specific significant locations in your organization. These addresses can be:
Employees workplace
Physical location of equipment or shipped to
Physical location of leased real estate
Addresses are typically associated with a Lessee, Entity, or Business Unit. (There may be a 1: n relationship because companies may have multiple teams “sitting” at a single location.)
All members of Addresses class share the same attributes (see Configuration Data Mapping for details).
Adding and updating addresses process flow
Process Step ID |
Process Step Description |
Phase |
|---|---|---|
100 |
Start |
Source system user |
200 |
Capture People data and prepare payload |
Source system user |
300 |
Invoke LeaseAcceleratorAddUpdateAddress API with payload |
Middleware |
400 |
Receive & validate payload |
LeaseAccelerator |
500 |
Valid? |
LeaseAccelerator |
550 |
Prepare error response with error payload |
LeaseAccelerator |
600 |
Receive error payload & inform caller |
Middleware |
700 |
Stop |
Middleware |
800 |
Add /Update People details |
LeaseAccelerator |
900 |
Update source with success |
Middleware |
1000 |
Stop |
Middleware |
Addresses class data mapping
# |
Field Name |
Description |
Validation / Valid Values |
Format |
Req’d System Import |
Req’d Acctg |
|---|---|---|---|---|---|---|
1 |
Address Role Type |
The function that this location plays within your leasing program. |
See Data Validation List below |
Text |
Y |
Y |
2 |
Company Name |
Name of the location used as reference within your company where assets are located. |
Alphanumeric (150) |
Y |
Y |
|
3 |
Address Line 1 |
Street Address |
Alphanumeric (250) |
N |
N |
|
4 |
Address Line 2 |
Additional address information such as floor or suite. |
Alphanumeric (250) |
N |
N |
|
5 |
City |
City used by postal service. This may not be the more common name used in conversation. |
Alphanumeric (100) |
Y |
N |
|
6 |
State Province |
Postal Abbreviation |
Validation to Postal Codes per USPS |
Alphanumeric (4) |
N |
N |
7 |
Country |
Postal Abbreviation |
See Data Validation List Below |
Drop Down |
Y |
N |
8 |
Postal Code |
Zip Code or other Postal code |
Alphanumeric (16) |
N |
N |
|
9 |
Facility Code |
Facility Code (ShipTo Key) is a client code associated with a specific ShipTo Address. Using a Facility Code on the PIW eliminates the need to enter any values in the ShipTo Address fields. |
Unique value, code cannot exist in the system already. |
Alphanumeric (100) |
N |
N |
10 |
Ledger Code |
The “value” used by your accounting system to identify the work location. Typically, this is one of many portions of an overall General Ledger string. |
Alphanumeric (32) |
N |
Y |