LeaseAccelerator Reference Data API

openapi: 3.1.0
info:
  title: LeaseAccelerator Documents Reference Data API
  version: '26.3'
  summary: REST-addressed, XML-RPC style API for the LeaseAccelerator enterprise lease lifecycle platform.
  description: 'The LeaseAccelerator API combines the simplicity of REST requests with the data exchange capabilities of XML Remote Procedure Calls (RPC). Each request is stateless and multiple method requests can be submitted concurrently from the same secure session.


    Access is secured by SAML2. Before submitting API requests you authenticate through the LeaseAccelerator SAML2 authentication layer (service provider URL `https://{environment}.leaseaccelerator.com/auth/api`, ECP mode against your own identity provider) and receive a text security token. Requests are then POSTed to `https://{environment}.leaseaccelerator.com/lease_accelerator/api/LeaseAccelerator/{operation}` with the `token` and `file` form fields, where `file` carries an `<APIRequest>` document.


    This description was generated by the API Evangelist enrichment pipeline from the publicly published LeaseAccelerator developer documentation. Operation keys, the URL template, the authentication model, and the request/response envelopes are taken verbatim from that documentation; per-field payload schemas are documented per operation in the API Methods reference and are not reproduced here.'
  termsOfService: https://insightsoftware.com/legal/terms-of-use/
  contact:
    name: LeaseAccelerator Support (insightsoftware)
    url: https://insightsoftware.com/support/
  x-generated-by: api-evangelist enrichment pipeline
  x-source-documentation: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895814655245-Application-Programming-Interface-API-for-Developers
servers:
- url: https://{environment}.leaseaccelerator.com/lease_accelerator/api/LeaseAccelerator
  description: LeaseAccelerator API endpoint. `environment` is the LeaseAccelerator environment being accessed (www for production); contact LeaseAccelerator Support for other environment URLs.
  variables:
    environment:
      default: www
      description: LeaseAccelerator environment; www is production.
security:
- saml2Token: []
tags:
- name: Reference Data
paths:
  /AddUpdateAddress:
    post:
      operationId: AddUpdateAddress
      summary: Add/Update Address
      description: 'This method may be used to update existing addresses and/or to add new addresses. Addresses are specific workplaces in your organization where employees work and/or equipment may be physically located or shipped to. This would also include the physical location of any leased Real Estate. They 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.)


        Operation key: `AddUpdateAddress`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reference Data
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /AddUpdateCompany:
    post:
      operationId: AddUpdateCompany
      summary: Add/Update Company
      description: 'This method may be used to update existing companies and/or to add new companies. The Companies tab defines those companies that are a part of your leasing program. Each company, however, may perform a different role or function. Examples include: Lessees: The legal party to the agreement 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 t


        Operation key: `AddUpdateCompany`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reference Data
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /AddUpdateCostCenters:
    post:
      operationId: AddUpdateCostCenters
      summary: Add/Update Cost Centers
      description: 'The AddUpdateCostCenters operation is used to add a new costcenter or update an existing costcenter in LeaseAccelerator. The adding of costcenter is similar to the the functionality ImportCostCenters in BulkImport screen using the spreadsheet.


        Operation key: `AddUpdateCostCenters`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reference Data
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /AddUpdatePerson:
    post:
      operationId: AddUpdatePerson
      summary: Add/Update Person
      description: 'This method may be used to update existing people and/or to add new people. Many people participate in your leasing program and have different roles. These people may or may not be users of the system. LeaseAccelerator captures 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: Employees who have fiduciary responsibility for the main


        Operation key: `AddUpdatePerson`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reference Data
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /DefineReferenceData:
    post:
      operationId: DefineReferenceData
      summary: Define Reference Data
      description: 'The DefineReferenceData operation. See the API Methods reference for the full request and response payload.


        Operation key: `DefineReferenceData`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reference Data
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /ImportAddresses:
    post:
      operationId: ImportAddresses
      summary: Import Addresses
      description: 'This method may be used to import addresses. This method is similar to the functionality when using the “Address tab” on the CIW. Note: NOTE: For Company addresses (i.e., the company tab on the CIW), use the Import Company method. For People addresses (i.e., the people tab on the CIW), use the Import People method. Addresses are specific workplaces in your organization where employees work and/or equipment may be physically located or shipped to. This would also include the physical location


        Operation key: `ImportAddresses`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reference Data
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /ImportCompanies:
    post:
      operationId: ImportCompanies
      summary: Import Companies
      description: 'This method may be used to add new companies. This method is similar to the functionality when using the “Company tab” on the CIW. Note: For ShipTo addresses (i.e., the address tab on the CIW), use the Import Addresses method. For People addresses (i.e., the people tab on the CIW), use the Import People method. The Companies tab defines those companies that are a part of your leasing program. Each company, however, may perform a different role or function. Examples include: Lessees – the legal


        Operation key: `ImportCompanies`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reference Data
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /ImportPeople:
    post:
      operationId: ImportPeople
      summary: Import People
      description: 'This method may be used to add new people. This method is similar to the functionality when using the “People tab” on the CIW. Note: For Company addresses (i.e., the company tab on the CIW), use the Import Company method. For ShipTo addresses (i.e., the address tab on the CIW), use the ImportAddresses method. Many people participate in your leasing program and have different roles. These people may or may not be users of the system. LeaseAccelerator captures these people so that they can rece


        Operation key: `ImportPeople`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reference Data
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
components:
  schemas:
    APIResponse:
      type: object
      description: The generic LeaseAccelerator API response envelope.
      xml:
        name: APIResponse
      properties:
        Response:
          type: object
          properties:
            RequestId:
              type: string
              description: The unique identifier specified in the request.
            Status:
              type: integer
              description: A code indicating success or failure. Zero (0) always means success; any other value represents an error.
            Context:
              type: string
              description: A description of the overall request results. "Ok" always means success; any other value describes the error encountered.
        Payload:
          type: string
          description: The operation-specific XML response payload.
  securitySchemes:
    saml2Token:
      type: apiKey
      in: query
      name: token
      description: 'SAML2-issued text security token, submitted as the `token` form field on every POST. Obtain it by submitting a SAML2 ECP GET request to https://{environment}.leaseaccelerator.com/auth/api identifying your identity provider and a user federated for access in LeaseAccelerator. Note: OpenAPI has no native representation for a form-field credential, so it is modelled here as an apiKey; the token is transmitted in the multipart body, not the query string.'
externalDocs:
  description: Application Programming Interface (API) for Developers
  url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895814655245-Application-Programming-Interface-API-for-Developers