MGCLatticePurchasePrepaymentInvoiceRequestContract

Request contract for posting a vendor prepayment invoice for a purchase order (postPurchasePrepaymentInvoice): the purchase order (or its external key), the vendor's invoice number, the prepayment to set up when the order has none yet (a percentage or a fixed amount, the procurement category it posts with and an optional description), the optional invoice and posting dates, the preview flag (always refused) and the common envelope fields.

Methods

construct

Creates a new instance of the MGCLatticePurchasePrepaymentInvoiceRequestContract class.

• Visibility: public
• Returns: MGCLatticePurchasePrepaymentInvoiceRequestContract A new MGCLatticePurchasePrepaymentInvoiceRequestContract instance.

No parameters.

parmCorrelationId

Gets or sets the correlation identifier for tracing the request across systems.

• Visibility: public
• Returns: Guid The CorrelationId value.

Name	Type	Optional	Description
_correlationId	Guid	Yes	The CorrelationId value.

parmRequestId

Gets or sets the unique request identifier for idempotency.

• Visibility: public
• Returns: Guid The RequestId value.

Name	Type	Optional	Description
_requestId	Guid	Yes	The RequestId value.

parmLegalEntityId

Gets or sets the legal entity (company) of the purchase order.

• Visibility: public
• Returns: DataAreaId The LegalEntityId value.

Name	Type	Optional	Description
_legalEntityId	DataAreaId	Yes	The LegalEntityId value.

parmUserContext

Gets or sets the calling system's user context (informational).

• Visibility: public
• Returns: UserId The UserContext value.

Name	Type	Optional	Description
_userContext	UserId	Yes	The UserContext value.

parmPurchaseOrderId

Gets or sets the purchase order the prepayment invoice is posted for (or send PurchaseOrderIdExternalKey).

• Visibility: public
• Returns: PurchId The PurchaseOrderId value.

Name	Type	Optional	Description
_purchaseOrderId	PurchId	Yes	The PurchaseOrderId value.

parmVendorInvoiceNumber

Gets or sets the vendor's number of the prepayment invoice (required); it becomes the posted invoice number.

• Visibility: public
• Returns: VendInvoiceId The VendorInvoiceNumber value.

Name	Type	Optional	Description
_vendorInvoiceNumber	VendInvoiceId	Yes	The VendorInvoiceNumber value.

parmPrepaymentPercent

Gets or sets the prepayment as a percentage of the order total (greater than 0, at most 100). Send it or PrepaymentAmount when the order has no prepayment yet; on an order that has one, leave both out (or send the same values).

• Visibility: public
• Returns: Percent The PrepaymentPercent value.

Name	Type	Optional	Description
_prepaymentPercent	Percent	Yes	The PrepaymentPercent value.

parmPrepaymentAmount

Gets or sets the prepayment as a fixed amount in the order's currency (greater than 0, at most the order total). Send it or PrepaymentPercent when the order has no prepayment yet.

• Visibility: public
• Returns: AmountCur The PrepaymentAmount value.

Name	Type	Optional	Description
_prepaymentAmount	AmountCur	Yes	The PrepaymentAmount value.

parmPrepaymentCategoryName

Gets or sets the procurement category the prepayment is posted with, by name. Required when the order has no prepayment yet; it must not be the category of any line of the order.

• Visibility: public
• Returns: EcoResCategoryName The PrepaymentCategoryName value.

Name	Type	Optional	Description
_prepaymentCategoryName	EcoResCategoryName	Yes	The PrepaymentCategoryName value.

parmPrepaymentCategoryHierarchyName

Gets or sets the procurement category hierarchy of PrepaymentCategoryName. Optional: needed only when the category name exists in more than one procurement category hierarchy.

• Visibility: public
• Returns: EcoResCategoryHierarchyName The PrepaymentCategoryHierarchyName value.

Name	Type	Optional	Description
_prepaymentCategoryHierarchyName	EcoResCategoryHierarchyName	Yes	The PrepaymentCategoryHierarchyName value.

parmPrepaymentDescription

Gets or sets the description of a prepayment the operation sets up. Optional.

• Visibility: public
• Returns: PurchPrepayDescription The PrepaymentDescription value.

Name	Type	Optional	Description
_prepaymentDescription	PurchPrepayDescription	Yes	The PrepaymentDescription value.

parmInvoiceDate

Gets or sets the invoice date of the prepayment invoice. Optional: the vendor invoice's default applies.

• Visibility: public
• Returns: DocumentDate The InvoiceDate value.

Name	Type	Optional	Description
_invoiceDate	DocumentDate	Yes	The InvoiceDate value.

parmPostingDate

Gets or sets the posting date of the prepayment invoice. Optional: today.

• Visibility: public
• Returns: TransDate The PostingDate value.

Name	Type	Optional	Description
_postingDate	TransDate	Yes	The PostingDate value.

parmPreviewMode

Gets or sets preview mode. The operation has no preview, so a request with PreviewMode set is refused.

• Visibility: public
• Returns: boolean The PreviewMode value.

Name	Type	Optional	Description
_previewMode	boolean	Yes	The PreviewMode value.

parmExternalSystem

Gets or sets the external system whose keys the request's external key members hold.

• Visibility: public
• Returns: MGCLatticeExternalSystemId The ExternalSystem value.

Name	Type	Optional	Description
_externalSystem	MGCLatticeExternalSystemId	Yes	The ExternalSystem value.

parmPurchaseOrderIdExternalKey

Gets or sets the external system's key of the purchase order, in place of PurchaseOrderId.

• Visibility: public
• Returns: MGCLatticeExternalKey The PurchaseOrderIdExternalKey value.

Name	Type	Optional	Description
_purchaseOrderIdExternalKey	MGCLatticeExternalKey	Yes	The PurchaseOrderIdExternalKey value.