Skip to main content

MGCLatticeExpenseReportCreateRequestContract

Data contract for creating an expense report (Expense management > My expenses > Expense reports) from an expense tool: the worker the report belongs to, its purpose, description and location, financial dimensions, the expense lines, and whether the report is submitted to its approval workflow right away, plus the standard header fields.

Methods​

new​

Initializes a new instance of the MGCLatticeExpenseReportCreateRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeExpenseReportCreateRequestContract class.

  • Visibility: public
  • Returns: MGCLatticeExpenseReportCreateRequestContract A new MGCLatticeExpenseReportCreateRequestContract 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 the expense report is created in.

  • 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.

parmWorkerPersonnelNumber​

Gets or sets the personnel number of the worker whose expense report it is. Empty = the calling user's worker, as the expense report page defaults it.

  • Visibility: public
  • Returns: HcmPersonnelNumberId The WorkerPersonnelNumber value.
NameTypeOptionalDescription
_workerPersonnelNumberHcmPersonnelNumberIdYesThe WorkerPersonnelNumber value.

parmPurpose​

Gets or sets the purpose of the expense report.

  • Visibility: public
  • Returns: TrvTravelTxtEDT The Purpose value.
NameTypeOptionalDescription
_purposeTrvTravelTxtEDTYesThe Purpose value.

parmDescription​

Gets or sets the description of the expense report.

  • Visibility: public
  • Returns: ItemFreeTxt The Description value.
NameTypeOptionalDescription
_descriptionItemFreeTxtYesThe Description value.

parmLocation​

Gets or sets the location (destination) of the expense report.

  • Visibility: public
  • Returns: TrvDestination The Location value.
NameTypeOptionalDescription
_locationTrvDestinationYesThe Location value.

parmDimensions​

Gets or sets financial dimensions of the report, merged over the worker's default dimensions; the lines default from them.

  • Visibility: public
  • Returns: List The Dimensions value.
NameTypeOptionalDescription
_dimensionsListYesThe Dimensions value.

parmLines​

Gets or sets the expense lines; at least one.

  • Visibility: public
  • Returns: List The Lines value.
NameTypeOptionalDescription
_linesListYesThe Lines value.

parmSubmitToWorkflow​

Gets or sets whether the report is submitted to its expense report approval workflow after it is created.

  • Visibility: public
  • Returns: boolean The SubmitToWorkflow value.
NameTypeOptionalDescription
_submitToWorkflowbooleanYesThe SubmitToWorkflow value.

parmComment​

Gets or sets the workflow comment of the submit; only with SubmitToWorkflow.

  • Visibility: public
  • Returns: WorkflowComment The Comment value.
NameTypeOptionalDescription
_commentWorkflowCommentYesThe Comment value.