Jump to Content
Home
Guides
API Reference
Changelog
Contact Us
API Reference
Home
Guides
API Reference
Changelog
Contact Us
Get transaction tags
All
Pages
Start typing to search…
JUMP TO
Identity
Token
Get an auth token from identity server.
post
Authorize
Get an authorization code from identity server.
get
Attachments
Files
Returns metadata for a file.
get
Creates a new file.
post
Contacts
ContactProducts
Deletes an existing product that is associated with a contact, scoped by the company/business unit of the current user
del
Returns a list of all products associated with a contact, scoped by the company/business unit of the current user
get
Creates a new product to be associated with a contact, scoped by the company/business unit of the current user
post
Contacts
Deletes an existing contact, scoped by the company/business unit of the current user
del
Returns a contact with the provided id, scoped by the company/business unit of the current user
get
Updates a contact, scoped by the company/business unit of the current user
put
Returns a list of all contacts that are associated with a vendor, scoped by the company/business unit of the current user
get
Creates a new contact for a vendor, scoped by the company/business unit of the current user
post
Offices
Deletes an existing office, scoped by the company/business unit of the current user
del
Returns an office with the provided id, scoped by the company/business unit of the current user
get
Updates an existing office, scoped by the company/business unit of the current user
put
Returns a list of all offices of a vendor, scoped by the company/business unit of the current user
get
Creates a new office, scoped by the company/business unit of the current user
post
ProductTypes
Deletes an existing product type, scoped by the company/business unit of the current user
del
Returns a product type by id, scoped by the company/business unit of the current user
get
Updates an existing product type, scoped by the company/business unit of the current user
put
Creates a new product type, scoped by the company/business unit of the current user
post
Vendors
Deletes an existing vendor by id, scoped by the company/business unit of the current user
del
Returns a vendor with the provided id, scoped by the company/business unit of the current user
get
Updates an existing vendor by id, scoped by the company/business unit of the current user
put
Deletes an existing product, scoped by the company/business unit of the current user
del
Returns a list of all vendors, scoped by the company/business unit of the current user
get
Creates a new vendor, scoped by the company/business unit of the current user
post
Returns a list of all products of a vendor, scoped by the company/business unit of the current user
get
Creates a new product for a vendor, scoped by the company/business unit of the current user
post
Products
Returns a list of all products, scoped to the company/business unit of the current user
get
Returns a list of all contacts associated with a product type, scoped to the company/business unit of the current user
get
Returns a list of all vendors associated with a product type, scoped to the company/business unit of the current user
get
Equipment360
BusinessUnit
Returns a list of all business units.
get
Cost
Get total fuel cost for all jobs.
get
Gets work order costs for all jobs.
get
Gets work order costs with extended details.
get
CustomField
Returns a list of all custom fields and their details.
get
Create a new custom field.
post
CustomFieldCategories
Returns a list of all custom field categories and their details.
get
CustomFieldList
Returns all options for List type custom field categories.
get
Employee
Returns all employees.
get
Create a new employee.
post
Returns a single employee record, based on its Id.
get
Updates employee with corresponding id. If fields are left blank, the corresponding employee field will be blanked out.
put
Equipment
Returns all equipment.
get
Create a new equipment record.
post
Returns a single equipment record, based on its Id.
get
Update equipment record, based on its Id.
put
EquipmentTransfer
Transfer ownership of equipment between business units.
post
EquipmentType
Returns a list of all equipment types.
get
Create a new equipment type.
post
Invoice
Gets invoice details.
get
Creates a new invoice.
post
Update invoice status and add details to invoice
put
Job
Returns a list of all jobs.
get
Create a new job.
post
Update an existing job.
put
Location
Returns a list of all locations.
get
Create a new location.
post
Update an existing location.
put
MaintenanceRequest
Gets all maintenance request or filtered by Equipment Code.
get
Creates a new maintenance request.
post
MeterReading
Submits a meter reading for specified equipment.
post
Gets the latest meter reading.
get
Part
Create a new part.
post
Get all parts.
get
Update an existing part.
put
Gets part locations.
get
Create a new part location.
post
PartCostEntry
Creates a new part cost entry.
post
Adds a detail to the part cost entry.
post
PartInventory
Gets inventory for a specific part.
get
Sets on hand quantity for part at part location to specified quantity.
post
Sets the on hand quantity for part at part location to specified quantity. Combination of PartNum and PartLocationCode should be unique. Two or more records that share the same PartNum and PartLocationCode combination will automatically be rejected.
post
PurchaseOrder
Get all purchase orders.
get
Creates a new purchase order.
post
Gets purchase order details by purchase order id.
get
Adds a detail to the purchase order.
post
Creates a new purchase order note.
post
SubletVendorCostEntry
Creates a new sublet vendor cost entry.
post
Adds a detail to the sublet vendor cost entry.
post
Tag
Returns all tags.
get
Creates a Tag.
post
TimeCard
Retrieve timecard information for one or all employees.
get
Retrieve timecard information for one or all employees with enhanced detail data.
get
Performs a bulk update to set timecards as 'Exported'
put
UnitOfMeasure
Get all units of measure.
get
Vendor
Returns all vendors.
get
Create a new vendor.
post
Update an existing vendor.
put
WorkOrder
Returns all work orders.
get
Creates a Work Order.
post
Returns a single work order, based on its Id.
get
Updates a work order by id.
put
Creates a new work order note.
post
WorkOrderPurchase
Gets work order purchases.
get
WorkOrderSchedule
Gets work order schedules.
get
HeavyBid Estimate Insights
Activities
Get All Activities
get
Get an Activity by Id
get
Activity Codebook
Retrieves all activity codebook activities for a business unit.
get
Retrieves a specific activity codebook activity by its id.
get
Activity Codebook Resources
Retrieves all activity codebook resources for a business unit.
get
Retrieves a specific activity codebook resource by its id.
get
Attachments
Get Estimate Attachments
get
Download an Estimate Attachment by Id
get
Biditem Codebook
Retrieves all biditem codebook biditems for a business unit.
get
Retrieves a specific biditem codebook biditem by its id.
get
Biditems
Get All Biditems
get
Get a Biditem by Id
get
Business Units
Get All Business Units
get
Estimates
Get All Estimates
get
Get an Estimate by Id
get
Get Key Indicators for an Estimate
get
Material Codebook
Retrieves all material codebook resources for a business unit.
get
Retrieves a specific material codebook resource by its id.
get
Replace a specific material codebook resource by its id.
put
Materials
Get all Materials for an Estimate of a specific Material Type
get
Partitions
Get All Database Partitions
get
Get a Database Partition by Id
get
Quote Folders
Get all quote folders in an estimate with details.
get
Get detailed quote folder by id
get
Resources
Get All Resources
get
Get a Resource by Id
get
HeavyBid Pre-Construction
BusinessUnit
Get all business units
get
Schemas
Get all schemas for a business unit
get
Get a schema for a business unit by id
get
Update the alias of a field on the schema
post
Get all schemas for a business unit
get
Get a schema for a business unit by id
get
Update the alias of a field on the schema
post
Projects
Gets a list of projects
get
Creates a new project
post
Gets a specific project
get
Replaces the project
put
Applies a partial change to the project
patch
Delete a project by id
del
Creates multiple projects
post
Delete multiple projects by id
del
QuickPriceSheet
Gets a Quick Price Sheet by Project ID
get
Reports
Generates a report for the given project id
post
HeavyJob
AccessGroup
Returns access groups
get
Accounting
Returns a list of accounting values that satisfy the filter criteria.
post
Returns a list of rate set group accounting values that satisfy the filter criteria.
post
AdvancedBudget
Returns material advanced budgets
get
Creates material advanced budget
post
Returns subcontract work item advanced budgets
get
Creates subcontract advanced budget
post
Returns a list of user-defined custom cost-type items advanced budget (i.e., the cartesian product of custom cost types and cost codes).
get
Creates a new custom-cost-type item advanced budget.
post
Attachment
Saves an attachment
post
BulkCreateJobsRequest
Returns bulk job creation requests
post
Returns single job creation requests.
post
BusinessUnit
Returns business units
get
BusinessUnitPreference
Gets the list of preferences for the business unit.
get
Updates preferences for the business unit.
put
ChangeOrder
Finds a change order by id.
get
Deletes a change order by id.
del
Creates a change order.
post
Updates a change order.
patch
Finds all change orders by job id.
get
Finds all change orders by business unit id.
get
Finds all change orders by business unit id that have been updated since a given timestamp.
get
Finds the change order incrementor data by business unit id.
get
Cost
Returns job costs
get
Returns job costs associated with a cost code
get
Returns costs and hours spent per cost code
post
Returns job costs
post
Returns a paginated list of job costs.
post
Returns a paginated list of job cost custom costs.
post
Returns cost code costs
get
Sets costs for the cost code by creating adjustments.
put
CostAdjustment
Returns a list of cost adjustments.
get
Creates cost adjustment
post
Updates an existing cost adjustment by its id.
put
Deletes a cost adjustment by its id.
del
CostCode
Returns cost codes
get
Creates a new cost code with accounting values.
post
Creates or updates cost codes (up to 10000)
patch
Returns cost codes
get
Returns cost codes
post
Returns cost codes
post
Creates or updates budgets for a list of cost code and custom cost type combination
patch
Links or Unlinks Pay Items from a specified Cost Code
patch
CostCodeProgress
Returns a list of quantities for a given date range, job Id and other optional parameters.
post
CostCodeTag
Returns cost code setup tags with their groups
get
Returns a list of cost code - tag relationships.
get
Deletes cost code - tag relationships.
del
Upserts cost code setup tags
patch
Returns cost codes with associated setup tags
post
CostCodeTransaction
Returns a paginated list of cost code time card transactions for the specified business unit or specified job list, or specified foreman list or specified date range.
post
CostCodeTransactionAdjustment
Returns a list of cost code transaction adjustments.
post
CostTypeQuantity
Returns installed material quantities
get
Returns subcontract work performed quantities
get
Returns quantity adjustment changes
get
Update an existing received custom cost type item with the values provided.
patch
CustomCostType
Returns cost categories
get
Creates cost category
post
CustomCostTypeItem
Returns custom cost type items
get
Creates cost type item
post
Updates custom cost type item
put
Deletes a custom cost type item
del
Returns job custom cost type items
get
Creates job custom cost type item
post
Returns a job custom cost type item
get
Updates job custom cost type item
put
Deletes job custom cost type item
del
Returns installed custom cost type items
post
Returns received custom cost type items
post
Diary
Returns a paginated list of diary summaries for a business unit, jobs, or foremen in a date range.
post
Creates or updates a diary record
put
Employee
Returns employees for a business unit
get
Returns employees
post
Call to get Employee details that include physical address, cell phone and other phone.
get
Delete an employee. Employee will be deleted at the company level, and business unit- or job-level relationships will also be deleted.
del
Equipment
Returns a list of equipment for a business unit.
get
Returns a list of equipment.
post
Updates an existing equipment
put
EquipmentType
Returns a list of equipment types.
get
Creates a new equipment type.
post
Returns a list of equipment types.
get
Creates a new equipment type.
post
ExecutedChangeOrder
Finds all executed change orders by business unit id.
get
Forecast
Returns forecast summary information
get
Returns forecast details
get
HourTag
Returns employee attendance hour tags
get
Returns equipment non-use hour tags
get
Hours
Returns employee time card hours
post
Returns equipment time card hours
post
Job
Returns jobs by business unit
get
Upserts multiple jobs
patch
Returns jobs by jobs or job tags
post
JobEmployee
Returns job employees
get
Delete job-employee relationships.
del
Creates and updates job-employee relationships.
patch
JobEquipment
Creates and updates job-equipment relationships.
patch
Returns job equipment
get
Delete job-equipment relationships.
del
JobTag
Returns a list of job tag groups and their corresponding tags
post
Update job tags
patch
Update job tag groups
patch
Material
Returns materials
get
Creates material
post
Updates material
put
Deletes a material
del
Returns job materials
get
Creates job material
post
Returns a job material
get
Updates job material
put
Deletes job material
del
Returns installed materials
post
Returns received materials
post
MaterialSubsAndCustomCosts
Update or add new material, subcontract, or custom cost type items
patch
PayClass
Returns pay classes in a business unit
get
Updates a pay class in a business unit
patch
PayItem
Returns pay items
get
Creates a new pay item.
post
Bulk upsert pay items by code and job id.
patch
Returns pay items
get
Returns pay items across multiple jobs.
post
Get Pay Item by Id
get
Updates all the cost codes on all pay items for a job
get
PayItemTag
Returns pay item setup tags with their groups
get
Returns pay items with associated setup tags
post
Deletes pay item - tag relationships.
del
Upserts pay item setup tags
patch
PayItemTransaction
Returns a list of pay item transactions for a given job, foreman, date range, and other optional parameters.
get
PurchaseOrder
Returns a list of purchase orders.
get
Creates a new purchase order on the specified job.
post
Returns purchase orders
get
Returns purchase order line items
get
Updates a purchase order
put
Returns a list of material purchase order details. This endpoint only supports web-only companies.
get
Creates a material purchase order detail
post
Updates material purchase order detail
put
Returns a list of purchase order details for custom cost types. This endpoint only supports web-only companies.
get
Creates a custom cost type purchase order detail
post
QuantityAdjustment
Creates a new quantity adjustment for a job. This endpoint only supports web-only companies.
post
ReleaseOrderApprovalRule
Deletes release order approval rule approvers
del
RevenueQuantity
Saves true-up revenue quantity adjustments based on the desired quantity.
patch
Subcontract
Returns subcontract items
get
Creates subcontract item
post
Updates subcontract item
put
Deletes a subcontract item
del
Returns job subcontract items
get
Creates job subcontract item
post
Returns a job subcontract item
get
Updates job subcontract item
put
Deletes job subcontract item
del
Returns subcontract transactions
post
TimeCard
Returns time card approvals
get
Returns time cards
get
Returns time cards
post
Returns the time card with the specified id.
get
Updates time card
put
Returns list of foremen with missing time cards for a specified business unit and date who have previously submitted in a specified date range.
get
Returns time card data using a piece of equipment
get
TransactionTag
Get transaction tags
post
Update transaction tags
patch
Update transaction tag groups
patch
User
Returns a user
get
UserAccessGroup
Returns list of users' access groups
post
Updates access group for users
patch
Vendor
Returns vendors
get
Creates a new vendor. Names and descriptions may be duplicated.
post
Returns a list of vendors, respecting the isDeleted and modifiedSince parameters.
get
Updates a vendor
put
Deletes a vendor by its id.
del
VendorContract
Returns vendor contracts
get
Creates a new vendor contract.
post
Returns vendor contracts
get
Updates a vendor contract
put
Returns a list of vendor contract details.
get
Creates a vendor contract detail
post
Returns vendor contract items
get
Updates a vendor contract detail
put
HeavyJob Project Management
DigPermit
Returns dig permits
post
Creates and updates dig permits
post
myField
Timeline
Adds/Updates timeline events for multiple users.
put
Plans
Group
Retrieves a list of user groups in the given business units
post
Project
Retrieves the state plane coordinate zone list
get
Creates an HCSS Plans project
post
Retrieves a list of projects in the given global business unit
post
Assigns groups to projects as either regular users or editor users
post
ProjectGroup
Fetches project groups in a company
post
Safety
AccessGroups
Gets a list of access groups
get
Alerts
Gets a list of alerts
get
Update an alert
put
Create an alert
post
Delete an alert
del
IncidentFormTypes
Gets a list of incident form types
get
Incidents
Gets a single incident case by ID.
get
Updates an existing incident case by ID
put
Gets a list of incident cases.
get
IncidentsV2
Gets a single incident case by ID.
get
Gets list of incidents case.
post
Post request to update an incident and the associated incident forms
post
InspectionTypes
Gets a list of inspection types
get
Jobs
Gets a list of jobs for the specified business unit or all jobs if no business unit is specified.
get
Meetings
Gets a list of recorded meetings
get
Providers
Gets a list of SMS Providers
get
UserAccessGroups
Returns list of users' access groups
post
Updates access group for users
patch
Users
Gets a single user by ID.
get
Setups
AccountingTemplate
Returns a list of accounting templates.
get
BulkCostCode
Creates multiple cost codes.
post
BusinessUnit
Returns a list of all business units.
get
Creates a new business unit.
post
Returns the default business unit.
get
CostCode
Creates a new cost code.
post
Returns a list of cost codes.
get
Creates and updates cost codes.
patch
Updates an existing cost code by its id.
put
Employee
Creates a new employee.
post
Returns a list of employees.
get
Updates an employee by its id.
put
Equipment
Creates a new piece of equipment.
post
Returns a list of equipment.
get
Updates a piece of equipment by its id.
put
Job
Creates a new job.
post
Returns a list of jobs.
get
Updates an existing job by its id.
put
PayClass
Creates a new pay class.
post
Returns a list of pay classes.
get
Updates an existing pay class by its id.
put
RateSet
Returns a single employee rate set.
get
Creates a new employee rate set.
post
Updates an existing employee rate set by its id.
put
Returns a single pay class rate set.
get
Creates a new pay class rate set.
post
Updates an existing pay class rate set by its id.
put
Returns a single equipment rate set.
get
Creates a new equipment rate set.
post
Updates an existing equipment rate set by its id.
put
Returns a single cost adjustment rate set.
get
Creates a new cost adjustment rate set.
post
Updates an existing cost adjustment rate set by its id.
put
RateSetGroup
Returns a list of rate set groups.
get
Creates a new rate set group.
post
Updates an existing rate set group by its id.
put
Skills
EmployeeSkills
Returns all skills that the specified employee has.
get
Returns all employees having the specified skill.
get
Gets the cartesian product of employees and skills.
get
Creates or updates a skill for an existing employee, using the skill's course code or name as a unique identifier.
post
Imports a list of employee skills, using the skill's course code or name as a unique identifier on each employee.
post
Skills
Gets a single skill by course code or by skill name.
get
Updates an existing skill, using the course code or skill name as a unique identifier.
put
Deletes a skill by course code or skill name.
del
Gets a list of skills.
get
Create a new skill, using the course code or skill name as a unique identifier.
post
Imports a list of skills, using the course code or name as a unique identifier for each skill.
post
Telematics
Equipment
Returns a list of equipment.
get
Users
BusinessUnits
Returns all business units in a company
get
Jobs
Returns all jobs in a business unit
get
Roles
Returns all roles in a company
get
SubscriptionGroups
Returns all subscription groups in a company
get
Users
Returns all users in a company with paging
get
Creates a new user
post
Returns user by id
get
Updates a user
patch
Deletes a user with the given id
del
Returns user by username
get
Returns logs of which products users have accessed
post
Webhooks
HeavyBid Pre-Construction
Gets all webhooks
get
Creates a subscription for an event
post
Updates a subscription for an event
put
Delete a subscription
del
HeavyJob
Gets all webhooks
get
Creates a subscription for an event
post
Updates a subscription for an event
put
Delete a subscription
del
Setups
Gets all webhooks
get
Creates a subscription for an event
post
Updates a subscription for an event
put
Delete a subscription
del
Powered by
Get transaction tags
post
https://api.hcssapps.com/heavyjob/api/v1/transactionTags/search
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
Authorization Code
Client Credentials
Client
Scopes
Missing 1 required scope
Log in to use your API keys
Response
Click
Try It!
to start a request and see the response here!