Jump to Content

API Support Log In

API

API Support Log In

Topics

Introduction
Getting Started

Contractors API

IcmUser
- /icm/user/{id}get
- /icm/user/{id}/merge/{destination_id}put
Contractors
MasterSub
- /mastersubget
- /mastersub/{contractor_id}get

Settlements API

Introduction
Partner API
Commissions
CommissionTypes
- Request a specific CommissionType by Idget
- Request a List of CommissionTypesget
ContractorDeductions
- Create a Contractor Deductionpost
- Delete a Contractor Deductiondelete
Deductions
DeductionTypes
- Request a specific DeductionType by Idget
- Request a List of DeductionTypesget
Disbursements
- Return a list of disbursements for a contractor.get
LegacySettlements
Reconciliations
- Request Settlement Reconciliation Data Containing Settlements, Commissions, & Deductions.get
Settlements
VendorDeductions

Integrations API

WorkflowVideo
- /workflows/{workflow_id}/components/{configuration_id}/videosget
WorkflowContracts
- /workflows/packages/{package_id}/contracts/countget
Configuration
System
- /integrations/systemspost
- Retrieves all available integration systems and the configurations for the given icm_client_id.get
Optimus
- Retrieves an Optimus token assigned to a contractor.get
EnrollmentVideo
- /enrollments/{enrollment_id}/videosget
Negotiations
- /clients/{client_id}/negotiable-enrollmentsget
- /enrollments/{enrollment_id}/negotiationsget
Enrollments
CumulioDashboard
- Returns necessary data to integrate dashboards in the UIpost
Contracts
Contractors
- /contractors/{contractor_id}/syncget
Subcontractors
- List of subcontractors by contractor accountget
- List of subcontractors by contractorget
Invitations
- /clients/{client_id}/invitationspost
- List of invitations for a master contractorget
Videos
- /clients/{client_id}/enrollments/videosget
Documents
- List of documents by contractor and clientget
Profile
- /accounts/{account_id}/profileput
- /accounts/{account_id}/profileget
Account
- /accounts/icm-tokens/{token}get
- /accountspost

Insurance

Claim Pending Election
- Claims a pending electionpost
Create Insured
- Create a new Insured recordpost
Get Insured
- Get a Insured recordget
Insurance Quote
- Get an insurance quoteget

Webhooks

How-to Configure a Webhook
Contractor Contracted
Profile Updated
Document Created
Document Updated
Settlement Status Change

Powered by

Request the Deductions for a specific Settlement

get https://api.oforce.com/settlements/{settlementId}/deductions

Language

Click Try It! to start a request and see the response here!