Agreements - Intergraph Smart Materials - Help - Hexagon

Intergraph Smart Materials Web API Help (10.6)

ft:locale
en-US
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Smart Materials/Smart Reference Data Version
10.6

Through agreements API, you can create and modify only following types of agreements.

  • Manual agreement

  • Agreement by requisition

  • Agreement by inquiry

  • Subcontracts

To create these agreements through API, certain elements are mandatory to pass. They are as following and their description and other details you can view in Create an agreement .

Elements that are needed

Manual agreement header

Agreement by requisition header

Agreement by inquiry header

Subcontracts

Line items for all agreement types

Mandatory elements

OrderType

RId

InqId

OrderType

LineItemPosition

PoNumber

OrderType

OrderType

PoNumber

LineItemSubPosition

SupplierId

PoNumber

PoNumber

SupplierId

Ident

Currency

SupplierId

SupplierId

Currency

ItemType

OriginCode

Currency

Currency

originCode

TagNumber

IssuedBy

OriginCode

OriginCode

IssuedBy

PriceBase

IssuedBy

IssuedBy

PaymentType

DiscountBase

PoSupp

SplitPostApprovalInd

QtyUnitCode

WeightUnitCode

You can update only following agreement types through these API.

  • Manual agreement

  • Agreement by requisition

  • Agreement by inquiry

  • Subcontracts

You can update these fields of agreement header and line items using these API. For their description and details, see Update an agreement and Update line items of an agreement.

Based on agreement type, few header elements and line items cannot be updated. Please go through the respective sections to know the details.

Agreement header elements that can be updated

Agreement line item elements that can be updated

PoNumber

LineItemPosition

ClientPoNumber

LineItemSubPosition

TemplatePoNumber

ItemType

ShortDescription

TagNumber

Description

QtyUnitCode

SupplierId

WeightUnitCode

Ccpcode

Currency

Buyer

PriceBase

Expediter

PoliQty

Traffic

PoliUnitWeight

DiscountBase

PoliTotalWeight

DiscountPercent

PoliVolume

DiscountAmount

PoliUnitPrice

PtyCode

ExtendedPrice

SectionCode

DiscountPercent

AccountCode

DiscountAmount

CountryOfOrigin

DiscountBase

ExpeditingIlvCode

DomProdPercent

InspectionlvCode

LastShip

CriticalityIlvCode

FinalApprovalAmount

PointOfOrigin

SplitPostApprovalInd (Only if a split item is attached to the agreement)

CommentsSettledInd

AccountCode

OffRentDate

VolumeUnitCode

OrgEtaSiteDate

CountryOfOrigin

RecvAcknowledgeDate

ExportLicenseNumber

TechEvaluationCompletionDate

FirstShip

ReadyForApprovalInd

ExportLicenseRequiredInd

PurchaseOrderIssueDate

AcceptedInd

EscNoticeInd

TechEvaluationPassedInd

Budget

ExpeditingInd

EstimatedValue

Incoterm

RetPercent

RevisedPromiseDate

InvCheckInd

PoliDimensions

RecvTolerance

ExportLicenseReceivedDate

InvTolerance

PoliCloseDate

PoNumberRuleCode

CatalogNumber

PaymentType

Manufacturer

FreightValue

CancelRequiredInd

SupplyPrice

InstallPrice

ApprovedPtyCode

FinalApprovedScheduleChange

NoticeToProceedDate

PoliComment

InvCheckInd

RentalStartDate

RentalEndDate

Interval

Valid period

CnrId (Only if any change order is already processed for this agreement.

ProcOrderSeq (Only for agreement by requisition)

PromContractDate (Only for agreement by requisition)