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:
MGCLatticeExpenseReportCreateRequestContractA new MGCLatticeExpenseReportCreateRequestContract instance.
No parameters.
parmCorrelationId
Gets or sets the correlation identifier for tracing the request across systems.
- Visibility:
public - Returns:
GuidThe 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:
GuidThe RequestId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_requestId | Guid | Yes | The RequestId value. |
parmLegalEntityId
Gets or sets the legal entity the expense report is created in.
- Visibility:
public - Returns:
DataAreaIdThe 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:
UserIdThe UserContext value.
| Name | Type | Optional | Description |
|---|---|---|---|
_userContext | UserId | Yes | The UserContext value. |
parmPreviewMode
Gets or sets preview mode. The operation has no preview, so a request with PreviewMode set is refused.
- Visibility:
public - Returns:
booleanThe PreviewMode value.
| Name | Type | Optional | Description |
|---|---|---|---|
_previewMode | boolean | Yes | The 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:
HcmPersonnelNumberIdThe WorkerPersonnelNumber value.
| Name | Type | Optional | Description |
|---|---|---|---|
_workerPersonnelNumber | HcmPersonnelNumberId | Yes | The WorkerPersonnelNumber value. |
parmPurpose
Gets or sets the purpose of the expense report.
- Visibility:
public - Returns:
TrvTravelTxtEDTThe Purpose value.
| Name | Type | Optional | Description |
|---|---|---|---|
_purpose | TrvTravelTxtEDT | Yes | The Purpose value. |
parmDescription
Gets or sets the description of the expense report.
- Visibility:
public - Returns:
ItemFreeTxtThe Description value.
| Name | Type | Optional | Description |
|---|---|---|---|
_description | ItemFreeTxt | Yes | The Description value. |
parmLocation
Gets or sets the location (destination) of the expense report.
- Visibility:
public - Returns:
TrvDestinationThe Location value.
| Name | Type | Optional | Description |
|---|---|---|---|
_location | TrvDestination | Yes | The 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:
ListThe Dimensions value.
| Name | Type | Optional | Description |
|---|---|---|---|
_dimensions | List | Yes | The Dimensions value. |
parmLines
Gets or sets the expense lines; at least one.
- Visibility:
public - Returns:
ListThe Lines value.
| Name | Type | Optional | Description |
|---|---|---|---|
_lines | List | Yes | The Lines value. |
parmSubmitToWorkflow
Gets or sets whether the report is submitted to its expense report approval workflow after it is created.
- Visibility:
public - Returns:
booleanThe SubmitToWorkflow value.
| Name | Type | Optional | Description |
|---|---|---|---|
_submitToWorkflow | boolean | Yes | The SubmitToWorkflow value. |
parmComment
Gets or sets the workflow comment of the submit; only with SubmitToWorkflow.
- Visibility:
public - Returns:
WorkflowCommentThe Comment value.
| Name | Type | Optional | Description |
|---|---|---|---|
_comment | WorkflowComment | Yes | The Comment value. |