1099Policy API documentation

Mar 10, 2022

Version

1.5.6

API structure has changed

Change #079d98e0

32 structure changes including:

DELETE /api/v1/contractors/{contractor_id}
- Response
  - 200 response
    - deleted, id, object properties Added
- Body
  - content type Added
DELETE /api/v1/entities/{entity_id}
- Response
  - 200 response
    - deleted, id, object properties Added
- Body
  - content type Added
DELETE /api/v1/invoices/{invoice_id}
- Response
  - 200 response
    - deleted, id, object properties Added
- Body
  - content type Added
DELETE /api/v1/jobs/{job_id}
- Response
  - 200 response
    - deleted, id, object properties Added
- Body
  - content type Added
DELETE /api/v1/policies/{policy_id}
- Response
  - 200 response
    - deleted, id, object properties Added
- Body
  - content type Added
GET /api/v1/apply/sessions
- Response
  - 200 response
    - cancel_url, contractor, created, id, job, success_url properties Added
- Body
  - content type Added
GET /api/v1/apply/sessions/{session_id}
- Response
  - 200 response
    - cancel_url, contractor, created, id, job, success_url properties Added
- Body
  - content type Added
GET /api/v1/contractors
- Response
  - 200 response
    - address, company_name, created, email, first_name, id, last_name, middle_name, phone properties Added
- Body
  - content type Added
GET /api/v1/contractors/{contractor_id}
- Response
  - 200 response
    - address, company_name, created, email, first_name, id, last_name, middle_name, phone properties Added
- Body
  - content type Added
GET /api/v1/entities
- Response
  - 200 response
    - address, coverage_limit, created, id, name, required_coverage properties Added
- Body
  - content type Added
GET /api/v1/entities/{entity_id}
- Response
  - 200 response
    - address, coverage_limit, created, id, name, required_coverage properties Added
- Body
  - content type Added
GET /api/v1/invoices
- Response
  - 200 response
    - contractor, created, gross_pay, id, job, paycycle_enddate, paycycle_startdate, premium_due properties Added
- Body
  - content type Added
GET /api/v1/invoices/{invoice_id}
- Response
  - 200 response
    - contractor, created, gross_pay, id, job, paycycle_enddate, paycycle_startdate, premium_due properties Added
- Body
  - content type Added
GET /api/v1/jobs
- Response
  - 200 response
    - category_code, created, description, entity, id, name, review_status, wage, years_experience properties Added
- Body
  - content type Added
GET /api/v1/jobs/{job_id}
- Response
  - 200 response
    - category_code, created, description, entity, id, name, review_status, wage, years_experience properties Added
- Body
  - content type Added
GET /api/v1/policies
- Response
  - 200 response
    - created, effective_date, expiration_date, id, pdf_url, quote, status properties Added
- Body
  - content type Added
GET /api/v1/policies/{policy_id}
- Response
  - 200 response
    - created, effective_date, expiration_date, id, pdf_url, quote, status properties Added
- Body
  - content type Added
GET /api/v1/quotes
- Response
  - 200 response
    - contractor, coverage_type, created, effective_date, eligible, id, job, net_rate properties Added
- Body
  - content type Added
GET /api/v1/quotes/{quote_id}
- Response
  - 200 response
    - contractor, coverage_type, created, effective_date, eligible, id, job, net_rate properties Added
- Body
  - content type Added
POST /api/v1/apply/sessions
- Response
  - 200 response
    - cancel_url, contractor, created, id, job, success_url properties Added
- Body
  - content type Added
POST /api/v1/contractors
- Response
  - 200 response
    - address, company_name, created, email, first_name, id, last_name, middle_name, phone properties Added
- Body
  - content type Added
POST /api/v1/entities
- Response
  - 200 response
    - address, coverage_limit, created, id, name, required_coverage properties Added
- Body
  - content type Added
POST /api/v1/invoices
- Response
  - 200 response
    - contractor, created, gross_pay, id, job, paycycle_enddate, paycycle_startdate, premium_due properties Added
- Body
  - content type Added
POST /api/v1/jobs
- Response
  - 200 response
    - category_code, created, description, entity, id, name, review_status, wage, years_experience properties Added
- Body
  - content type Added
POST /api/v1/policies
- Response
  - 200 response
    - created, effective_date, expiration_date, id, pdf_url, quote, status properties Added
- Body
  - content type Added
POST /api/v1/quotes
- Response
  - 200 response
    - contractor, coverage_type, created, effective_date, eligible, id, job, net_rate properties Added
- Body
  - content type Added
PUT /api/v1/contractors/{contractor_id}
- Response
  - 200 response
    - address, company_name, created, email, first_name, id, last_name, middle_name, phone properties Added
- Body
  - content type Added
PUT /api/v1/entities/{entity_id}
- Response
  - 200 response
    - address, coverage_limit, created, id, name, required_coverage properties Added
- Body
  - content type Added
PUT /api/v1/invoices/{invoice_id}
- Response
  - 200 response
    - contractor, created, gross_pay, id, job, paycycle_enddate, paycycle_startdate, premium_due properties Added
- Body
  - content type Added
PUT /api/v1/jobs/{job_id}
- Response
  - 200 response
    - category_code, created, description, entity, id, name, review_status, wage, years_experience properties Added
- Body
  - content type Added
PUT /api/v1/policies/{policy_id}
- Response
  - 200 response
    - created, effective_date, expiration_date, id, pdf_url, quote, status properties Added
- Body
  - content type Added
PUT /api/v1/quotes/{quote_id}
- Response
  - 200 response
    - contractor, coverage_type, created, effective_date, eligible, id, job, net_rate properties Added
- Body
  - content type Added