IM Adjustment (XML)

IM Adjustment (XML)

Element

Parent

Required

Data Type

Description

Valid Values

Element

Parent

Required

Data Type

Description

Valid Values

TransactionHeader

 

Yes

 

 

 

TransactionType

TransactionHeader

Yes

VARCHAR(20)

This is the type of transaction that is being integrated

Adjustment

TransactionClassID

TransactionHeader

No

VARCHAR(50)

This is the ID of the inventory transaction class the transaction belongs to. The default transaction class is used, if the value is not provided. 

 

TransactionID

TransactionHeader

No

VARCHAR(50)

This is the transaction number. If a transaction number is passed and this transaction exists we will add the items to the transaction. If the transaction does not exist we will create it. If this is empty we will use the next number.

 

TransactionStatusName

TransactionHeader

No

VARCHAR(25)

This is the status that the transaction should be integrated as. If no status is passed, "New" will be used.

New, Released, In Process, Staging, Loading, Shipped, Approved, Ready To Post

SiteID

TransactionHeader

Yes

VARCHAR(20)

This is the site ID that the transaction is being completed in.

 

TransactionDate

TransactionHeader

Yes

DATETIME

This is the date the transaction affects inventory.

 

ReasonCode

TransactionHeader

No

VARCHAR(50)

This is the reason code for the adjustment. Must be a valid NorthScope reason code.

 

UserID

TransactionHeader

No

VARCHAR(110)

This is the user who is completing the transaction. Does not have to be a valid NS user.

 

CompanyID

TransactionHeader

Yes

VARCHAR(15)

This is the ID of the company that you are sending data for. The value must match an entry in ERPx_MFDataEntityCompany for the Company ID column.

 

TransactionDetail

TransactionHeader

Yes

 

 

 

ItemSort

TransactionDetail

No

Integer

This is the sequence of the items on the transaction. If not passed we will sequence them. If a sequence conflict comes up we will override with the new information.

 

ItemID

TransactionDetail

Yes

VARCHAR(50)

This is the item ID for the inventory item being adjusted. This must be a valid Sales/Inventory item type.

 

TransactionUnits

TransactionDetail

No

NUMERIC(18,5)

This is the number of units for this line on the transaction. If an item is managed by units only or units and weight this value must be passed.

 

UnitsUOMID

TransactionDetail

No

VARCHAR(10)

This is the unit of measure for the units on the transaction. It is required if TransactionUnits is being used.

 

TransactionWeight

TransactionDetail

No

NUMERIC(18,5)

This is the weight value for this line on the transaction. If an item is managed by weight only this value must be passed. If an item is managed by units and weight, and no weight value is provided it will be calculated based on the item's unit of measure schedule and conversions per the number of units provided for the line on the transaction. 

 

WeightUOMID

TransactionDetail

No

VARCHAR(10)

This is the unit of measure for the weight on the transaction. It is required if TransactionWeight is being used.

 

Lot

TransactionDetail

No

VARCHAR(50)

This is the production batch (or "lot") number for this line of the transaction if batches/lots are being managed.

 

Owner

TransactionDetail

No

VARCHAR(25)

This is the name of the owner assigned to the lot and must be a valid owner name configured in the system. This value will default to the value assigned to the "Default Owner" preference if not provided in the XML.

 

Attributes

TransactionDetail

No

 

 

 

TransactionAttributeList

Attributes

No

 

Child element of Attributes.

 

TransactionAttribute

TransactionAttributeList

No

 

Child element of TransactionAttributeList.

 

Name

TransactionAttribute

No

VARCHAR(25)

This is the attribute name associated with the Adjustment transaction. 

 

Value

TransactionAttribute

No

VARCHAR(200)

This is the attribute value for the associated transaction attribute.

 

LotAttributeList

Attributes

No

 

Child element of Attributes.

 

LotAttribute

LotAttributeList

No

 

Child element of LotAttributeList.

 

ItemID

LotAttribute

No

VARCHAR(50)

This is the Item ID of the item for the associated production batch (lot) that the attributes are to be assigned to. This must be a valid item that is setup in the inventory items master file and should match the ItemID entered in the TransactionDetail.

 

Lot

LotAttribute

No

VARCHAR(50)

This is the production batch (or "lot") number associated with the item that the attributes are to be assigned to. This can either be a new or existing lot, but should match the Lot entered in the TransactionDetail. 

 

SiteID

LotAttribute

No

VARCHAR(20)

This is the Site ID associated with the item and lot that the attributes are to be assigned to.   This value should match the SiteID entered in the TransactionHeader.

 

Owner

LotAttribute

No

VARCHAR(25)

This is the name of the owner assigned to the lot.  This must be a valid owner name configured in the system and should match the Owner entered in the TransactionDetail.

 

AttributesList

LotAttribute

No

 

Child element of LotAttribute.

 

Attribute

AttributesList

No

 

Child element of AttributesList.

 

AttributeName

Attribute

No

VARCHAR(25)

This is the attribute name associated with the production batch (Lot) configured in the Attributes master file for production batches.

 

AttributeValue

Attribute

No

VARCHAR(200)

This is the attribute value for the associated production batch (lot) attribute.  Valid values are dependent upon what type of attribute the value is associated to.  For List type attributes the value entered must exist as an option in the list, for Date type attributes the value entered must be a valid date and format. 

 

Pallets

TransactionDetail

No

 

 

 

ItemPallet

Pallets

No

 

Child element of Pallets.

 

ItemID

ItemPallet

No

VARCHAR(50)

This is the Item ID of the item that is associated to the Pallet. This must be a valid item that is setup in the inventory items master file and should match the ItemID entered in the TransactionDetail.

 

Lot

ItemPallet

No

VARCHAR(50)

This is the production batch (or "lot") number associated with the item on the Pallet. This can either be a new or existing lot, but should match the Lot entered in the TransactionDetail. 

 

SiteID

ItemPallet

No

VARCHAR(20)

This is the Site ID associated with the item and lot on the Pallet.   This value should match the SiteID entered in the TransactionHeader.

 

Owner

ItemPallet

No

VARCHAR(25)

This is the name of the owner assigned to the lot on the Pallet.  This must be a valid owner name configured in the system and should match the Owner entered in the TransactionDetail.

 

PalletList

ItemPallet

No

 

Child element of ItemPallet.

 

Pallet

PalletList

No

 

Child element of PalletList. 

 

Number

Pallet

No

VARCHAR(50)

This is the Pallet Number assigned to the pallet. 

 

Units

Pallet

No

NUMERIC(18,5)

This is the quantity of Units for the item on the pallet. If an item is managed by units only or units and weight this value must be passed.

 

UnitsUOMID

Pallet

No

VARCHAR(10)

This is the unit of measure for the item's units on the pallet. 

 

Weight

Pallet

No

NUMERIC(18,5)

This is the weight value for the item on the pallet.  If an item is managed by weight only or units and weight this value must be passed.

 

WeightUOMID

Pallet

No

VARCHAR(10)

This is the unit of measure for the item's weight on the pallet. 

 

Certifications

TransactionDetail

No

 

 

 

LotCertificationsList

Certifications

No

 

Child element of Certifications.

 

LotCertification

LotCertificationsList

No

 

Child element of LotCertificationsList.

 

ItemID

LotCertification

No

VARCHAR(50)

This is the Item ID of the item that the certifications are to be assigned to. This must be a valid item that is setup in the inventory items master file and should match the ItemID entered in the TransactionDetail.

 

Lot

LotCertification

No

VARCHAR(50)

This is the production batch (or "lot") number associated with the item that the certifications are to be assigned to. This can either be a new or existing lot, but should match the Lot entered in the TransactionDetail. 

 

SiteID

LotCertification

No

VARCHAR(20)

This is the Site ID associated with the item and lot that the certifications are to be assigned to.   This value should match the SiteID entered in the TransactionHeader.

 

Owner

LotCertification

No

VARCHAR(25)

This is the name of the owner assigned to the lot.  This must be a valid owner name configured in the system and should match the Owner entered in the TransactionDetail.

 

CertificationsList

Certifications

No

 

Child element of Certifications.

 

Certification

CertificationsList

No