Jump to Content
Guides
API Reference
Changelog
Discussions
v1
v2
v3
v4
v5
v6
v326
API Reference
Log In
Jump to Content
v1
Guides
API Reference
Changelog
Discussions
Markdown Page
Log In
JUMP TO
My Requests
Money Movement APIs
Linked Bank Accounts
List User Linked Bank Accounts
get
Link Bank Account
post
Retrieve Linked Bank Account
get
Update Linked Bank Account
patch
Delete Linked Bank Account
del
Virtual Bank Accounts
Retrieve Account Virtual Bank Account
get
Deposits
List Account Deposits
get
List User Deposits
get
List User Recurring Deposits
get
Create Deposit
post
List Deposits
get
Retrieve Deposit
get
Update Deposit ACH Settlement
patch
Retrieve Recurring Deposits
get
Update Recurring Deposit
patch
Delete Recurring Deposit
del
Withdrawals
List Account Withdrawals
get
List User Withdrawals
get
Create Withdrawal
post
List Withdrawals
get
Retrieve Withdrawal
get
Asset Transfer
Create ACATS Transfer
post
Update ACAT Transfer
patch
Create Minor Graduation Transfer
post
Retrieve Transfer
get
List Transfers
get
Create Internal Asset Transfer
post
Settlements
Retrieve Settlements
get
Retrieve Settlement
get
Update Settlement
patch
Attest Settlement
patch
List Cashless Reconciliations
get
Retrieve Cashless Reconciliation
get
Update Cashless Reconciliation
patch
Attest Cashless Reconciliation
patch
Create DVP RVP Report
post
List DVP RVP Reports
get
Retrieve DVP RVP
get
Subscriptions
Create Subscription
post
List Subscriptions by User
get
Delete Subscription
del
Common Slug
Markdown Page
Polymorphism support
/anything/one-of-object
oneOf object
post
HeavyJob
AccessGroup
Returns access groups
get
Returns access groups
post
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
AccountingTemplate
Returns a list of accounting templates.
get
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
Creates or updates a bulk list of advanced budgets.
patch
Attachment
Gets attachments (Photos and Documents) for jobs.
post
Associates an uploaded 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
Bulk update cost codes costs by creating adjustments (up to 1000)
patch
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
Creates or updates cost codes.
patch
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
Creates multiple cost codes.
post
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
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
Hours
Returns employee time card hours
post
Returns equipment time card hours
post
HourTag
Returns employee attendance hour tags
get
Returns equipment non-use hour tags
get
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
Insert or update material, subcontract, or custom cost type items
patch
Add new MSE transactions. At most 50 transactions per api call can be processed.
put
Update existing MSE transactions. All transactions with the same transaction Id will be updated with the provided info.
patch
Searches material, subcontract, and custom cost-type item transactions.
post
PayClass
Returns pay classes in a business unit
get
Updates a pay class in a business unit
patch
Creates a new pay class.
post
Returns a list of pay classes.
get
Updates an existing pay class by its id.
put
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 on the latest revision for a given job, foreman, date range, and other optional parameters.
get
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
Creates or updates a bulk list of purchase orders.
patch
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
Creates or updates a bulk list of purchase order details.
patch
QuantityAdjustment
Creates a new quantity adjustment for a job. This endpoint only supports web-only companies.
post
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
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
TMEquipmentRate
Updates time & materials equipment rates
patch
TMPayClassRate
Updates time & materials pay class rates
patch
TransactionTag
Get transaction tags
post
Get job transaction tags
post
Update transaction tags
patch
Update transaction tag groups
patch
Update job transaction tags
patch
Update job 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
Creates or updates a bulk list of vendor contracts.
patch
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
Creates or updates a bulk list of vendor contract details.
patch
Powered by
Markdown Page
Content
Updated 7 days ago
Common Slug
/anything/one-of-object
Did this page help you?
Yes
No
Updated 7 days ago
Common Slug
/anything/one-of-object
Did this page help you?
Yes
No
