The unique company ID used by LeaseAccelerator to identify the company with which the address is associated.

None, All, or a comma-separated list of states of deals to which changes should be applied where the address being updated is already associated with deals in the specified state.  If None, the change will be limited to future deals; if All, the change will be retroactively applied to all deals in which the address is a participant.

Specifies an external identifier by which the address may be recognized.  Note that if addressId is not specified but importKey is, LeaseAccelerator will attempt to look up the importKey to see if this is a known address and, if so, will update the corresponding address.  This enables external systems to perform adds and updates using their own identifiers to reference the address.

Specifies a name for the external source associated with the importKey.  This name is limited to 32 characters in length.

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.

The unique address ID used by LeaseAccelerator to identify a location. If specified, the address will be updated; if not specified (and if the address cannot be resolved using importKey), a new address will be created.

Street Address.  The specified address must be configured in LeaseAccelerator.

Additional address information such as floor or suite.

City used by postal service.  This may not be the more common name used in conversation.

The country component of the address.

The function that this location plays within your leasing program.

The postal/zip code of the address.

The latitude, in degrees of the address, where positive is in the Northern Hemisphere, negative the Southern.

The longitude, in degress of the address.

Postal abbreviation for acceptable Countries in short form.

Postal abbreviation for acceptable Countries in long form.

Name of attribute associated with the company that will be persisted.  Custom attribute types can be configured as needed.

The unique company ID used by LeaseAccelerator to identify the company.

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.

Email address for POC.  Valid Format contains @xxx

The unique address ID used by LeaseAccelerator to identify a location at the specified company in the context of the specified contactTypes.

Street Address.  The specified address must be configured in LeaseAccelerator.

Additional address information such as floor or suite.

Telephone number

City used by postal service.  This may not be the more common name used in conversation.

The country component of the address.

The postal/zip code of the address.

The unique party ID used by LeaseAccelerator to identify the person portion of this participant.

First name Last name

Company Type Role in which this company can participate in transactions

Website Address - Must be in standard format

Title

The postal/zip code of the address.

Postal Abbreviation for acceptable Countries.

Name of attribute associated with API Method.  Custom attribute types can be configured as needed.

If LineItems are provided for the artifact (see below), detailLevel specifies the level of granularity for the line items.  Asset-level granularity means that all items will be elaborated as quantity 1 and may include asset-level details such as serialNumber, assetTag, and assetComments; whereas LineItem-level granularity allows for quantities greater than 1, but does not support asset-level details.  Typically, LineItem granularity is used until the contract is finalized, at which point Asset-level detail becomes relevant.  If detailLevel is not specified but LineItems are provided, the default granularity is LineItem.  None may be used if LineItems are not being provided.

If provided, specifies the unique transaction ID used by LeaseAccelerator to identify the deal to which the artifact should be added.  If both dealId and artifactId are omitted, a new deal will be created, containing only the new document.

If provided, specifies the unique artifact ID used by LeaseAccelerator to identify the document being updated.  If omitted, a new artifact will be created, either in a new deal or in an existing deal as specified by dealId.

The type of document being added/updated.

Specify ‘Y’ if you want to rename the current artifact specified by dealId and artifactType, ‘N’ if you want to create a new artifact.

The identifying number associated with the document being added/updated.  Note that if neither artifactId nor artifactNumber is specified in the request, the artifactNumber will be automatically assigned by the system.

Any related comments to be captured in LA

The currency used to value the line items on the artifact being added/updated.

The creation date of the document being added/updated. If creationDate is not specified in the request, it will be populated with the current date when the API request is processed.

The date of receipt of the document being added/updated.  If dateReceived is not specified in the request, it will be populated with the current date when the API request is processed.

Document Status/Workflow state of document

Operational group within customer organization primarily used for management reporting. (Known on CIW as SBU.)  Must exactly match value from Companies Tab where Company Role Type = SBU.

The legal party to the agreement leasing the equipment or renting the real estate. Real estate leases may refer to this as the Tenant.  Must exactly match a Lessee listed on the Companies Tab with the Company Role Type = Lessee.

Primary business entity which should match one of the entities listed on Companies Tab.  Must exactly match value from Companies Tab where Company Role Type = Entity.

Country Name that governs the accounting and tax rules for a transaction.

Also referred to as Lessor, they provide the cash to finance the equipment purchase through a lease agreement. Real Estate leases may refer to this as the Landlord.  Must exactly match a Lessee listed on the Companies Tab with the Company Role Type = Funder.

Used to identify parent/child relationships (if any) for a group of assets.

A unique identifier for equipment typically used to delineate the type of equipment in the manufacturer’s product catalogue.

Company Name. This field may be used to identify the Real Estate Developer for a real estate lease.

Description of equipment or real estate which may include model year, make, lot number, parcel number, and other descriptors.

Department code asset is assigned to for responsibility/management reporting.  Required if part of General Ledger String.  Note that this will be validated against the list of configured cost centers.

Number of units.  Must be >0; If blank, system assumes 1.

Original equipment cost per unit in local currency.  Must be >0.

The price at which the Lessee would purchase the lease or non-lease component separately. The relative percent for each component is used to allocate the total consideration of lease payments to each component for accounting purposes. If the observable standalone prices are not readily available, the Lessee shall estimate the standalone prices, maximizing the use of observable information. If observable price is entered for one asset, it should be entered for all assets, even if the observable price is the same as the unit price. The accounting standards prescribe the use of the SOP. This field should be entered if the explicit SOP or an estimate is used.  However, LeaseAccelerator does not REQUIRE the field since the system has default rules-based estimates.  Must be > 0

A specific rental or payment amount defined in the lease agreement for the specific asset or lease component. If the standalone observable price is not provided, this amount will be used as the estimate for allocating the total payments to each individual component and/or asset (if provided). If unit rent is specified for one asset, it must be specified for all assets on schedule. The accounting standards prescribe the use of the SOP.

Unique identifier for each asset

A field available to customers to group assets.  Typically, the asset tag assigned by your physical asset management (PAM) or IT asset management (ITAM) team and.  This may serve as a linking ID for reference to an external PAM or ITAM ssystem.  This attribute is not used by LeaseAccelerator beyond reporting, andreporting and may be repurposed.

Free form field for user comments

Name or employee responsible from organization/fiduciary perspective.  Must exactly match value on People Tab where People Role Type = Asset Owner.

Description field.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

The unit of measure for area (currently used for real estate leases).  Required if payments are utility-based calculations (versus a specified amount).

The amount of total space leased.  Required if payments are utility-based calculations (versus a specified amount).  Required only if utilityPricingBasis is Total.

The amount of space that can be used in the leased premises, generally measured from wall to wall.  Required only if utilityPricingBasis is Usable.

Refers to the usable space, plus a proportional share of common areas of the building, such as the main lobby, elevator lobbies and hallways, and bathrooms that are outside a tenant’s leased space and available for use by other tenants, etc. Required only if utilityPricingBasis is Rentable.

Price Per Utilized Unit - Rate used to determine rental payment.  Required if Utility Based payment; Amount >0.  For example, $100/square foot for 1000 square feet of usable space, utilityPricing would be 100, units would be Square Feet and usableSpace would be 1000 and utilityPricingBasis would be Usable.

The type of space factor used to identify the quantity of space rented.  Required if Utility based pricing.

Company Type Role in which this company can participate in transactions

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.

Street Address.  The specified address must be configured in LeaseAccelerator.

Additional address information such as floor or suite.

City used by postal service.  This may not be the more common name used in conversation.

Postal Abbreviation for acceptable Countries.

The country component of the address.

Type of contractual agreement.

Number of payments between commencement and original end of term. (Examples: 3-year lease paid monthly, Duration is 36. 3-year lease paid quarterly, Duration is 12.)  Must be positive number.

The frequency with which payments will be made.  If the lease uses a step payment schedule with multiple payment frequencies, specify Monthly here.

Specifies whether payments will be made at the beginning of the period or at the end of the period.

Indicates whether the lease pricing is quoted in terms of a Lease Rate Factor (LRF), a Fixed Interest Rate (Fixed), or a Floating Interest Rate (Floating).  

If the paymentBasis is specified as an LRF, a blendedLrf must be specified. 

If the paymentBasis is specified as a Fixed rate, the interestRate must be specified, along with an optional residualAmount. 

If the paymentBasis is specified as a Floating rate, the floatingRateBasis, spreadOverBasis, benchmarkDate, and adjustmentFrequency must all be specified, along with an optional residualAmount. 

Any amount that must be paid upfront by the lessee and is not included in the net amount financed.  Specify without currency formatting.

The unique transaction ID used by LeaseAccelerator to identify the deal to which the artifact was added/updated.

The unique artifact ID used by LeaseAccelerator to identify the document added/updated.

The type of document added/updated.

The identifying number associated with the document that was added/updated.  Note that if neither artifactId nor artifactNumber was specified in the request, the artifactNumber will be automatically assigned by the system.

The comments provided for the artifact in the request.

The currency provided for the artifact in the request.

The total value of the artifact based on the aggregation of the line items.

The creation date of the document being added/updated. If creationDate is not specified in the request, it will be populated with the current date when the API request is processed.

The date of receipt of the document being added/updated.  If dateReceived is not specified in the request, it will be populated with the current date when the API request is processed.

A comma-separated list of roles (of type Company) in which this company can participate in transactions:

None, All, or a comma-separated list of states of deals to which changes should be applied where the company being updated is already associated with deals in the specified state.  If None, the change will be limited to future deals; if All, the change will be retroactively applied to all deals in which the company is a participant.

Specifies an external identifier by which the company may be recognized.  Note that if companyId is not specified but importKey is, LeaseAccelerator will attempt to look up the importKey to see if this is a known company and, if so, will update the corresponding company.  This enables external systems to perform adds and updates using their own identifiers to reference the company.

The unique address ID used by LeaseAccelerator to identify a location.

Specifies a name for the external source associated with the importKey.  This name is limited to 32 characters in length.

The unique company ID used by LeaseAccelerator to identify the company.  If specified, the specified company will be updated; if not specified (and if the company cannot be resolved using importKey), a new company will be added.

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.

The unique company ID of the parent company, if this company rolls up to a higher parent. The highest organization within a company’s legal structure. 

Contact name.  First name Last name

Email address for POC.  Valid Format contains @xxx

The unique party ID used by LeaseAccelerator to identify a contact person at the specified company in the context of the specified contactTypes.

Name of attribute associated with the company that will be persisted.  Custom attribute types can be configured as needed.

The unique company ID used by LeaseAccelerator to identify the company

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.

Email address for POC.  Valid Format contains @xxx

The unique address ID used by LeaseAccelerator to identify a location at the specified company in the context of the specified contactTypes.

Street Address.  The specified address must be configured in LeaseAccelerator.

Additional address information such as floor or suite.

Telephone number

City used by postal service.  This may not be the more common name used in conversation.

The country component of the address.

The postal/zip code of the address.

Postal Abbreviation for acceptable Countries.

The unique party ID used by LeaseAccelerator to identify the person portion of this participant.

First name Last name

Company Type Role in which this company can participate in transactions

Website Address - Must be in standard format

Title

Name of attribute associated with API Method.  Custom attribute types can be configured as needed.

Name of the costcenter which needs to be added or updated.

Description of the costcenters which needs to to be added or updated.

This is used to retire the existing costcenters. When a new cost center is added, this will be defaulted to ‘N’. If an existing costcenter needs to be retired, then this value should be set to ‘Y’ along with the name of the costcenter that needs to be retired.  Retired cost centers are not deleted as they can be used by existing deals but are not valid to be selected for new deals or to change existing assets.

The function that a person plays within your leasing program.  A comma-separated list of roles (of type Person) in which this person can participate in transactions. 

None, All, or a comma-separated list of states of deals to which changes should be applied where the person being updated is already associated with deals in the specified state.  If None, the change will be limited to future deals; if All, the change will be retroactively applied to all deals in which the person is a participant.

Specifies an external identifier by which the person may be recognized.  Note that if partyId is not specified but importKey is, LeaseAccelerator will attempt to look up the importKey to see if this is a known person and, if so, will update the corresponding person.  This enables external systems to perform adds and updates using their own identifiers to reference the person.

Specifies a name for the external source associated with the importKey.  This name is limited to 32 characters in length.

The unique company ID used by LeaseAccelerator to identify the company with which the person is associated.

Name of the entity which you want to use which must already exist in the system. This Company is meant to be the main company for this person, NOT the companies they can act as the role type. This tab does NOT define which companies a person can be a participant for.

The unique party ID used by LeaseAccelerator to identify a person. If specified, the specified person will be updated; if not specified (and if the person cannot be resolved using importKey), a new person will be added. 

First name Last name

Email address for POC.  Valid Format contains @xxx

The unique address ID used by LeaseAccelerator to identify the primary location for the person.  If blank, data from corresponding Company Name on Companies Tab will be applied.

The title of the person

Phone number of the corresponding person

Name of attribute associated with the company that will be persisted.  Custom attribute types can be configured as needed.

The unique company ID used by LeaseAccelerator to identify the company

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.

Email address for POC.  Valid Format contains @xxx

The unique address ID used by LeaseAccelerator to identify a location at the specified company in the context of the specified contactTypes.

Street Address.  The specified address must be configured in LeaseAccelerator.

Additional address information such as floor or suite.

Telephone number

City used by postal service.  This may not be the more common name used in conversation.

The country component of the address.

The postal/zip code of the address.

Postal Abbreviation for acceptable Countries.

The unique party ID used by LeaseAccelerator to identify the person portion of this participant.

First name Last name

Company Type Role in which this company can participate in transactions

Website Address - Must be in standard format

Title

Phone number of the corresponding person

Name of attribute associated with API Method.  Custom attribute types can be configured as needed.

The unique artifact ID used by LeaseAccelerator to identify the document to which the file should be attached.

The creation date of the document being added/updated. If creationDate is not specified in the request, it will be populated with the current date when the API request is processed.

Document Status/Workflow state of document

The file creation date

Comment field

The unique artifact ID used by LeaseAccelerator to identify the document to which the file was attached.

The unique file-level ID used by LeaseAccelerator to identify the file attached to the document.

Unique identifier for a lease, i.e., schedule number

Category of Document

Unique number used as customer reference for the document. This is NOT the system defined artifact-ID. If left blank, system will assign number.

Choose a valid value for Company Type, People Type, or Address Type that you want to update.

For Company Type, you must fill in the company field.

For People Type, you must fill in the person field.

For Address Type, you must fill in the address fields.

For company particpantTypes, this specifies the company to update to.  To change the SBU to IT, participantType would be SBU and company would be IT.  The specified company must be configured in LeaseAccelerator as the specified participantType and must exactly match a value on Companies Tab where Company Role Type = Area, Geo, Lessee, Entity, Funder, Vendor, PropertyTaxAuthority, Project or SBU.

For people particpantTypes, this specifies the person to update to.  To change the OrderAdministrator to Gary Jones, participantType would be OrderAdministator and person would be Gary Jones.  The specified person must be configured in LeaseAccelerator as the specified participantType and must exactly match a value on People Tab where People Role Type = Asset Owner, Analyst, AssetUser, FinanceApprover, OrderAdministrator or Sourcing. 

Street Address.  The specified address must be configured in LeaseAccelerator.

Additional address information such as floor or suite.

City used by postal service.  This may not be the more common name used in conversation.

Postal Abbreviation for acceptable Countries.

The country component of the address.

The postal/zip code of the address.

Description

The set of books to which a schedule should be recorded. This may be one configured ledger or a list.  Must exactly match to configured list. See User Interface - Settings:  Ledger Name. 

The attributeName specified must match the Name specified for a segment in the Ledger Number configuration for a Set of Books (ledger) in LeaseAccelerator.  Contact your LeaseAccelerator Administrator for a list of the configured segment Names by ledger.

A valid value for the specified attribute.  This is the value that will be transferred as part of any export of accounting data.

First name Last name

Email address for POC.  Valid Format contains @xxx

The key used by the Identity Provider to uniquely identify this user, and that will be provided as part of authenticating this user through SSO.

User name.  Often same as email.

Name of the entity which you want to use which must already exist in the system. This Company is meant to be the main company for this person, NOT the companies they can act as the role type. This tab does NOT define which companies a person can be a participant for.

Chinese

English

French

Telephone number.  Valid Format.

The function that a person plays within your leasing program.

A comma-separated list of roles in which this person can participate in transactions. 

The identifying number associated with a document in the deal.  Note that User-attached documents (not otherwise categorized to a specific document type) and E-mail messages are not considered for search purposes. artifactType must also be specified or artifactNumber will be ignored.  Only assets in deals containing a document of the specified artifactType with the specified artifactNumber will be retrieved.

A type of document present in the deal.  The document need not have a physical version (e.g.,PDF). artifactNumber must also be specified or artifactType will be ignored.  Only assets in deals containing a document of the specified artifactType with the specified artifactNumber will be retrieved.

Unique identifier for each assetThe serial number(s) for the asset.

A pair of dates specifying a date range.

Choose a valid value for Company Type, People Type, or Address Type that you want to update.

For Company Type, you must fill in the company name field.

For People Type, you must fill in the asset participant name field.

For Address Type, you must fill in the address fields.

The name of a company participating in the transaction.  ContactType must also be specified or companyName will be ignored.  Only assets with the specified companyName selected as a document-level participant of the specified ContactType will be retrieved.

First name Last name.  The name of a person or company associated with the asset at the asset- or allocation-level. contactType must also be specified or assetParticipantName will be ignored.  Only assets with the specified assetParticipantName selected as an asset- or allocation-level participant of the specified contactType will be retrieved.  Contact your LeaseAccelerator Administrator for a list of any additional (custom) configured participant types at the asset- and allocation-level.

City used by postal service.  This may not be the more common name used in conversation.

Postal Abbreviation for acceptable Countries.

The country component of the address.

Determines whether or not active assets are retrieved.  Active assets include Renewed and Evergreen assets.

Determines whether or not terminated assets are retrieved.  Terminated assets are assets where the lessee is still in possession of the asset, but the lease obligation has been terminated, typically assets that have been Bought Out and not otherwise Disposed.

Determines whether or not disposed assets are retrieved.  Disposed assets are assets where the lease obligation has been terminated and the lessee is no longer in possession of the asset, typically Returned assets and Bought Out assets that have been subsequently, explicitly Disposed.

The unique ID used by LeaseAccelerator to identify the asset.

Free form field for user comments

Unique identifier for each assetThe serial number(s) for the asset.

A field available to customers to group assets.  Typically, the asset tag assigned by your physical asset management (PAM) or IT asset management (ITAM) team and.  This may serve as a linking ID for reference to an external PAM or ITAM ssystem.  This attribute is not used by LeaseAccelerator beyond reporting, andreporting and may be repurposed.

The unique address ID used by LeaseAccelerator to identify a location.

Free form field which may be used for any number of reference numbers desired.  This is often used to store a PO number or other operational reference information.

Description field used for identifying the Internet Points of Presence (POPs).  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field often used for IT-related equipment.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Department code asset is assigned to for responsibility/management reporting.  Required if part of General Ledger String.  Note that this will be validated against the list of configured cost centers.

GL Coding Convention ruleset that maps to the series of account codes where accounting transactions are recorded for this asset.  Must exactly match value set during GL Configuration in UI; Settings: Ledger Number: Set of Books Edit: GL Code (Coding Convention).  Enter only if different than Lease Start Date

A unique identifier for equipment typically used to delineate the type of equipment in the manufacturer’s product catalogue.

Grouping of assets by type

Description of equipment or real estate which may include model year, make, lot number, parcel number, and other descriptors.

Number of units.  Must be >0; If blank, system assumes 1

The type of contact retrieved.  This field does not support wildcarding and is case-sensitive.

The full name of the person as entered in LeaseAccelerator.

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.   Criteria on this field are searched in a case-insensitive manner and support the * and ? wildcards.

The name of the city to add to the search criteria. 

The name of the country to add to the search criteria. 

The unique company ID used by LeaseAccelerator to identify the company

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.

Email address for POC.  Valid Format contains @xxx

The unique address ID used by LeaseAccelerator to identify a location at the specified company in the context of the specified contactTypes.

Street Address.  The specified address must be configured in LeaseAccelerator.

Additional address information such as floor or suite.

Telephone number

City used by postal service.  This may not be the more common name used in conversation.

The country component of the address.

The postal/zip code of the address.

Postal Abbreviation for acceptable Countries.

The unique party ID used by LeaseAccelerator to identify the person portion of this participant.

First name Last name

Company Type Role in which this company can participate in transactions

Website Address - Must be in standard format

The identifying number associated with a document in the deal.  Note that User-attached documents (not otherwise categorized to a specific document type) and E-mail messages are not considered for search purposes. artifactType must also be specified or artifactNumber will be ignored.  Only assets in deals containing a document of the specified artifactType with the specified artifactNumber will be retrieved.

A type of document present in the deal.  The document need not have a physical version (e.g.,PDF). artifactNumber must also be specified or artifactType will be ignored.  Only assets in deals containing a document of the specified artifactType with the specified artifactNumber will be retrieved.

An internal document state code identifying the workflow state for a document in the deal.  This attribute is reserved for internal use only.

A pair of dates specifying a date range.

Choose a valid value for Company Type, People Type, or Address Type that you want to update.

For Company Type, you must fill in the company name field.

The name of a company participating in the transaction.  ContactType must also be specified or companyName will be ignored.  Only assets with the specified companyName selected as a document-level participant of the specified ContactType will be retrieved.

City used by postal service.  This may not be the more common name used in conversation.

Postal Abbreviation for acceptable Countries.

The country component of the address.

Limit returned deals to deals in the specified stage of the leasing lifecycle.

The maximum number of matching deals to be retrieved.  If not otherwise specified, the first 1,000 matches will be retrieved.

A type of document present in the deal.  If this tag is omitted, deals will be identified by their Deal Summary number, or by the most advanced document in the workflow if the deal has not yet reached the stage of having a Deal Summary.  Note that the artifactType specified in the TargetArtifact tag may be the same as or different from the artifactType specified as a criterion, and either or both may be omitted from the Payload.

The unique transaction ID used by LeaseAccelerator to identify a deal.

The date the transaction was most recently acted upon.

The lease commencement date for the transaction.

The identifying number associated with the key document in the deal.  If a TargetArtifact was specified in the request criteria, that artifactType will override whatever would have been returned as the default key document.

The unique artifact ID used by LeaseAccelerator to identify the key document.

The type of document identified as being the key document for the deal, typically Deal Summary.  If a TargetArtifact was specified in the request criteria, that artifactType will override whatever would have been returned as the default key document type.

The currency in which the deal was transacted.

The Original Equipment Cost of the lease transaction.

The key participant(s) in the deal, which may be the name of a company (e.g.,the Lessee), the name of a person (e.g.,the responsible Order Administrator), or a brief location description (e.g.,state or country of Ship To).

Limit returned deals to deals in the specified stage of the leasing lifecycle.

A text description summarizing the status of the deal.  This is often more granular and descriptive than the searchBucket, particularly during the pre-origination process, and when one or more partial EOT events has taken place.

The name of a configured report or document type to be rendered.  The report/document type must be accessible to the user with whom the API session was authenticated, or to the P_USERNAME specified as a Parameter.

A valid format configured for the requested report/document.  Not all reports/documents are configured for all output formats; consult your LeaseAccelerator Administrator to determine what formats are supported for your desired report/document.

The name of a parameter to be used in generating the document or report.  While the list of parameters varies from report to report, the following three parameters are particularly significant:

P_ARTIFACTID – This parameter is required when rendering a document, and specifies the unique LeaseAccelerator identifier for the document.

P_ASATDATE – For reports that support “as at” reporting, this specifies that the report should only reflect information known “as at” the end of day of the specified date.  “As at” dates in the future may yield inconsistent results, since future events can only be assumed, and are subject to change.

P_USERNAME – If specified, indicates that the report is to be run as this user.

The date to be used to determine what data should be included in the report.  Only deals and assets known “as at” the specified date will be included, and the cost, rent, and status values will reflect the values “as at” that date.

Used to filter the list of assets returned.  Only assets on leases for which the specified company participates as Business Unit will be returned.

Used to filter the list of assets returned.  Only assets located in the specified city will be returned.

Used to filter the list of assets returned.  Only assets allocated – at least partially – to the specified cost center will be returned.

Used to filter the list of assets returned.  Only assets located in the specified country will be returned.

Used to filter the list of assets returned.  Only assets on leases for which the specified company ID participates as the Funder will be returned.

Used to filter the list of assets returned.  Only assets of the specified asset type will be returned.

Used to filter the list of assets returned.  Only assets which are scheduled to reach natural end of term (or which are in evergreen) within the specified number of months will be returned.

Used to filter the list of assets returned.  Only assets on the specified lease schedule will be returned.

Used to filter the list of assets returned.  Only assets matching the specified serial number will be returned.  Wildcards (* and ?) may be used.

Used to filter the list of assets returned.  If set to N, assets which roll up to a parent asset will be excluded from the report.

The data exported should only reflect information known “as at” the end of day of the specified date.  Ledger entries are typically transferred to the ERP “as at” the last day of the fiscal period.  Note that using an “as at” date in the future may produce misleading or incorrect results, as future behavior must be inferred.

The unique identifier for a set of books in LeaseAccelerator.  Please contact your LeaseAccelerator Administrator for a list of valid ledgerId values.  Even though the tag is required, the value can be left blank if ledgerName tag is specified.

The unique name for a set of books in LeaseAccelerator.  Please contact your LeaseAccelerator Administrator for a list of valid ledgerName values.  If this tag value is specified, ledgerId value can be left blank.

The level of granularity at which ledger entries should be transferred to the ERP.  Regardless of this setting, debits and credits will always be separated based on ledger account coding, e.g.,cost center allocation.  For GL entries, PORTFOLIO is typically the preferred level of detail.

The fiscal year number, e.g.,2016, from which to start when transferring ledger entries.

The fiscal period from which to start transferring ledger entries.  Values 0 through 11 represent the months of the fiscal year (i.e. 0=January…11=December for December year end, 0=May…11=April for April year end, etc.).  Other allowable values are as follows:

• -4 – Q1

• -3 – Q2

• -2 – Q3

• -1 – Q4

• -10 – Current Month

• -20 – Prior Month

• -100 – Current Quarter

• -200 – Prior Quarter

The number of fiscal months for which to transfer ledger entries.

An optional parameter which limits the ledger entries transferred to a specific schedule (or set of schedules if a wildcard character is included).  If omitted, ledger entries are transferred for all schedules in the specified set of books that have entries in the specified reporting window (as defined by the combination of fiscalYear, periodCode, and numMonths).

Used to filter the list of ledger entries returned.  Only ledger entries which book to the specified cost center will be returned.

The ledger date for the posting.

The ERP account number to which the amount should be posted.

The descriptive name of the ERP account (e.g.,OPEX Expense).

A ledger segment as configured through the LeaseAccelerator Settings page.  LeaseAccelerator supports up to eleven client-specific ledger segments, each of which may be mapped to a corresponding ERP field.  Contact your LeaseAccelerator Administrator to determine how your ledger segments are configured for each configured set of books.

Indicates whether this posting is a debit or credit against the specified account.

The transactional currency of the ledger entry.

The date that should be used for FX conversion from transactional currency to functional currency, if different.

The amount of the debit/credit.

Provides context for the posting.  If the detailLevel was specified in the Request as SCHEDULE, this will include the Schedule number; if detailLevel was specified as ASSET, comments will include the unique LeaseAccelerator identifier for the associated asset.

Every entry in the Ledger Export file (line) will have a unique LedgerEntrySubId.

Entries sharing the same LedgerEntryID constitute a balanced entry. 

Every entry in the Ledger Export file (line) will have a ledgerEntryLineId.  Send back the ledgerEntryLineId(s) to LeaseAccelerator to acknowledge posting using CaptureDocumentId.

Every entry in the Ledger Export file (line) will have a postingEntryId that will identify a balanced entry.  Send back the postingEntryId (s) to LeaseAccelerator to acknowledge posting using CaptureDocumentId.  Note: postingEntryId will group by adjustment date.

The data exported should only reflect information known “as at” the end of day of the specified date.  Ledger entries are typically transferred to the ERP “as at” the last day of the fiscal period.  Note that using an “as at” date in the future may produce misleading or incorrect results, as future behavior must be inferred.

The unique identifier for a set of books in LeaseAccelerator.  Please contact your LeaseAccelerator Administrator for a list of valid ledgerId values.  Even though the tag is required, the value can be left blank if ledgerName tag is specified.

The unique name for a set of books in LeaseAccelerator.  Please contact your LeaseAccelerator Administrator for a list of valid ledgerName values.  If this tag value is specified, ledgerId can be left blank.

The level of granularity at which ledger entries should be transferred to the ERP.  Regardless of this setting, debits and credits will always be separated based on ledger account coding, e.g.,cost center allocation.  For GL entries, PORTFOLIO is typically the preferred level of detail.

The fiscal year number, e.g.,2016, from which to start when transferring ledger entries.

The fiscal period from which to start transferring ledger entries.  Values 0 through 11 represent the months of the fiscal year (i.e. 0=January…11=December for December year end, 0=May…11=April for April year end, etc.).  Other allowable values are as follows:

• -4 – Q1

• -3 – Q2

• -2 – Q3

• -1 – Q4

• -10 – Current Month

• -20 – Prior Month

• -100 – Current Quarter

• -200 – Prior Quarter

The number of fiscal months for which to transfer ledger entries.

An optional parameter which limits the ledger entries transferred to a specific schedule (or set of schedules if a wildcard character is included).  If omitted, ledger entries are transferred for all schedules in the specified set of books that have entries in the specified reporting window (as defined by the combination of fiscalYear, periodCode, and numMonths).

Used to filter the list of ledger entries returned.  Only ledger entries which book to the specified cost center will be returned.

The name of a configured report or document type to be rendered.  The report/document type must be accessible to the user with whom the API session was authenticated, or to the P_USERNAME specified as a Parameter.

A valid format configured for the requested report/document.  Not all reports/documents are configured for all output formats; consult your LeaseAccelerator Administrator to determine what formats are supported for your desired report/document.

Choose a valid value for Company Type, People Type, or Address Type that you want to validate.

This is the request id for the report request which can be used to track the status and download the report later.

The name of a configured report or document type to be rendered.  The report/document type must be accessible to the user with whom the API session was authenticated, or to the P_USERNAME specified as a Parameter.

This is the format of the requested report. Not all reports/documents are configured for all output formats.

The end of the month the close took effect.

The actual date the user performed the month-end close.

The user name of the LeaseAccelerator user that performed the close.

The comments entered by the user when closing the period.

This is the request id for the requested report which can be used to track the status and download the report later.

The status of the report.

File name of the generated report.

This is the flag which informs whether the report request cancelled or not.

If the sweeping task is currently running the return value will be “Y” else “N”.

If the sweeping task is currently running the return value will be “Y” else “N”.

The status of the actual sweep, if applicable.

The unique transaction ID used by LeaseAccelerator to identify a deal.

The unique artifact ID used by LeaseAccelerator to identify the document added/updated.

The type of document added/updated.

The identifying number associated with the document that was added/updated.  Note that if neither artifactId nor artifactNumber was specified in the request, the artifactNumber will be automatically assigned by the system.

The comments provided for the artifact in the request.

The currency provided for the artifact in the request.

The unique transaction ID used by LeaseAccelerator to identify the deal to which the artifact was added/updated.

The total value of the artifact based on the aggregation of the line items.

The creation date of the document being added/updated. If creationDate is not specified in the request, it will be populated with the current date when the API request is processed.

The date of receipt of the document being added/updated.  If dateReceived is not specified in the request, it will be populated with the current date when the API request is processed.

The unique document ID used by LeaseAccelerator to identify a specific document within a deal.

The unique transaction ID used by LeaseAccelerator to identify a deal.

Type of event

The name used to record the event.  If not specified, this defaults to the user credentials used to authenticate the API connection.

A free-form text block of additional comments to be recorded as part of the event.

Is event superseded by another event.

The unique transaction ID used by LeaseAccelerator to identify a deal.

The unique company ID used by LeaseAccelerator to identify the company

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.

Email address for POC.  Valid Format contains @xxx

The unique address ID used by LeaseAccelerator to identify a location at the specified company in the context of the specified contactTypes.

Street Address.  The specified address must be configured in LeaseAccelerator.

Additional address information such as floor or suite.

Telephone number

City used by postal service.  This may not be the more common name used in conversation.

The country component of the address.

The postal/zip code of the address.

Postal Abbreviation for acceptable Countries.

The unique party ID used by LeaseAccelerator to identify the person portion of this participant.

First name Last name

Company Type Role in which this company can participate in transactions

Website Address - Must be in standard format

The function that this location plays within your leasing program.

Name of the location used as reference within your company where assets are located.

The highest organization within a company’s legal structure.

Street Address. 

Additional address information such as floor or suite.

City used by postal service.  This may not be the more common name used in conversation.

Postal Abbreviation for acceptable Countries.

Postal Abbreviation for acceptable Countries.

The country component of the address.

The postal/zip code of the address.

Facility Code (ShipTo Key) is a customer code associated with a specific ShipTo Address. Using a Facility Code as on the PIW eliminates the need to enter any values in the ShipTo Address fields in the PIW only. 

Unique value, code cannot exist in the system already.

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

The unique ID used by LeaseAccelerator to identify a deal.

The identifying number associated with a document in the deal being updated.  Note that either dealId or artifactNumber must be specified in the request, but only one is required.  If dealId is specified, artifactNumber will be ignored.

Grouping of assets by type

Used to identify parent/child relationships (if any) for a group of assets.  If you have multiple parent assets with associated child assets, you must list them each on their own line.  Each parent assets get a whole number in External Id and each child asset to that parent has the associated .1, .2, etc.

A unique identifier for equipment typically used to delineate the type of equipment in the manufacturer’s product catalogue.

Company Name. This field may be used to identify the Real Estate Developer for a real estate lease.

Description of equipment or real estate which may include model year, make, lot number, parcel number, and other descriptors.

Department code asset is assigned to for responsibility/management reporting.  Required if part of General Ledger String.  Note that this will be validated against the list of configured cost centers.

GL Coding Convention ruleset that maps to the series of account codes where accounting transactions are recorded for this asset.  Must exactly match value set during GL Configuration in UI; Settings: Ledger Number: Set of Books Edit: GL Code (Coding Convention).  Enter only if different than Lease Start Date

Free form field which may be used for any number of reference numbers desired.  This is often used to store a PO number or other operational reference information.

Number of units.  Must be >0; If blank, system assumes 1

Original equipment cost per unit in local currency.  This is not an extended price; that will be calculated by LeaseAccelerator.  Must be >0

Unique identifier for each asset.

A field available to customers to group assets.  Typically, the asset tag assigned by your physical asset management (PAM) or IT asset management (ITAM) team and.  This may serve as a linking ID for reference to an external PAM or ITAM ssystem.  This attribute is not used by LeaseAccelerator beyond reporting, andreporting and may be repurposed.

Free form field for user comments

Name or employee responsible from organization/fiduciary perspective.  Must exactly match value on People Tab where People Role Type = Asset Owner.

Name of employee with custodial responsibility.  Must exactly match value on People Tab where Person Role Type = Asset User.

The unique address ID used by LeaseAccelerator to identify the address at which the asset(s) is currently located.

The unique address ID used by LeaseAccelerator to identify the address at which the asset(s) is currently located.

Customer code (Facility Code) which may be used instead of any of the ShipTo fields.  Code must exist in system already, having been configured with an Address Bulk Import from the CIW.

Description field often used for IT-related equipment.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field used for identifying the Internet Points of Presence (POPs). This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

A description field often used by customers to define the work state of an asset. Examples may include: Out for Repair, Under Construction, In Service. This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Company Code assigned to the asset.

Profit Center assigned to the asset.

Internal Order assigned to the asset.

Project assigned to the asset.

Vendor assigned to the asset.

The percentage of the asset that is to be applied to the given cost center, GL Code and any customer allocation participants.

Default action to take on the asset at end-of-term.  Valid values include ZeroBuyout or Evergreen

This is a description of the function that this company plays within your leasing program.

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.

The highest organization within a company’s legal structure.

Website Address - Must be in standard format

Street Address. 

Additional address information such as floor or suite.

City used by postal service.  This may not be the more common name used in conversation.

Postal Abbreviation for acceptable Countries.

The country component of the address.

The postal/zip code of the address.

First Name, Last Name of Primary Contact

Telephone number

Email address for POC - Valid Format contains @xxx

The code or “value” per Chart of Accounts or accounting system associated with the participant company, if appropriate.

Functional Currency is the currency which is used for accounting purposes.  This currency is common for all contracts for the specified company role.  The functional currency causes a remeasurement of accounting transactions from the local or transaction currency so that all contracts are accounted for using the same currency. Each Entity may only have 1 Functional Currency.

Unique identifier for a lease.

The commencement date or takedown date. The date when the duration of the lease starts and therefore the payment schedule begins.

The set of books to which a schedule should be recorded. This may be one configured ledger or a list.   Must exactly match to configured list. See User Interface - Settings:  Ledger Name.    If not specified, and only one ledger is configured, the deal will be automatically booked into the only configured ledger.

The date that transaction becomes known and should be recognized from an accounting perspective.

The currency used to value the line items on the deal being loaded.

Internal Reference number that matches the customer’s ERP Procurement Purchase Order Number to the Supplier’s.  If a deal contains assets spanning multiple Purchase Orders, the ReferenceNumber tag at the asset level may be more appropriate to use.

Primary business entity which should match one of the entities listed on Companies Tab.  Must exactly match value from Companies Tab where Company Role Type = Entity

Operational group within customer organization primarily used for management reporting. (Known on CIW as SBU.)  Must exactly match value from Companies Tab where Company Role Type = SBU.

Incremental Borrowing Rate.  Will default to configuration value if blank. 

For ASC840, Operating or Capital Leases. For ASC842  Capitalized Operating or Finance. For IFRS 16, Finance.  Leave blank to engage automated LA Classification Engine

Explanation for accounting classification.  Required if Accounting Classification is input

The legal party to the agreement leasing the equipment or renting the real estate. Real estate leases may refer to this as the Tenant.  Must exactly match a Lessee listed on the Companies Tab with the Company Role Type = Lessee.

Also referred to as Lessor, they provide the cash to finance the equipment purchase through a lease agreement. Real Estate leases may refer to this as the Landlord.  Must exactly match a Lessee listed on the Companies Tab with the Company Role Type = Funder.

This must be the individual location name where the asset is physically located.

Mailing address line 1 of ShipTo Company.

Mailing address line 2 of ShipTo Company.

Mailing address City of ShipTo Company.

Mailing address postal abbreviation for acceptable countries of ShipTo Company.

Mailing address Country of ShipTo Company.

Mailing address Postal Code of ShipTo Company.

Customer code (Facility Code) which may be used instead of any of the ShipTo fields.  Code must exist in system already, having been configured with an Address Bulk Import from the CIW.

Country Name that governs the accounting and tax rules for a transaction.

Participant used to drive internal management reporting which is typically used for geographic region but may be used for other reporting requirements.  Must exactly match value on Companies Tab where Company Role Type = Area

Name or employee responsible from organization/fiduciary perspective.  Must exactly match value on People Tab where People Role Type = Asset Owner

The LeaseAccelerator internal Id of the Asset Owner for the deal.

Name of employee with custodial responsibility.  Must exactly match value on People Tab where People Role Type = Asset User

The LeaseAccelerator internal Id of the Asset User for the deal.

Name of employee responsible for procurement.  Must exactly match value on People Tab where People Role Type = Order Administrator

The LeaseAccelerator internal Id of the Order Administrator for the deal.

Name of employees responsible for approving deal from Finance organization.  Must exactly match value on People Tab where People Role Type = Finance Approver

A company providing a service related to the leased asset.  Often used for providers of IDCs, Lease Incentives, or other real estate expenses such as insurance.  Must exactly match value on Companies Tab where Company Role Type = Vendor.

The name of the InterCompany role for the deal.

The percentage of the asset that is to be applied to the given cost center, GL Code and any customer allocation participants.

Default action to take on the asset at end-of-term.  Valid values include ZeroBuyout or Evergreen

Real Estate related.  Determines if leased property is for an entire building. This impacts the lease classification testing procedures such that a partial building does not have a FMV (no cost basis available) for purposes of the Substantially All Test (90% for ASC840).  Required for Real Estate leases. Allowed for the following Product Categories only: Real Estate, Billboards, Buildings, Data Center, Land, Stadium Suite, Available for any custom real estate sub-categories requested by customers.

The unique address id of type ShipToAddress

Grouping of assets by type

Used to identify parent/child relationships (if any) for a group of assets.

A unique identifier for equipment typically used to delineate the type of equipment in the manufacturer’s product catalogue.

Company Name. This field may be used to identify the Real Estate Developer for a real estate lease.

Description of equipment or real estate which may include model year, make, lot number, parcel number, and other descriptors.

Department code asset is assigned to for responsibility/management reporting.  Required if part of General Ledger String.  Note that this will be validated against the list of configured cost centers.

Project code asset is assigned for responsibility/management reporting.  Required if part of General Ledger String.

GL Coding Convention ruleset that maps to the series of account codes where accounting transactions are recorded for this asset.  Must exactly match value set during GL Configuration in UI; Settings: Ledger Number: Set of Books Edit: GL Code (Coding Convention).  Enter only if different than Lease Start Date

Date the asset becomes available for use by the Lessee. This date is used to define the effective dates for factors used in lease classification.

The date that assets should begin to depreciate.  Enter only if different than Lease Start Date or Available for Use Date   Note that the depreciationStartDate cannot precede the assetAvailableDate. 

Free form field which may be used for any number of reference numbers desired.  This is often used to store a PO number or other operational reference information.

Number of units.  Must be >0; If blank, system assumes 1

Original equipment cost per unit in local currency.  This is not an extended price; that will be calculated by LeaseAccelerator.  Must be >0

The price at which the Lessee would purchase the lease or non-lease component separately. The relative percent for each component is used to allocate the total consideration of lease payments to each component for accounting purposes. If the observable standalone prices are not readily available, the Lessee shall estimate the standalone prices, maximizing the use of observable information. If observable price is entered for one asset, it should be entered for all assets, even if the observable price is the same as the unit price. The accounting standards prescribe the use of the SOP. This field should be entered if the explicit SOP or an estimate is used.  However, LeaseAccelerator does not REQUIRE the field since the system has default rules-based estimates.  Must be > 0

A specific rental or payment amount defined in the lease agreement for the specific asset or lease component. If the standalone observable price is not provided, this amount will be used as the estimate for allocating the total payments to each individual component and/or asset (if provided). If unit rent is specified for one asset, it must be specified for all assets on schedule. The accounting standards prescribe the use of the SOP.

This field should be entered if the explicit SOP or an estimate is used.  However, LeaseAccelerator does not REQUIRE the field since the system has default rules-based estimates.  Must be > 0

Unique identifier for each asset.

A field available to customers to group assets.  Typically, the asset tag assigned by your physical asset management (PAM) or IT asset management (ITAM) team and.  This may serve as a linking ID for reference to an external PAM or ITAM ssystem.  This attribute is not used by LeaseAccelerator beyond reporting, andreporting and may be repurposed.

Free form field for user comments

Name or employee responsible from organization/fiduciary perspective.  Must exactly match value on People Tab where People Role Type = Asset Owner.

The LeaseAccelerator internal Id of the Asset Owner for the asset.

Name of employee with custodial responsibility.  Must exactly match value on People Tab where Person Role Type = Asset User.

The LeaseAccelerator internal Id of the Asset User for the asset.

The unique address ID used by LeaseAccelerator to identify the address at which the asset(s) is currently located.

The unique address ID used by LeaseAccelerator to identify the address at which the asset(s) is currently located.

This must be the individual location name where the asset is physically located.

Mailing address line 1 of ShipTo Company.

Mailing address line 2 of ShipTo Company.

Mailing address City of ShipTo Company.

Mailing address State of ShipTo Company. (May be Province where appropriate) See Country Province List in Valid Values Glossary.

Mailing address Postal Code of ShipTo Company.

Mailing address State of ShipTo Company. (May be Province where appropriate) See Country Province List in Valid Values Glossary.

Customer code (Facility Code) which may be used instead of any of the ShipTo fields.  Code must exist in system already, having been configured with an Address Bulk Import from the CIW.

Description field often used for IT-related equipment.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field used for identifying the Internet Points of Presence (POPs). This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Description field.  This attribute is not used by LeaseAccelerator beyond reporting and may be repurposed.

Type of contractual agreement.  FMV and FinLse-Put (also known as “$1 Out”) are the most commonly used structures.

Number of payments between commencement and original end of term. (Examples: 3-year lease paid monthly, Duration is 36. 3-year lease paid quarterly, Duration is 12.)  Must be positive number

Periodic nature of payments.   If the lease uses a step payment schedule with multiple payment frequencies, specify Monthly here.

Specifies whether payments will be made at the beginning of the period or at the end of the period.

Indicates whether the lease pricing is quoted in terms of a Lease Rate Factor (LRF), a Fixed Interest Rate (Fixed), or a Floating Interest Rate (Floating).   If the paymentBasis is specified as an LRF, a Lrf must be specified. 

If the paymentBasis is specified as a Fixed rate, the interestRate must be specified, along with an optional residualAmount. 

If the paymentBasis is specified as a Floating rate, the floatingRateBasis, spreadOverBasis, benchmarkDate, and adjustmentFrequency must all be specified, along with an optional residualAmount. 

Lease Rate Factor. Numeric factor expressed as a decimal used to calculate a payment, renewal or buyout amount by multiplying against the Original Equipment Cost.  Required if Payment not specified. Note that the blendedLrf times the aggregate extended price (quantity * unitPrice) of the specified line items must match the periodicPayment (if both blendedLrf and periodicPayment are specified) or the request will be rejected with an error.  Should be specified only if paymentBasis is LRF.

Funder Implicit Interest Rate, which is not ordinarily known by the Lessee.  Enter as a number (i.e. 5% not 0.05).  Note that the payment calculated by applying the interestRate to the aggregate extended price (quantity * unitPrice) of the specified line items, less any specified residualAmount, must match the periodicPayment (if both interestRate and periodicPayment are specified) or the request will be rejected with an error. Should be specified only if paymentBasis is Fixed.

Specifies the residual value, expressed as a percentage of asset value for tangible (hard cost) assets, excluded by the lessor in calculating the periodic payment.  Should be specified only if paymentBasis is Fixed or Floating.  Defaults to zero if not specified and paymentBasis is Fixed or Floating. 

The publicly reported interest rate on which the Floating rate is based.  Should be specified only if paymentBasis is Floating.

The increment which is added/subtracted to the index to determine the lease’s specific rate. For example, the lease is based on CPI + 1%, where 1% is the spread over index.   Enter as a number (i.e. 5% not 0.05)    Note that the payment calculated by applying the uplifted basis rate as of the specified benchmarkDate to the aggregate extended price (quantity * unitPrice) of the specified line items, less any specified residualAmount, must match the periodicPayment (if both interestRate and periodicPayment are specified) or the request will be rejected with an error.  Should be specified only if paymentBasis is Floating.

The date that the initial floating rate is based on. This serves as the base index by which changes are measured from.  Required if Floating Rate Lease.  Should be specified only if paymentBasis is Floating.

How often the index basis is measured for change.  Required if Floating Rate Lease .  Should be specified only if paymentBasis is Floating.

Maximum increase that a rental payment may increase for a single measurement if floating rate lease.  Number >= 0 or Null (if None). Should be specified only if paymentBasis is Floating.

Initial Payment Amount - First payment amount from which escalation caps are applied. Amount, if any, in addition to the base rent.  May be Required where Expense Type = CAMS or Other Related Expense and Lease Type = Gross Lease, Triple-Net, or Full Service. Number >

Type of Interim Rent which denotes how and when to apply the rent to the payment schedule.  Specifies whether the lease does not have interim rent (EXEMPT), accrues interim rent which is payable on the first day of the lease (Accrue and Pay at Commencement), or accrues interim rent that is then rolled into the financed amount (Accrue and Add to Amount Financed at Commencement).

The basis for the rent charge.  Specifies whether interim rent will be calculated based on a fixed interest rate (Fixed), based on a rate that floats proportionate to the base lease terms based on changes in a publicly reported interest rate (Floating), based on a pro rata daily charge equal to the monthly rent throughout the term of the lease (Same), or based on a fixed amount already determined (Amount).  If Fixed is specified, then either interimRate or interimLRF must be specified.  If Floating is specified, then interimIndexType must be specified.  If Amount is specified, then interimRent must be specified.  Should be specified only if interimRentType is not EXEMPT.

The interest rate benchmark if Interim Rent Basis = Floating. Also required for Fixed.  Number >0.

An increment/decrement to the Interim Rate to determine the final Interim Rent.  Number; may be positive or negative.

The public index to which the interim floating rate is tied.   Should be specified only if interimRentBasis is Floating and interimRentType is not EXEMPT.

Amount of Interim Rent payment.  Number >0. May be blank if Interim LRF is defined to calculate payment amount.  Specify only if interimRentBasis is Amount and interimRentType is not EXEMPT.

Lease Rate Factor applied to OEC to calculate the Interim Rent if not specified.  Number >0. May be blank if Interim Rent Amount is specified Should be specified only if interimRentBasis is Fixed and interimRentType is not EXEMPT.

Amount of Payment.  Number >0. Note that this must match the calculated amount based on the specified paymentBasis and associated attributes.

Number of months that the assets contained in the lease are expected to be used. This may be shorter than Duration if assets are typically bought out early or may be longer than duration if renewal periods are typically exercised or evergreen is typically incurred.  Must be a positive number and must be number of months regardless of Frequency.

The type of option.

Indicates whether the option is exercisable at a specific point in time (Mid-Term) or if the option is exercisable at end of term (EOT), even if that date changes as a result of a Renewal event.

Should be set to Y if this is the option which is reasonably certain to be exercised at end of term.

Specifies the month number in which the option may be exercised.  For Renewal options, this should be the first month number after the end of term, e.g.,37 for a three-year lease.  If optionTiming is specified as Mid-Term, then monthExercisable must be specified.

Indicates whether or not the lessee must provide notice to the lessor in order to exercise the option.  If notificationRequired is N, the option will exercise automatically at end of term.  Note that only one option may have notificationRequired set to N.  If not specified, notificationRequired defaults to Y.

The minimum advance notice in days that a lessee must provide to the lessor before they can exercise the option.   If specified, notificationRequired will be treated as Y for the option, regardless of what is specified.

The maximum advance notice in days that a lessee may provide to the lessor that they intend to exercise the option.   If specified, notificationRequired will be treated as Y for the option, regardless of what is specified.

Indicates whether this option is exercised at the discretion of the Lessee (Y) or the Lessor (N).  If not specified, defaults to Y.

The prenegotiated price for a Buyout option. May be specified as a fixed amount (e.g.,5000) or as a percentage of original equipment cost (e.g.,12.5%); the percent sign is used to interpret the specified purchasePrice.  If purchasePrice is not specified for a Buyout option, it is assumed to be an FMV Buyout, with purchase price to be determined at the time of exercise.  This tag should not be specified unless optionType is Buyout. 

The minimum price for a Buyout option. May be specified as a fixed amount (e.g.,5000) or as a percentage of original equipment cost (e.g.,12.5%); the percent sign is used to interpret the specified minimumPurchasePrice.  This tag should not be specified unless optionType is Buyout. 

The maximum price for a Buyout option, also known as a Buyout cap. May be specified as a fixed amount (e.g.,5000) or as a percentage of original equipment cost (e.g.,12.5%); the percent sign is used to interpret the specified maximumPurchasePrice.  This tag should not be specified unless optionType is Buyout. 

The number of months to which the lessee commits to renew the assets at the specified renewalPayment, if the option is exercised.

The prenegotiated periodic payment for a Renewal option. May be specified as a fixed amount (e.g.,5000) or as a percentage of original equipment cost (e.g.,12.5%); the percent sign is used to interpret the specified renewalPayment.  If renewalPayment is not specified for a Renewal option, it is assumed to be an FMV Renewal, with renewal payment to be determined at the time of exercise.  This tag should not be specified unless optionType is Renewal. 

Specifies the lease rate factor used to calculate the renewal payment at the time of renewal, e.g.,0.025.

For utilization-based renewal options, specifies the price per unit used to calculate the renewal payment at the time of renewal, e.g.,$8/sf.

Specifies the utilization unit used to price the renewal.  This renewal option will be applicable only to assets for which utilization-based pricing is specified, and where the pricing is based on the matching utilization unit type.

The minimum periodic payment for a Renewal option. May be specified as a fixed amount (e.g.,5000) or as a percentage of original equipment cost (e.g.,12.5%); the percent sign is used to interpret the specified minimumRenewalPayment.  This tag should not be specified unless optionType is Renewal. 

The maximum periodic payment for a Renewal option, also known as a Renewal cap. May be specified as a fixed amount (e.g.,5000) or as a percentage of original equipment cost (e.g.,12.5%); the percent sign is used to interpret the specified maximumRenewalPayment.  This tag should not be specified unless optionType is Renewal. 

A prenegotiated fee associated with a Return option, often for early returns. May be specified as a fixed amount (e.g., 5000) or as a percentage of original equipment cost (e.g.,12.5%); the percent sign is used to interpret the specified returnFee.  If returnFee is not specified for a Return option, no return fee is assumed to apply.  This tag should not be specified unless optionType is Return. 

The maximum fee associated with a Return option, also known as a Limit. May be specified as a fixed amount (e.g., 5000) or as a percentage of original equipment cost (e.g.,12.5%); the percent sign is used to interpret the specified maximumReturnFee.  This tag should not be specified unless optionType is Return. 

Indicates whether the returnFee will be reduced by the proceeds, if any, from the sale of the asset by the lessor subsequent to returning the asset.

The month in which this step begins.  The first monthNumber is 1.

The number of consecutive payment periods, starting from monthNumber, during which the same payment amount will be due on the same payment frequency.  Note that the StepPaymentSchedule should define enough Steps to cover the entire lease, and each month within the lease term should be associated with exactly one Step.  Steps may not overlap.

The frequency with which payments will be made in this step.

Specifies the type of related expense for accounting purposes.

Describes more specifically the type of related expense, within the specified expense type grouping.

The frequency with which the expense recurs.  If this is a one-time expense, e.g.,a security deposit, One-Time should be specified.

If the expense is only applicable to a certain type of assets (e.g.,Custodial fees may apply only to Building assets), the asset type may be specified here to limit the allocation of expense to those assets of the specified type.

The company name to whom the expense will be remitted.

A benchmark amount for comparison purposes.  This amount is not used for any calculations other than to display onscreen the percentage variance from the benchmarkPaymentAmount as actual amounts are invoiced and/or paid.

The maximum amount, expressed as a percentage, by which the expense amount may increase from period to period.  Ignored if paymentFrequency is One-Time.

The maximum amount which may be billed for this expense in any given period.

The scheduled date, if known, for the next (or only) payment of this type of expense.

The amount, if known, to be paid per period or as a one-time expense.

For Security Deposits and Special Deposits, indicates if the deposit will earn interest between the time the deposit is paid and when it is refunded.  For Late Fees, indicates if the Late Fee is calculated by applying an interest rate.

The deal id for which payment adjustment needs to be performed

Artifact number or the schedule number of the portfolio which needs to be imported

The date from which the payment needs to be adjusted

The date at which a remeasurement is required for adjustment

The amount which needs to be adjusted or needs to be updated

The predefined reason for the payment adjustment

Timings for the payment adjustment. Either one time or recurring.

Posting ID of the Payment in the source system. For example: Check Number, Wire Transfer Number, or ACH Number.

The unique transaction ID used by the ERP to identify this payment.  If the postingId has already been seen in LeaseAccelerator, but for a different amount, processing will depend on the WarningPolicy for the Request.  If the WarningPolicy is Ignore, the existing entry will be adjusted or, if the existing entry has been locked by Month-End Close, an adjusting entry will be created.  If the WarningPolicy is Stop or Skip, the Disbursement will be ignored, and a warning will be returned as part of the Response payload.

The date the payment was made.

The currency in which the payment was made.

The amount of the payment.

Often Vendor Invoice# from external system.

This value should be the “ledgerentryid” identifier specified during the export of the payment export to the Accounts Payable module.  In order for LeaseAccelerator to properly link the actual disbursement back to the original expected payment(s), this reference ID must be specified.  Note that multiple PaymentReferenceId tags may be specified for a single Disbursement.

Internal Reference number can be used to match payment made in Accounts Payable system to the original expected payment in Lease Accelerator.  This must match the number for the Purchase Order for the deal in LA.  This can be used instead of paymentReferenceID.   API will error if both paymentReferenceID and poNumber fields are populated.

Internal Reference number that can be used in conjunction with PONumber to help match payment made in Accounts Payable system to the original expected payment in Lease Accelerator.

Name of local currency.

Name of currency translation for accounting or reporting purposes.

Date which the multiplier is active (as of the beginning of the day).

Factor to multiply the From Currency against to arrive at the To Currency.  Multipliers are published indices.

The source of the currency translation factor.

The unique ID used by LeaseAccelerator to identify a deal.

The identifying number associated with a document in the deal being updated.  Note that either dealId or artifactNumber must be specified in the request, but only one is required.  If dealId is specified, artifactNumber will be ignored.

Grouping of Assets by type

A type of related expense specified in the contract as the responsibility of the Lessee. Payment may be made to the Lessor/Landlord or directly to the Vendor.

A grouping of expenses within a category by function.

A company providing services related to the leased asset. Often used for providers of IDCs, Lease Incentives, or other real estate expenses such as insurance.  Must exactly match value on Companies Tab where Company Role Type = Vendor

Description of Expense

Beginning date for which services were provided for the expense.  By Expense/Sub-Expense Type

Ending date for which services were provided for the expense.  By Expense/Sub-Expense Type

Amount of Expense.  Number >0

Currency associated with Invoiced Amount

Invoice Date per Vendor Invoice Artifact

Reference Number assigned by Vendor

The legal party to the agreement leasing the equipment or renting the real estate. Real estate leases may refer to this as the Tenant.  Must exactly match a Lessee listed on the Companies Tab with the Company Role Type = Lessee.

Country Name that governs the accounting and tax rules for a transaction.

The number of months the rate is applicable.

The type of rate specified.

The actual numeric rate to be imported.