This article lists the ToolWatch API request for job cost and billing with rates: Export. Every request needs an authorization token. To get one, see ToolWatch API: Authorization.
Export
Request
URI
https://api.{cluster}.toolwatch.net/billingwithrates/exportAllowable querystring parameters
Parameter | Description |
postedfrom | Only include entries posted on or after this date (mm/dd/yyyy). |
postedto | Only include entries posted on or before this date (mm/dd/yyyy). |
costcenters | Comma-separated list of cost center ids (guid) to filter by. |
columns | Comma-separated list of properties to return. |
Http Method
GET
Headers
Authorization: {token}
Request Body
Not allowed for GET
Response
200 Ok
Every field listed in the data dictionary is returned. Use the columns querystring parameter to limit the response to specific properties.
Response body:
{
"EntryNumber": "1",
"UniqueIdentifier": "e9777382-acaf-4428-a5ac-71d47f12c70c",
"TodaysDate": "6/1/2022",
"AmountEach": "19107.264",
"BillingEntryType": "T",
"BillingRate": "Weekly",
"CostCenterNumber": "08251",
"ChargeAmount": "19107.264",
"CreditAmount": "-19107.264",
"Empty": "",
"HourlyRate": "5.4282",
"DailyRate": "43.4256",
"WeeklyRate": "217.1280",
"MonthlyRate": "868.512",
"HourlyRatePercent": "302.50 %",
"DailyTotal": "347.4048",
"WeeklyTotal": "8685.12",
"MonthlyTotal": "138961.92",
"PostingNumber": "1"
}Data Dictionary
Field | Type | Description |
EntryNumber | integer | Sequential row identifier assigned during export. |
UniqueIdentifier | guid | Unique identifier for billing entry |
TodaysDate | date | Date export was created. |
AmountEach | decimal | From the billingentries.chargeeach field |
Assignment | string | Who received the transfer |
BillingEntryType | string | (M)aterials or (T)ools |
BillingEntryDescription | string | Item Description |
BillingRate | string | Hourly | Daily | Weekly | Monthly |
RateHour | decimal | Hourly Billing Rate |
RateDay | decimal | Daily billing rate |
RateWeek | decimal | Weekly billing rate |
RateMonth | decimal | Monthly billing rate |
CalculatedDate | date | Date total was calculated |
CalculatedTime | string | Time total was calculated |
CostCenterId | guid | Cost Center Id |
CostCenterNumber | string | Cost Center Number |
CostCenterDescription | string | Cost Center Description |
CostCenterExtraNumber | string | Cost Center Extra Number |
CostCodeNumber | string | Cost Code Number |
CostCodeDescription | string | Cost Code Description |
ChargeType | string | From billing entry type |
ChargeAmount | decimal | Charge Each * Quantity |
CreditAmount | decimal | Charge Each * Quantity * -1 |
CalculationMethod | string | Assignment, Calendar (Days | Weeks | Months), Hourly |
ChargeAccountNumber | string | GL Number for you accounting system. |
CreditAccountNumber | string | GL Number for accounting system. |
CutoffDate | date | Cut-off Date |
DateFrom | date | Date assignment began |
DateTo | date | Date assignment ended |
ItemQuantity | integer | Quantity |
ItemType | string | Unique (T)ool | (Q)uantity Tool | (M)aterials | (K)it |
ItemNumber | string | Item Number |
ItemDescription | string | Item Description |
ItemUnitofMeasure | string | Unit of Measure defined by organization |
ItemBaseCost | decimal | Base cost of item |
ModelId | guid | Model Id |
ModelNumber | string | Model Number |
InventoryTransactionType | string | Same as Transaction Type |
NumberofDays | decimal | Number of billable days |
NumberofWeeks | decimal | Number of billable weeks |
NumberofMonths | decimal | Number of billable months |
NumberofHours | decimal | Number of billable hours |
RateSheetType | string | Tools & Equipment | Materials & Consumables | Labor |
RateSheetEntryType | string | 0 - Job Cost | 1 - Billing |
TransferNumber | string | Identifier of transfer |
TransactionType | integer | 1 through 12. See Descriptions |
TransactionTypeDesc | string | Transfer | Inventory Adjustment | Initial Fill | Receiving Ticket | Retirement | Reinstatement | Item Deleted | Work Order Park | To-From Kit | Restack | Unstock | Count |
TransferDate | date | Date of transfer |
TransferTime | string | Time of transfer |
TotalPotentialHours | decimal | Maximum hours between the starting and ending transaction. |
TotalHours | decimal | Total billable hours |
TotalNumberofUnits | integer | Total Number of Units |
PostedDate | date | Date posted |
PostedTime | string | Time posted |
PostingEmployeeNumber | string | Identifier of employee initiating posting |
PostingEmployeeName | string | Name of employee initiating posting |
PostingNumber | integer | Posting Number |
Message | string | Message |
Empty | string | Empty field |
InitialCharge | decimal | Initial Charge |
RateMinCharge | decimal | Min. Charge |
MaxCharge | decimal | Max Charge |
LossCharge | decimal | Loss Charge |
HourlyRate | decimal | Hourly Usage Rate |
DailyRate | decimal | Effective Daily Rate Per Hour |
WeeklyRate | decimal | Effective Weekly Rate Per Hour |
MonthlyRate | decimal | Effective Monthly Rate Per Hour |
IdleRate | decimal | Idle Rate Per Hour |
MaintenanceRatePromoteAt | decimal | Maintenance Rate Promote At |
MaintenanceRate | decimal | Maint. Rate |
MinCharge | decimal | Min. Charge |
ReturnCharge | decimal | Return Credit |
HourlyRatePercent | decimal | Hourly Usage Rate Percent |
DailyRatePercent | decimal | Effective Daily Rate Per Hour Percent |
WeeklyRatePercent | decimal | Effective Weekly Rate Per Hour Percent |
MonthlyRatePercent | decimal | Effective Monthly Rate Per Hour Percent |
IdleRatePercent | decimal | Idle Rate Percent |
MaintenanceRatePromoteAtPercent | decimal | Maintenance Rate Promote At Percentage |
MaintenanceRatePercent | decimal | Maint. Rate Percent |
InitialChargePercent | decimal | Initial Charge Percent |
MinChargePercent | decimal | Min. Charge Percent |
MaxChargePercent | decimal | Max Charge Percent |
LossChargePercent | decimal | Loss Charge Percent |
ReturnChargePercent | decimal | Return Credit Percent |
RateEntryType | integer | Rate Entry Type |
BaseCost | decimal | Base Value |
DoNotBill | boolean | Do Not Bill |
MaxChargeEnabled | boolean | Use Max Item Charge |
MaxChargeEnabledAtJob | boolean | Use Max Job Charge |
MaxPeriodEnabled | boolean | Use Max Period Charge |
IdleRateEnabled | boolean | Use Idle Rate |
RateChargeAccountNo | string | Charge Account No |
RateCreditAccountNo | string | Credit Account No |
MaintenanceRateEnabled | boolean | Use Maint. Rate Item Charge |
MaintenanceRateEnabledAtJob | boolean | Use Maint. Rate Job Charge |
DailyTotal | decimal | Daily Total |
WeeklyTotal | decimal | Weekly Total |
MonthlyTotal | decimal | Monthly Total |