1099Policy API documentation

Sep 10, 2024

Version 1.11.1

Change #95d1a86c

Breaking Changes

Update PUT documentation

12 structure changes including:

Modified

  1. PUT /api/v1/assignments/{assignment_id}

    • Body
      • application/json content type
      • bind property
        • Full types is now boolean
    • Removed properties
      • certificates, created, eligible, id
      • Removing a resource is always breaking unless it was deprecated before
    • Path
      • assignment path parameter added

  2. PUT /api/v1/contractors/{contractor_id}

    • Body
      • application/json content type
      • company_name, middle_name properties
        • Full types went from string | null to string
      • withhold_premium property
        • Full types is now boolean
    • Removed properties
      • created, id
      • Removing a resource is always breaking unless it was deprecated before
    • Path
      • contractor path parameter added

  3. PUT /api/v1/entities/{entity_id}

    • Body
      • application/json content type
      • required_coverage property
        • Full types went from array[string] to array
    • Removed properties
      • created, id
      • Removing a resource is always breaking unless it was deprecated before
    • Path
      • entity path parameter added

  4. PUT /api/v1/invoices/{invoice_id}

    • Body
      • application/json content type
      • Invoice property removed
    • Path
      • invoice path parameter added

  5. PUT /api/v1/jobs/{job_id}

    • Body
      • application/json content type
      • wage_type property
        • Full types is now string
      • category_code, created, id properties removed
      • Removing a resource is always breaking unless it was deprecated before
    • Path
      • job path parameter added

  6. PUT /api/v1/policies/{policy_id}

    • Body
      • application/json content type
      • certificates, created, effective_date, expiration_date, id, quote properties removed
      • Removing a resource is always breaking unless it was deprecated before
      • is_active property added
    • Path
      • policy path parameter added

  7. PUT /api/v1/quotes/{quote_id}

    • Body
      • application/json content type
      • coverage_type property
        • Full types went from object to array[string]
      • Removed properties
        • coverage_type
        • Removing a resource is always breaking unless it was deprecated before
      • effective_date, end_date properties modified
        • Full types went from string(int64) to integer(int64)
      • Removed properties
        • created, id
        • Removing a resource is always breaking unless it was deprecated before
    • Path
      • quote path parameter added

  8. PUT /api/v1/webhook_endpoints/{webhook_endpoint_id}

    • Body
      • application/json content type
      • Removed properties
        • created, id, secret
        • Removing a resource is always breaking unless it was deprecated before
    • Path
      • webhook_endpoint path parameter added

Added