OpsCloseTimeCardBatch
Request
Name | Data Type | Required? | Default Value | Discussion |
---|---|---|---|---|
BatchId | int | yes | The batch ID created by invoking the OpenTimeCardBatch service. | |
BatchActionType | int | yes | Import | "Import"=Add time cards |
Status | string | yes | S | Used only if BatchActionType is Import. The Status is always approved when the BatchActionType is Replace. |
OverrideRulesFlag | Boolean | no | false | When true, causes the procedure to ignore violations of project status, date range, resource status, booked resources only, and narrative required rules. This bit is meaningful only if the cards are being imported, not if they are being replaced. |
PurgeBeginDate | date | no | Used only if BatchActionType is Replace. Caution: If the date is null then all cards will be purged that are earlier than the PurgeEndDate. If the account setting Prevent Unbounded Deletion of FRO Time and Cost Cards is turned on, if no value is passed in for PurgeBeginDate and PurgeEndDate, no existing "for reporting only" time cards will be purged. Otherwise, all "for reporting only" time cards within the date range will be purged. | |
PurgeEndDate | date | no | Used only if BatchActionType is Replace. Caution: If the date is null then all cards will be purged that are later than the PurgeBeginDate. If the account setting Prevent Unbounded Deletion of FRO Time and Cost Cards is turned on, if no value is passed in for PurgeBeginDate and PurgeEndDate, no existing "for reporting only" time cards will be purged. Otherwise, all 'for reporting only" time cards within the date range will be purged. | |
UseFirstRoleFlag | boolean | no | false | If true, then time cards without roles are given the first project role. If false, then time cards without roles are rejected. |
UseFirstTaskFlag | boolean | no | false | If true, then time cards without tasks are given the first project task. If false, then time cards without tasks are rejected. |
CreateTaskCodesFlag | boolean | no | false | If true, task codes will get created to accommodate time cards if they do not already exist. Otherwise, unrecognized task codes are rejected. |
CreateTasksFlag | boolean | no | false | If true, tasks will get created to accommodate time cards if they do not already exist. Otherwise, unrecognized tasks are rejected. |
AlterProjectDatesAsNeededFlag | boolean | no | false | If true, then time that is outside of the project begin and end dates causes the begin and end dates to be adjusted. Otherwise, the time is rejected. |
RecalcContractRatesFlag | Boolean | no | false | When replacing and this is true then Projector calculates the contract revenue for each card |
SetAdjustedRevenueToContractRevenue | Boolean | no | false | Applies only when replacing time cards. If true then the billing adjusted revenue is set to the contract revenue. One use is to set the billing adjusted revenue to the calculated contract rates. |
SetSystemRevenueToContractRevenue | Boolean | no | false | Applies only when replacing time cards. If true then the system revenue is set to the contract revenue. One use is to set the system revenue to the calculated contract rates. |
CreateTaskTypesFlag | boolean | no | false | |
RecalcBillingAdjustedRatesFlag | boolean | no | false | |
SetSystemRevenueToAdjustedRevenueFlag | boolean | no | false | |
LastFroTimeCardDate | date | no | The last FRO time card date is stored at the CLI level. It is the last time for which system revenue on time cards is locked. If later than the last date for which revenue recognition was actually run, then Projector considers the last FRO time card date to be the computed last date for which revenue recognition was run. NULL, preserve old behavior, which is to move the last FRO time card date to latest work date in import batch if the existing last FRO time card date is earlier or null. A common use case is to set this date to a very early date (e.g., 3/3/1989, which was a very good date), so that users can use Projector's revenue recognition to set the revenue on FRO time cards – just as is done on "real" time cards. Otherwise, set the last FRO time card date to the specified last FRO time card date with no restrictions. This is useful if the revenue on these time cards is set when the cards are loaded. | |
ReportOnlyFlag | boolean | no | false | If set to "true", the time card importing process is exercised, but not completed. If there is any error triggered during the importing process, it will be reported in the response. |
PurgeExternalGroupingIdentifier | string | no | The group of time cards associated with this externalgroupindentifier will be purged. | |
PurgeUidList | string | no | Comma separated list of time cards that are to be purged. | |
PurgeProjectCode | string | no | The code for the project whose time cards are to be purged. |
Response
The following data is returned:
Name | Data Type | Discussion |
---|---|---|
TimeCardErrors | list of TimeCardError items | see below |
DeletedTimeCardCount | int (nullable) | If time cards were deleted as part of this request, this will be the number of cards that were deleted. |
Each TimeCardError item contains:
Name | Data Type | Discussion |
---|---|---|
Index | int | Index of the time card (position in the batch) that failed. |
OpsError | OpsWebError | See Responses |
Changelog
4.4
Parameter | Notes |
---|---|
CreateTaskTypesFlag | Added as a request parameter |
RecalcBillingAdjustedRatesFlag | Added as a request parameter |
SetSystemRevenueToAdjustedRevenueFlag | Added as a request parameter |