iMIS SDK

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.

Get Started    Discussions
Suggest Edits

Item, Dues, Financial, Invoices

 

Commerce relates to products for an online store, payments for membership dues, and financial aspects including invoices, payments, taxes, financial entities, financial accounts, and much more.

To run Try It examples from this site, a valid Bearer access_token is required.

Create Token

Suggest Edits

ComboOrder

 
Suggest Edits

Creates a ComboOrder

Creates an instance of ComboOrder

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ComboOrder
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ComboOrder");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ComboOrder");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.ComboOrderData, Asi.Contracts"

ComboOrderId
string

Gets or sets the order.

Currency
object

Currency (value type).

 
Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Currency.DecimalPositions
int32

Gets the decimal positions.

Invoices
array of objects

A collection of items.

$type
AccountingMethod
Balance 
BillToParty 
Description
DueDate
FinancialEntity 
HasMultipleShipToParty
InvoiceAmount 
InvoiceDate
InvoiceId
InvoiceNumber
InvoicePurpose
PaymentAdjustmentAmount 
PendingPaymentAdjustmentAmount 
SoldToParty 
Order
object

Sales order.

 
Order.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.OrderData, Asi.Contracts"

Order.AdditionalCharges
array of objects

A collection of additional charges.

$type
AdditionalChargeId
Description
Tax 
TotalAmount 
Order.BillToCustomerParty
object

Customer party datacontract. Represents either a reference to a party by partyid, id, external party id or includes a new party to be added.

 
Order.BillToCustomerParty.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.CustomerPartyData, Asi.Contracts"

Order.BillToCustomerParty.Id
string

Gets or sets the id; the member number, account number, etc.

Order.BillToCustomerParty.OriginatorCustomerId
object

Alternate id. Represent an alternate id, such as an alternate type id product code or party code.

 
Order.BillToCustomerParty.OriginatorCustomerId.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.AlternateIdData, Asi.Contracts"

Order.BillToCustomerParty.OriginatorCustomerId.AlternateIdId
string

Gets or sets the Id of the Alternate Id.

Order.BillToCustomerParty.OriginatorCustomerId.Id
string

Gets or sets the Id.

Order.BillToCustomerParty.OriginatorCustomerId.IdType
string

Gets or sets the type of the Id.

Order.BillToCustomerParty.OriginatorCustomerId.IsMarkedForDelete
boolean

Gets or sets the deletion indicator.

Order.BillToCustomerParty.Party
object

Party data contract. A party represents any sort of business organization or person. It is roughly equivalent to a name instance in imis 20-300 data schema, a ccontact in ibo, or a contact in imis 20-100. These samples show how to add a new party.

 
Order.BillToCustomerParty.Party.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartyData, Asi.Contracts"

Order.BillToCustomerParty.Party.Addresses
array of objects

A collection of full addresses.

$type
AdditionalLines
Address 
AddresseeText
AddressPurpose
BadAddress
CommunicationPreferences
DisplayName
DisplayOrganizationName
DisplayOrganizationTitle
Email
Fax
FullAddressId
IsAddresseeOverridden
IsMarkedForDelete
Note
Phone
Salutation 
Status 
Order.BillToCustomerParty.Party.AlternateIds
array of objects

A collection of alternate ids.

$type
AlternateIdId
Id
IdType
IsMarkedForDelete
Order.BillToCustomerParty.Party.CityName
string

Gets or sets the name of the city for the primary address.

Order.BillToCustomerParty.Party.CommunicationTypePreferences
array of objects

Collection of links to party's communicationtypepreference entries.

$type
CommunicationTypeId
OptInFlag
PartyCommunicationTypePreferenceId
Order.BillToCustomerParty.Party.CountryName
string

Gets or sets the name of the country for the primary address.

Order.BillToCustomerParty.Party.CountrySubEntityName
string

Gets or sets the name of the country sub entity for the primary address. (State/province)

Order.BillToCustomerParty.Party.Email
string

Gets or sets the primary email.

Order.BillToCustomerParty.Party.Emails
array of objects

Collection of email addresses.

$type
Address
EmailType
IsPrimary
Order.BillToCustomerParty.Party.FinancialInformation
object

Financial information.

 
Order.BillToCustomerParty.Party.Id
string

Gets or sets the id; The member number, account number.

Order.BillToCustomerParty.Party.ImageVirtualPath
string

Gets or sets the image virtual path.

Order.BillToCustomerParty.Party.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

Order.BillToCustomerParty.Party.Name
string

Gets or sets the name of the party.

Order.BillToCustomerParty.Party.PartyId
string

Gets or sets the party Id.

Order.BillToCustomerParty.Party.Phone
string

Gets or sets the primary phone.

Order.BillToCustomerParty.Party.Phones
array of objects

Collection of phone numbers.

$type
IsPrimary
Number
PhoneType
Order.BillToCustomerParty.Party.Salutations
array of objects

A collection of salutations.

$type
IsMarkedForDelete
IsOverridden
SalutationId
SalutationMethod 
Text
Order.BillToCustomerParty.Party.SocialNetworks
array of objects

Collection of links to party's social network profiles.

$type
PartySocialNetworkId
SocialNetwork 
SocialNetworkProfileLinkURL
SocialNetworkToken
SocialNetworkUserId
SocialNetworkUserName
UseSocialNetworkProfilePhoto
Order.BillToCustomerParty.Party.Sort
string

Gets or sets the sort string.

Order.BillToCustomerParty.Party.SortIsOverridden
boolean

Gets or sets the sort is overridden indicator.

Order.BillToCustomerParty.Party.Status
object

Party status.

 
Order.BillToCustomerParty.Party.UniformId
string

Gets or sets the uniform identifier.

Order.BillToCustomerParty.Party.UpdateInformation
object

Entity update information datacontract. Describe standard set of updated information.

 
Order.BillToCustomerParty.Party.WebsiteUrl
string

Gets or sets the website URI/URL.

Order.BillToCustomerParty.PartyId
string

Gets or sets the party Id.

Order.BillToCustomerParty.UpdateParty
boolean

Gets or sets a value indicating whether to update the party.

Order.Currency
object

Currency (value type).

 
Order.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Order.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Order.Currency.DecimalPositions
int32

Gets the decimal positions.

Order.DefaultWarehouse
object

Warehouse summary

 
Order.DefaultWarehouse.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.WarehouseSummaryData, Asi.Contracts"

Order.DefaultWarehouse.Description
string

Gets or sets the description of the facility.

Order.DefaultWarehouse.FacilityId
string

Gets or sets the facility Id.

Order.DefaultWarehouse.Name
string

Gets or sets the name or title of the facility.

Order.Delivery
array of objects

A collection of delivery points.

$type
Address 
AddressId
CustomerParty 
DeliveryId
DeliveryMethod 
Order.Description
string

Gets or sets the description of the order.

Order.HoldInformation
object

Order on hold information.

 
Order.HoldInformation.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.OrderHoldInformationData, Asi.Contracts"

Order.HoldInformation.HoldCode
string

Gets or sets the hold code.

Order.HoldInformation.IsOrderOnHold
boolean

Gets or sets the order is on hold indicator.

Order.HoldInformation.Note
string

Gets or sets the note.

Order.Instructions
string

Gets or sets the instructions for the order.

Order.IsOrderDateOverridden
boolean

Indicates whether the has been explicitly set on the SOA client side and should not be updated to today's date on server.

Order.LineDiscountTotal
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.LineDiscountTotal.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.LineDiscountTotal.Amount
object

Gets or sets the amount.

 
Order.LineDiscountTotal.Currency
object

Currency (value type).

 
Order.LineDiscountTotal.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Order.LineDiscountTotal.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Order.LineDiscountTotal.Currency.DecimalPositions
int32

Gets the decimal positions.

Order.LineDiscountTotal.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.Lines
array of objects

A collection of order lines.

$type
Balance 
BaseUnitPrice 
CanCombine
ChildOrderLines
DeliveryId
Discount 
DiscountCode
ExtendedAmount 
IsPrimary
IsUnitPriceOverridden
Item 
LineGroupTerms 
LineIncomeAccount 
LineNumber
LinePaymentTerms 
Note
OrderLineId
QuantityBackordered 
QuantityOrdered 
QuantityShipped 
ReceiptNumber
SoftCreditPartyId
SoftCredits 
SourceCode
Tax 
UnitPrice 
Order.LineTotal
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.LineTotal.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.LineTotal.Amount
object

Gets or sets the amount.

 
Order.LineTotal.Currency
object

Currency (value type).

 
Order.LineTotal.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Order.LineTotal.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Order.LineTotal.Currency.DecimalPositions
int32

Gets the decimal positions.

Order.LineTotal.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.MiscellaneousChargesTotal
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.MiscellaneousChargesTotal.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.MiscellaneousChargesTotal.Amount
object

Gets or sets the amount.

 
Order.MiscellaneousChargesTotal.Currency
object

Currency (value type).

 
Order.MiscellaneousChargesTotal.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Order.MiscellaneousChargesTotal.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Order.MiscellaneousChargesTotal.Currency.DecimalPositions
int32

Gets the decimal positions.

Order.MiscellaneousChargesTotal.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.Note
string

Gets or sets the note.

Order.OrderDate
date-time

Gets or sets the order date.

Order.OrderDiscount
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.OrderDiscount.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.OrderDiscount.Amount
object

Gets or sets the amount.

 
Order.OrderDiscount.Currency
object

Currency (value type).

 
Order.OrderDiscount.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Order.OrderDiscount.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Order.OrderDiscount.Currency.DecimalPositions
int32

Gets the decimal positions.

Order.OrderDiscount.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.OrderId
string

Gets or sets the order Id. Unique identifier for the order.

Order.OrderNumber
string

Gets or sets the assigned order number.

Order.OrderReference
object

Customer order reference.

 
Order.OrderReference.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.OrderReferenceData, Asi.Contracts"

Order.OrderReference.PurchaseOrder
string

Gets or sets the purchase order.

Order.OrderState
string

Order state enumeration.

Order.OrderTotal
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.OrderTotal.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.OrderTotal.Amount
object

Gets or sets the amount.

 
Order.OrderTotal.Currency
object

Currency (value type).

 
Order.OrderTotal.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Order.OrderTotal.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Order.OrderTotal.Currency.DecimalPositions
int32

Gets the decimal positions.

Order.OrderTotal.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.OriginatorCustomerParty
object

Customer party datacontract. Represents either a reference to a party by partyid, id, external party id or includes a new party to be added.

 
Order.OriginatorCustomerParty.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.CustomerPartyData, Asi.Contracts"

Order.OriginatorCustomerParty.Id
string

Gets or sets the id; the member number, account number, etc.

Order.OriginatorCustomerParty.OriginatorCustomerId
object

Alternate id. Represent an alternate id, such as an alternate type id product code or party code.

 
Order.OriginatorCustomerParty.OriginatorCustomerId.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.AlternateIdData, Asi.Contracts"

Order.OriginatorCustomerParty.OriginatorCustomerId.AlternateIdId
string

Gets or sets the Id of the Alternate Id.

Order.OriginatorCustomerParty.OriginatorCustomerId.Id
string

Gets or sets the Id.

Order.OriginatorCustomerParty.OriginatorCustomerId.IdType
string

Gets or sets the type of the Id.

Order.OriginatorCustomerParty.OriginatorCustomerId.IsMarkedForDelete
boolean

Gets or sets the deletion indicator.

Order.OriginatorCustomerParty.Party
object

Party data contract. A party represents any sort of business organization or person. It is roughly equivalent to a name instance in imis 20-300 data schema, a ccontact in ibo, or a contact in imis 20-100. These samples show how to add a new party.

 
Order.OriginatorCustomerParty.Party.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartyData, Asi.Contracts"

Order.OriginatorCustomerParty.Party.Addresses
array of objects

A collection of full addresses.

$type
AdditionalLines
Address 
AddresseeText
AddressPurpose
BadAddress
CommunicationPreferences
DisplayName
DisplayOrganizationName
DisplayOrganizationTitle
Email
Fax
FullAddressId
IsAddresseeOverridden
IsMarkedForDelete
Note
Phone
Salutation 
Status 
Order.OriginatorCustomerParty.Party.AlternateIds
array of objects

A collection of alternate ids.

$type
AlternateIdId
Id
IdType
IsMarkedForDelete
Order.OriginatorCustomerParty.Party.CityName
string

Gets or sets the name of the city for the primary address.

Order.OriginatorCustomerParty.Party.CommunicationTypePreferences
array of objects

Collection of links to party's communicationtypepreference entries.

$type
CommunicationTypeId
OptInFlag
PartyCommunicationTypePreferenceId
Order.OriginatorCustomerParty.Party.CountryName
string

Gets or sets the name of the country for the primary address.

Order.OriginatorCustomerParty.Party.CountrySubEntityName
string

Gets or sets the name of the country sub entity for the primary address. (State/province)

Order.OriginatorCustomerParty.Party.Email
string

Gets or sets the primary email.

Order.OriginatorCustomerParty.Party.Emails
array of objects

Collection of email addresses.

$type
Address
EmailType
IsPrimary
Order.OriginatorCustomerParty.Party.FinancialInformation
object

Financial information.

 
Order.OriginatorCustomerParty.Party.Id
string

Gets or sets the id; The member number, account number.

Order.OriginatorCustomerParty.Party.ImageVirtualPath
string

Gets or sets the image virtual path.

Order.OriginatorCustomerParty.Party.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

Order.OriginatorCustomerParty.Party.Name
string

Gets or sets the name of the party.

Order.OriginatorCustomerParty.Party.PartyId
string

Gets or sets the party Id.

Order.OriginatorCustomerParty.Party.Phone
string

Gets or sets the primary phone.

Order.OriginatorCustomerParty.Party.Phones
array of objects

Collection of phone numbers.

$type
IsPrimary
Number
PhoneType
Order.OriginatorCustomerParty.Party.Salutations
array of objects

A collection of salutations.

$type
IsMarkedForDelete
IsOverridden
SalutationId
SalutationMethod 
Text
Order.OriginatorCustomerParty.Party.SocialNetworks
array of objects

Collection of links to party's social network profiles.

$type
PartySocialNetworkId
SocialNetwork 
SocialNetworkProfileLinkURL
SocialNetworkToken
SocialNetworkUserId
SocialNetworkUserName
UseSocialNetworkProfilePhoto
Order.OriginatorCustomerParty.Party.Sort
string

Gets or sets the sort string.

Order.OriginatorCustomerParty.Party.SortIsOverridden
boolean

Gets or sets the sort is overridden indicator.

Order.OriginatorCustomerParty.Party.Status
object

Party status.

 
Order.OriginatorCustomerParty.Party.UniformId
string

Gets or sets the uniform identifier.

Order.OriginatorCustomerParty.Party.UpdateInformation
object

Entity update information datacontract. Describe standard set of updated information.

 
Order.OriginatorCustomerParty.Party.WebsiteUrl
string

Gets or sets the website URI/URL.

Order.OriginatorCustomerParty.PartyId
string

Gets or sets the party Id.

Order.OriginatorCustomerParty.UpdateParty
boolean

Gets or sets a value indicating whether to update the party.

Order.PaymentTerms
object

Payment terms summary

 
Order.PaymentTerms.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.PaymentTermsSummaryData, Asi.Contracts"

Order.PaymentTerms.Description
string

Gets or sets the description.

Order.PaymentTerms.Name
string

Gets or sets the name.

Order.PaymentTerms.PaymentTermsId
string

Gets or sets the payment terms id.

Order.Pricing
object

Pricing information for the order.

 
Order.Pricing.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.OrderPricingInformationData, Asi.Contracts"

Order.Pricing.DiscountCodes
string

Gets or sets the discount codes.

Order.Pricing.PriceSheet
object

A price sheet specifies a pricing set to be used.

 
Order.Pricing.PriceSheet.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.PriceSheetSummaryData, Asi.Contracts"

Order.Pricing.PriceSheet.Description
string

Gets or sets the description.

Order.Pricing.PriceSheet.Name
string

Gets or sets the name.

Order.Pricing.PriceSheet.PriceSheetId
string

Gets or sets the price sheet id.

Order.Pricing.Promotions
array of objects

Promotion collection.

$type
BeginDate
EndDate
IsImplicit
ItemClassPromotionDetails
ItemPromotionDetails
MaximumDiscountsAllowedPerItemPromotion
OrderPromotionDetails 
PromotionCode
PromotionDiscountType
PromotionId
PromotionName
PurchaseItemDetails
RequiredPurchaseItemQuantity 
Order.RequestedShipDate
date-time

Gets or sets the requested ship date.

Order.ReturnInformation
object

Information related to a return.

 
Order.ReturnInformation.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.OrderReturnInformationData, Asi.Contracts"

Order.ReturnInformation.AuthorizationNumber
string

Gets or sets the return authorization number, for the case of a return.

Order.ReturnInformation.IsReturn
boolean

Gets or sets the is return.

Order.ReturnInformation.IsReturnFullOrder
boolean

Gets or sets the full order return indicator.

Order.ReturnInformation.OriginalOrderNumber
string

Gets or sets the original order number for the case of a return.

Order.ReturnInformation.ReasonCode
string

Gets or sets the return reason code.

Order.SalesLocation
object

Facility, such as a meeting location, building, office or room.

 
Order.SalesLocation.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.FacilitySummaryData, Asi.Contracts"

Order.SalesLocation.Description
string

Gets or sets the description of the facility.

Order.SalesLocation.FacilityId
string

Gets or sets the facility Id.

Order.SalesLocation.Name
string

Gets or sets the name or title of the facility.

Order.SalesTeam
object

Class that describes sales history

 
Order.SalesTeam.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.SalesTeamSummaryData, Asi.Contracts"

Order.SalesTeam.Name
string
Order.SalesTeam.SalesTeamId
string

Gets or sets the collection of alternate ids.

Order.ShippingTotal
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.ShippingTotal.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.ShippingTotal.Amount
object

Gets or sets the amount.

 
Order.ShippingTotal.Currency
object

Currency (value type).

 
Order.ShippingTotal.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Order.ShippingTotal.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Order.ShippingTotal.Currency.DecimalPositions
int32

Gets the decimal positions.

Order.ShippingTotal.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.SoldToCustomerParty
object

Customer party datacontract. Represents either a reference to a party by partyid, id, external party id or includes a new party to be added.

 
Order.SoldToCustomerParty.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.CustomerPartyData, Asi.Contracts"

Order.SoldToCustomerParty.Id
string

Gets or sets the id; the member number, account number, etc.

Order.SoldToCustomerParty.OriginatorCustomerId
object

Alternate id. Represent an alternate id, such as an alternate type id product code or party code.

 
Order.SoldToCustomerParty.OriginatorCustomerId.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.AlternateIdData, Asi.Contracts"

Order.SoldToCustomerParty.OriginatorCustomerId.AlternateIdId
string

Gets or sets the Id of the Alternate Id.

Order.SoldToCustomerParty.OriginatorCustomerId.Id
string

Gets or sets the Id.

Order.SoldToCustomerParty.OriginatorCustomerId.IdType
string

Gets or sets the type of the Id.

Order.SoldToCustomerParty.OriginatorCustomerId.IsMarkedForDelete
boolean

Gets or sets the deletion indicator.

Order.SoldToCustomerParty.Party
object

Party data contract. A party represents any sort of business organization or person. It is roughly equivalent to a name instance in imis 20-300 data schema, a ccontact in ibo, or a contact in imis 20-100. These samples show how to add a new party.

 
Order.SoldToCustomerParty.Party.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartyData, Asi.Contracts"

Order.SoldToCustomerParty.Party.Addresses
array of objects

A collection of full addresses.

$type
AdditionalLines
Address 
AddresseeText
AddressPurpose
BadAddress
CommunicationPreferences
DisplayName
DisplayOrganizationName
DisplayOrganizationTitle
Email
Fax
FullAddressId
IsAddresseeOverridden
IsMarkedForDelete
Note
Phone
Salutation 
Status 
Order.SoldToCustomerParty.Party.AlternateIds
array of objects

A collection of alternate ids.

$type
AlternateIdId
Id
IdType
IsMarkedForDelete
Order.SoldToCustomerParty.Party.CityName
string

Gets or sets the name of the city for the primary address.

Order.SoldToCustomerParty.Party.CommunicationTypePreferences
array of objects

Collection of links to party's communicationtypepreference entries.

$type
CommunicationTypeId
OptInFlag
PartyCommunicationTypePreferenceId
Order.SoldToCustomerParty.Party.CountryName
string

Gets or sets the name of the country for the primary address.

Order.SoldToCustomerParty.Party.CountrySubEntityName
string

Gets or sets the name of the country sub entity for the primary address. (State/province)

Order.SoldToCustomerParty.Party.Email
string

Gets or sets the primary email.

Order.SoldToCustomerParty.Party.Emails
array of objects

Collection of email addresses.

$type
Address
EmailType
IsPrimary
Order.SoldToCustomerParty.Party.FinancialInformation
object

Financial information.

 
Order.SoldToCustomerParty.Party.Id
string

Gets or sets the id; The member number, account number.

Order.SoldToCustomerParty.Party.ImageVirtualPath
string

Gets or sets the image virtual path.

Order.SoldToCustomerParty.Party.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

Order.SoldToCustomerParty.Party.Name
string

Gets or sets the name of the party.

Order.SoldToCustomerParty.Party.PartyId
string

Gets or sets the party Id.

Order.SoldToCustomerParty.Party.Phone
string

Gets or sets the primary phone.

Order.SoldToCustomerParty.Party.Phones
array of objects

Collection of phone numbers.

$type
IsPrimary
Number
PhoneType
Order.SoldToCustomerParty.Party.Salutations
array of objects

A collection of salutations.

$type
IsMarkedForDelete
IsOverridden
SalutationId
SalutationMethod 
Text
Order.SoldToCustomerParty.Party.SocialNetworks
array of objects

Collection of links to party's social network profiles.

$type
PartySocialNetworkId
SocialNetwork 
SocialNetworkProfileLinkURL
SocialNetworkToken
SocialNetworkUserId
SocialNetworkUserName
UseSocialNetworkProfilePhoto
Order.SoldToCustomerParty.Party.Sort
string

Gets or sets the sort string.

Order.SoldToCustomerParty.Party.SortIsOverridden
boolean

Gets or sets the sort is overridden indicator.

Order.SoldToCustomerParty.Party.Status
object

Party status.

 
Order.SoldToCustomerParty.Party.UniformId
string

Gets or sets the uniform identifier.

Order.SoldToCustomerParty.Party.UpdateInformation
object

Entity update information datacontract. Describe standard set of updated information.

 
Order.SoldToCustomerParty.Party.WebsiteUrl
string

Gets or sets the website URI/URL.

Order.SoldToCustomerParty.PartyId
string

Gets or sets the party Id.

Order.SoldToCustomerParty.UpdateParty
boolean

Gets or sets a value indicating whether to update the party.

Order.SourceCode
string

Gets or sets the source code.

Order.TaxInformation
object

Tax information for an order.

 
Order.TaxInformation.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.OrderTaxInformationData, Asi.Contracts"

Order.TaxInformation.InclusiveTaxTotal
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.TaxInformation.InclusiveTaxTotal.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.TaxInformation.InclusiveTaxTotal.Amount
object

Gets or sets the amount.

 
Order.TaxInformation.InclusiveTaxTotal.Currency
object

Currency (value type).

 
Order.TaxInformation.InclusiveTaxTotal.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.TaxInformation.OrderTaxes
array of objects

A collection order tax subtotals lines.

$type
Details
InclusiveTaxTotal 
TaxableAmountTotal 
TaxCategory 
TaxSchedule 
TaxTotal 
Order.TaxInformation.TaxTotal
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.TaxInformation.TaxTotal.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.TaxInformation.TaxTotal.Amount
object

Gets or sets the amount.

 
Order.TaxInformation.TaxTotal.Currency
object

Currency (value type).

 
Order.TaxInformation.TaxTotal.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.TotalBasePrice
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
Order.TotalBasePrice.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

Order.TotalBasePrice.Amount
object

Gets or sets the amount.

 
Order.TotalBasePrice.Currency
object

Currency (value type).

 
Order.TotalBasePrice.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

Order.TotalBasePrice.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

Order.TotalBasePrice.Currency.DecimalPositions
int32

Gets the decimal positions.

Order.TotalBasePrice.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Order.UpdateInformation
object

Entity update information datacontract. Describe standard set of updated information.

 
Order.UpdateInformation.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts"

Order.UpdateInformation.CreatedBy
string

Gets or sets the created by.

Order.UpdateInformation.CreatedOn
date-time

Gets or sets the created on.

Order.UpdateInformation.UpdatedBy
string

Gets or sets the updated by.

Order.UpdateInformation.UpdatedOn
date-time

Gets or sets the updated on.

Payments
array of objects

A collection of payments.

$type
Amount 
Applications
BankDraftInformation 
CreditCardInformation 
Message
Note
PaymentDate
PaymentId
PaymentMethod 
PaymentToken 
PayorParty 
ReferenceNumber

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

FinancialEntity

 

Financial account details for the current entity. This object is currently only supported for iMIS 20-300 to provide backward compatibility with features that are required for proper maintenance and usage of legacy data. Any usage of this object will result in a not-yet implemented exception.

Suggest Edits

Returns a list of FinancialEntity

Returns a list containing a collection of FinancialEntity

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Creates a FinancialEntity

Creates an instance of FinancialEntity

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialEntityData, Asi.Contracts"

AdditionalInformation
string

Gets or sets the additional information.

CharityRegistrationNumber
string

Gets or sets the charity registration number for the current financial entity.

DefaultFinancialAccounts
object

Financial account details for the current entity. This object is currently only supported for imis 20-300 to provide backward compatibility with features that are required for proper maintenance and usage of legacy data. Any usage of this object will result in a not yet implemented exception.

 
DefaultFinancialAccounts.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.EntityFinancialAccountsData, Asi.Contracts"

DefaultFinancialAccounts.AccountReceivable
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.AccountReceivable.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.AccountReceivable.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.AccountReceivable.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.AccountReceivable.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.AccountReceivable.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.AccountReceivable.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.AccountReceivable.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.AccountReceivable.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Cash
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Cash.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Cash.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Cash.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Cash.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Cash.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Cash.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Cash.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Cash.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Freight
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Freight.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Freight.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Freight.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Freight.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Freight.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Freight.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Freight.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Freight.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Handling
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Handling.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Handling.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Handling.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Handling.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Handling.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Handling.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Handling.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Handling.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Income
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Income.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Income.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Income.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Income.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Income.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Income.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Income.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Income.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Prepaid
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Prepaid.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Prepaid.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Prepaid.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Prepaid.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Prepaid.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Prepaid.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Prepaid.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Prepaid.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.RefundAccountsPayable
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.RefundAccountsPayable.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.RefundClearing
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.RefundClearing.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.RefundClearing.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.RefundClearing.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.RefundClearing.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.RefundClearing.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.RefundClearing.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.RefundClearing.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.RefundClearing.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Restock
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Restock.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Restock.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Restock.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Restock.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Restock.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Restock.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Restock.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Restock.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.SalesTax
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.SalesTax.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.SalesTax.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.SalesTax.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.SalesTax.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.SalesTax.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.SalesTax.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.SalesTax.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.SalesTax.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.TransferClearing
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.TransferClearing.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.TransferClearing.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.TransferClearing.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.TransferClearing.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.TransferClearing.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.TransferClearing.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.TransferClearing.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.TransferClearing.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.WriteOffOffset
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.WriteOffOffset.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.WriteOffOffset.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.WriteOffOffset.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.WriteOffOffset.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.WriteOffOffset.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.WriteOffOffset.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.WriteOffOffset.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.WriteOffOffset.GLAccount.Project
object

Class projectdata.

 
EntityCode
string

Gets or sets the entity code.

FinancialEntityFullAddress
string

Gets or sets the financial entity full address.

FinancialEntityId
string

Gets or sets the financial entity id.

FirstMonthOfFiscalYear
int32

Gets or sets first month of the fiscal year.

InstituteFormattedAddress
string

Gets or sets the institute primary address.

InstituteParty
object

Party summary data contract. A set of basic data to identify a party.

 
InstituteParty.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts"

InstituteParty.CityName
string

Gets or sets the name of the city for the primary address.

InstituteParty.CountryName
string

Gets or sets the name of the country for the primary address.

InstituteParty.CountrySubEntityName
string

Gets or sets the name of the country sub entity for the primary address. (State/province)

InstituteParty.Email
string

Gets or sets the primary email.

InstituteParty.Id
string

Gets or sets the id; The member number, account number.

InstituteParty.ImageVirtualPath
string

Gets or sets the image virtual path.

InstituteParty.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

InstituteParty.Name
string

Gets or sets the name of the party.

InstituteParty.PartyId
string

Gets or sets the party Id.

InstituteParty.Phone
string

Gets or sets the primary phone.

InstituteParty.Sort
string

Gets or sets the sort string.

InstituteParty.Status
object

Party status.

 
InstituteParty.Status.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts"

InstituteParty.Status.ActiveStatus
string

Party active status enumeration.

InstituteParty.Status.Description
string

Gets or sets the description.

InstituteParty.Status.Name
string

Gets or sets the name.

InstituteParty.Status.PartyStatusId
string

Gets or sets the party status id.

InstituteParty.UniformId
string

Gets or sets the uniform identifier.

IsCharity
boolean

Gets or sets a value indicating whether this instance is a charity.

IsDefault
boolean

Gets or sets a value indicating whether this instance is default.

LetterheadAddress
string

Gets or sets the financial entity letter head address.

LogoImage
object

Class virtualfiledata.

 
LogoImage.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.VirtualFileData, Asi.Contracts"

LogoImage.AlternateText
string

Gets or sets the alternate text.

LogoImage.Description
string

Gets or sets the description.

LogoImage.IsDefault
boolean

Gets or sets a value indicating whether this the specification for the defailt file/image.

LogoImage.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

LogoImage.VirtualPath
string

Gets or sets the image virtual path.

LogoImageDescription
string

Gets or sets the image alt text/description of the entity logo.

LogoImageUrl
string

Gets or sets url of the entity logo.

Name
string

Gets or sets the name.

SignatureImage
object

Class virtualfiledata.

 
SignatureImage.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.VirtualFileData, Asi.Contracts"

SignatureImage.AlternateText
string

Gets or sets the alternate text.

SignatureImage.Description
string

Gets or sets the description.

SignatureImage.IsDefault
boolean

Gets or sets a value indicating whether this the specification for the defailt file/image.

SignatureImage.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

SignatureImage.VirtualPath
string

Gets or sets the image virtual path.

SignatureImageDescription
string

Gets or sets description of the entity signature image.

SignatureImageUrl
string

Gets or sets url of the entity signature image.

TaxationPolicy
object

Tax policy details for the current entity. This object is currently only supported for imis 20-300 to provide backward compatibility with features that are required for proper maintenance and usage of legacy data. Any usage of this object will result in a not yet implemented exception.

 
TaxationPolicy.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.EntityTaxData, Asi.Contracts"

TaxationPolicy.GstRemittanceNumber
string

Gets or sets the remittance number for the current financial entity. This value is only applicable for a using the model.

TaxationPolicy.GstTaxAuthority
object

Tax authority datacontract.

 
TaxationPolicy.GstTaxAuthority.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.TaxAuthoritySummaryData, Asi.Contracts"

TaxationPolicy.GstTaxAuthority.Description
string

Gets or sets the description.

TaxationPolicy.GstTaxAuthority.Name
string

Gets or sets the tax category authority.

TaxationPolicy.GstTaxAuthority.TaxAuthorityCode
string

Gets or sets the tax authority code.

TaxationPolicy.GstTaxAuthority.TaxAuthorityId
string

Gets or sets the tax authority id.

TaxationPolicy.TaxationModel
string

Taxation model enumeration. This object is currently only supported for imis 20-300 to provide backward compatibility with features that are required for proper maintenance and usage of legacy data. Any usage of this object or its child objects will result in a not yet implemented exception.

TaxationPolicy.VatBranchId
string

Gets or sets the branch id for the current financial entity. This value is only applicable for a using the model.

TaxationPolicy.VatCompany
string

Gets or sets the company name that matches the financial entity's tax registration for the current financial entity. This value is only applicable for a using the model.

TaxationPolicy.VatCountryCode
string

Gets or sets the country code for the current financial entity. This value is only applicable for a using the model.

TaxationPolicy.VatRegistrationNumber
string

Gets or sets the registration number for the current financial entity. This value is only applicable for a using the model.

TaxReceiptMessage
string

Gets or sets the tax receipt message.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes a FinancialEntity by id

Removes an instance of FinancialEntity by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

FinancialEntityId
string
required

Id of FinancialEntity to be Removed

Response

The request was successful.

Suggest Edits

Returns a FinancialEntity by id

Returns an instance of FinancialEntity by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

FinancialEntityId
string
required

Id of FinancialEntity to be Returned

Response

The request was successful.

Examples of FinancialEntityID

  • BLDG
  • DSRT
  • EMERG
Suggest Edits

Updates a FinancialEntity by id

Updates an instance of FinancialEntity by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntity/FinancialEntityId");
var request = new RestRequest(Method.PUT);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

FinancialEntityId
string
required

Id of FinancialEntity to be Updated

Body Params

$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialEntityData, Asi.Contracts"

AdditionalInformation
string

Gets or sets the additional information.

CharityRegistrationNumber
string

Gets or sets the charity registration number for the current financial entity.

DefaultFinancialAccounts
object

Financial account details for the current entity. This object is currently only supported for imis 20-300 to provide backward compatibility with features that are required for proper maintenance and usage of legacy data. Any usage of this object will result in a not yet implemented exception.

 
DefaultFinancialAccounts.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.EntityFinancialAccountsData, Asi.Contracts"

DefaultFinancialAccounts.AccountReceivable
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.AccountReceivable.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.AccountReceivable.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.AccountReceivable.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.AccountReceivable.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.AccountReceivable.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.AccountReceivable.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.AccountReceivable.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.AccountReceivable.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Cash
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Cash.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Cash.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Cash.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Cash.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Cash.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Cash.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Cash.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Cash.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Freight
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Freight.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Freight.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Freight.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Freight.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Freight.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Freight.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Freight.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Freight.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Handling
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Handling.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Handling.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Handling.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Handling.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Handling.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Handling.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Handling.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Handling.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Income
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Income.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Income.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Income.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Income.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Income.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Income.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Income.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Income.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Prepaid
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Prepaid.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Prepaid.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Prepaid.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Prepaid.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Prepaid.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Prepaid.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Prepaid.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Prepaid.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.RefundAccountsPayable
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.RefundAccountsPayable.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.RefundAccountsPayable.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.RefundClearing
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.RefundClearing.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.RefundClearing.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.RefundClearing.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.RefundClearing.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.RefundClearing.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.RefundClearing.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.RefundClearing.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.RefundClearing.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.Restock
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.Restock.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.Restock.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.Restock.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.Restock.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.Restock.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.Restock.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.Restock.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.Restock.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.SalesTax
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.SalesTax.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.SalesTax.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.SalesTax.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.SalesTax.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.SalesTax.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.SalesTax.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.SalesTax.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.SalesTax.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.TransferClearing
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.TransferClearing.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.TransferClearing.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.TransferClearing.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.TransferClearing.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.TransferClearing.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.TransferClearing.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.TransferClearing.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.TransferClearing.GLAccount.Project
object

Class projectdata.

 
DefaultFinancialAccounts.WriteOffOffset
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
DefaultFinancialAccounts.WriteOffOffset.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

DefaultFinancialAccounts.WriteOffOffset.GLAccount
object

General ledger account.

 
DefaultFinancialAccounts.WriteOffOffset.GLAccount.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"

DefaultFinancialAccounts.WriteOffOffset.GLAccount.FinancialEntity
object

Financial entity summary.

 
DefaultFinancialAccounts.WriteOffOffset.GLAccount.GLAccountCode
string

Gets or sets the general ledger account code.

DefaultFinancialAccounts.WriteOffOffset.GLAccount.GLAccountId
string

Gets or sets the general ledger account id.

DefaultFinancialAccounts.WriteOffOffset.GLAccount.Name
string

Gets or sets the name.

DefaultFinancialAccounts.WriteOffOffset.GLAccount.Project
object

Class projectdata.

 
EntityCode
string

Gets or sets the entity code.

FinancialEntityFullAddress
string

Gets or sets the financial entity full address.

FinancialEntityId
string

Gets or sets the financial entity id.

FirstMonthOfFiscalYear
int32

Gets or sets first month of the fiscal year.

InstituteFormattedAddress
string

Gets or sets the institute primary address.

InstituteParty
object

Party summary data contract. A set of basic data to identify a party.

 
InstituteParty.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts"

InstituteParty.CityName
string

Gets or sets the name of the city for the primary address.

InstituteParty.CountryName
string

Gets or sets the name of the country for the primary address.

InstituteParty.CountrySubEntityName
string

Gets or sets the name of the country sub entity for the primary address. (State/province)

InstituteParty.Email
string

Gets or sets the primary email.

InstituteParty.Id
string

Gets or sets the id; The member number, account number.

InstituteParty.ImageVirtualPath
string

Gets or sets the image virtual path.

InstituteParty.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

InstituteParty.Name
string

Gets or sets the name of the party.

InstituteParty.PartyId
string

Gets or sets the party Id.

InstituteParty.Phone
string

Gets or sets the primary phone.

InstituteParty.Sort
string

Gets or sets the sort string.

InstituteParty.Status
object

Party status.

 
InstituteParty.Status.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts"

InstituteParty.Status.ActiveStatus
string

Party active status enumeration.

InstituteParty.Status.Description
string

Gets or sets the description.

InstituteParty.Status.Name
string

Gets or sets the name.

InstituteParty.Status.PartyStatusId
string

Gets or sets the party status id.

InstituteParty.UniformId
string

Gets or sets the uniform identifier.

IsCharity
boolean

Gets or sets a value indicating whether this instance is a charity.

IsDefault
boolean

Gets or sets a value indicating whether this instance is default.

LetterheadAddress
string

Gets or sets the financial entity letter head address.

LogoImage
object

Class virtualfiledata.

 
LogoImage.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.VirtualFileData, Asi.Contracts"

LogoImage.AlternateText
string

Gets or sets the alternate text.

LogoImage.Description
string

Gets or sets the description.

LogoImage.IsDefault
boolean

Gets or sets a value indicating whether this the specification for the defailt file/image.

LogoImage.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

LogoImage.VirtualPath
string

Gets or sets the image virtual path.

LogoImageDescription
string

Gets or sets the image alt text/description of the entity logo.

LogoImageUrl
string

Gets or sets url of the entity logo.

Name
string

Gets or sets the name.

SignatureImage
object

Class virtualfiledata.

 
SignatureImage.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.VirtualFileData, Asi.Contracts"

SignatureImage.AlternateText
string

Gets or sets the alternate text.

SignatureImage.Description
string

Gets or sets the description.

SignatureImage.IsDefault
boolean

Gets or sets a value indicating whether this the specification for the defailt file/image.

SignatureImage.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

SignatureImage.VirtualPath
string

Gets or sets the image virtual path.

SignatureImageDescription
string

Gets or sets description of the entity signature image.

SignatureImageUrl
string

Gets or sets url of the entity signature image.

TaxationPolicy
object

Tax policy details for the current entity. This object is currently only supported for imis 20-300 to provide backward compatibility with features that are required for proper maintenance and usage of legacy data. Any usage of this object will result in a not yet implemented exception.

 
TaxationPolicy.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.EntityTaxData, Asi.Contracts"

TaxationPolicy.GstRemittanceNumber
string

Gets or sets the remittance number for the current financial entity. This value is only applicable for a using the model.

TaxationPolicy.GstTaxAuthority
object

Tax authority datacontract.

 
TaxationPolicy.GstTaxAuthority.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.TaxAuthoritySummaryData, Asi.Contracts"

TaxationPolicy.GstTaxAuthority.Description
string

Gets or sets the description.

TaxationPolicy.GstTaxAuthority.Name
string

Gets or sets the tax category authority.

TaxationPolicy.GstTaxAuthority.TaxAuthorityCode
string

Gets or sets the tax authority code.

TaxationPolicy.GstTaxAuthority.TaxAuthorityId
string

Gets or sets the tax authority id.

TaxationPolicy.TaxationModel
string

Taxation model enumeration. This object is currently only supported for imis 20-300 to provide backward compatibility with features that are required for proper maintenance and usage of legacy data. Any usage of this object or its child objects will result in a not yet implemented exception.

TaxationPolicy.VatBranchId
string

Gets or sets the branch id for the current financial entity. This value is only applicable for a using the model.

TaxationPolicy.VatCompany
string

Gets or sets the company name that matches the financial entity's tax registration for the current financial entity. This value is only applicable for a using the model.

TaxationPolicy.VatCountryCode
string

Gets or sets the country code for the current financial entity. This value is only applicable for a using the model.

TaxationPolicy.VatRegistrationNumber
string

Gets or sets the registration number for the current financial entity. This value is only applicable for a using the model.

TaxReceiptMessage
string

Gets or sets the tax receipt message.

Response

The request was successful.

Suggest Edits

FinancialEntitySummary

 
Suggest Edits

Returns a list of FinancialEntitySummary

Returns a list containing a collection of FinancialEntitySummary

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Removes a FinancialEntitySummary by id

Removes an instance of FinancialEntitySummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary/FinancialEntitySummaryId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary/FinancialEntitySummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary/FinancialEntitySummaryId");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

FinancialEntitySummaryId
string
required

Id of FinancialEntitySummary to be Removed

Response

The request was successful.

Suggest Edits

Returns a FinancialEntitySummary by id

Returns an instance of FinancialEntitySummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary/FinancialEntitySummaryId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary/FinancialEntitySummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/FinancialEntitySummary/FinancialEntitySummaryId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

FinancialEntitySummaryId
string
required

Id of FinancialEntitySummary to be Returned

Response

The request was successful.

Examples of FinancialEntitySummaryID (FinancialEntityId)

  • GSTIN
  • VAT
  • CANAD
 
Suggest Edits

Returns a list of Invoice

Returns a list containing a collection of Invoice

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Invoice
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Invoice");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Invoice");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Returns an Invoice by id

Returns an instance of Invoice by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Invoice/InvoiceId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Invoice/InvoiceId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Invoice/InvoiceId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

InvoiceId
string
required

Id of Invoice to be Returned

Response

The request was successful.

Examples of InvoiceId

  • 10
  • 156
  • 1000
Suggest Edits

InvoiceSummary

 
Suggest Edits

Returns a list of InvoiceSummary

Returns a list containing a collection of InvoiceSummary

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/InvoiceSummary
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/InvoiceSummary");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/InvoiceSummary");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Returns an InvoiceSummary by id

Returns an instance of InvoiceSummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/InvoiceSummary/InvoiceSummaryId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/InvoiceSummary/InvoiceSummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/InvoiceSummary/InvoiceSummaryId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

InvoiceSummaryId
string
required

Id of InvoiceSummary to be Returned

Response

The request was successful.

Examples of InvoiceSummaryId (InvoiceId)

  • 1001
  • 1002
  • 1003,

Provides information for commerce items such as products, fundraising items and events. Includes information such as the name and type of the item, whether the item is charitable and which group and role the purchaser is assigned to, if applicable.

Suggest Edits

Returns a list of Item

Returns a list containing a collection of Item

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Creates an Item

Creates an instance of Item

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.ItemData, Asi.Contracts"

AllowOrderLineNote
boolean

Gets or sets the boolean for whether the product can have an "In Kind" note associated with it (pay with other than cash). Associated with donation products such as "Marshland".

AlternateIds
array of objects

A collection of alternate ids.

$type
AlternateIdId
Id
IdType
IsMarkedForDelete
Description
string

Gets or sets the description.

DisplayOrder
int32

The display order for the product category

FairMarketValue
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
FairMarketValue.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

FairMarketValue.Amount
object

Gets or sets the amount.

 
FairMarketValue.Currency
object

Currency (value type).

 
FairMarketValue.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

FairMarketValue.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

FairMarketValue.Currency.DecimalPositions
int32

Gets the decimal positions.

FairMarketValue.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

Group
object

Membership group summary. (membership) groups are used to represent almost any list of parties (persons or organizations). Typical groups include committees, community members, membership and subscription groups.

 
Group.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.GroupSummaryData, Asi.Contracts"

Group.Description
string

Gets or sets the description.

Group.GroupClass
object

Group class summary. Grouptyperef table

 
Group.GroupClass.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.GroupClassSummaryData, Asi.Contracts"

Group.GroupClass.Description
string

Gets or sets the description.

Group.GroupClass.GroupClassId
string

Gets or sets the group class id.

Group.GroupClass.IsDateLimited
boolean

Gets or sets a value indicating whether this class of groups has roles that are date limited (have a begin and/or expiration date)

Group.GroupClass.IsReadOnly
boolean

Gets or sets the read only indicator.

Group.GroupClass.IsRelationshipGroup
boolean

Gets or sets a value indicating whether this instance groups supports two-way relationships.

Group.GroupClass.IsSimpleGroup
boolean

Gets or sets a value indicating whether this class of groups is a simple group. Simple groups have no MembershipDetails.

Group.GroupClass.IsSystem
boolean

Gets or sets a value indicating whether this class of groups is system defined group.

Group.GroupClass.Name
string

Gets or sets the name.

Group.GroupId
string

Gets or sets the group Id.

Group.IsMemberGroup
boolean

Gets or sets a value indicating whether this instance is member group.

Group.IsPrimaryGroup
boolean

Gets or sets a value indicating whether this instance is a primary group.

Group.IsRelationshipGroup
boolean

Gets or sets a value indicating whether this instance supports relationships.

Group.IsSimpleGroup
boolean

Gets or sets a value indicating whether this instance is simple group. Simple groups have no MembershipDetails.

Group.IsSystem
boolean

Gets or sets a value indicating whether this instance is system defined.

Group.Name
string

Gets or sets the name of the group. Group names do not have to be unique.

Group.ParentIdentity
object

Datacontract represents the unique identifier of an entity.

 
Group.ParentIdentity.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts"

Group.ParentIdentity.EntityTypeName
string

Gets or sets the name of the entity type.

Group.ParentIdentity.Id
object

To the identifier.

 
Group.ParentIdentity.IdentityElements
array of strings

Gets or sets the identity elements.

Group.ParentIdentity.Key
string

Gets the key.

Group.StatusCode
string

Gets or sets a value indicating whether this instance is active/Inactive.

GroupRole
object

Group role summary. (membership) group roles are used to represent the different ways that parties (persons or organizations) can participate with a group. Typical roles include member, donor, registrant, guest, officer, etc.

 
GroupRole.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.GroupRoleSummaryData, Asi.Contracts"

GroupRole.Description
string

Gets or sets the role description.

GroupRole.Name
string

Gets or sets the name of the role.

GroupRole.Priority
int32

Gets or sets the priority.

GroupRole.RoleId
string

Gets or sets the role Id.

GroupTermPolicy
object

Information about the term of the group we assign someone to upon purchashing an item.

 
GroupTermPolicy.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.GroupTermPolicyData, Asi.Contracts"

GroupTermPolicy.TermExtensionBeginMonth
int32

If set, extend the end date starting with joins in this month of the year.

GroupTermPolicy.TermSpan
int32

How long, in months, the purchaser of the item will be assigned to the group.

HasPhysicalInventory
boolean

Gets or sets the physical inventory indicator.

Image
object

Class virtualfiledata.

 
Image.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.VirtualFileData, Asi.Contracts"

Image.AlternateText
string

Gets or sets the alternate text.

Image.Description
string

Gets or sets the description.

Image.IsDefault
boolean

Gets or sets a value indicating whether this the specification for the defailt file/image.

Image.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

Image.VirtualPath
string

Gets or sets the image virtual path.

ImageDescription
string

Gets or sets the image alt text/description.

ImageUrl
string

Gets or sets the image URL.

IsPremium
boolean

Gets or sets the boolean for whether the product is being offered as a premium

ItemClass
object

An item class describes the default financial and processing attributes of an item.

 
ItemClass.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.ItemClassSummaryData, Asi.Contracts"

ItemClass.ItemClassId
string

Gets or sets the item class id.

ItemClass.Name
string

Gets or sets the name of the item class.

ItemCode
string

Gets or sets the item code.

ItemFinancialInformation
object

Item financial information.

 
ItemFinancialInformation.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.ItemFinancialInformationData, Asi.Contracts"

ItemFinancialInformation.AccountingMethod
string

Accounting methods.

ItemFinancialInformation.CommissionPercent
object

Gets or sets a value indicating the percent of a commission.

 
ItemFinancialInformation.DefaultSalesUom
object

Unit of measure summary.

 
ItemFinancialInformation.DefaultSalesUom.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.UomSummaryData, Asi.Contracts"

ItemFinancialInformation.DefaultSalesUom.Description
string

Gets or sets the description.

ItemFinancialInformation.DefaultSalesUom.Name
string

Gets or sets the tax category name.

ItemFinancialInformation.DefaultSalesUom.UomId
string

Gets or sets the unit of measure id.

ItemFinancialInformation.FinancialEntity
object

Financial entity summary.

 
ItemFinancialInformation.FinancialEntity.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialEntitySummaryData, Asi.Contracts"

ItemFinancialInformation.FinancialEntity.AdditionalInformation
string

Gets or sets the additional information.

ItemFinancialInformation.FinancialEntity.EntityCode
string

Gets or sets the entity code.

ItemFinancialInformation.FinancialEntity.FinancialEntityFullAddress
string

Gets or sets the financial entity full address.

ItemFinancialInformation.FinancialEntity.FinancialEntityId
string

Gets or sets the financial entity id.

ItemFinancialInformation.FinancialEntity.FirstMonthOfFiscalYear
int32

Gets or sets first month of the fiscal year.

ItemFinancialInformation.FinancialEntity.InstituteFormattedAddress
string

Gets or sets the institute primary address.

ItemFinancialInformation.FinancialEntity.InstituteParty
object

Party summary data contract. A set of basic data to identify a party.

 
ItemFinancialInformation.FinancialEntity.InstituteParty.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts"

ItemFinancialInformation.FinancialEntity.InstituteParty.CityName
string

Gets or sets the name of the city for the primary address.

ItemFinancialInformation.FinancialEntity.InstituteParty.CountryName
string

Gets or sets the name of the country for the primary address.

ItemFinancialInformation.FinancialEntity.InstituteParty.CountrySubEntityName
string

Gets or sets the name of the country sub entity for the primary address. (State/province)

ItemFinancialInformation.FinancialEntity.InstituteParty.Email
string

Gets or sets the primary email.

ItemFinancialInformation.FinancialEntity.InstituteParty.Id
string

Gets or sets the id; The member number, account number.

ItemFinancialInformation.FinancialEntity.InstituteParty.ImageVirtualPath
string

Gets or sets the image virtual path.

ItemFinancialInformation.FinancialEntity.InstituteParty.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

ItemFinancialInformation.FinancialEntity.InstituteParty.Name
string

Gets or sets the name of the party.

ItemFinancialInformation.FinancialEntity.InstituteParty.PartyId
string

Gets or sets the party Id.

ItemFinancialInformation.FinancialEntity.InstituteParty.Phone
string

Gets or sets the primary phone.

ItemFinancialInformation.FinancialEntity.InstituteParty.Sort
string

Gets or sets the sort string.

ItemFinancialInformation.FinancialEntity.InstituteParty.Status
object

Party status.

 
ItemFinancialInformation.FinancialEntity.InstituteParty.UniformId
string

Gets or sets the uniform identifier.

ItemFinancialInformation.FinancialEntity.IsDefault
boolean

Gets or sets a value indicating whether this instance is default.

ItemFinancialInformation.FinancialEntity.LetterheadAddress
string

Gets or sets the financial entity letter head address.

ItemFinancialInformation.FinancialEntity.LogoImage
object

Class virtualfiledata.

 
ItemFinancialInformation.FinancialEntity.LogoImage.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.VirtualFileData, Asi.Contracts"

ItemFinancialInformation.FinancialEntity.LogoImage.AlternateText
string

Gets or sets the alternate text.

ItemFinancialInformation.FinancialEntity.LogoImage.Description
string

Gets or sets the description.

ItemFinancialInformation.FinancialEntity.LogoImage.IsDefault
boolean

Gets or sets a value indicating whether this the specification for the defailt file/image.

ItemFinancialInformation.FinancialEntity.LogoImage.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

ItemFinancialInformation.FinancialEntity.LogoImage.VirtualPath
string

Gets or sets the image virtual path.

ItemFinancialInformation.FinancialEntity.LogoImageDescription
string

Gets or sets the image alt text/description of the entity logo.

ItemFinancialInformation.FinancialEntity.LogoImageUrl
string

Gets or sets url of the entity logo.

ItemFinancialInformation.FinancialEntity.Name
string

Gets or sets the name.

ItemFinancialInformation.FinancialEntity.SignatureImage
object

Class virtualfiledata.

 
ItemFinancialInformation.FinancialEntity.SignatureImage.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.VirtualFileData, Asi.Contracts"

ItemFinancialInformation.FinancialEntity.SignatureImage.AlternateText
string

Gets or sets the alternate text.

ItemFinancialInformation.FinancialEntity.SignatureImage.Description
string

Gets or sets the description.

ItemFinancialInformation.FinancialEntity.SignatureImage.IsDefault
boolean

Gets or sets a value indicating whether this the specification for the defailt file/image.

ItemFinancialInformation.FinancialEntity.SignatureImage.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

ItemFinancialInformation.FinancialEntity.SignatureImage.VirtualPath
string

Gets or sets the image virtual path.

ItemFinancialInformation.FinancialEntity.SignatureImageDescription
string

Gets or sets description of the entity signature image.

ItemFinancialInformation.FinancialEntity.SignatureImageUrl
string

Gets or sets url of the entity signature image.

ItemFinancialInformation.FinancialEntity.TaxReceiptMessage
string

Gets or sets the tax receipt message.

ItemFinancialInformation.IncursHandling
boolean

Gets or sets a value indicating whether [incurs handling].

ItemFinancialInformation.IncursRestock
boolean

Gets or sets a value indicating whether [incurs restock].

ItemFinancialInformation.IncursShipping
boolean

Gets or sets a value indicating whether [incurs shipping].

ItemFinancialInformation.InventoryUom
object

Unit of measure summary.

 
ItemFinancialInformation.InventoryUom.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.UomSummaryData, Asi.Contracts"

ItemFinancialInformation.InventoryUom.Description
string

Gets or sets the description.

ItemFinancialInformation.InventoryUom.Name
string

Gets or sets the tax category name.

ItemFinancialInformation.InventoryUom.UomId
string

Gets or sets the unit of measure id.

ItemFinancialInformation.IsCharitable
boolean

Gets or sets whether an item qualifies as a charitable item.

ItemFinancialInformation.IsCommissionable
boolean

Gets or sets a value indicating whether this instance is commissionable.

ItemFinancialInformation.ItemFinancialAccounts
object

Item financial accounts.

 
ItemFinancialInformation.ItemFinancialAccounts.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.ItemFinancialAccountsData, Asi.Contracts"

ItemFinancialInformation.ItemFinancialAccounts.AccountsReceivable
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
ItemFinancialInformation.ItemFinancialAccounts.AccountsReceivable.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

ItemFinancialInformation.ItemFinancialAccounts.AccountsReceivable.GLAccount
object

General ledger account.

 
ItemFinancialInformation.ItemFinancialAccounts.CostOfGoodsSold
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
ItemFinancialInformation.ItemFinancialAccounts.CostOfGoodsSold.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

ItemFinancialInformation.ItemFinancialAccounts.CostOfGoodsSold.GLAccount
object

General ledger account.

 
ItemFinancialInformation.ItemFinancialAccounts.DamagedGoods
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
ItemFinancialInformation.ItemFinancialAccounts.DamagedGoods.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

ItemFinancialInformation.ItemFinancialAccounts.DamagedGoods.GLAccount
object

General ledger account.

 
ItemFinancialInformation.ItemFinancialAccounts.DeferredIncome
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
ItemFinancialInformation.ItemFinancialAccounts.DeferredIncome.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

ItemFinancialInformation.ItemFinancialAccounts.DeferredIncome.GLAccount
object

General ledger account.

 
ItemFinancialInformation.ItemFinancialAccounts.Income
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
ItemFinancialInformation.ItemFinancialAccounts.Income.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

ItemFinancialInformation.ItemFinancialAccounts.Income.GLAccount
object

General ledger account.

 
ItemFinancialInformation.ItemFinancialAccounts.Inventory
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
ItemFinancialInformation.ItemFinancialAccounts.Inventory.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

ItemFinancialInformation.ItemFinancialAccounts.Inventory.GLAccount
object

General ledger account.

 
ItemFinancialInformation.ItemFinancialAccounts.InventoryAdjustments
object

Financial account. Contains a glaccount and project code. Is the standard unit for defining account flow.

 
ItemFinancialInformation.ItemFinancialAccounts.InventoryAdjustments.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"

ItemFinancialInformation.ItemFinancialAccounts.InventoryAdjustments.GLAccount
object

General ledger account.

 
ItemFinancialInformation.PurchaseUom
object

Unit of measure summary.

 
ItemFinancialInformation.PurchaseUom.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.UomSummaryData, Asi.Contracts"

ItemFinancialInformation.PurchaseUom.Description
string

Gets or sets the description.

ItemFinancialInformation.PurchaseUom.Name
string

Gets or sets the tax category name.

ItemFinancialInformation.PurchaseUom.UomId
string

Gets or sets the unit of measure id.

ItemFinancialInformation.TaxCategory
object

Tax category datacontract.

 
ItemFinancialInformation.TaxCategory.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.TaxCategorySummaryData, Asi.Contracts"

ItemFinancialInformation.TaxCategory.Description
string

Gets or sets the description.

ItemFinancialInformation.TaxCategory.Name
string

Gets or sets the tax category name.

ItemFinancialInformation.TaxCategory.TaxCategoryId
string

Gets or sets the tax category Id.

ItemFinancialInformation.TaxSchedule
object

Tax schedule

 
ItemFinancialInformation.TaxSchedule.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.TaxScheduleSummaryData, Asi.Contracts"

ItemFinancialInformation.TaxSchedule.Description
string

Gets or sets the description.

ItemFinancialInformation.TaxSchedule.Name
string

Gets or sets the tax category name.

ItemFinancialInformation.TaxSchedule.ShowTaxDetails
boolean

Gets or sets the show tax details indicator. If , then UI should normally show breakdown of tax authority details.

ItemFinancialInformation.TaxSchedule.TaxScheduleId
string

Gets or sets the tax schedule id.

ItemFinancialInformation.UomGroup
object

Unit of measure group summary.

 
ItemFinancialInformation.UomGroup.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.UomGroupSummaryData, Asi.Contracts"

ItemFinancialInformation.UomGroup.Description
string

Gets or sets the description.

ItemFinancialInformation.UomGroup.Name
string

Gets or sets the tax category name.

ItemFinancialInformation.UomGroup.UomGroupId
string

Gets or sets the unit of measure group id.

ItemId
string

Gets or sets the item Id.

ItemStatus
string

List of item status

Name
string

Gets or sets the name or title of the item.

PremiumInformation
object

Additional details about an item offered as a premium.

 
PremiumInformation.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.PremiumInformationData, Asi.Contracts"

PremiumInformation.IsOfferedAsPremium
boolean

Gets or sets a value indicating whether this instance is offered as a premium.

PremiumInformation.RequiredGiftAmount
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
PremiumInformation.RequiredGiftAmount.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

PremiumInformation.RequiredGiftAmount.Amount
object

Gets or sets the amount.

 
PremiumInformation.RequiredGiftAmount.Currency
object

Currency (value type).

 
PremiumInformation.RequiredGiftAmount.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

PremiumInformation.RequiredGiftAmount.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

PremiumInformation.RequiredGiftAmount.Currency.DecimalPositions
int32

Gets the decimal positions.

PremiumInformation.RequiredGiftAmount.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

ProrateRule
object

Rules for fee prorating

 
ProrateRule.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.ProrateRuleData, Asi.Contracts"

ProrateRule.ProrateRule
string
ProrateRule.ProrateSchedule
object

Rules for fee prorating

 
ProrateRule.ProrateSchedule.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.ProrateScheduleData, Asi.Contracts"

ProrateRule.ProrateSchedule.Description
string

Gets or sets the description.

ProrateRule.ProrateSchedule.Name
string

Gets or sets the name.

ProrateRule.ProrateSchedule.ProrateScheduleId
string

Gets or sets the Id.

ProrateRule.ProrateSchedule.Rates
array of objects

Gets or sets an array of rates for this schedule

PublishingInformation
object

Publishing information. Defines a standardized set of properties that describe the information that is relevant to publishing for an object.

 
PublishingInformation.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.PublishingInformationData, Asi.Contracts"

PublishingInformation.ExpirationDate
date-time

Gets or sets the expiration date after which the published object will be unavailable to public users.

PublishingInformation.IsClosed
boolean

Gets or sets the is closed flag.

PublishingInformation.IsMarkedForDelete
boolean

Gets or sets the marked for delete indicator.

PublishingInformation.Keywords
array of strings

Gets or sets the keywords.

PublishingInformation.PublishingState
string

Publishing status. This class summarizes an item's publishing state in terms of availability and visibility on the web site.

PublishingInformation.StartDate
date-time

Gets or sets the start date on which the published object will be available to public users.

PublishingInformation.TagInformation
object

Tag information.

 
PublishingInformation.TagInformation.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.TagInformationData, Asi.Contracts"

PublishingInformation.TagInformation.Tags
array of objects

A collection of tags.

$type
ChildTags
Description
Name
TagId
ReceiptType
string

Receipt type enumeration.

RelatedContentMessage
string

Gets or sets the string representing the item's related content message. This message is intended for display in places such as order confirmation.

TempDefaultPrice
object

The default, non-discounted price for the object. This value will be replaced by a price sheet.

 
ThumbnailUrl
string

Gets or sets the thumbnail URL.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Returns an Item by id

Returns an instance of Item by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item/ItemId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item/ItemId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Item/ItemId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

ItemId
string
required

Id of Item to be Returned

Response

The request was successful.

Suggest Edits

ItemSummary

 
Suggest Edits

Returns a list of ItemSummary

Returns a list containing a collection of ItemSummary

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ItemSummary
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ItemSummary");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ItemSummary");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Returns an ItemSummary by id

Returns an instance of ItemSummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ItemSummary/ItemSummaryId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ItemSummary/ItemSummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/ItemSummary/ItemSummaryId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

ItemSummaryId
string
required

Id of ItemSummary to be Returned

Response

The request was successful.

Examples of ItemSummaryId (ItemId)

  • TEACHCONF/ACAPELLA
  • TEACHCONF/ACCMPNT
  • ACCT101
Suggest Edits

PartyItemPrice

 
Suggest Edits

Returns a list of PartyItemPrice

Returns a list containing a collection of PartyItemPrice

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyItemPrice
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyItemPrice");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyItemPrice");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Returns a PartyItemPrice by id

Returns an instance of PartyItemPrice by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyItemPrice/PartyItemPriceId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyItemPrice/PartyItemPriceId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyItemPrice/PartyItemPriceId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

PartyItemPriceId
string
required

Id of PartyItemPrice to be Returned

Response

The request was successful.

PartyItemPriceId Format

~[partyId]|[itemId]

Examples of PartyItemPriceId

  • ~101|3YEAR
  • ~101|ADDLCHARGES/FREIGHT
  • ~101|ADDLCHARGES/TAX
Suggest Edits

Promotion

 
Suggest Edits

Returns a list of Promotion

Returns a list containing a collection of Promotion

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Creates a Promotion

Creates an instance of Promotion

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.PromotionData, Asi.Contracts"

BeginDate
date-time

Gets or sets the begin date.

EndDate
date-time

Gets or sets the end date.

IsImplicit
boolean

Gets or sets whether to apply promotion automatically.

ItemClassPromotionDetails
array of objects

Item class promotion detail collection.

$type
ItemClass 
PricingData 
ItemPromotionDetails
array of objects

Item promotion detail collection.

$type
Item 
PricingData 
MaximumDiscountsAllowedPerItemPromotion
int32

The maximum number of items that can be discounted within one transation

OrderPromotionDetails
object

Special price rule.

 
OrderPromotionDetails.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.SpecialPriceRuleData, Asi.Contracts"

OrderPromotionDetails.Amount
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
OrderPromotionDetails.Amount.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

OrderPromotionDetails.Amount.Amount
object

Gets or sets the amount.

 
OrderPromotionDetails.Amount.Currency
object

Currency (value type).

 
OrderPromotionDetails.Amount.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

OrderPromotionDetails.Amount.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

OrderPromotionDetails.Amount.Currency.DecimalPositions
int32

Gets the decimal positions.

OrderPromotionDetails.Amount.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

OrderPromotionDetails.BeginDate
date-time

Gets or sets the begin date.

OrderPromotionDetails.CalculationType
string

Special price rule type.

OrderPromotionDetails.Description
string

Gets or sets the description.

OrderPromotionDetails.EndDate
date-time

Gets or sets the end date.

OrderPromotionDetails.IsMarkedForDelete
boolean

Gets or sets a value indicating whether this instance is marked for delete.

OrderPromotionDetails.Mapping
object

Special price rule mappings - collections of valuemap or valuerangemap items.

 
OrderPromotionDetails.Mapping.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.MapSourceData, Asi.Contracts"

OrderPromotionDetails.Mapping.Calculation
object

Special price rule mappings - collections of valuemap or valuerangemap items.

 
OrderPromotionDetails.Mapping.Calculation.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.CalculationData, Asi.Contracts"

OrderPromotionDetails.Mapping.Calculation.Constant
object

Gets or sets the property holding the values for the mapping

 
OrderPromotionDetails.Mapping.Calculation.Operator
string

Special price rule type.

OrderPromotionDetails.Mapping.RuleSourceEntity
string

Gets or sets the source for the mapping - typically a table or view

OrderPromotionDetails.Mapping.RuleSourceProperty
string

Gets or sets the property holding the values for the mapping

OrderPromotionDetails.Mapping.ValueMappings
array of objects

Value mapping rule collection.

$type
DisplayText
MappedAmount 
Value
OrderPromotionDetails.Mapping.ValueRanges
array of objects

Value range mapping rule collection.

$type
AdditionalUnitAmount 
BaseAmount 
RangeBeginValue 
OrderPromotionDetails.Name
string

Gets or sets the name.

OrderPromotionDetails.Percent
object

Gets or sets the percent.

 
OrderPromotionDetails.RuleType
string

Special price rule type.

OrderPromotionDetails.SpecialPriceRuleId
string

Gets or sets the special price rule id.

PromotionCode
string

Gets or sets the promotion code.

PromotionDiscountType
string

The discount type for the promotion

PromotionId
string

Gets or sets the promotion id.

PromotionName
string

A user friendly name for the promotion.

PurchaseItemDetails
array of objects

Item promotion detail collection.

$type
Item 
RequiredPurchaseItemQuantity
object

Represents a quantity. For instance an line item order quantity.

 
RequiredPurchaseItemQuantity.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.QuantityData, Asi.Contracts"

RequiredPurchaseItemQuantity.Amount
object

Gets or sets the amount.

 
RequiredPurchaseItemQuantity.Uom
object

Unit of measure summary.

 
RequiredPurchaseItemQuantity.Uom.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.UomSummaryData, Asi.Contracts"

RequiredPurchaseItemQuantity.Uom.Description
string

Gets or sets the description.

RequiredPurchaseItemQuantity.Uom.Name
string

Gets or sets the tax category name.

RequiredPurchaseItemQuantity.Uom.UomId
string

Gets or sets the unit of measure id.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes a Promotion by id

Removes an instance of Promotion by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

PromotionId
string
required

Id of Promotion to be Removed

Response

The request was successful.

Suggest Edits

Returns a Promotion by id

Returns an instance of Promotion by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

PromotionId
string
required

Id of Promotion to be Returned

Response

The request was successful.

Examples of PromotionId

  • 8023cc99-127f-4ad6-b560-2e04189c49bc
  • 10ab3a6e-bae5-4478-a861-618a47ca91a7
  • eb71ae6b-494f-4e19-922f-cf3879d39a6d
Suggest Edits

Updates a Promotion by id

Updates an instance of Promotion by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Promotion/PromotionId");
var request = new RestRequest(Method.PUT);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

PromotionId
string
required

Id of Promotion to be Updated

Body Params

$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.PromotionData, Asi.Contracts"

BeginDate
date-time

Gets or sets the begin date.

EndDate
date-time

Gets or sets the end date.

IsImplicit
boolean

Gets or sets whether to apply promotion automatically.

ItemClassPromotionDetails
array of objects

Item class promotion detail collection.

$type
ItemClass 
PricingData 
ItemPromotionDetails
array of objects

Item promotion detail collection.

$type
Item 
PricingData 
MaximumDiscountsAllowedPerItemPromotion
int32

The maximum number of items that can be discounted within one transation

OrderPromotionDetails
object

Special price rule.

 
OrderPromotionDetails.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.SpecialPriceRuleData, Asi.Contracts"

OrderPromotionDetails.Amount
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
OrderPromotionDetails.Amount.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"

OrderPromotionDetails.Amount.Amount
object

Gets or sets the amount.

 
OrderPromotionDetails.Amount.Currency
object

Currency (value type).

 
OrderPromotionDetails.Amount.Currency.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"

OrderPromotionDetails.Amount.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

OrderPromotionDetails.Amount.Currency.DecimalPositions
int32

Gets the decimal positions.

OrderPromotionDetails.Amount.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

OrderPromotionDetails.BeginDate
date-time

Gets or sets the begin date.

OrderPromotionDetails.CalculationType
string

Special price rule type.

OrderPromotionDetails.Description
string

Gets or sets the description.

OrderPromotionDetails.EndDate
date-time

Gets or sets the end date.

OrderPromotionDetails.IsMarkedForDelete
boolean

Gets or sets a value indicating whether this instance is marked for delete.

OrderPromotionDetails.Mapping
object

Special price rule mappings - collections of valuemap or valuerangemap items.

 
OrderPromotionDetails.Mapping.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.MapSourceData, Asi.Contracts"

OrderPromotionDetails.Mapping.Calculation
object

Special price rule mappings - collections of valuemap or valuerangemap items.

 
OrderPromotionDetails.Mapping.Calculation.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.CalculationData, Asi.Contracts"

OrderPromotionDetails.Mapping.Calculation.Constant
object

Gets or sets the property holding the values for the mapping

 
OrderPromotionDetails.Mapping.Calculation.Operator
string

Special price rule type.

OrderPromotionDetails.Mapping.RuleSourceEntity
string

Gets or sets the source for the mapping - typically a table or view

OrderPromotionDetails.Mapping.RuleSourceProperty
string

Gets or sets the property holding the values for the mapping

OrderPromotionDetails.Mapping.ValueMappings
array of objects

Value mapping rule collection.

$type
DisplayText
MappedAmount 
Value
OrderPromotionDetails.Mapping.ValueRanges
array of objects

Value range mapping rule collection.

$type
AdditionalUnitAmount 
BaseAmount 
RangeBeginValue 
OrderPromotionDetails.Name
string

Gets or sets the name.

OrderPromotionDetails.Percent
object

Gets or sets the percent.

 
OrderPromotionDetails.RuleType
string

Special price rule type.

OrderPromotionDetails.SpecialPriceRuleId
string

Gets or sets the special price rule id.

PromotionCode
string

Gets or sets the promotion code.

PromotionDiscountType
string

The discount type for the promotion

PromotionId
string

Gets or sets the promotion id.

PromotionName
string

A user friendly name for the promotion.

PurchaseItemDetails
array of objects

Item promotion detail collection.

$type
Item 
RequiredPurchaseItemQuantity
object

Represents a quantity. For instance an line item order quantity.

 
RequiredPurchaseItemQuantity.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.QuantityData, Asi.Contracts"

RequiredPurchaseItemQuantity.Amount
object

Gets or sets the amount.

 
RequiredPurchaseItemQuantity.Uom
object

Unit of measure summary.

 
RequiredPurchaseItemQuantity.Uom.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.UomSummaryData, Asi.Contracts"

RequiredPurchaseItemQuantity.Uom.Description
string

Gets or sets the description.

RequiredPurchaseItemQuantity.Uom.Name
string

Gets or sets the tax category name.

RequiredPurchaseItemQuantity.Uom.UomId
string

Gets or sets the unit of measure id.

Response

The request was successful.