QuickBooks: Create an employee

← employee operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.employee.create_an_employee

Provider route: POST /v3/company/{realmID}/employee. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/quickbooks with npm, or alter-sdk-quickbooks with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { QuickBooksIntegration } from "@alter-ai/quickbooks";

async function execute(input: Parameters<QuickBooksIntegration["employee"]["create"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new QuickBooksIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.employee.create(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_quickbooks import QuickBooksIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = QuickBooksIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.employee.create(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.minorversion	integer	Optional	Must equal: 75
query.requestid	string	Optional	Minimum length: 1
body	object	Required within parent	Fields not accepted: Id, SyncToken Additional keys: not allowed
body.Active	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
body.Active (anyOf 1)	boolean	Alternative
body.Active (anyOf 2)	string	Alternative	One of: true, false
body.BillRate	JSON	Optional	This attribute can only be set if BillableTime is true. Not supported when QuickBooks Payroll is enabled. Decimal string
body.BillRate (anyOf 1)	number	Alternative
body.BillRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.BillableTime	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
body.BillableTime (anyOf 1)	boolean	Alternative
body.BillableTime (anyOf 2)	string	Alternative	One of: true, false
body.BirthDate	string	Optional	Birth date of the employee.
body.CostRate	JSON	Optional	Pay rate of the employee Decimal string
body.CostRate (anyOf 1)	number	Alternative
body.CostRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.DisplayName	string	Optional	The name of the person or organization as displayed. Default Value: If not supplied, the system generates DisplayName by concatenating employee name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix . When QuickBooks Payroll is enabled, this attribute is read-only and a concatenation of GivenName , MiddleName , and FamilyName .
body.EmployeeNumber	string	Optional	Specifies the ID number of the employee in the employer’s directory.
body.FamilyName	string	Optional	Family name or the last name of the person. At least one of GivenName or FamilyName attributes is required.
body.Gender	string	Optional	Gender of the employee. To clear the gender value, set to Null in a full update request. Supported values include: Male or Female .
body.GivenName	string	Optional	Given name or Family name of a person. At least one of GivenName or FamilyName attributes is required.
body.HiredDate	string	Optional	Hire date of the employee.
body.MetaData	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
body.MiddleName	string	Optional	Middle name of the person. The person can have zero or more middle names.
body.Mobile	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
body.Organization	JSON	Optional	true —the object represents an organization. false —the object represents a person.
body.Organization (anyOf 1)	boolean	Alternative
body.Organization (anyOf 2)	string	Alternative	One of: true, false
body.PrimaryAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Represents the physical street address for this employee. If QuickBooks Payroll is enabled for the company, the following PhysicalAddress fields are required: City , maximum of 255 chars CountrySubDivisionCode , maximum of 255 chars PostalCode Required when QuickBooks Payroll is enabled. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
body.PrimaryEmailAddr	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
body.PrimaryPhone	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
body.PrintOnCheckName	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName . Cannot be removed with sparse update. Not supported when QuickBooks Payroll is enabled.
body.ReleasedDate	string	Optional	Release date of the employee.
body.SSN	string	Optional	Social security number (SSN) of the employee. If SSN is set, it is masked in the response with XXX-XX-XXXX. If XXX-XX-XXXX is sent in the create or update request, XXX-XX-XXXX is ignored and the old value is preserved. This attribute cannot be passed in a request when QuickBooks Payroll is enabled. Code for this field must be removed before submitting.
body.Suffix	string	Optional	Suffix of the name. For example, Jr . Not supported when QuickBooks Payroll is enabled.
body.Title	string	Optional	Title of the person. This tag supports i18n, all locale. Not supported when QuickBooks Payroll is enabled.
body.V4IDPseudonym	string	Optional	Employee reference number. For internal use only. Read only: true
body.domain	string	Optional
body.sparse	boolean	Optional

Referenced models: Full update companyinfo — request body — body Email, Read a bill — response body — Bill Meta Data, Create a vendor — request body — body Bill Addr, Create a vendor — request body — body Fax

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
time	string	Optional
Employee	Model	Optional	Expand Read an employee — response body — Employee

Referenced models: Read an employee — response body — Employee

Policy, approvals and errors

SDK function policy ID: quickbooks.employee.create_an_employee. Catalog operation: employee/create_an_employee. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source