iMIS SDK Developer Guide

The iMIS software development kit (SDK) provides a secure set of web services for accessing the iMIS platform, across the organization, across different physical locations, and even across organizational boundaries.

This documentation contains the following sections and supports iMIS versions 20.2.26 (iMIS 20-300), 100.1.65 (iMIS 20-100 and iMIS 20-200), and later versions, unless a specific environment is specified.

Data models list the properties available and their datatype, and will explain the purpose of each property. Swagger files describe the API and can be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools.

For more information, see iMIS REST API Data models and swagger json files.

Get Started    Discussions

Commerce primary entities

  • Cart – A universal order. It contains the major components Order, Payments, Invoices to be paid, and a property for the ComboOrder.
  • ComboOrder – Properties of a ComboOrder, including the Order, Invoices, and Payments.
  • Order – Detailed properties of a sales order. The enumeration of OrderData provides a list of possible order states.
  • ItemSummary – A subset of properties for an item. An item is used mainly for the purposes of ordering and pricing, and represents a product or service.
  • Item – An extension of ItemSummary, which provides additional properties for an item. An item is used mainly for the purposes of ordering and pricing, and represents a product or service.
  • ItemClassSummary – Properties of an item class. An item class describes the default financial and processing attributes of an item.
  • ItemClass – An extension of ItemClassSummary which provides additional properties for the item class, such as financial information.
  • CommerceSettings – Properties for commerce settings, including Price Sheet information.
  • DeliveryMethod – Properties of a delivery method.
  • DeliveryMethodSet – Properties for a set of delivery methods.
  • FinancialEntitySummary – Properties of a financial entity.
  • GLAccount – Properties of a general ledger account.
  • InvoiceSummary – A subset of properties for an invoice. The enumeration of InvoiceSummary provides a list of possible invoice types.
  • Invoice – An extension of InvoiceSummary which provides additional properties for an invoice, such as the invoice lines.
  • PartyCommercePreferences – Party-specific commerce preferences.
  • UserCommercePreferences – User-specific commerce preferences.
  • PartyItemPrice – Properties describing the pricing information for a specified Item within the context of a specific Party. Each party might receive different pricing for the same item based on various pricing rules; party item price always returns the correct pricing for the given party.
  • PriceSheetSummary – Properties of a price sheet, which specifies a pricing set to be used.
  • PaymentMethod – Properties of a payment method. This is derived from cash accounts.
  • PaymentMethodSet – Properties of a set of payment methods.
  • PaymentTermsSummary – Properties of payment terms generally related to InvoiceData.
  • TaxAuthoritySummary – Properties of a tax authority.
  • TaxCategorySummary – Properties of a tax category.
  • TaxScheduleSummary – Properties of a tax schedule.
  • UomGroup – Properties of a unit of measure group.

Updated about a year ago

Commerce primary entities

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.