Jump to Content
Support
API
API
Support
Log In
API
API
Support
Log In
API
/accounts/icm-tokens/{token}
Search
JUMP TO
Topics
Introduction
Getting Started
Contractors API
IcmUser
/icm/user/{id}
get
/icm/user/{id}/merge/{destination_id}
put
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
MasterSub
/mastersub
get
/mastersub/{contractor_id}
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
delete
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
delete
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
delete
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
delete
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}
delete
/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}
delete
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
/accounts/icm-tokens/{token}
get
/accounts/icm-tokens/{token}
delete
/accounts/{account_id}/insurance-policies
post
/accounts
post
Settings
/clients/{client_id}
get
Contracts
/clients/{client_id}/contracts/subcontractors
get
/clients/{client_id}/contracts/{id}
put
/clients/{client_id}/contracts/{id}/sync
get
/clients/{client_id}/contracts
post
/clients/{client_id}/contracts
get
Updates a contractors external_id.
put
/accounts/{account_id}/contracts
get
/clients/{client_id}/contractors/{contractor_id}/contracts
get
/contracts/account-merge
put
/clients/{client_id}/contracts/sync
get
/contracts/{contract_id}/activations
put
/contractors/{contractor_id}/contracts
get
Get a contract by ID
get
Removes a contract
delete
Profile
/accounts/{account_id}/profile
put
/accounts/{account_id}/profile
get
Subcontractors
List of subcontractors by contractor account
get
List of subcontractors by contractor
get
Contractors
/clients/{client_id}/contractors
get
/clients/{client_id}/contractors/{contractor_id}/sync-contract
get
/merge
get
/contractors/{contractor_id}/sync
get
EnrollmentVideo
/enrollments/{enrollment_id}/videos/{video_id}
put
/enrollments/{enrollment_id}/videos
get
WorkflowVideo
/workflows/{workflow_id}/components/{configuration_id}/videos
post
/workflows/{workflow_id}/components/{configuration_id}/videos
get
/workflows/{workflow_id}/components/{configuration_id}/videos/{video_id}
get
/workflows/{workflow_id}/components/{configuration_id}/videos/{video_id}
delete
Configuration
/integrations/systems/{system_id}/configurations/{configuration_id}/extra_configuration
put
Creates a client configuration.
post
Retrieves a client configuration.
get
Updates a client configuration.
put
Documents
List of documents by contractor and client
get
/documents/{id}
get
Negotiations
/clients/{client_id}/negotiable-enrollments
get
/enrollments/{enrollment_id}/negotiations
get
CumulioDashboard
Returns necessary data to integrate dashboards in the UI
post
Adds cumul.io dashboard to integration
post
System
/integrations/systems
post
Retrieves all available integration systems and the configurations for the given icm_client_id.
get
Invitations
/invitations/{invitation_id}
put
/clients/{client_id}/invitations
post
List of invitations for a master contractor
get
SystemStatuses
/system_statuses
get
/system_statuses/{id}
put
Jobvite
/clients/{client_id}/jobvite/workflows
get
/clients/{client_id}/jobvite/events
post
/clients/{client_id}/jobvite/dispositions
get
Optimus
Retrieves an Optimus token assigned to a contractor.
get
Enrollments
Active master contracts by enrollment ids
post
List of invitations from enrollment ID's
post
Get an invitation with the users account id
get
/enrollments
post
/enrollments
get
Updates a contracts external_id.
put
/enrollments/{enrollment_id}
get
Get the contract associated with an enrollment
get
Tenstreet
/clients/{client_id}/tenstreet/send-docs
post
/clients/{client_id}/tenstreet/events
post
Videos
/clients/{client_id}/enrollments/videos
get
WorkflowContracts
/workflows/packages/{package_id}/contracts
put
/workflows/packages/{package_id}/contracts/count
get
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
/accounts/icm-tokens/{token}
get
https://localhost:4000/accounts/icm-tokens/
{token}
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
