COconductor-is

Retrieve a payroll wage item

Changed on

Retrieves a payroll wage item by ID.

IMPORTANT: If you need to fetch multiple specific payroll wage items by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/payroll-wage-items/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the payroll wage item to retrieve.

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns the specified 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.

wageType'bonus' | 'commission' | 'hourly_overtime' | 'hourly_regular' | 'hourly_sick' | 'hourly_vacation' | 'salary_regular' | 'salary_sick' | 'salary_vacation' required

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

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property overtimeMultiplier list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property rate list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property ratePercent list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status