Skip to main content
Vindicia Knowledge Center

MigrationTransactionItem Subobject

MigrationTransactionItem Subobject

MigrationTransactionItem Subobject

A line-item in a MigrationTransaction. All line-items added together should add up to the total Transaction amount.

Table 18-6: MigrationTransactionItem Object Data Members

Data Members

Data Type

Description

itemType

MigrationTransactionItemType

The Migrated Transaction Item’s type, which may be one of three values:

  • Credit: a one-time charge (not necessarily associated with an AutoBillItem).
  • NonRecurringCharge: an after tax Credit applied to a Transaction.
  • RecurringCharge: a one-time charge (not necessarily associated with an AutoBillItem).

If unspecified, the type defaults to RecurringCharge.

merchantAutoBillItemId

string

OptionalYour unique identifier for the AutoBillItem associated with this MigrationTransactionItem. Use this data member to distinguish between two or more AutoBillItems for the same Product.

migrationTaxItems

MigrationTaxItem

OptionalAn array of tax line-items in aMigrationTransactionItem.

The MigrationTaxItems subobject contains three data members:

  • amount: Tax amount in the currency of the overall transaction. (Required decimal.)
  • jurisdiction: Sales tax jurisdiction. (Optional string.)
  • name: Sales tax name. (Optional string.)

name

string

RequiredA description of the item, which should match an existing Product description field. This is a free-form string of 256 or fewer characters.

price

decimal

RequiredThe price of the item, in the currency of the overall transaction.

Currencies may not be mixed on a single Transaction. This value must be zero or positive.

servicePeriodEndDate

dateTime

RequiredThe entitlement end date for this item (generally associated with an AutoBill item).

servicePeriodStartDate

dateTime

RequiredThe entitlement start date for this item (generally associated with an AutoBill item).

If unspecified, defaults to the MigrationTransaction’s billingDate.

sku

string

Required. Your unique identifier for the product or service purchased with this MigrationTransactionItem. This value should match the merchantProductId for an existing Product, but it is not required to do so.

This is a free-form string of 256 or fewer characters.

taxClassification

string

The item’s tax classification.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top