{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Form_1099"
  }
}

{
  "type": "object",
  "required": [
    "name",
    "routing_number",
    "account_number",
    "account_type"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "account_type": {
      "enum": [
        "Checking",
        "Savings"
      ],
      "type": "string"
    },
    "account_number": {
      "type": "string"
    },
    "routing_number": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Contractor-Bank-Account"
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Versionable-Required"
    },
    {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            "Direct Deposit",
            "Check"
          ],
          "type": "string",
          "description": "The payment method type. If type is Direct Deposit, the contractor is required to have a bank account.\nsee [Bank account endpoint](./post-v1-contractors-contractor_uuid-bank_accounts)"
        }
      }
    }
  ]
}

{
  "type": "object",
  "required": [
    "contractor_uuid",
    "date"
  ],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "example": "2020-01-01",
      "description": "The contractor receiving the payment"
    },
    "wage": {
      "type": "number",
      "example": 5000,
      "description": "If the contractor is on a fixed wage, this is the fixed wage payment for the contractor, regardless of hours worked"
    },
    "bonus": {
      "type": "number",
      "example": 500,
      "description": "If the contractor is on an hourly wage, this is the bonus the contractor earned"
    },
    "hours": {
      "type": "number",
      "example": 40,
      "description": "If the contractor is on an hourly wage, this is the number of hours that the contractor worked for the payment"
    },
    "reimbursement": {
      "type": "number",
      "example": 20,
      "description": "Reimbursed wages for the contractor"
    },
    "payment_method": {
      "enum": [
        "Direct Deposit",
        "Check",
        "Historical Payment"
      ],
      "type": "string",
      "default": "Direct Deposit"
    },
    "contractor_uuid": {
      "type": "string",
      "description": "The contractor receiving the payment"
    }
  }
}

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/Contractor-Payment-Summary"
    },
    {
      "$ref": "#/components/schemas/Contractor-Payment-Summary-By-Dates"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "object",
      "properties": {
        "base": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "full_message": {
                "type": "string"
              }
            }
          }
        },
        "check_date": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "full_message": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "x-examples": {
    "example-1": {
      "errors": {
        "base": [
          {
            "type": "Invalid Object",
            "message": "Please enter a contractor payment before continuing.",
            "full_message": "Please enter a contractor payment before continuing."
          }
        ],
        "check_date": [
          {
            "type": "Invalid Object",
            "message": "Please enter a contractor payment before continuing.",
            "full_message": "Please enter a contractor payment before continuing."
          }
        ]
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "contractor_payments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string"
          },
          "wage": {
            "type": "integer"
          },
          "bonus": {
            "type": "integer"
          },
          "hours": {
            "type": "integer"
          },
          "hourly_rate": {
            "type": "integer"
          },
          "reimbursement": {
            "type": "integer"
          },
          "payment_method": {
            "type": "string"
          },
          "contractor_uuid": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-examples": {
    "example-1": {
      "contractor_payments": [
        {
          "wage": 123,
          "bonus": 0,
          "hours": 0,
          "check_date": "2022-09-02",
          "hourly_rate": 0,
          "reimbursement": 0,
          "payment_method": "Check",
          "contractor_uuid": "5376e95b-cca0-482b-bb81-aba5e360eb04"
        },
        {
          "wage": 456,
          "bonus": 0,
          "hours": 0,
          "check_date": "2022-09-02",
          "hourly_rate": 0,
          "reimbursement": 0,
          "payment_method": "Check",
          "contractor_uuid": "0c984dce-de9a-47db-8bfb-5f0c823afe6f"
        }
      ]
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "properties": {
    "expected_debit_date": {
      "type": "string",
      "description": "The calculated debit date. If the payment method is Direct Deposit, the debit date will account for the company's ACH speed. If the payment method is Check, the debit date will be the same as the check date."
    }
  },
  "x-examples": {
    "example-1": {
      "expected_debit_date": "2022-08-16"
    }
  }
}

{
  "type": "object",
  "required": [
    "onboarding_status"
  ],
  "properties": {
    "onboarding_status": {
      "enum": [
        "onboarding_completed"
      ],
      "type": "string",
      "default": "onboarding_completed",
      "description": "The updated onboarding status for the employee"
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Contractor-Body"
    },
    {
      "required": [
        "type",
        "wage_type",
        "start_date"
      ]
    }
  ]
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Contractor"
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Versionable-Required"
    },
    {
      "type": "object",
      "properties": {
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "street_1": {
          "type": "string"
        },
        "street_2": {
          "type": "string"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Versionable-Required"
    },
    {
      "$ref": "#/components/schemas/Contractor-Body"
    }
  ]
}

{
  "type": "string",
  "format": "date-time",
  "readOnly": true,
  "description": "Datetime for when the resource was created."
}

{
  "enum": [
    "text",
    "currency",
    "number",
    "date",
    "radio"
  ],
  "type": "string",
  "x-tags": [
    "Custom Fields"
  ],
  "description": "Input type for the custom field."
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Versionable"
    },
    {
      "type": "object",
      "properties": {
        "uuid": {
          "type": "string",
          "description": "The UUID of the department"
        },
        "title": {
          "type": "string",
          "description": "Name of the department"
        },
        "employees": {
          "type": "array",
          "items": {
            "properties": {
              "uuid": {
                "type": "string"
              }
            }
          },
          "description": "Array of employees assigned to the department."
        },
        "contractors": {
          "type": "array",
          "items": {
            "properties": {
              "uuid": {
                "type": "string"
              }
            }
          },
          "description": "Array of contractors assigned to the department."
        },
        "company_uuid": {
          "type": "string",
          "description": "The UUID of the company"
        }
      }
    }
  ]
}

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/versioning#object-layer) for information on how to use this field."
    },
    "employees": {
      "type": "array",
      "items": {
        "properties": {
          "uuid": {
            "type": "string"
          }
        }
      },
      "description": "Array of employees to add to the department"
    },
    "contractors": {
      "type": "array",
      "items": {
        "properties": {
          "uuid": {
            "type": "string"
          }
        }
      },
      "description": "Array of contractors to add to the department"
    }
  }
}

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Department"
  }
}

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/versioning#object-layer) for information on how to use this field."
    },
    "employees": {
      "type": "array",
      "items": {
        "properties": {
          "uuid": {
            "type": "string"
          }
        }
      },
      "description": "Array of employees to remove from a department"
    },
    "contractors": {
      "type": "array",
      "items": {
        "properties": {
          "uuid": {
            "type": "string"
          }
        }
      },
      "description": "Array of contractors to remove from a department"
    }
  }
}

{
  "type": "object",
  "required": [
    "version"
  ],
  "properties": {
    "title": {
      "type": "string"
    },
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/versioning#object-layer) for information on how to use this field."
    }
  }
}

{
  "type": "object",
  "x-tags": [
    "Earning Types"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the earning type."
    },
    "uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The ID of the earning type."
    }
  },
  "x-examples": {
    "Example": {
      "name": "Cash Tips",
      "uuid": "f5618c94-ed7d-4366-b2c4-ff05e430064f"
    }
  },
  "description": ""
}

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the custom earning type."
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Earning-Type"
      },
      "description": "The custom earning types for the company."
    },
    "default": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Earning-Type"
      },
      "description": "The default earning types for the company."
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the custom earning type."
    }
  }
}

{
  "type": "object",
  "title": "Employee",
  "x-tags": [
    "Employees"
  ],
  "readOnly": true,
  "properties": {
    "ssn": {
      "type": "string",
      "description": "Deprecated. This field always returns an empty string."
    },
    "jobs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Job"
      }
    },
    "uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the employee in Gusto."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "description": "The email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing)."
    },
    "phone": {
      "type": "string"
    },
    "has_ssn": {
      "type": "boolean",
      "description": "Indicates whether the employee has an SSN in Gusto."
    },
    "version": {
      "type": "string",
      "readOnly": true,
      "description": "The current version of the employee. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field."
    },
    "last_name": {
      "type": "string"
    },
    "onboarded": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether the employee has completed onboarding."
    },
    "department": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "The employee's department in the company."
    },
    "first_name": {
      "type": "string"
    },
    "terminated": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether the employee is terminated."
    },
    "work_email": {
      "type": "string",
      "nullable": true,
      "description": "The work email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing)."
    },
    "company_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the company the employee is employed by."
    },
    "garnishments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Garnishment"
      }
    },
    "manager_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the employee's manager."
    },
    "terminations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Termination"
      }
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Employee-Custom-Field"
      },
      "description": "Custom fields are only included for the employee if the include param has the custom_fields value set"
    },
    "date_of_birth": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "middle_initial": {
      "type": "string",
      "nullable": true
    },
    "payment_method": {
      "enum": [
        "Direct Deposit",
        "Check"
      ],
      "type": "string",
      "default": "Check",
      "nullable": false,
      "description": "The employee's payment method"
    },
    "onboarding_status": {
      "enum": [
        "onboarding_completed",
        "admin_onboarding_incomplete",
        "self_onboarding_pending_invite",
        "self_onboarding_invited",
        "self_onboarding_invited_started",
        "self_onboarding_invited_overdue",
        "self_onboarding_completed_by_employee",
        "self_onboarding_awaiting_admin_review"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The current onboarding status of the employee"
    },
    "preferred_first_name": {
      "type": "string",
      "description": ""
    },
    "eligible_paid_time_off": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Paid-Time-Off"
      }
    },
    "two_percent_shareholder": {
      "type": "boolean",
      "description": "Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type."
    },
    "current_employment_status": {
      "enum": [
        "full_time",
        "part_time_under_twenty_hours",
        "part_time_twenty_plus_hours",
        "variable",
        "seasonal"
      ],
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "The current employment status of the employee. Full-time employees work 30+ hours per week. Part-time employees are split into two groups: those that work 20-29 hours a week, and those that work under 20 hours a week. Variable employees have hours that vary each week. Seasonal employees are hired for 6 months of the year or less."
    }
  },
  "x-examples": {
    "Example": {
      "ssn": "",
      "jobs": [
        {
          "rate": "22.00",
          "uuid": "5d5e3ce5-ea8f-4885-90e5-7ebaed03f7c5",
          "title": "Client Support Manager",
          "primary": true,
          "version": "91179081a7309c9fbd31bb3cf7b9893e",
          "hire_date": "2020-01-20",
          "payment_unit": "Hour",
          "compensations": [
            {
              "rate": "22.00",
              "uuid": "94f17a77-cfe5-436a-af94-422bbf8248ff",
              "version": "233f0096a8015e62d9795fadf1fd300d",
              "job_uuid": "64711ac0-83ff-4aaf-bec1-db72f5a44e56",
              "flsa_status": "Nonexempt",
              "payment_unit": "Hour",
              "effective_date": "2021-01-20",
              "adjust_for_minimum_wage": false
            }
          ],
          "employee_uuid": "a987bce1-6d06-43f8-9978-9db886f479fb",
          "current_compensation_uuid": "798a962f-0fcf-491e-9b71-cfa6a1db114f"
        }
      ],
      "uuid": "9779767c-6044-48e0-bf68-aeb370b9a2e7",
      "email": "kory7757869450111548@barton-hermiston.io",
      "phone": "1234567890",
      "has_ssn": true,
      "version": "414dedaca594b77135e0b8d2f398516d",
      "last_name": "Boehm",
      "onboarded": true,
      "department": null,
      "first_name": "Nicole",
      "terminated": false,
      "work_email": "vanessa.boehm@example.com",
      "company_uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2",
      "garnishments": [],
      "manager_uuid": "5e53e257-c8d6-45aa-aa8a-ec99283a3acd",
      "terminations": [],
      "custom_fields": [
        {
          "id": "ee515986-f3ca-49da-b576-2691b95262f9",
          "name": "employee_level",
          "type": "text",
          "value": "2",
          "description": "Employee Level",
          "company_custom_field_id": "ea7e5d57-6abb-47d7-b654-347c142886c0"
        },
        {
          "id": "3796e08d-c2e3-434c-b4de-4ce1893e7b59",
          "name": "t-shirt size",
          "type": "text",
          "value": "md",
          "description": "What is your t-shirt size?",
          "company_custom_field_id": "299650e4-e970-4acf-9bf0-6f05585d20ba"
        }
      ],
      "date_of_birth": "1996-05-08",
      "middle_initial": "M",
      "onboarding_status": "onboarding_completed",
      "preferred_first_name": "Vanessa",
      "eligible_paid_time_off": [
        {
          "name": "Sick Hours",
          "policy_name": "Sick Policy",
          "policy_uuid": "8dc8f324-3c03-4b42-8602-02476fa21c1b",
          "accrual_rate": "208.0",
          "accrual_unit": "Hour",
          "accrual_method": "per_hour_worked",
          "accrual_period": "Year",
          "accrual_balance": "71.0",
          "paid_at_termination": false,
          "maximum_accrual_balance": "240.0"
        },
        {
          "name": "Vacation Hours",
          "policy_name": "Vacation Policy",
          "policy_uuid": "ab59de61-239f-4805-933b-0e3360ed291c",
          "accrual_rate": "208.0",
          "accrual_unit": "Hour",
          "accrual_period": "Year",
          "accrual_balance": "34.0",
          "paid_at_termination": true,
          "maximum_accrual_balance": "240.0"
        }
      ],
      "two_percent_shareholder": false
    }
  },
  "description": "The representation of an employee in Gusto."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Address"
    },
    {
      "type": "object",
      "properties": {
        "uuid": {
          "type": "string",
          "description": "The UUID of the employee address"
        },
        "employee_uuid": {
          "type": "string",
          "description": "The UUID of the employee"
        },
        "effective_date": {
          "type": "string",
          "format": "date",
          "description": "The date the employee started living at the address."
        },
        "courtesy_withholding": {
          "type": "boolean",
          "description": "Determines if home taxes should be withheld and paid for employee."
        }
      }
    }
  ],
  "example": {
    "zip": "94107",
    "city": "San Francisco",
    "uuid": "9557fe01-f8f8-4c14-a61c-ca6221a9f118",
    "state": "CA",
    "active": true,
    "country": "USA",
    "street_1": "333 Kiera Stravenue",
    "street_2": "Suite 391",
    "employee_uuid": "da441196-43a9-4d23-ad5d-f37ce6bb99c0",
    "effective_date": "2021-01-01",
    "courtesy_withholding": true
  }
}

{
  "type": "object",
  "title": "Employee-Bank-Account",
  "x-tags": [
    "Employee Payment Method"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for the bank account"
    },
    "uuid": {
      "type": "string",
      "description": "UUID of the bank account"
    },
    "account_type": {
      "enum": [
        "Checking",
        "Savings"
      ],
      "type": "string",
      "description": "Bank account type"
    },
    "employee_uuid": {
      "type": "string",
      "description": "UUID of the employee"
    },
    "routing_number": {
      "type": "string",
      "description": "The bank account's routing number"
    },
    "hidden_account_number": {
      "type": "string",
      "description": "Masked bank account number"
    }
  },
  "x-examples": {
    "Example": {
      "value": {
        "name": "BoA Checking Account",
        "uuid": "1531e824-8d9e-4bd8-9f90-0d04608125d7",
        "account_type": "Checking",
        "employee_uuid": "9fcf1b1d-8886-4691-9283-383d3bdd4fd9",
        "routing_number": "266905059",
        "hidden_account_number": "XXXX1207"
      }
    }
  }
}

{
  "type": "object",
  "title": "",
  "properties": {
    "uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the employee benefit."
    },
    "active": {
      "type": "boolean",
      "default": true,
      "description": "Whether the employee benefit is active."
    },
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field."
    },
    "catch_up": {
      "type": "boolean",
      "default": false,
      "description": "Whether the employee should use a benefit’s \"catch up\" rate. Only Roth 401k and 401k benefits use this value for employees over 50."
    },
    "elective": {
      "type": "boolean",
      "default": false,
      "description": "Whether the company contribution is elective (aka matching). For \"tiered\" contribution types, this is always true."
    },
    "contribution": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The company contribution scheme.\n\n\"amount\": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"percentage\": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"tiered\": The company contribution varies according to the size of the employee deduction."
        },
        "value": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "object",
              "properties": {
                "tiers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "rate": {
                        "type": "string",
                        "description": "The percentage of employee deduction within this tier the company contribution will match."
                      },
                      "threshold": {
                        "type": "string",
                        "description": "The percentage threshold at which this tier ends (inclusive).\n\nFor example, a value of \"5\" means the company contribution will match employee deductions from the previous tier's threshold up to and including 5% of payroll.\n\nIf this is the first tier, a value of \"5\" means the company contribution will match employee deductions from 0% up to and including 5% of payroll."
                      },
                      "threshold_delta": {
                        "type": "string",
                        "description": "The step up difference between this tier's threshold and the previous tier's threshold. In the first tier, this is equivalent to threshold."
                      }
                    },
                    "description": "A single tier of a tiered matching scheme."
                  },
                  "description": ""
                }
              }
            }
          ],
          "description": "For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.\n\nFor the `tiered` contribution type, an array of tiers."
        }
      },
      "description": "An object representing the type and value of the company contribution."
    },
    "limit_option": {
      "type": "string",
      "nullable": true,
      "description": "Some benefits require additional information to determine their limit. For example, for an HSA benefit, the limit option should be either \"Family\" or \"Individual\". For a Dependent Care FSA benefit, the limit option should be either \"Joint Filing or Single\" or \"Married and Filing Separately\"."
    },
    "employee_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the employee to which the benefit belongs."
    },
    "coverage_amount": {
      "type": "string",
      "nullable": true,
      "description": "The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set."
    },
    "employee_deduction": {
      "type": "string",
      "default": "0.00",
      "description": "The amount to be deducted, per pay period, from the employee's pay."
    },
    "company_benefit_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the company benefit."
    },
    "company_contribution": {
      "type": "string",
      "default": "0.00",
      "deprecated": true,
      "description": "The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types."
    },
    "deduct_as_percentage": {
      "type": "boolean",
      "default": false,
      "description": "Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll."
    },
    "contribute_as_percentage": {
      "type": "boolean",
      "default": false,
      "deprecated": true,
      "description": "Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types."
    },
    "coverage_salary_multiplier": {
      "type": "string",
      "default": "0.00",
      "description": "The coverage amount as a multiple of the employee’s salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set."
    },
    "retirement_loan_identifier": {
      "type": "string",
      "description": "Identifier for a 401(k) loan assigned by the 401(k) provider"
    },
    "deduction_reduces_taxable_income": {
      "enum": [
        "unset",
        "reduces_taxable_income",
        "does_not_reduce_taxable_income",
        null
      ],
      "type": "string",
      "default": "unset",
      "nullable": true,
      "description": "Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not \"unset\", coverage amount and coverage salary multiplier are ignored."
    },
    "employee_deduction_annual_maximum": {
      "type": "string",
      "nullable": true,
      "description": "The maximum employee deduction amount per year. A null value signifies no limit."
    },
    "company_contribution_annual_maximum": {
      "type": "string",
      "nullable": true,
      "description": "The maximum company contribution amount per year. A null value signifies no limit."
    }
  },
  "x-examples": {
    "Example": {
      "uuid": "e91ca856-a915-4339-9b18-29f9cd66b031",
      "active": true,
      "version": "09j3d29jqdpj92109j9j2d90dq",
      "catch_up": false,
      "elective": false,
      "contribution": {
        "type": "amount",
        "value": "100.00"
      },
      "limit_option": null,
      "employee_uuid": "73274962-63ce-4e5c-b689-1df8d4df09f4",
      "coverage_amount": null,
      "employee_deduction": "100.00",
      "company_benefit_uuid": "54e37c27-43e6-4ae5-a5b2-e29895a133be",
      "company_contribution": "100.00",
      "deduct_as_percentage": false,
      "contribute_as_percentage": false,
      "coverage_salary_multiplier": "0.00",
      "retirement_loan_identifier": null,
      "deduction_reduces_taxable_income": null,
      "employee_deduction_annual_maximum": "200.00",
      "company_contribution_annual_maximum": "200.00"
    },
    "Tiered Example": {
      "uuid": "e91ca856-a915-4339-9b18-29f9cd66b031",
      "active": true,
      "version": "09j3d29jqdpj92109j9j2d90dq",
      "catch_up": false,
      "elective": true,
      "contribution": {
        "type": "tiered",
        "value": {
          "tiers": [
            {
              "rate": "100.0",
              "threshold": "2.0",
              "threshold_delta": "2.0"
            },
            {
              "rate": "50.0",
              "threshold": "5.0",
              "threshold_delta": "3.0"
            }
          ]
        }
      },
      "limit_option": null,
      "employee_uuid": "73274962-63ce-4e5c-b689-1df8d4df09f4",
      "coverage_amount": null,
      "employee_deduction": "100.00",
      "company_benefit_uuid": "54e37c27-43e6-4ae5-a5b2-e29895a133be",
      "deduct_as_percentage": false,
      "coverage_salary_multiplier": "0.00",
      "deduction_reduces_taxable_income": null,
      "employee_deduction_annual_maximum": "200.00",
      "company_contribution_annual_maximum": "200.00"
    }
  },
  "description": "The representation of an employee benefit."
}

{
  "type": "object",
  "x-tags": [
    "Custom Fields"
  ],
  "required": [
    "id",
    "company_custom_field_id",
    "name",
    "type",
    "value"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/Custom-Field-Type"
    },
    "value": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "selection_options": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "An array of options for fields of type radio. Otherwise, null."
    },
    "company_custom_field_id": {
      "type": "string",
      "description": "This is the id of the response object from when you get the company custom fields"
    }
  },
  "x-examples": {
    "Employee Level": {
      "id": "ae4e2cd5-e9b6-40f9-88a1-415a02365dd0",
      "name": "employee_level",
      "value": "2",
      "description": "Employee Level",
      "company_custom_field_id": "da84500d-d05c-4e4f-bcf2-43152ca33278"
    }
  },
  "description": "A custom field of an employee"
}

{
  "type": "object",
  "title": "Employee-Federal-Tax",
  "x-tags": [
    "Employee Tax Setup"
  ],
  "properties": {
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field."
    },
    "two_jobs": {
      "type": "boolean",
      "description": "If there are only two jobs (i.e., you and your spouse each have a job, or you have two), you can set it to true."
    },
    "deductions": {
      "type": "string"
    },
    "other_income": {
      "type": "string",
      "description": "Other income amount."
    },
    "w4_data_type": {
      "enum": [
        "pre_2020_w4",
        "rev_2020_w4"
      ],
      "type": "string",
      "description": "The version of w4 form."
    },
    "filing_status": {
      "type": "string",
      "description": "It determines which tax return form an individual will use and is an important factor in computing taxable income. One of:\n- Single\n- Married\n- Head of Household\n- Exempt from withholding\n- Married, but withhold as Single (does not apply to rev_2020_w4 form)"
    },
    "dependents_amount": {
      "type": "string",
      "description": "A dependent is a person other than the taxpayer or spouse who entitles the taxpayer to claim a dependency exemption."
    },
    "extra_withholding": {
      "type": "string",
      "description": "An employee can request an additional amount to be withheld from each paycheck."
    },
    "additional_withholding": {
      "type": "boolean",
      "description": "*does not apply to rev_2020_w4 form*"
    },
    "federal_withholding_allowance": {
      "type": "string",
      "description": "*does not apply to rev_2020_w4 form*\n\nAn exemption from paying a certain amount of income tax."
    }
  },
  "x-examples": {
    "Example": {
      "value": {
        "version": "56a489ce86ed6c1b0f0cecc4050a0b01",
        "two_jobs": true,
        "deductions": "0.0",
        "other_income": "0.0",
        "w4_data_type": "rev_2020_w4",
        "filing_status": "Single",
        "dependents_amount": "0.0",
        "extra_withholding": "0.0"
      }
    }
  }
}

{
  "type": "object",
  "title": "Employee-Onboarding-Status",
  "x-tags": [
    "Employees"
  ],
  "properties": {
    "uuid": {
      "type": "string",
      "description": "Unique identifier for this employee."
    },
    "onboarding_steps": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Onboarding step",
        "properties": {
          "id": {
            "type": "string",
            "description": "String identifier for the onboarding step."
          },
          "title": {
            "type": "string",
            "description": "User-friendly description of the onboarding step."
          },
          "required": {
            "type": "boolean",
            "description": "When true, this step has been completed."
          },
          "completed": {
            "type": "boolean",
            "description": "When true, this step has been completed."
          },
          "requirements": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "A list of onboarding steps required to begin this step."
          }
        }
      },
      "description": "List of steps required to onboard an employee."
    },
    "onboarding_status": {
      "type": "string",
      "description": "One of the \"onboarding_status\" enum values."
    }
  },
  "x-examples": {
    "Example - Employee Self-Onboarding": {
      "uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2",
      "onboarding_steps": [
        {
          "id": "personal_details",
          "title": "Personal details",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "compensation_details",
          "title": "Enter compensation details",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "add_work_address",
          "title": "Add work address",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "add_home_address",
          "title": "Add home address",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "federal_tax_setup",
          "title": "Enter federal tax withholdings",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "state_tax_setup",
          "title": "Enter state tax information",
          "required": true,
          "completed": false,
          "requirements": [
            "add_work_address",
            "add_home_address"
          ]
        },
        {
          "id": "direct_deposit_setup",
          "title": "Direct deposit setup",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "employee_form_signing",
          "title": "Employee form signing",
          "required": true,
          "completed": false,
          "requirements": [
            "federal_tax_setup",
            "state_tax_setup"
          ]
        },
        {
          "id": "admin_review",
          "title": "Admin review",
          "required": true,
          "completed": false,
          "requirements": [
            "personal_details",
            "compensation_details",
            "add_home_address",
            "add_work_address",
            "federal_tax_setup",
            "state_tax_setup"
          ]
        }
      ],
      "onboarding_status": "self_onboarding_invited"
    },
    "Example - Employee Onboarding by Admin": {
      "uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2",
      "onboarding_steps": [
        {
          "id": "personal_details",
          "title": "Personal details",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "compensation_details",
          "title": "Enter compensation details",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "add_work_address",
          "title": "Add work address",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "add_home_address",
          "title": "Add home address",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "federal_tax_setup",
          "title": "Enter federal tax withholdings",
          "required": true,
          "completed": false,
          "requirements": []
        },
        {
          "id": "state_tax_setup",
          "title": "Enter state tax information",
          "required": true,
          "completed": false,
          "requirements": [
            "add_work_address",
            "add_home_address"
          ]
        },
        {
          "id": "direct_deposit_setup",
          "title": "Direct deposit setup",
          "required": false,
          "completed": false,
          "requirements": []
        },
        {
          "id": "employee_form_signing",
          "title": "Employee form signing",
          "required": true,
          "completed": false,
          "requirements": [
            "federal_tax_setup",
            "state_tax_setup"
          ]
        },
        {
          "id": "file_new_hire_report",
          "title": "File new hire report",
          "required": true,
          "completed": false,
          "requirements": [
            "add_work_address"
          ]
        }
      ],
      "onboarding_status": "admin_onboarding_incomplete"
    }
  },
  "description": "The representation of an employee's onboarding status."
}

{
  "type": "object",
  "x-tags": [
    "Payrolls"
  ],
  "properties": {
    "uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the employee pay stub."
    },
    "net_pay": {
      "type": "string",
      "readOnly": true,
      "description": "The net pay amount for the pay stub."
    },
    "gross_pay": {
      "type": "string",
      "readOnly": true,
      "description": "The gross pay amount for the pay stub."
    },
    "check_date": {
      "type": "string",
      "readOnly": true,
      "description": "The check date of the pay stub."
    },
    "check_amount": {
      "type": "string",
      "readOnly": true,
      "description": "The check amount for the pay stub."
    },
    "payroll_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "A unique identifier of the payroll to which the pay stub belongs."
    }
  },
  "description": "The representation of an employee pay stub information."
}

{
  "type": "object",
  "title": "Employee-Payment-Method",
  "x-tags": [
    "Employee Payment Method"
  ],
  "properties": {
    "type": {
      "enum": [
        "Direct Deposit",
        "Check"
      ],
      "type": "string",
      "description": "The payment method type. If type is Check, then split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required."
    },
    "splits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Payment-Method-Bank-Account"
      },
      "nullable": true
    },
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field."
    },
    "split_by": {
      "enum": [
        "Amount",
        "Percentage"
      ],
      "type": "string",
      "nullable": true,
      "description": "Describes how the payment will be split. If split_by is Percentage, then the split amounts must add up to exactly 100. If split_by is Amount, then the last split amount must be nil to capture the remainder."
    }
  },
  "x-examples": {
    "Example-1": {
      "value": {
        "type": "Direct Deposit",
        "splits": [
          {
            "name": "BoA Checking Account",
            "uuid": "e88f9436-b74e-49a8-87e9-777b9bfe715e",
            "priority": 1,
            "split_amount": 500
          },
          {
            "name": "Chase Checking Account",
            "uuid": "0d2b7f73-05d6-4184-911d-269edeecc30a",
            "priority": 2,
            "split_amount": 1000
          },
          {
            "name": "US Bank Checking Account",
            "uuid": "1531e824-8d9e-4bd8-9f90-0d04608125d7",
            "priority": 3,
            "split_amount": null
          }
        ],
        "version": "63859768485e218ccf8a449bb60f14ed",
        "split_by": "Amount"
      }
    },
    "Example-2": {
      "value": {
        "type": "Direct Deposit",
        "splits": [
          {
            "name": "BoA Checking Account",
            "uuid": "e88f9436-b74e-49a8-87e9-777b9bfe715e",
            "priority": 1,
            "split_amount": 60
          },
          {
            "name": "Chase Checking Account",
            "uuid": "0d2b7f73-05d6-4184-911d-269edeecc30a",
            "priority": 2,
            "split_amount": 40
          }
        ],
        "version": "63859768485e218ccf8a449bb60f14ed",
        "split_by": "Percentage"
      }
    },
    "Example-3": {
      "value": {
        "type": "Check",
        "version": "63859768485e218ccf8a449bb60f14ed"
      }
    }
  },
  "description": ""
}

{
  "type": "object",
  "title": "Employee-State-Tax",
  "x-tags": [
    "Employee Tax Setup"
  ],
  "required": [
    "employee_uuid",
    "state",
    "questions"
  ],
  "properties": {
    "state": {
      "type": "string",
      "description": "Two letter US state abbreviation"
    },
    "questions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Employee-State-Tax-Question"
      }
    },
    "employee_uuid": {
      "type": "string",
      "description": "The employee's uuid"
    },
    "is_work_state": {
      "type": "boolean"
    },
    "file_new_hire_report": {
      "type": "boolean"
    }
  },
  "x-examples": {
    "example-1": {
      "state": "CA",
      "questions": [
        {
          "key": "filing_status",
          "label": "Filing Status",
          "answers": [
            {
              "value": "S",
              "valid_from": "2010-01-01",
              "valid_up_to": null
            }
          ],
          "description": "The Head of Household status applies to unmarried individuals who have a relative living with them in their home. If unsure, read the <a target='_blank' data-bypass rel='noopener noreferrer' tabindex='99' href='https://www.ftb.ca.gov/file/personal/filing-status/index.html'>CA Filing Status explanation</a>.\n",
          "input_question_format": {
            "type": "Select",
            "options": [
              {
                "label": "Single",
                "value": "S"
              },
              {
                "label": "Married one income",
                "value": "M"
              },
              {
                "label": "Married dual income",
                "value": "MD"
              },
              {
                "label": "Head of household",
                "value": "H"
              },
              {
                "label": "Do Not Withhold",
                "value": "E"
              }
            ]
          }
        },
        {
          "key": "withholding_allowance",
          "label": "Withholding Allowance",
          "answers": [
            {
              "value": 1,
              "valid_from": "2010-01-01",
              "valid_up_to": null
            }
          ],
          "description": "This value is needed to calculate the employee's CA income tax withholding. If unsure, use the <a target='_blank' data-bypass rel='noopener noreferrer' tabindex='99' href='http://www.edd.ca.gov/pdf_pub_ctr/de4.pdf'>CA DE-4 form</a> to calculate the value manually.\n",
          "input_question_format": {
            "type": "Number"
          }
        },
        {
          "key": "additional_withholding",
          "label": "Additional Withholding",
          "answers": [
            {
              "value": "0.0",
              "valid_from": "2010-01-01",
              "valid_up_to": null
            }
          ],
          "description": "You can withhold an additional amount of California income taxes here.",
          "input_question_format": {
            "type": "Currency"
          }
        },
        {
          "key": "file_new_hire_report",
          "label": "File a New Hire Report?",
          "answers": [
            {
              "value": true,
              "valid_from": "2010-01-01",
              "valid_up_to": null
            }
          ],
          "options": [
            {
              "label": "Yes, file the state new hire report for me.",
              "value": true
            },
            {
              "label": "No, I have already filed.",
              "value": false
            }
          ],
          "description": "State law requires you to file a new hire report within 20 days of hiring or re-hiring an employee.",
          "input_question_format": {
            "type": "Select"
          }
        }
      ],
      "employee_uuid": "2005e601-3c78-410a-9d40-b960ae130383"
    }
  }
}

{
  "type": "object",
  "title": "Employee-State-Tax-Answer",
  "x-tags": [
    "Employee Tax Setup"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "The answer to the corresponding question - this may be a string, number, boolean, or null."
    },
    "valid_from": {
      "type": "string",
      "description": "The effective date of the answer - currently always “2010-01-01”."
    },
    "valid_up_to": {
      "nullable": true,
      "description": "The effective end date of the answer - currently always null."
    }
  },
  "x-examples": {
    "example-1": {
      "value": "0.0",
      "valid_from": "2010-01-01",
      "valid_up_to": null
    }
  }
}

{
  "type": "object",
  "title": "Employee-State-Tax-Input-Question-Format",
  "x-tags": [
    "Employee Tax Setup"
  ],
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Describes the type of question - Text, Number, Select, Currency, Date"
    },
    "options": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "label"
        ],
        "properties": {
          "label": {
            "type": "string",
            "description": "A display label that corresponds to the answer value"
          },
          "value": {
            "type": "string",
            "description": "An allowed value to answer the question"
          }
        }
      },
      "description": "For \"Select\" type questions, the allowed values and display labels.",
      "uniqueItems": true
    }
  },
  "x-examples": {
    "number-example": {
      "type": "Number"
    },
    "select-example": {
      "type": "Select",
      "options": [
        {
          "label": "Single",
          "value": "S"
        },
        {
          "label": "Married one income",
          "value": "M"
        },
        {
          "label": "Married dual income",
          "value": "MD"
        },
        {
          "label": "Head of household",
          "value": "H"
        },
        {
          "label": "Do Not Withhold",
          "value": "E"
        }
      ]
    }
  }
}

{
  "type": "object",
  "title": "Employee-State-Tax-Question",
  "x-tags": [
    "Employee Tax Setup"
  ],
  "required": [
    "label",
    "description",
    "key",
    "input_question_format",
    "answers"
  ],
  "properties": {
    "key": {
      "type": "string",
      "description": "A unique identifier of the question (for the given state) - used for updating the answer."
    },
    "label": {
      "type": "string",
      "description": "A short title for the question"
    },
    "answers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Employee-State-Tax-Answer"
      }
    },
    "description": {
      "type": "string",
      "description": "An explaination of the question - this may contain inline html formatted links."
    },
    "input_question_format": {
      "$ref": "#/components/schemas/Employee-State-Tax-Input-Question-Format"
    }
  },
  "x-examples": {
    "example-1": {
      "key": "filing_status",
      "label": "Filing Status",
      "answers": [
        {
          "value": "S",
          "valid_from": "2010-01-01",
          "valid_up_to": null
        }
      ],
      "description": "The Head of Household status applies to unmarried individuals who have a relative living with them in their home. If unsure, read the <a target='_blank' data-bypass rel='noopener noreferrer' tabindex='99' href='https://www.ftb.ca.gov/file/personal/filing-status/index.html'>CA Filing Status explanation</a>.\n",
      "input_question_format": {
        "type": "Select",
        "options": [
          {
            "label": "Single",
            "value": "S"
          },
          {
            "label": "Married one income",
            "value": "M"
          },
          {
            "label": "Married dual income",
            "value": "MD"
          },
          {
            "label": "Head of household",
            "value": "H"
          },
          {
            "label": "Do Not Withhold",
            "value": "E"
          }
        ]
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "zip": "28572",
    "city": "Pink Hill",
    "uuid": "34925ef7-6234-440d-83b8-788a24d0d69a",
    "state": "NC",
    "active": true,
    "country": "USA",
    "version": "6a22da647ed391f184a212e6e83a541d",
    "street_1": "977 Marks Viaduct",
    "street_2": null,
    "employee_uuid": "2363b9c0-6625-4425-9261-47627fd68783",
    "location_uuid": "aba6d0fd-7294-4997-b1a4-bc9268c45932",
    "effective_date": "2023-05-15"
  },
  "properties": {
    "zip": {
      "type": "string",
      "readOnly": true
    },
    "city": {
      "type": "string",
      "readOnly": true
    },
    "uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The unique identifier of this work address."
    },
    "state": {
      "type": "string",
      "readOnly": true
    },
    "active": {
      "type": "boolean",
      "readOnly": true,
      "description": "Signifies if this address is the active work address for the current date"
    },
    "country": {
      "type": "string",
      "default": "USA",
      "readOnly": true
    },
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field."
    },
    "street_1": {
      "type": "string",
      "readOnly": true
    },
    "street_2": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "employee_uuid": {
      "type": "string",
      "description": "UUID reference to the employee for this work address."
    },
    "location_uuid": {
      "type": "string",
      "description": "UUID reference to the company location for this work address."
    },
    "effective_date": {
      "type": "string",
      "description": "The date the employee began working at this location."
    }
  }
}

{
  "type": "object",
  "required": [
    "version"
  ],
  "properties": {
    "zip": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "street_1": {
      "type": "string"
    },
    "street_2": {
      "type": "string",
      "nullable": true
    },
    "effective_date": {
      "type": "string",
      "format": "date"
    },
    "courtesy_withholding": {
      "type": "boolean"
    }
  },
  "description": ""
}

{
  "type": "object",
  "properties": {
    "location_uuid": {
      "type": "string",
      "description": "Reference to a company location"
    },
    "effective_date": {
      "type": "string",
      "format": "date",
      "description": "Date the employee began working at the company location"
    }
  },
  "description": ""
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Employee-Address"
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Employee-Work-Address"
  }
}

{
  "type": "object",
  "required": [
    "version"
  ],
  "properties": {
    "zip": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/versioning#object-layer) for information on how to use this field."
    },
    "street_1": {
      "type": "string"
    },
    "street_2": {
      "type": "string",
      "nullable": true
    },
    "effective_date": {
      "type": "string",
      "format": "date"
    },
    "courtesy_withholding": {
      "type": "boolean"
    }
  },
  "description": ""
}

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/versioning#object-layer) for information on how to use this field."
    },
    "location_uuid": {
      "type": "string",
      "description": "Reference to a company location"
    },
    "effective_date": {
      "type": "string",
      "format": "date"
    }
  },
  "description": ""
}

{
  "type": "object",
  "required": [
    "company_benefit_uuid"
  ],
  "properties": {
    "active": {
      "type": "boolean",
      "default": true,
      "description": "Whether the employee benefit is active."
    },
    "catch_up": {
      "type": "boolean",
      "default": false,
      "description": "Whether the employee should use a benefit’s \"catch up\" rate. Only Roth 401k and 401k benefits use this value for employees over 50."
    },
    "elective": {
      "type": "boolean",
      "default": false,
      "description": "Whether the company contribution is elective (aka \"matching\"). For `tiered`, `elective_amount`, and `elective_percentage` contribution types this is ignored and assumed to be `true`."
    },
    "contribution": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "tiered",
            "percentage",
            "amount"
          ],
          "type": "string",
          "description": "The company contribution scheme.\n\n`amount`: The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.\n\n`percentage`: The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.\n\n`tiered`: The size of the company contribution corresponds to the size of the employee deduction relative to a tiered matching scheme."
        },
        "value": {
          "oneOf": [
            {
              "type": "string",
              "description": "For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage."
            },
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "rate": {
                    "type": "string",
                    "description": "The percentage of employee deduction within this tier the company contribution will match."
                  },
                  "threshold": {
                    "type": "string",
                    "description": "The percentage threshold at which this tier ends (inclusive).\n\nFor example, a value of \"5\" means the company contribution will match employee deductions from the previous tier's threshold up to and including 5% of payroll.\n\nIf this is the first tier, a value of \"5\" means the company contribution will match employee deductions from 0% up to and including 5% of payroll."
                  }
                },
                "description": "A single tier of a tiered matching scheme."
              },
              "description": "For `tiered` contribution types, an array of tiers."
            }
          ],
          "description": "For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.\n\nFor the `tiered` contribution type, an array of tiers."
        }
      },
      "description": "An object representing the company contribution type and value."
    },
    "limit_option": {
      "type": "string",
      "nullable": true,
      "description": "Some benefits require additional information to determine their limit. For example, for an HSA benefit, the limit option should be either \"Family\" or \"Individual\". For a Dependent Care FSA benefit, the limit option should be either \"Joint Filing or Single\" or \"Married and Filing Separately\"."
    },
    "coverage_amount": {
      "type": "string",
      "nullable": true,
      "description": "The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set."
    },
    "employee_deduction": {
      "type": "string",
      "default": "0.00",
      "description": "The amount to be deducted, per pay period, from the employee's pay."
    },
    "company_benefit_uuid": {
      "type": "string",
      "description": "The UUID of the company benefit."
    },
    "company_contribution": {
      "type": "string",
      "default": "0.00",
      "deprecated": true,
      "description": "The amount to be paid, per pay period, by the company."
    },
    "deduct_as_percentage": {
      "type": "boolean",
      "default": false,
      "description": "Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll."
    },
    "contribute_as_percentage": {
      "type": "boolean",
      "default": false,
      "deprecated": true,
      "description": "Whether the company contribution amount should be treated as a percentage to be deducted from each payroll."
    },
    "coverage_salary_multiplier": {
      "type": "string",
      "default": "0.00",
      "description": "The coverage amount as a multiple of the employee’s salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set."
    },
    "deduction_reduces_taxable_income": {
      "enum": [
        "unset",
        "reduces_taxable_income",
        "does_not_reduce_taxable_income",
        null
      ],
      "type": "string",
      "nullable": true,
      "description": "Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not \"unset\", coverage amount and coverage salary multiplier are ignored."
    },
    "employee_deduction_annual_maximum": {
      "type": "string",
      "nullable": true,
      "description": "The maximum employee deduction amount per year. A null value signifies no limit."
    },
    "company_contribution_annual_maximum": {
      "type": "string",
      "nullable": true,
      "description": "The maximum company contribution amount per year. A null value signifies no limit."
    }
  },
  "description": ""
}