ExportCostCards
- Thomas Sherman (Deactivated)
- Bettina Borces
Rate Limiting
In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.
Request
The service request contains:
Name | Data Type | Required? | Default Value | Discussion |
|---|---|---|---|---|
MinIncurredDate | date | no | Export is limited to cards no earlier than this date. | |
MaxIncurredDate | date | no | Export is limited to cards no later than this date. | |
ApprovedMinTimestamp | dateTime | no | Export is limited to cards approved on or after this time. To avoid skipping or duplicating cards set this to the last ApprovedTimestamp from the previous result set. | |
ApprovedIdsAfter | int | no | 0 | Export is limited to cards with a ReferenceSystemId greater than this. Note that Projector assigns a ReferenceSystemId that is greater than any previously assigned value. To avoid skipping or duplicating cards set this to the last ReferenceSystemId from the previous result set. |
MaxRowsToReturn | int | no | 1000 | The maximum number of cards to be exported. Values greater than 1000 may fail due to system-enforced transaction time limits. |
CurrencyCode | string | no | If the currency is not specified, then monetary amounts are returned in the engagement currency. | |
IncludeBillableOnly | boolean | no | false | If true, include billable cost cards only. |
OnlyCountRows | boolean | no | false | If true, then only the RowCount is returned. |
Response
For each card in the result set the following data is returned:
Name | Data Type | Discussion |
|---|---|---|
ApprovedTimestamp | dateTime | Time at which the card was approved. |
ReferenceSystemId | int | Unique integer identifying the card. |
ProjectCode | string | Unique code identifying the project |
ExpenseReportNumber | string | Identifies the expense report that the card is assigned to. Null if the cost card is not associated with an expense report. |
ExpenseReportName | string | Description attached to the cost card |
ResourceReferenceSystemId | string | Unique code identifying the resource. |
IncurredDate | date | Date for which the cost was reported. |
CostCodeName | string | Name of the expense type for the cost card |
Description | string | Description of the cost |
DisbursedAmount | double | In the currency indicated by CurrencyCode |
ClientAmount | double | In the currency indicated by CurrencyCode |
RevenueAmount | double | In the currency indicated by CurrencyCode |
ExpenseAmount | double | In the currency indicated by CurrencyCode |
CurrencyCode | string | Currency of the reported monetary amounts. This is either the engagement currency (if no currency is specified in the request) or the specified currency. |
DisbursedAmountDisbursedCurrency | double | Disbursed amount in the disbursing currency |
VATAmountDisbursedCurrency | double | VAT amount in the disbursing currency |
TotalAmountDisbursedCurrency | double | Total amount (DisbursedAmountDisbursedCurrency + VATAmountDisbursedCurrency)in the disbursing currency |
DisbursedCurrencyCode | string | Disbursing currency code |
LocationName | string | Location name |
CostCardUnits | double | Units (for mileage and unit driven costs) |
NonBillableFlag | boolean | True if cost card has been marked non-billable |
CostCardUid | int | Unique identifier for cost card |
ResourceDisplayName | string | Resource display name |
PayeeVendorNumber | string | Payee vendor number |
PayeeVendorName | string | Payee vendor name |
ExpenseDocumentuid | int | Unique identifier for expense document containing cost card |
VendorUid | int | Unique identifier for payee vendor |
CostCenteruid | int | Unique identifier for expense document's disbursing cost center |