Create a payroll wage item

Creates a new payroll wage item.

post/quickbooks-desktop/payroll-wage-items

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Request body

namestring required

The case-insensitive unique name of this payroll wage item, unique across all payroll wage items.

NOTE: Payroll wage items do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

Maximum length: 31 characters.

isActiveboolean

Indicates whether this payroll wage item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Categorizes how this payroll wage item calculates pay - can be hourly (regular, overtime, sick, or vacation), salary (regular, sick, or vacation), bonus, or commission based.

overtimeMultiplierstring

The overtime pay multiplier for this payroll wage item, represented as a decimal string. For example, "1.5" represents time-and-a-half pay.

ratestring

The default rate for this payroll wage item, represented as a decimal string. Only one of rate and ratePercent can be set.

Decimal string format: up to 5 decimal places and up to 10 digits before the decimal point (for example, "123.45").

ratePercentstring

The default rate for this payroll wage item expressed as a percentage. Only one of rate and ratePercent can be set.

expenseAccountIdstring required

The expense account used to track wage expenses paid through this payroll wage item.

Example request

{
  "name": "Regular Pay",
  "isActive": true,
  "wageType": "hourly_regular",
  "overtimeMultiplier": "1.5",
  "rate": "15.00",
  "ratePercent": "10",
  "expenseAccountId": "80000001-1234567890"
}

Response

Returns the newly created payroll wage item.

idstring required

The unique identifier assigned by QuickBooks to this payroll wage item. This ID is unique across all payroll wage items but not across different QuickBooks object types.

objectType'qbd_payroll_wage_item' required

The type of object. This value is always "qbd_payroll_wage_item".

createdAtstring required

The date and time when this payroll wage item was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this payroll wage item was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this payroll wage item object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

namestring required

The case-insensitive unique name of this payroll wage item, unique across all payroll wage items.

NOTE: Payroll wage items do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

isActiveboolean required

Indicates whether this payroll wage item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Categorizes how this payroll wage item calculates pay - can be hourly (regular, overtime, sick, or vacation), salary (regular, sick, or vacation), bonus, or commission based.

overtimeMultiplierstring nullable required

The overtime pay multiplier for this payroll wage item, represented as a decimal string. For example, "1.5" represents time-and-a-half pay.

ratestring nullable required

The default rate for this payroll wage item, represented as a decimal string. Only one of rate and ratePercent can be set.

ratePercentstring nullable required

The default rate for this payroll wage item expressed as a percentage. Only one of rate and ratePercent can be set.

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_payroll_wage_item",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Regular Pay",
  "isActive": true,
  "wageType": "hourly_regular",
  "expenseAccount": {
    "id": "80000001-1234567890",
    "fullName": "Expenses:Payroll"
  },
  "overtimeMultiplier": "1.5",
  "rate": "15.00",
  "ratePercent": "10"
}

Changes

Changed in 4 of the 46 revisions of this API.1718

May 2, 20261de07095c4b71See the full diff
- ●
  the expenseAccountId request property's maxLength was set to 36
  request-property-max-length-set
Apr 20, 202610d4e9ebd1df61See the full diff
- ▲
  response property overtimeMultiplier list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property rate list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property ratePercent list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the expenseAccount response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property expenseAccount/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property expenseAccount/id from the response with the 200 status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the expenseAccount response property anyOf list for the response status 200
  response-property-any-of-added
Apr 20, 20268e0b7df2044d56See the full diff
- ▲
  the response property expenseAccount became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property overtimeMultiplier became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property rate became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property ratePercent became nullable for the status 200
  response-property-became-nullable
- ▲
  the expenseAccount response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ○
  removed subschema #1 subschema #2 from the expenseAccount response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  response property overtimeMultiplier list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property rate list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property ratePercent list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  added the required property expenseAccount/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property expenseAccount/id to the response with the 200 status
  response-required-property-added
Apr 20, 20265f832f69567561See the full diff
- ▲
  response property overtimeMultiplier list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property rate list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property ratePercent list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the expenseAccount response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property expenseAccount/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property expenseAccount/id from the response with the 200 status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the expenseAccount response property anyOf list for the response status 200
  response-property-any-of-added

Full history