Create Employee

Creates a new Employee in QuickBooks.

Loading API schema for Employee…

curl -X POST "https://api.nx-us.net/api/v1/employee" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "X-Connection-Id: YOUR_CONNECTION_ID" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "isActive": "true", "salutation": "\"Dr.\"", "firstName": "\"John\"", "middleName": "\"A.\"", "lastName": "\"Doe\"", "jobTitle": "\"Purchasing Manager\"", "supervisorId": "<string>", "department": "\"Sales\"", "description": "\"This employee is a key employee.\"", "employeeAddress": { "line1": "<string>", "line2": "<string>", "line3": "<string>", "line4": "<string>", "line5": "<string>", "city": "<string>", "state": "<string>", "postalCode": "<string>", "country": "<string>", "note": "\"This employee is a key employee.\"" }, "printAs": "\"John Doe\"", "phone": "\"+1-555-123-4567\"", "mobile": "\"+1-555-555-1212\"", "pager": "\"+1-555-555-1212\"", "pagerPin": "\"1234\"", "alternatePhone": "<string>", "fax": "\"+1-555-555-1212\"", "email": "\"employee@example.com\"", "ssn": "\"123-45-6789\"", "additionalContacts": [ { "name": "<string>", "value": "<string>", "relation": "<string>" } ], "emergencyContacts": { "primaryContact": { "name": "<string>", "value": "<string>", "relation": "<string>" }, "secondaryContact": { "name": "<string>", "value": "<string>", "relation": "<string>" } }, "additionalNotes": [ { "note": "<string>" } ], "employeeType": "\"regular\"", "partOrFullTime": "<string>", "gender": "\"male\"", "hiredDate": "2024-01-01 00:00:00+00:00", "releasedDate": "<date>", "birthDate": "1990-01-01 00:00:00+00:00", "accountNumber": "\"1010\"", "notes": "<string>", "billingRateId": "<string>", "targetBonus": "\"10000.00\"", "exempt": "<string>", "keyEmployee": "<string>", "originalHireDate": "2024-01-01 00:00:00+00:00", "adjustedServiceDate": "2024-01-01 00:00:00+00:00", "usCitizen": "<string>", "ethnicity": "\"asian\"", "disabled": "<string>", "disabilityDesc": "<string>", "onFile": "<string>", "workAuthExpireDate": "<date>", "usVeteran": "<string>", "militaryStatus": "\"active\"", "employeePayrollInfo": { "payPeriod": "<string>", "paySchedule": { "id": "<string>", "fullname": "<string>" }, "class": { "id": "<string>", "fullname": "<string>" }, "clearEarnings": "<boolean>", "clearNonEarnings": "<boolean>", "useTimeDataToCreatePaychecks": "<string>", "sickHours": { "hoursAvailable": "<string>", "accrualPeriod": "<string>", "hoursAccrued": "<string>", "maximumHours": "<string>", "isResettingHoursEachNewYear": "<boolean>", "hoursUsed": "<string>", "yearBeginsDate": "<date>", "accrualStartDate": "<date>" }, "vacationHours": { "hoursAvailable": "<string>", "accrualPeriod": "<string>", "hoursAccrued": "<string>", "maximumHours": "<string>", "isResettingHoursEachNewYear": "<boolean>", "hoursUsed": "<string>", "yearBeginsDate": "<date>", "accrualStartDate": "<date>" } }, "externalId": "<string>", "suffix": "<string>" }'

{ "id": "<string>", "objectType": "<string>", "name": "<string>", "createdAt": "<date-time>", "updatedAt": "<date-time>", "revisionNumber": "<string>", "salutation": "<string>", "firstName": "<string>", "middleName": "<string>", "lastName": "<string>", "jobTitle": "<string>", "supervisor": { "id": "<string>", "fullname": "<string>" }, "department": "<string>", "description": "<string>", "targetBonus": "<number>", "employeeAddress": { "line1": "<string>", "line2": "<string>", "line3": "<string>", "line4": "<string>", "line5": "<string>", "city": "<string>", "state": "<string>", "postalCode": "<string>", "country": "<string>", "note": "\"This employee is a key employee.\"" }, "printAs": "<string>", "phone": "<string>", "mobile": "<string>", "pager": "<string>", "pagerPin": "<string>", "alternatePhone": "<string>", "fax": "<string>", "ssn": "<string>", "email": "<string>", "emergencyContacts": { "primaryContact": { "name": "<string>", "value": "<string>", "relation": "<string>" }, "secondaryContact": { "name": "<string>", "value": "<string>", "relation": "<string>" } }, "additionalContacts": [ { "name": "<string>", "value": "<string>" } ], "additionalNotes": [ { "noteId": "<integer>", "date": "<date>", "note": "<string>" } ], "employeeType": "<string>", "partOrFullTime": "<string>", "exempt": "<string>", "keyEmployee": "<string>", "gender": "<string>", "hiredDate": "<date>", "originalHireDate": "<date>", "adjustedServiceDate": "<date>", "releasedDate": "<date>", "birthDate": "<date>", "usCitizen": "<string>", "ethnicity": "<string>", "disabled": "<string>", "disabilityDesc": "<string>", "onFile": "<string>", "workAuthExpireDate": "<date>", "usVeteran": "<string>", "militaryStatus": "<string>", "accountNumber": "<string>", "notes": "<string>", "billingRate": { "id": "<string>", "fullname": "<string>" }, "employeePayrollInfo": { "payPeriod": "<string>", "paySchedule": { "id": "<string>", "fullname": "<string>" }, "class": { "id": "<string>", "fullname": "<string>" }, "clearEarnings": "<boolean>", "clearNonEarnings": "<boolean>", "useTimeDataToCreatePaychecks": "<string>", "sickHours": { "hoursAvailable": "<string>", "accrualPeriod": "<string>", "hoursAccrued": "<string>", "maximumHours": "<string>", "isResettingHoursEachNewYear": "<boolean>", "hoursUsed": "<string>", "yearBeginsDate": "<date>", "accrualStartDate": "<date>" }, "vacationHours": { "hoursAvailable": "<string>", "accrualPeriod": "<string>", "hoursAccrued": "<string>", "maximumHours": "<string>", "isResettingHoursEachNewYear": "<boolean>", "hoursUsed": "<string>", "yearBeginsDate": "<date>", "accrualStartDate": "<date>" } }, "externalId": "<string>", "isActive": "<boolean>", "customFields": [ { "ownerId": "<string>", "name": "<string>", "type": "<string>", "value": "<string>" } ] }