Estimated Costs
GET
/api/v1/tickets/estimatedCosts/externalTechExpressReturns estimated costs for a ticket based on service type, account, and dispatch schedule.
Auth Scope
urn:grt:techexpressContent-Type
application/jsonRate Limit
60 req/min
Headers
| Header | Value |
|---|---|
Authorization | Bearer access-token |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
service_type | string | Yes | The type of service being requested for the ticket. Must be one of the predefined service types from the List of Service Options |
dispatch_start | datetime | Yes | The scheduled start date and time for the service at this location. Should be in ISO 8601 format (YYYY-MM-DDTHH:MM:SS) |
dispatch_end | datetime | Yes | The scheduled end date and time for the service at this location. Validation: Must occur after dispatch_start and on the same calendar day as dispatch_start. Note: if hard start is required, dispatch_end should be the same as dispatch_start. Should be in ISO 8601 format (YYYY-MM-DDTHH:MM:SS) |
account_id | integer | Yes | A unique numerical identifier for the associated account |
granted_tenant_macnum | string | No | The company macnum on whose behalf the action is performed |
Response
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
dispatch_fee_dollars | float | The specific fee charged for dispatch services |
hours | integer | The total number of hours incurred or estimated for the service or task |
misc_fee_dollars | float | Any additional, miscellaneous fees applied |
rate_per_hour | float | The hourly rate charged for the service |
total | float | The grand total cost, which is typically the sum of all applicable fees and hourly charges |
Code Examples
Errors
| HTTP Status | Error Description | Resolution |
|---|---|---|
400 | Bad Request | Review the error response body for specific validation errors. Common issues: missing required parameters, invalid service_type (must be from the List of Service Options), invalid date format, or dispatch_end not occurring after dispatch_start or on the same calendar day. |
401 | Authentication Failed | Verify your access token is valid and included in the Authorization header with the "Bearer " prefix. |
403 | Permission Denied | Your access token does not have the required scope (urn:grt:techexpress). Contact your administrator to request the appropriate permissions. |
Last updated on