For AI agents: visit https://api-guide.oforce.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Support
API
API
Support
Log In
API
API
Support
Log In
API
Account
Topics
Introduction
Getting Started
Contractors API
IcmUser
/icm/user/{id}
get
/icm/user/{id}/merge/{destination_id}
put
MasterSub
/mastersub
get
/mastersub/{contractor_id}
get
Contractors
/contractors
get
/contractors/byclient
get
/contractors/search
get
/contractors/{contractor_id}
get
/contractors/{contractor_id}
put
/contractors/{contractor_id}/ic_ids
get
/contractors/{contractor_id}/rollup_ids
get
/contractors/{contractor_id}/phones
get
/contractors/{contractor_id}/deposit-options
get
/contractors/{contractor_id}/clients
get
Settlements API
Introduction
Partner API
Businesses Get
get
Business Post
post
Business Get
get
Business Put
put
Deduction Types Get
get
Deduction Types Delete
del
Deduction Types Post
post
Deduction Types Get List
get
Clients Get
get
Client Post
post
Client Get
get
Client Put
put
Commissions Get
get
Commission Post
post
Commission Get
get
Commission Put
put
Commission Types Get List
get
Commission Types Post
post
Commission Types Get
get
Commission Types Delete
del
Contractor Deduction Post
post
Contractors Get
get
Contractors Post
post
Contractors Get
get
Contractors Put
put
Get Contractors Settlements
get
Partners Deduction Post
post
Partners Deductions Get
get
Partners Deduction Get
get
Partners Deduction Put
put
Direct Deposit Get
get
Direct Deposit Put
put
Settlement Post
post
Settlement Get
get
Settlement Put
put
Deduction Get
get
Deduction Put
put
Deductions Get
get
Deduction Post
post
Spreadsheet Get
get
Commissions
Request the Commissions for a specific Settlement
get
Create a Commission
post
Request a specific Commission
get
Update a Commission
put
Cancel a Commission
del
Create a Commission batch.
post
CommissionTypes
Request a specific CommissionType by Id
get
Request a List of CommissionTypes
get
ContractorDeductions
Create a Contractor Deduction
post
Delete a Contractor Deduction
del
Deductions
Request api_client Summarized List of Deductions and Payments by contractorId
get
Request Contractor Deduction
get
Request the Deductions for a specific Settlement
get
Create a Deduction
post
Request a specific Deduction
get
/settlements/{settlementId}/deductions/{deductionId}
put
/settlements/{settlementId}/deductions/{deductionId}
del
/settlements/{settlementId}/deductions/batch
post
DeductionTypes
Request a specific DeductionType by Id
get
Request a List of DeductionTypes
get
Disbursements
Return a list of disbursements for a contractor.
get
LegacySettlements
Request Summary of Legacy Settlement Disbursements by Contractor and by Date
get
Request Legacy Settlement Detail by DisbursementId
get
Request Partner Report by DisbursementId
get
Request Contractor Deduction Types
get
Request Contractor Reserve Balance
get
Request Client Commission Line Items
get
Request Settlement Commission Data
get
Request Client Expense Line Items
get
Request Settlement Deduction Data
get
Reconciliations
Request Settlement Reconciliation Data Containing Settlements, Commissions, & Deductions.
get
Settlements
Request a specific Settlement
get
/settlements/{settlementId}
put
/settlements/{settlementId}
del
Create a Settlement
post
Request a specific Configuration
get
/settlements/{settlementId}/source-uri
put
VendorDeductions
Get All Vendor Deductions For A Contractor
get
Create A Contractor Vendor Deduction
post
Get Vendor Deductions For A Contractor By Id
get
Update A Contractor Vendor Deduction
put
Integrations API
Account
Settings
Enrollments
Active master contracts by enrollment ids
post
/enrollments
get
/enrollments/{enrollment_id}
get
Get the contract associated with an enrollment
get
Profile
Subcontractors
List of subcontractors by contractor
get
Contractors
EnrollmentVideo
WorkflowVideo
Configuration
Contracts
/clients/{client_id}/contracts
get
/contractors/{contractor_id}/contracts
get
Negotiations
CumulioDashboard
Invitations
/clients/{client_id}/invitations
post
System
Documents
List of documents by contractor and client
get
SystemStatuses
Jobvite
Optimus
Tenstreet
Videos
WorkflowContracts
Insurance
Claim Pending Election
Claims a pending election
post
Create Insured
Create a new Insured record
post
Get Insured
Get a Insured record
get
Insurance Quote
Get an insurance quote
get
Webhooks
How-to Configure a Webhook
Contractor Contracted
Profile Updated
Document Created
Document Updated
Settlement Status Change
Powered by
Copy Page
Account
Updated 3 days ago
Update A Contractor Vendor Deduction
Settings
Updated 3 days ago
Update A Contractor Vendor Deduction
Settings
