Skip to main content

ToolWatch API: Job Cost & Billing

ToolWatch API request to export job cost and billing entries, with URIs, filters, an example response, and the data dictionary.

This article lists the ToolWatch API request for job cost and billing: Export. Every request needs an authorization token. To get one, see ToolWatch API: Authorization.

Export

Request

URI

https://api.{cluster}.toolwatch.net/billing/export

Allowable 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": "033ab474-8512-4b79-933c-0a5888e3df73",
"TodaysDate": "2/9/2011",
"AmountEach": "8421.168",
"Assignment": "Main Warehouse",
"BillingEntryType": "T",
"BillingEntryDescription": "TC Desc-999",
"BillingRate": "Monthly",
"CostCenterNumber": "1002010",
"CostCenterDescription": "Denver Branch Cost Center",
"ItemType": "T",
"ItemNumber": "14",
"ChargeAmount": "8421.168",
"CreditAmount": "-8421.168",
"PostedDate": "7/21/2010",
"PostingNumber": "1",
"Empty": ""
}

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 | (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

Did this answer your question?