Skip to main content
GET
/
quickbooks-desktop
/
payroll-wage-items
/
{id}
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

const payrollWageItem = await conductor.qbd.payrollWageItems.retrieve('80000001-1234567890', {
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(payrollWageItem.id);
{
  "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"
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

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

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

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

Example:

"80000001-1234567890"

Response

200 - application/json

Returns the specified payroll wage item.

​
id
string
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.

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_payroll_wage_item"
Example:

"qbd_payroll_wage_item"

​
createdAt
string
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.

Example:

"2025-01-01T12:34:56+00:00"

​
updatedAt
string
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.

Example:

"2025-02-01T12:34:56+00:00"

​
revisionNumber
string
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.

Example:

"1721172183"

​
name
string
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.

Example:

"Regular Pay"

​
isActive
boolean
required

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

Example:

true

​
wageType
enum<string>
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.

Available options:
bonus,
commission,
hourly_overtime,
hourly_regular,
hourly_sick,
hourly_vacation,
salary_regular,
salary_sick,
salary_vacation
Example:

"hourly_regular"

​
expenseAccount
object
required

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

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Expenses:Payroll"
}
​
overtimeMultiplier
string | null
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.

Example:

"1.5"

​
rate
string | null
required

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

Example:

"15.00"

​
ratePercent
string | null
required

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

Example:

"10"