PUT /v2/team-members/{team_member_id}/wage-setting

Creates or updates a WageSetting object. The object is created if a WageSetting with the specified team_member_id does not exist. Otherwise, it fully replaces the WageSetting object for the team member. The WageSetting is returned on a successful update. Learn about Troubleshooting the Team API.

Servers

https://connect.squareup.com

Path parameters

Name	Type	Required	Description
`team_member_id`	String	Yes	The ID of the team member for which to update the `WageSetting` object.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`wage_setting`	Object	Yes	An object representing a team member's wage information.
`wage_setting.team_member_id`	String	No	The unique ID of the `TeamMember` whom this wage setting describes.
`wage_setting.is_overtime_exempt`	Boolean	No	Whether the team member is exempt from the overtime rules of the seller's country.
`wage_setting.job_assignments[]`	Array	No	Required. The ordered list of jobs that the team member is assigned to. The first job assignment is considered the team member's primary job. The minimum length is 1 and the maximum length is 12.
`wage_setting.job_assignments[].job_title`	String	Yes	The title of the job.
`wage_setting.job_assignments[].annual_rate`	Object	No	Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
`wage_setting.job_assignments[].annual_rate.amount`	Integer	No	The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.
`wage_setting.job_assignments[].annual_rate.currency`	String	No	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is `USD`. See Currency for possible values.
`wage_setting.job_assignments[].hourly_rate`	Object	No	Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
`wage_setting.job_assignments[].hourly_rate.amount`	Integer	No	The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.
`wage_setting.job_assignments[].hourly_rate.currency`	String	No	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is `USD`. See Currency for possible values.
`wage_setting.job_assignments[].weekly_hours`	Integer	No	The planned hours per week for the job. Set if the job `PayType` is `SALARY`.
`wage_setting.job_assignments[].pay_type`	String	Yes	The current pay type for the job assignment used to calculate the pay amount in a pay period.
`wage_setting.version`	Integer	No	Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write, potentially overwriting data from another write. For more information, see optimistic concurrency.
`wage_setting.created_at`	String	No	The timestamp, in RFC 3339 format, describing when the wage setting object was created. For example, "2018-10-04T04:00:00-07:00" or "2019-02-05T12:00:00Z".
`wage_setting.updated_at`	String	No	The timestamp, in RFC 3339 format, describing when the wage setting object was last updated. For example, "2018-10-04T04:00:00-07:00" or "2019-02-05T12:00:00Z".

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.