Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Data Type

Required?

Default Value

Discussion

BatchId

int

yes


The batch ID created by invoking the OpenTimeCardBatch service.

BatchActionType

int

yes


This parameter specifies how the cost cards in the batch should get imported. See table below for possible values and their definitions.

PurgeBeginDate

date

no

Beginning of time.

Applies to Replace batch action only. Caution: If the date is null then all for reporting only 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" cost cards will be purged. Otherwise, all "for reporting only" cost cards in the date range will be purged.

PurgeEndDate

date

no

End of time.

Applies to Replace batch action only. Caution: If the date is null then all for reporting only 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" cost cards will be purged. Otherwise, all "for reporting only" cost cards in the date range will be purged.

ExpenseReportNumber

string

no


Applies to ExpenseReport batch. If not specified, an expense report number will be generated.

ExpenseDocumentNumber

string

yes


Applies to ExpenseReport, VendorInvoice and SoftCosts batch. If not specified, a document number will be generated.

ResourceReferenceSystemId

string

yes


Applies to ExpenseReport batch action only. The employee ID of the resource that the expense report is connected to.

CostCenterName

string

yes*


Applies to SoftCosts batch action only. The name of cost center to import soft cost batch for. Specify cost center name or cost center number, but not both.

CostCenterNumber

string

yes*


Applies to SoftCosts batch action only. The number of cost center to import soft cost batch for. Specify cost center name or cost center number, but not both.

ExpenseReportName

string

no


Applies to ExpenseReport batch actions only.

ExpenseDocumentName

string

yes


Applies to ExpenseReport, VendorInvoice and SoftCosts batch actions.

CashAdvanceReturnAmount

float

no


Applies to ExpenseReport batch action only. The cash advance amount for the expense report.

DisbursedCurrencyCode

string



Applies to ExpenseReport batch action only. The disbursed currency code.

MileageUom

string

yes


Applies to ExpenseReport batch action only. Mileage unit of measure. "M"=miles. "K"=kilometers.

Status

string

no

S

Applies to ExpenseReport, VendorInvoice and SoftCosts batch actions only.

"D"=draft
"S"=submitted
"A"=approved

OverrideRulesFlag

boolean

no

false

Applies to Import batch action only. When true, causes the procedure to ignore violations of project status, date range, resource status, booked resources only, and narrative required rules.

PayeeVendorName

string

yes


Applies to VendorInvoice batch action only. The name of the vendor connected to the vendor invoice.

VendorInvoiceDate

date

yes


Applies to VendorInvoice batch action only. The vendor invoice date.

ReferenceNumber

string

no


Applies to VendorInvoice batch action only. The vendor invoice reference number.

ReportOnlyFlag

booleannofalseIf 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

stringno
The group of cost cards associated with this externalgroupindentifier will be purged.

PurgeUidList

stringno
Comma separated list of cost cards that are to be purged.
ClientAndRevenueAmountsCurrencyTypeCodeStringno

The client amount and revenue amount currency code used.

"D" = disbursed currency code

"E" = engagement currency code

PurgeProjectCodestringno
The code for the project whose cost cards are to be purged.

...