POST
/
quickbooks-desktop
/
payroll-wage-items
import Conductor from 'conductor-node';

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

async function main() {
  const payrollWageItem = await client.qbd.payrollWageItems.create({
    expenseAccountId: '80000001-1234567890',
    name: 'Regular Pay',
    wageType: 'bonus',
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(payrollWageItem.id);
}

main();
{
  "id": "80000001-1234567890",
  "objectType": "qbd_payroll_wage_item",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "name": "Regular Pay",
  "isActive": true,
  "wageType": "hourly_regular",
  "expenseAccount": {
    "id": "80000001-1234567890",
    "fullName": "Expenses:Payroll"
  }
}

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Body

application/json
​
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.

Maximum length: 31 characters.

Maximum length: 31
​
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
​
expenseAccountId
string
required

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

​
isActive
boolean
default:
true

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

Response

200 - application/json
Returns the newly created 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.

​
objectType
string
required

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

Allowed value: "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). The time zone is the same as the user's time zone in QuickBooks.

​
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). The time zone is the same as the user's time zone in QuickBooks.

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

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

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

​
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
​
expenseAccount
object
required

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

The Payroll Wage Item objectRetrieve a payroll wage item