{
  "type": "object",
  "properties": {
    "gross_up": {
      "type": "string",
      "description": "Gross up earnings."
    }
  }
}

{
  "type": "object",
  "required": [
    "version",
    "company_uuid",
    "federal_holidays",
    "employees"
  ],
  "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": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string"
          }
        }
      },
      "description": "List of employee uuids under a time off policy"
    },
    "company_uuid": {
      "type": "string",
      "description": "A unique identifier for the company owning the holiday pay policy"
    },
    "federal_holidays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "mlk_day": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "labor_day": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "juneteenth": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "columbus_day": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "memorial_day": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "thanksgiving": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "veterans_day": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "new_years_day": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "presidents_day": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          },
          "independence_day": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "selected": {
                "type": "boolean"
              }
            }
          }
        }
      },
      "description": "List of the eleven supported federal holidays and their details"
    }
  },
  "x-examples": {
    "example": {
      "version": "1b37938b017c7fd7116bada007072290",
      "employees": {
        "uuid": "1ca3cd25-3eda-48c6-ac88-f0e7fb91a15a"
      },
      "company_uuid": "b7845189-f12b-4378-918a-d2b9de3dc4ea",
      "federal_holidays": {
        "mlk_day": {
          "date": "Third Monday in January",
          "name": "Martin Luther King, Jr. Day",
          "selected": true
        },
        "labor_day": {
          "date": "First Monday in September",
          "name": "Labor Day",
          "selected": false
        },
        "juneteenth": {
          "date": "June 19",
          "name": "Juneteenth",
          "selected": false
        },
        "columbus_day": {
          "date": "Second Monday in October",
          "name": "Columbus Day (Indigenous Peoples' Day)",
          "selected": false
        },
        "memorial_day": {
          "date": "Last Monday in May",
          "name": "Memorial Day",
          "selected": true
        },
        "thanksgiving": {
          "date": "Fourth Thursday in November",
          "name": "Thanksgiving",
          "selected": true
        },
        "veterans_day": {
          "date": "November 11",
          "name": "Veterans Day",
          "selected": true
        },
        "christmas_day": {
          "date": "December 25",
          "name": "Christmas Day",
          "selected": true
        },
        "new_years_day": {
          "date": "January 1",
          "name": "New Year's Day",
          "selected": true
        },
        "presidents_day": {
          "date": "Third Monday in February",
          "name": "Presidents' Day",
          "selected": false
        },
        "independence_day": {
          "date": "July 4",
          "name": "Independence Day",
          "selected": true
        }
      }
    }
  },
  "description": "Representation of a Holiday Pay Policy"
}

{
  "type": "object",
  "required": [
    "version"
  ],
  "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."
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string"
          }
        }
      },
      "description": "An array of employee objects, each containing an employee_uuid."
    }
  }
}

{
  "type": "object",
  "properties": {
    "federal_holidays": {
      "type": "object",
      "properties": {
        "mlk_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "labor_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "juneteenth": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "columbus_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "memorial_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "thanksgiving": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "veterans_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "christmas_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "new_years_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "presidents_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "independence_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        }
      },
      "description": "An object containing federal holiday objects, each containing a boolean selected property."
    }
  }
}

{
  "type": "object",
  "properties": {
    "year": {
      "type": "string",
      "description": "If a year is passed, paid holidays for that year will be returned. Otherwise, paid holidays for the next three years will be returned."
    }
  }
}

{
  "type": "object",
  "required": [
    "version"
  ],
  "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."
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string"
          }
        }
      },
      "description": "An array of employee objects, each containing an employee_uuid."
    }
  }
}

{
  "type": "object",
  "required": [
    "version"
  ],
  "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."
    },
    "federal_holidays": {
      "type": "object",
      "properties": {
        "mlk_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "labor_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "juneteenth": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "columbus_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "memorial_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "thanksgiving": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "veterans_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "christmas_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "new_years_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "presidents_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        },
        "independence_day": {
          "type": "object",
          "properties": {
            "selected": {
              "type": "boolean"
            }
          }
        }
      },
      "description": "An object containing federal holiday objects, each containing a boolean selected property."
    }
  }
}

{
  "type": "object",
  "title": "Industry",
  "x-tags": [
    "Industry"
  ],
  "properties": {
    "title": {
      "type": "string",
      "readOnly": true,
      "description": "Industry title"
    },
    "sic_codes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "description": "A list of Standard Industrial Classification (SIC) codes, which are four digit number that categorize the industries that companies belong to based on their business activities."
    },
    "naics_code": {
      "type": "string",
      "readOnly": true,
      "description": "North American Industry Classification System (NAICS) is used to classify businesses with a six digit number based on the primary type of work the business performs."
    },
    "company_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "Company uuid"
    }
  },
  "x-examples": {
    "Example": {
      "title": "Computer Training",
      "sic_codes": [
        "8243"
      ],
      "naics_code": "611420",
      "company_uuid": "423dd616-6dbc-4724-938a-403f6217a933"
    }
  }
}

{
  "type": "object",
  "required": [
    "title",
    "naics_code"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Industry title"
    },
    "sic_codes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of Standard Industrial Classification (SIC) codes, which are four digit number that categorize the industries that companies belong to based on their business activities. If sic_codes is not passed in, we will perform an internal lookup with naics_code."
    },
    "naics_code": {
      "type": "string",
      "description": "North American Industry Classification System (NAICS) is used to classify businesses with a six digit number based on the primary type of work the business performs"
    }
  },
  "description": ""
}

{
  "type": "object",
  "required": [
    "client_id",
    "client_secret",
    "grant_type",
    "refresh_token"
  ],
  "properties": {
    "client_id": {
      "type": "string",
      "description": "Your client id"
    },
    "grant_type": {
      "type": "string",
      "description": "this should be the literal string 'refresh_token'"
    },
    "redirect_uri": {
      "type": "string",
      "description": "The redirect URI you set up via the Developer Portal"
    },
    "client_secret": {
      "type": "string",
      "description": "Your client secret"
    },
    "refresh_token": {
      "type": "string",
      "description": "The `refresh_token` being exchanged for an access token code"
    }
  },
  "description": ""
}

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "Space delimited string of accessible scopes."
    },
    "resource": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of object"
        },
        "uuid": {
          "type": "string",
          "description": "UUID of object"
        }
      },
      "description": "Information about the token resource."
    }
  },
  "description": ""
}

{
  "type": "object",
  "properties": {
    "active_companies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "company_uuid": {
            "type": "string",
            "description": "unique identifier for the company associated with the invoice data"
          },
          "active_employees": {
            "type": "integer",
            "description": "The number of active employees the company was or will be invoiced for that invoice period. Active employees are calculated as the count of onboarded employees hired before the end of the invoice period and not terminated before the start of the invoice period."
          },
          "active_contractors": {
            "type": "integer",
            "description": "The number of active contractors the company was or will be invoiced for that invoice period. Active contractors are calculated as any contractor with an active contractor payment during the invoice period."
          },
          "initial_invoice_period": {
            "type": "string",
            "description": "The first invoice period for the company. This will either be the invoice period of the first invoice-able event (first payroll or contractor payment) or the date they migrated to embedded, whichever is later."
          }
        }
      },
      "description": "The list of companies that are active within the invoice period"
    }
  },
  "x-examples": {
    "example": {
      "active_companies": [
        {
          "company_uuid": "05ed3150-591e-4f8b-bfd5-55d478edd2d8",
          "active_employees": 5,
          "active_contractors": 3,
          "initial_invoice_period": "2022-01"
        },
        {
          "company_uuid": "9b37429c-e540-40fb-86b3-738ca9af65c7",
          "active_employees": 0,
          "active_contractors": 1,
          "initial_invoice_period": "2023-05"
        }
      ]
    }
  },
  "description": "Representation of a partners invoice data"
}

{
  "type": "object",
  "title": "Job",
  "x-tags": [
    "Jobs and Compensations"
  ],
  "properties": {
    "rate": {
      "type": "string",
      "readOnly": true,
      "description": "The current compensation rate of the job."
    },
    "uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the job."
    },
    "title": {
      "type": "string",
      "default": null,
      "nullable": true,
      "readOnly": false,
      "description": "The title for the job."
    },
    "primary": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether this is the employee's primary job. The value will be set to true unless an existing job exists for the employee."
    },
    "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."
    },
    "hire_date": {
      "type": "string",
      "readOnly": false,
      "description": "The date when the employee was hired or rehired for the job."
    },
    "payment_unit": {
      "type": "string",
      "readOnly": true,
      "description": "The payment unit of the current compensation for the job."
    },
    "compensations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Compensation"
      },
      "readOnly": true
    },
    "employee_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the employee to which the job belongs."
    },
    "state_wc_covered": {
      "type": "boolean",
      "readOnly": false,
      "description": "Whether this job is eligible for workers' compensation coverage in the state of Washington (WA)."
    },
    "state_wc_class_code": {
      "type": "string",
      "readOnly": false,
      "description": "The risk class code for workers' compensation in Washington state. Please visit [Washington state's Risk Class page](https://www.lni.wa.gov/insurance/rates-risk-classes/risk-classes-for-workers-compensation/risk-class-lookup#/) to learn more."
    },
    "two_percent_shareholder": {
      "type": "boolean",
      "readOnly": false,
      "description": "Whether the employee owns at least 2% of the company."
    },
    "current_compensation_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the current compensation of the job."
    }
  },
  "x-examples": {
    "Example": {
      "rate": "78000.00",
      "uuid": "d6d1035e-8a21-4e1d-89d5-fa894f9aff97",
      "title": "Account Director",
      "primary": true,
      "version": "d0e719137f89ca3dd334dd4cc248ffbb",
      "hire_date": "2020-01-20",
      "payment_unit": "Year",
      "compensations": [
        {
          "rate": "78000.00",
          "uuid": "ea8b0b90-1112-4f9d-bb93-bf029bc8537a",
          "version": "994b75511d1debac5d7e2ddeae13679f",
          "job_uuid": "d6d1035e-8a21-4e1d-89d5-fa894f9aff97",
          "flsa_status": "Exempt",
          "payment_unit": "Year",
          "effective_date": "2021-01-20",
          "adjust_for_minimum_wage": false
        }
      ],
      "employee_uuid": "948daac8-4355-4ece-9e2a-229898accb22",
      "current_compensation_uuid": "ea8b0b90-1112-4f9d-bb93-bf029bc8537a"
    }
  },
  "description": "The representation of a job in Gusto."
}

{
  "type": "object",
  "required": [
    "payment_unit",
    "flsa_status"
  ],
  "properties": {
    "rate": {
      "type": "string",
      "description": "The dollar amount paid per payment unit."
    },
    "flsa_status": {
      "$ref": "#/components/schemas/Flsa-Status-Type"
    },
    "payment_unit": {
      "enum": [
        "Hour",
        "Week",
        "Month",
        "Year",
        "Paycheck"
      ],
      "type": "string",
      "description": "The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'."
    },
    "minimum_wages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "The UUID of the minimum wage record. Required if adjust_for_minimum_wage set to true"
          }
        },
        "description": "The minimum wage record you want to apply to the compensation"
      }
    },
    "effective_date": {
      "type": "string",
      "description": "The date when the compensation takes effect."
    },
    "adjust_for_minimum_wage": {
      "type": "boolean",
      "description": "Determines whether the compensation should be adjusted for minimum wage. Only applies to Nonexempt employees."
    }
  },
  "description": ""
}

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

{
  "type": "object",
  "required": [
    "title",
    "hire_date"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "The job title"
    },
    "hire_date": {
      "type": "string",
      "description": "The date when the employee was hired or rehired for the job."
    },
    "state_wc_covered": {
      "type": "boolean",
      "description": "Whether this job is eligible for workers' compensation coverage in the state of Washington (WA)."
    },
    "state_wc_class_code": {
      "type": "string",
      "description": "The risk class code for workers' compensation in Washington state. Please visit [Washington state's Risk Class page](https://www.lni.wa.gov/insurance/rates-risk-classes/risk-classes-for-workers-compensation/risk-class-lookup#/) to learn more."
    },
    "two_percent_shareholder": {
      "type": "boolean",
      "description": "Whether the employee owns at least 2% of the company."
    }
  },
  "description": ""
}

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

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

{
  "type": "object",
  "required": [
    "version"
  ],
  "properties": {
    "rate": {
      "type": "string",
      "description": "The dollar amount paid per payment unit."
    },
    "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."
    },
    "flsa_status": {
      "$ref": "#/components/schemas/Flsa-Status-Type"
    },
    "payment_unit": {
      "enum": [
        "Hour",
        "Week",
        "Month",
        "Year",
        "Paycheck"
      ],
      "type": "string",
      "description": "The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'."
    },
    "minimum_wages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "The UUID of the minimum wage record. Required if adjust_for_minimum_wage set to true"
          }
        },
        "description": "The minimum wage record you want to apply to the compensation"
      }
    },
    "adjust_for_minimum_wage": {
      "type": "boolean",
      "description": "Determines whether the compensation should be adjusted for minimum wage. Only applies to Nonexempt employees."
    }
  },
  "description": ""
}

{
  "type": "object",
  "required": [
    "version"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "The job title"
    },
    "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."
    },
    "hire_date": {
      "type": "string",
      "description": "The date when the employee was hired or rehired for the job."
    },
    "state_wc_covered": {
      "type": "boolean",
      "description": "Whether this job is eligible for workers' compensation coverage in the state of Washington (WA)."
    },
    "state_wc_class_code": {
      "type": "string",
      "description": "The risk class code for workers' compensation in Washington state. Please visit [Washington state's Risk Class page](https://www.lni.wa.gov/insurance/rates-risk-classes/risk-classes-for-workers-compensation/risk-class-lookup#/) to learn more."
    },
    "two_percent_shareholder": {
      "type": "boolean",
      "description": "Whether the employee owns at least 2% of the company."
    }
  },
  "description": ""
}

{
  "type": "object",
  "title": "",
  "x-tags": [
    "Locations"
  ],
  "properties": {
    "zip": {
      "type": "string",
      "readOnly": false
    },
    "city": {
      "type": "string",
      "readOnly": false
    },
    "uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the location object."
    },
    "state": {
      "type": "string",
      "readOnly": false
    },
    "active": {
      "type": "boolean",
      "readOnly": true,
      "description": "The status of the location. Inactive locations have been deleted, but may still have historical data associated with them."
    },
    "country": {
      "type": "string",
      "default": "USA",
      "readOnly": false
    },
    "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": false
    },
    "street_2": {
      "type": "string",
      "nullable": true,
      "readOnly": false
    },
    "created_at": {
      "type": "string",
      "description": "Datetime for when location is created"
    },
    "updated_at": {
      "type": "string",
      "description": "Datetime for when location is updated"
    },
    "company_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID for the company to which the location belongs. Only included if the location belongs to a company."
    },
    "phone_number": {
      "type": "string",
      "readOnly": false,
      "description": "The phone number for the location. Required for company locations. Optional for employee locations."
    },
    "filing_address": {
      "type": "boolean",
      "nullable": true,
      "description": "Specifies if the location is the company's filing address. Only included if the location belongs to a company."
    },
    "mailing_address": {
      "type": "boolean",
      "nullable": true,
      "description": "Specifies if the location is the company's mailing address. Only included if the location belongs to a company."
    }
  },
  "x-examples": {
    "Company Location": {
      "zip": "94107",
      "city": "San Francisco",
      "uuid": "064a4107-c9f4-4fad-acbf-f12cd81c0d6c",
      "state": "CA",
      "active": true,
      "country": "USA",
      "version": "7d9753112507b9dda4fb97910f39b06e",
      "street_1": "412 Kiera Stravenue",
      "street_2": "Suite 391",
      "created_at": "2023-09-12T16:42:25.000-07:00",
      "updated_at": "2023-09-12T16:42:25.000-07:00",
      "company_uuid": "768a1043-f6bf-4f0b-a606-98465ea01ad7",
      "phone_number": "5825710808"
    }
  },
  "description": "The representation of an address in Gusto."
}

{
  "type": "object",
  "required": [
    "phone_number",
    "street_1",
    "city",
    "state",
    "zip"
  ],
  "properties": {
    "zip": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "country": {
      "type": "string",
      "default": "USA"
    },
    "street_1": {
      "type": "string"
    },
    "street_2": {
      "type": "string",
      "nullable": true
    },
    "phone_number": {
      "type": "string",
      "pattern": "[0-9]{10}"
    },
    "filing_address": {
      "type": "boolean",
      "description": "Specify if this location is the company's filing address."
    },
    "mailing_address": {
      "type": "boolean",
      "description": "Specify if this location is the company's mailing address."
    }
  },
  "description": ""
}

{
  "type": "object",
  "required": [
    "phone_number",
    "street_1",
    "street_2",
    "city",
    "state",
    "zip",
    "country"
  ],
  "properties": {
    "zip": {
      "type": "string",
      "minLength": 1
    },
    "city": {
      "type": "string",
      "minLength": 1
    },
    "state": {
      "type": "string",
      "minLength": 1
    },
    "country": {
      "type": "string",
      "minLength": 1
    },
    "street_1": {
      "type": "string",
      "minLength": 1
    },
    "street_2": {
      "type": "string",
      "nullable": true,
      "minLength": 1
    },
    "phone_number": {
      "type": "string",
      "minLength": 1
    }
  },
  "description": ""
}

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

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Minimum-Wage"
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Versionable-Required"
    },
    {
      "type": "object",
      "properties": {
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "street_1": {
          "type": "string"
        },
        "street_2": {
          "type": "string",
          "nullable": true
        },
        "phone_number": {
          "type": "string",
          "pattern": "[0-9]{10}"
        },
        "filing_address": {
          "type": "boolean",
          "description": "For a company location, specify if this location is the company's filing address. A company has a single filing address, so this designation will override any previous selection."
        },
        "mailing_address": {
          "type": "boolean",
          "description": "For a company location, specify if this location is the company's mailing address. A company has a single mailing address, so this designation will override any previous selection."
        }
      },
      "description": ""
    }
  ]
}

{
  "type": "object",
  "required": [
    "uuid",
    "wage",
    "wage_type",
    "effective_date",
    "authority"
  ],
  "properties": {
    "uuid": {
      "type": "string",
      "description": "unique identifier of a minimum wage"
    },
    "wage": {
      "type": "string",
      "format": "float",
      "description": "The wage rate for a minimum wage record. Represented as a float, e.g. \"15.0\"."
    },
    "notes": {
      "type": "string",
      "description": "Description of parties the minimum wage applies to."
    },
    "authority": {
      "type": "string",
      "description": "The governing authority that created the minimum wage, e.g. \"City\", \"State\", or \"Federal\"."
    },
    "wage_type": {
      "type": "string",
      "description": "The type of wage the minimum wage applies to, e.g. \"Regular\", \"Regular-Industry-Specific\"."
    },
    "effective_date": {
      "type": "string",
      "format": "date",
      "description": "The date the minimum wage rule is effective on."
    }
  },
  "x-examples": {
    "example": {
      "uuid": "70c523ff-c71e-4474-9c83-a4ea51bd54a8",
      "wage": "13.0",
      "notes": "Employers with 6 or more employees",
      "authority": "State",
      "wage_type": "Regular",
      "effective_date": "2022-01-01"
    }
  },
  "description": "Representation of a Minimum Wage"
}

{
  "type": "object",
  "properties": {
    "uuid": {
      "type": "string",
      "description": "Unique identifier of a notification."
    },
    "title": {
      "type": "string",
      "description": "The title of the notification. This highlights the actionable component of the notification."
    },
    "due_at": {
      "type": "string",
      "description": "Timestamp of when the notification is due. If the notification has no due date, this field will be null."
    },
    "message": {
      "type": "string",
      "description": "The message of the notification. This provides additional context for the user and recommends a specific action to resolve the notification."
    },
    "category": {
      "type": "string",
      "description": "The notification's category."
    },
    "resources": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "entity_type",
          "entity_uuid"
        ],
        "properties": {
          "entity_type": {
            "type": "string",
            "description": "The type of entity being described, could be “Contractor”, “Employee”, “BankAccount”, “Payroll”, “ContractorPayment”, “RecoveryCase”, or “Signatory”"
          },
          "entity_uuid": {
            "type": "string",
            "description": "Unique identifier of the entity"
          },
          "reference_type": {
            "type": "string",
            "description": "Optional. The type of a resource that is related to the one described by entity_type and entity_uuid. For instance, if the entity_type is “BankAccount”, the reference_type could be the “Employee” or “Contractor” to whom the bank account belongs."
          },
          "reference_uuid": {
            "type": "string",
            "description": "Optional. Unique identifier of the reference."
          }
        }
      },
      "description": "An array of entities relevant to the notification"
    },
    "actionable": {
      "type": "boolean",
      "description": "Indicates whether a notification requires action or not. If false, the notification provides critical information only."
    },
    "company_uuid": {
      "type": "string",
      "description": "Unique identifier of the company to which the notification belongs."
    },
    "published_at": {
      "type": "string",
      "description": "Timestamp of when the notification was published."
    }
  },
  "x-examples": {
    "example": {
      "uuid": "7b1d0df1-6403-4a06-8768-c1dd7d24d27a",
      "title": "Action required: Additional information needed to process payroll",
      "message": "If we do not receive this information as soon as possible, your payroll may not be processed on time.",
      "category": "information_request",
      "created_at": "2022-01-01T00:00:00.000Z",
      "company_uuid": "88f7cca1-dcad-4d20-84db-7fb80303d69f"
    }
  },
  "description": "Representation of a notification"
}

{
  "enum": [
    "Benefit reversal",
    "Bonus",
    "Correction",
    "Dismissed employee",
    "Hired employee",
    "Wage correction",
    "Tax reconciliation",
    "Reversal",
    "Disability insurance distribution",
    "Transition from old pay schedule"
  ],
  "type": "string",
  "nullable": true,
  "readOnly": true,
  "description": "The off-cycle reason. Only included for off-cycle payrolls."
}

{
  "type": "object",
  "properties": {
    "schema": {
      "type": "object",
      "properties": {
        "end_date": {
          "type": "string",
          "description": "the holiday's end date (YYYY-MM-DD)"
        },
        "start_date": {
          "type": "string",
          "description": "the holiday's start date (YYYY-MM-DD)"
        },
        "holiday_key": {
          "type": "string",
          "description": "the holiday's identifier"
        },
        "holiday_name": {
          "type": "string",
          "description": "the holiday's official name"
        }
      }
    }
  },
  "description": "Representation of a company's paid holidays as descibed by their Holiday Pay Policy"
}

{
  "type": "object",
  "x-tags": [
    "Payrolls"
  ],
  "properties": {
    "name": {
      "enum": [
        "Vacation Hours",
        "Sick Hours",
        "Holiday Hours"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The name of the paid time off type."
    },
    "policy_name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the time off policy."
    },
    "policy_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the time off policy."
    },
    "accrual_rate": {
      "type": "string",
      "readOnly": true,
      "description": "The number of accrual units accrued per accrual period."
    },
    "accrual_unit": {
      "type": "string",
      "example": "Hour",
      "readOnly": true,
      "description": "The unit the PTO type is accrued in."
    },
    "accrual_method": {
      "type": "string",
      "example": "unlimited",
      "readOnly": true,
      "description": "The accrual method of the time off policy"
    },
    "accrual_period": {
      "type": "string",
      "example": "Year",
      "readOnly": true,
      "description": "The frequency at which the PTO type is accrued."
    },
    "accrual_balance": {
      "type": "string",
      "readOnly": true,
      "description": "The number of accrual units accrued."
    },
    "paid_at_termination": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether the accrual balance is paid to the employee upon termination."
    },
    "maximum_accrual_balance": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "The maximum number of accrual units allowed. A null value signifies no maximum."
    }
  },
  "x-examples": {
    "Example": {
      "name": "Sick Hours",
      "policy_name": "Sick Policy",
      "policy_uuid": "8dc8f324-3c03-4b42-8602-02476fa21c1b",
      "accrual_rate": "208.0",
      "accrual_unit": "Hour",
      "accrual_period": "Year",
      "accrual_balance": "64.0",
      "paid_at_termination": false,
      "maximum_accrual_balance": "240.0"
    }
  },
  "description": "The representation of paid time off in Gusto."
}

{
  "type": "object",
  "x-tags": [
    "Payrolls"
  ],
  "properties": {
    "payroll": {
      "type": "object",
      "readOnly": true,
      "properties": {
        "processed": {
          "type": "boolean",
          "readOnly": true,
          "description": "Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline."
        },
        "check_date": {
          "type": "string",
          "readOnly": true,
          "description": "The date on which employees will be paid for the payroll if the payroll is submitted on time."
        },
        "payroll_type": {
          "enum": [
            "regular",
            "transition"
          ],
          "type": "string",
          "readOnly": true,
          "description": "Whether it is regular pay period or transition pay period."
        },
        "payroll_uuid": {
          "type": "string",
          "readOnly": true,
          "description": "The UUID of the payroll for this pay period."
        },
        "payroll_deadline": {
          "type": "string",
          "format": "date-time",
          "readOnly": true,
          "description": "The date by which payroll should be run for employees to be paid on time. Payroll data, such as time and attendance data, should be submitted on or before this date."
        }
      },
      "description": "Information about the payroll for the pay period."
    },
    "end_date": {
      "type": "string",
      "minLength": 1,
      "description": "The end date, inclusive, of the pay period."
    },
    "start_date": {
      "type": "string",
      "readOnly": true,
      "description": "The start date, inclusive, of the pay period."
    },
    "pay_schedule_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "A unique identifier of the pay schedule to which the pay period belongs."
    }
  },
  "description": "The representation of a pay period."
}

{
  "type": "object",
  "title": "Pay Schedule",
  "x-tags": [
    "Pay Schedules"
  ],
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "This field will be hourly when the pay schedule is for hourly employees, salaried when the pay schedule is for salaried employees, the department name if pay schedule is by department, and null when the pay schedule is for all employees."
    },
    "uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The unique identifier of the pay schedule in Gusto."
    },
    "day_1": {
      "type": "integer",
      "nullable": true,
      "readOnly": true,
      "description": "An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the “Twice per month” and “Monthly” frequencies. It will be null for pay schedules with other frequencies."
    },
    "day_2": {
      "type": "integer",
      "nullable": true,
      "readOnly": true,
      "description": "An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the \"Twice per month\" frequency. For semi-monthly pay schedules, this field should be set to 31. For months shorter than 31 days, we will set the second pay date to the last day of the month. It will be null for pay schedules with other frequencies."
    },
    "active": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned."
    },
    "frequency": {
      "enum": [
        "Every week",
        "Every other week",
        "Twice per month",
        "Monthly",
        "Quarterly",
        "Annually"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The frequency that employees on this pay schedule are paid with Gusto."
    },
    "auto_pilot": {
      "type": "boolean",
      "description": "With Autopilot® enabled, payroll will run automatically one day before your payroll deadlines."
    },
    "custom_name": {
      "type": "string",
      "readOnly": true,
      "description": "A custom name for a pay schedule, defaults to the pay frequency description."
    },
    "anchor_pay_date": {
      "type": "string",
      "readOnly": true,
      "description": "The first date that employees on this pay schedule are paid with Gusto."
    },
    "anchor_end_of_pay_period": {
      "type": "string",
      "readOnly": true,
      "description": "The last date of the first pay period. This can be the same date as the anchor pay date."
    }
  },
  "x-examples": {
    "Example": {
      "name": "Engineering",
      "uuid": "f2a69c38-e2f9-4e31-b5c5-4754fc60a052",
      "day_1": 15,
      "day_2": 31,
      "frequency": "Twice per month",
      "auto_pilot": false,
      "custom_name": "A new monthly pay schedule",
      "anchor_pay_date": "2020-05-15",
      "anchor_end_of_pay_period": "2020-05-08"
    }
  },
  "description": "The representation of a pay schedule."
}

{
  "type": "object",
  "x-tags": [
    "Pay Schedules"
  ],
  "properties": {
    "type": {
      "enum": [
        "single",
        "hourly_salaried",
        "by_employee",
        "by_department"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The pay schedule assignment type."
    },
    "employees": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Pay-Schedule-Assignment-Employee"
      },
      "nullable": true,
      "readOnly": true,
      "description": "List of employees and their pay schedules."
    },
    "departments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Pay-Schedule-Assignment-Department"
      },
      "nullable": true,
      "readOnly": true,
      "description": "List of departments and their pay schedules."
    },
    "hourly_pay_schedule_uuid": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "Pay schedule for hourly employees."
    },
    "default_pay_schedule_uuid": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "Default pay schedule for employees."
    },
    "salaried_pay_schedule_uuid": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "Pay schedule for salaried employees."
    }
  },
  "x-examples": {
    "example-1": {
      "type": "by_employee",
      "employees": {
        "employee_uuid": "f0238368-f2cf-43e2-9a07-b0265f2cec69",
        "pay_schedule_uuid": "c277ac52-9871-4a96-a1e6-0c449684602a"
      }
    }
  },
  "description": "The representation of a pay schedule assignment."
}

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "single",
        "hourly_salaried",
        "by_employee",
        "by_department"
      ],
      "type": "string",
      "description": "The pay schedule assignment type."
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "employee_uuid": {
            "type": "string",
            "description": "Employee UUID"
          },
          "pay_schedule_uuid": {
            "type": "string",
            "description": "Pay schedule UUID"
          }
        }
      },
      "description": "List of employees and their pay schedules."
    },
    "departments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "department_uuid": {
            "type": "string",
            "description": "Department UUID"
          },
          "pay_schedule_uuid": {
            "type": "string",
            "description": "Pay schedule UUID"
          }
        }
      },
      "description": "List of departments and their pay schedules."
    },
    "hourly_pay_schedule_uuid": {
      "type": "string",
      "description": "Pay schedule for hourly employees."
    },
    "default_pay_schedule_uuid": {
      "type": "string",
      "description": "Default pay schedule for employees."
    },
    "salaried_pay_schedule_uuid": {
      "type": "string",
      "description": "Pay schedule for salaried employees."
    }
  }
}

{
  "type": "object",
  "x-tags": [
    "Pay Schedules"
  ],
  "properties": {
    "department_uuid": {
      "type": "string",
      "description": "The UUID of the department."
    },
    "pay_schedule_uuid": {
      "type": "string",
      "description": "The department's pay schedule UUID."
    }
  },
  "x-examples": {
    "example-1": {
      "department_uuid": "43b39ada-dc49-4879-9594-fe95f67ae434",
      "pay_schedule_uuid": "3f029a58-155d-4c30-8361-cc266b2c1f11"
    }
  }
}

{
  "type": "object",
  "x-tags": [
    "Pay Schedules"
  ],
  "properties": {
    "employee_uuid": {
      "type": "string",
      "description": "The UUID of the employee."
    },
    "pay_schedule_uuid": {
      "type": "string",
      "description": "The employee's pay schedule UUID."
    }
  },
  "x-examples": {
    "example-1": {
      "employee_uuid": "43b39ada-dc49-4879-9594-fe95f67ae434",
      "pay_schedule_uuid": "3f029a58-155d-4c30-8361-cc266b2c1f11"
    }
  }
}

{
  "type": "object",
  "x-tags": [
    "Pay Schedules"
  ],
  "properties": {
    "last_name": {
      "type": "string",
      "readOnly": true,
      "description": "The employee's last name."
    },
    "first_name": {
      "type": "string",
      "readOnly": true,
      "description": "The employee's first name."
    },
    "employee_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "The UUID of the employee."
    },
    "pay_frequency": {
      "type": "string",
      "readOnly": true,
      "description": "New pay schedule frequency and name."
    },
    "first_pay_period": {
      "$ref": "#/components/schemas/Pay-Schedule-Assignment-Pay-Period"
    },
    "transition_pay_period": {
      "$ref": "#/components/schemas/Pay-Schedule-Assignment-Transition-Pay-Period"
    }
  },
  "x-examples": {
    "example-1": {
      "last_name": "Parker",
      "first_name": "Penny",
      "employee_uuid": "43b39ada-dc49-4879-9594-fe95f67ae434",
      "pay_frequency": "Twice per month — Salaried pay schedule",
      "first_pay_period": {
        "end_date": "2023-08-01",
        "check_date": "2023-08-02",
        "start_date": "2023-07-01",
        "pay_schedule_uuid": "3f029a58-155d-4c30-8361-cc266b2c1f11"
      },
      "transition_pay_period": {
        "end_date": "2023-06-30",
        "start_date": "2023-06-20"
      }
    }
  }
}

{
  "type": "object",
  "x-tags": [
    "Pay Schedules"
  ],
  "properties": {
    "end_date": {
      "type": "string",
      "description": "Pay period end date."
    },
    "check_date": {
      "type": "string",
      "description": "Pay period check date."
    },
    "start_date": {
      "type": "string",
      "description": "Pay period start date."
    },
    "pay_schedule_uuid": {
      "type": "string",
      "description": "The pay schedule UUID."
    }
  },
  "x-examples": {
    "example-1": {
      "end_date": "2023-08-01",
      "check_date": "2023-08-02",
      "start_date": "2023-07-01",
      "pay_schedule_uuid": "3f029a58-155d-4c30-8361-cc266b2c1f11"
    }
  },
  "description": "Pay schedule assignment first pay period information."
}

{
  "type": "object",
  "x-tags": [
    "Pay Schedules"
  ],
  "properties": {
    "type": {
      "enum": [
        "single",
        "hourly_salaried",
        "by_employee",
        "by_department"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The pay schedule assignment type."
    },
    "employee_changes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Pay-Schedule-Assignment-Employee-Change"
      },
      "description": "A list of pay schedule changes including pay period and transition pay period."
    }
  },
  "x-examples": {
    "example-1": {
      "type": "hourly_salaried",
      "employee_changes": {
        "last_name": "Parker",
        "first_name": "Penny",
        "employee_uuid": "43b39ada-dc49-4879-9594-fe95f67ae434",
        "pay_frequency": "Twice per month — Salaried pay schedule",
        "first_pay_period": {
          "end_date": "2023-08-01",
          "check_date": "2023-08-02",
          "start_date": "2023-07-01",
          "pay_schedule_uuid": "3f029a58-155d-4c30-8361-cc266b2c1f11"
        },
        "transition_pay_period": {
          "end_date": "2023-06-30",
          "start_date": "2023-06-20"
        }
      }
    }
  },
  "description": "The representation of a pay schedule assignment preview."
}

{
  "type": "object",
  "x-tags": [
    "Pay Schedules"
  ],
  "properties": {
    "end_date": {
      "type": "string",
      "description": "Pay period end date."
    },
    "start_date": {
      "type": "string",
      "description": "Pay period start date."
    }
  },
  "x-examples": {
    "example-1": {
      "end_date": "2023-08-01",
      "start_date": "2023-07-01"
    }
  },
  "description": "Pay schedule assignment transition pay period information."
}

{
  "type": "object",
  "required": [
    "frequency",
    "anchor_pay_date",
    "anchor_end_of_pay_period"
  ],
  "properties": {
    "day_1": {
      "type": "integer",
      "nullable": true,
      "description": "An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the “Twice per month” and “Monthly” frequencies. It will be null for pay schedules with other frequencies."
    },
    "day_2": {
      "type": "integer",
      "nullable": true,
      "description": "An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the \"Twice per month\" frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, we will set the second pay date to the last day of the month. It will be null for pay schedules with other frequencies."
    },
    "frequency": {
      "enum": [
        "Every week",
        "Every other week",
        "Twice per month",
        "Monthly"
      ],
      "type": "string",
      "description": "The frequency that employees on this pay schedule are paid with Gusto."
    },
    "custom_name": {
      "type": "string",
      "description": "A custom pay schedule name, defaults to the pay frequency description."
    },
    "anchor_pay_date": {
      "type": "string",
      "example": "2020-05-15",
      "description": "The first date that employees on this pay schedule are paid with Gusto."
    },
    "anchor_end_of_pay_period": {
      "type": "string",
      "example": "2020-05-08",
      "description": "The last date of the first pay period. This can be the same date as the anchor pay date."
    }
  },
  "description": ""
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Pay-Period"
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Unprocessed-Termination-Pay-Period"
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Pay-Schedule"
  }
}

{
  "type": "object",
  "properties": {
    "holidays": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of dates for bank closures"
    },
    "pay_periods": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "end_date": {
            "type": "string",
            "description": "The last day of the pay period"
          },
          "check_date": {
            "type": "string",
            "description": "The payment date, \"Check date\", for the pay period"
          },
          "start_date": {
            "type": "string",
            "description": "The first day of the pay period"
          },
          "run_payroll_by": {
            "type": "string",
            "description": "The deadline to run payroll for direct deposit on the check date"
          }
        }
      },
      "description": "A list of pay periods for the previewed pay schedule"
    }
  },
  "description": "Pay schedule preview"
}

{
  "type": "object",
  "required": [
    "version"
  ],
  "properties": {
    "day_1": {
      "type": "integer",
      "nullable": true,
      "description": "An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the “Twice per month” and “Monthly” frequencies. It will be null for pay schedules with other frequencies."
    },
    "day_2": {
      "type": "integer",
      "nullable": true,
      "description": "An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the \"Twice per month\" frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, we will set the second pay date to the last day of the month. It will be null for pay schedules with other frequencies."
    },
    "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."
    },
    "frequency": {
      "enum": [
        "Every week",
        "Every other week",
        "Twice per month",
        "Monthly"
      ],
      "type": "string",
      "description": "The frequency that employees on this pay schedule are paid with Gusto."
    },
    "auto_pilot": {
      "type": "boolean",
      "description": "With Autopilot® enabled, payroll will run automatically one day before your payroll deadlines."
    },
    "custom_name": {
      "type": "string",
      "description": "A custom pay schedule name."
    },
    "anchor_pay_date": {
      "type": "string",
      "example": "2020-05-15",
      "description": "The first date that employees on this pay schedule are paid with Gusto."
    },
    "anchor_end_of_pay_period": {
      "type": "string",
      "example": "2020-05-08",
      "description": "The last date of the first pay period. This can be the same date as the anchor pay date."
    }
  },
  "description": ""
}

{
  "type": "object",
  "title": "Payment-Configs",
  "x-tags": [
    "Payment Configs"
  ],
  "properties": {
    "company_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "Company uuid"
    },
    "partner_uuid": {
      "type": "string",
      "readOnly": true,
      "description": "Partner uuid"
    },
    "payment_speed": {
      "type": "string",
      "readOnly": true,
      "description": "Payment speed for 1-day, 2-day, 4-day"
    },
    "fast_payment_limit": {
      "type": "string",
      "readOnly": true,
      "description": "Payment limit for 1-day or 2-day payroll"
    }
  },
  "x-examples": {
    "Example": {
      "company_uuid": "423dd616-6dbc-4724-938a-403f6217a933",
      "partner_uuid": "556f05d0-48e0-4c47-bce5-db9aea923043",
      "payment_speed": "2-day",
      "fast_payment_limit": "5000"
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The bank account name"
    },
    "uuid": {
      "type": "string",
      "description": "The bank account ID"
    },
    "priority": {
      "type": "integer",
      "description": "The order of priority for each payment split, with priority 1 being the first bank account paid. Priority must be unique and sequential."
    },
    "split_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The cents amount allocated for each payment split"
    },
    "hidden_account_number": {
      "type": "string",
      "description": "Masked bank account number"
    }
  },
  "description": "Representation of a bank account item"
}

{
  "type": "object",
  "required": [
    "fast_payment_limit",
    "payment_speed"
  ],
  "properties": {
    "payment_speed": {
      "enum": [
        "1-day",
        "2-day",
        "4-day"
      ],
      "type": "string",
      "description": "Gusto Embedded supports three payment speeds (1-day, 2-day, and 4-day). For next-day payments, funds are deposited in your team's bank account by the end of the next business day. Most people will see the funds arrive the next afternoon, but payments may arrive as late as the end of the business day."
    },
    "fast_payment_limit": {
      "type": "string",
      "description": "Fast payment limit. This limit is an aggregate of all fast payrolls amount."
    }
  },
  "description": ""
}