Cancel an assignment | 1099Policy API documentation

Cancel an assignment Run in API Explorer

POST /api/v1/assignments/cancel

Cancels an existing assignment based on the provided job ID. If you attempt to cancel an assignment after it has started, the request will fail.

application/json

Body

job_id string Required

The ID of the job associated with the assignment
reason string

Optional reason for cancellation

Responses

200 application/json

Assignment successfully cancelled
Hide response attributes Show response attributes object
- bind
  
  Indicates whether to start the process of binding coverage, which includes notifying and subsequently charging the independent contractor for the premium amount due. Defaults to true. When false, 1099Policy does not notify or schedule a charge. Note that the independent contractor will not be issued coverage if bind is set to false.
  
  Default value is true.
- certificates object
  
  URLs to the certificates of insurance for each of the types of coverage issued to the contractor for the specific job assignment.
  
  Additional properties are allowed.
  
  Hide certificates attributes Show certificates attributes object
  
  gl_coi_pdf_url string
  
  The general liability certificate of insurance PDF URL.
  
  wc_coi_pdf_url string
  
  The workers compensation certificate of insurance PDF URL.
- contractor string
  
  ID of the contractor.
- coverage_type array[string]
  
  An array of coverage types that can include one or more of the following insurance coverage values: general, professional and workers-comp. If provided, coverage type is factored into the eligibility determination (i.e., does contractor have an active workers-comp policy, etc). Defaults to the coverage types of the most recent active policy if coverage_type is not provided.
  
  Values are general, professional, or workers-comp.
- created integer(int64)
  
  Time at which the object was created. Measured in seconds since the Unix epoch.
- effective_date integer(int64)
  
  The job assignment start date, measured in seconds since the Unix epoch.
- eligible object
  
  Object with the result of the insurance eligiblity check for a given job assignment.
  
  Additional properties are allowed.
  
  Hide eligible attributes Show eligible attributes object
  
  message string
  
  A message with more detail related to the eligibility result.
  
  result boolean
  
  The result of the insurance eligibility check.
- end_date integer(int64)
  
  The projected job assignment end date, measured in seconds since the Unix epoch.
- id string
- job string
  
  ID of the job that the contractor intends to accept.
- net_rate integer
  
  The amount of money the 1099 contractor pays in premium per every $100 earned.
  
  A positive integer representing the premium owed per $100 earned. The net_rate is stored in cents (e.g., 48 represents $0.48).
- policy string
  
  ID of the policy that you want attached to the assignment. Defaults to the most recent active policy with a matching job category code, work state and contractor home state.
400

Invalid request or assignment cannot be cancelled
404

No assignment found for the associated job id.

POST /api/v1/assignments/cancel

curl \
 --request POST https://api.1099policy.com/api/v1/assignments/cancel \
 --header "Content-Type: application/json" \
 --data '{"job_id":"jb_123abc","reason":"client_request"}'

Request example

{
  "job_id": "jb_123abc",
  "reason": "client_request"
}

Response examples (200)

{
  "id": "an_5HviNgc2Br",
  "job": "jb_jsb9KEcTpc",
  "policy": "pl_WzFRszJhoY",
  "eligible": {
    "result": true,
    "message": "Contractor is pre-approved for insurance coverage."
  },
  "end_date": 1678334737,
  "net_rate": 65,
  "cancelled": true,
  "contractor": "cn_Ehb3bYa",
  "certificates": null,
  "coverage_type": [
    "general",
    "workers-comp"
  ],
  "effective_date": 1646818364,
  "cancellation_date": 1678334737,
  "cancellation_reason": "client_request"
}