Skip to main content

MGCLatticePendingVendorInvoicePostRequestContract

Data contract for posting a pending vendor invoice (Accounts payable > Invoices > Pending vendor invoices): the invoice is named either by its HeaderReference (the key of the standard VendorInvoiceHeaders entity) or by VendorAccount together with InvoiceNumber, plus the standard header fields.

Methods​

new​

Initializes a new instance of the MGCLatticePendingVendorInvoicePostRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticePendingVendorInvoicePostRequestContract class.

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

No parameters.

parmCorrelationId​

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

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

parmRequestId​

Gets or sets the unique request identifier for idempotency.

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

parmLegalEntityId​

Gets or sets the legal entity whose pending vendor invoice is posted.

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

parmUserContext​

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

  • Visibility: public
  • Returns: UserId The UserContext value.
NameTypeOptionalDescription
_userContextUserIdYesThe UserContext 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.
NameTypeOptionalDescription
_previewModebooleanYesThe PreviewMode value.

parmExternalSystem​

Gets or sets the external system whose key VendorAccountExternalKey holds.

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

parmHeaderReference​

Gets or sets the pending invoice's header reference: the key of the standard VendorInvoiceHeaders entity (VendInvoiceInfoTable.TableRefId). Send it, or VendorAccount with InvoiceNumber, not both.

  • Visibility: public
  • Returns: TradeLineRefId The HeaderReference value.
NameTypeOptionalDescription
_headerReferenceTradeLineRefIdYesThe HeaderReference value.

parmVendorAccount​

Gets or sets the vendor of the pending invoice (its invoice account or its vendor account), sent together with InvoiceNumber in place of HeaderReference.

  • Visibility: public
  • Returns: VendAccount The VendorAccount value.
NameTypeOptionalDescription
_vendorAccountVendAccountYesThe VendorAccount value.

parmVendorAccountExternalKey​

Gets or sets the external system's key of the vendor, in place of VendorAccount.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The VendorAccountExternalKey value.
NameTypeOptionalDescription
_vendorAccountExternalKeyMGCLatticeExternalKeyYesThe VendorAccountExternalKey value.

parmInvoiceNumber​

Gets or sets the vendor's invoice number of the pending invoice (the Invoice field of the page), sent together with VendorAccount in place of HeaderReference.

  • Visibility: public
  • Returns: VendInvoiceId The InvoiceNumber value.
NameTypeOptionalDescription
_invoiceNumberVendInvoiceIdYesThe InvoiceNumber value.