An employee is a resource that executes work for a company and is associated with a financial transaction such as a timesheet entry or expense transaction. If the employee is also a user in Sage Intacct (which is required if they will be entering Time & Expenses), the employee must be associated with the correct Sage Intacct user.


List Employees

readByQuery

<readByQuery>
    <object>EMPLOYEE</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use EMPLOYEE
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Employee

read

<read>
    <object>EMPLOYEE</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use EMPLOYEE
keys Required string The employee RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Get Employee by Name

readByName

<readByName>
    <object>EMPLOYEE</object>
    <keys>E1234</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use EMPLOYEE
keys Required string The employee EMPLOYEEID to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Employee

create

<create>
    <EMPLOYEE>
        <PERSONALINFO>
            <CONTACTNAME>John Smith</CONTACTNAME>
        </PERSONALINFO>
    </EMPLOYEE>
</create>

Parameters

Name Required Type Description
EMPLOYEE Optional object The object to create

EMPLOYEE

Name Required Type Description
EMPLOYEEID Optional string The employee ID to create. Required if company does not use auto-numbering.
PERSONALINFO Required object Contact info
STARTDATE Optional string Start date in format mm/dd/yyyy
TITLE Optional string Title
SSN Optional string Social security number
EMPLOYEETYPE Optional string Employee type
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
BIRTHDATE Optional string Birth date in format mm/dd/yyyy
ENDDATE Optional string End date in format mm/dd/yyyy
TERMINATIONTYPE Optional string Termination type. Use voluntary, involuntary, deceased, disability, or retired
SUPERVISORID Optional string Manager employee ID
GENDER Optional string Gender
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID. Required only when an employee is created at the top level in a multi-entity, multi-base-currency company.
CLASSID Optional string Class ID
CURRENCY Optional string Default currency code
EARNINGTYPENAME Optional string Earning type name
POSTACTUALCOST Optional boolean Post actual cost. Use false for No, true for Yes. (Default: false)
NAME1099 Optional string Form 1099 name
FORM1099TYPE Optional string Form 1099 type
FORM1099BOX Optional string Form 1099 box
SUPDOCFOLDERNAME Optional string Attachment folder name
PAYMETHODKEY Optional string Preferred payment method
PAYMENTNOTIFY Optional boolean Send automatic payment notification. Use false for No, true for Yes. (Default: false)
MERGEPAYMENTREQ Optional boolean Merge payment requests. Use false for No, true for Yes. (Default: true)
ACHENABLED Optional boolean ACH enabled. Use false for No, true for Yes. (Default: false)
ACHBANKROUTINGNUMBER Optional string ACH bank routing number.
ACHACCOUNTNUMBER Optional string ACH bank account number.
ACHACCOUNTTYPE Optional string ACH bank account type.
ACHREMITTANCETYPE Optional string ACH bank account class.
Custom fields Optional varies This object supports custom fields.

PERSONALINFO

Name Required Type Description
CONTACTNAME Required string Contact name of an existing contact

Create Employee (Legacy)

create_employee

<create_employee>
    <employeeid>E1234</employeeid>
    <title>Project Manager</title>
    <locationid>100</locationid>
    <personalinfo>
        <contactname>Bill Jones (EE1234)</contactname>
    </personalinfo>
</create_employee>

Parameters

Name Required Type Description
employeeid Required string The employee ID to create. If company uses auto-numbering then leave blank.
ssn Optional string Social security number
title Optional string Title
locationid Optional string Location ID. Required only when an employee is created at the top level in a multi-entity, multi-base-currency company.
departmentid Optional string Department ID
classid Optional string Class ID
supervisorid Optional string Manager employee ID
birthdate Optional object Birth date
startdate Optional object Start date
enddate Optional object End date
terminationtype Optional string Termination type. Use voluntary, involuntary, deceased, disability, or retired
employeetype Optional string Employee type
gender Optional string Gender
status Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
currency Optional string Default currency code
name1099 Optional string Form 1099 name
form1099type Optional string Form 1099 type
form1099box Optional string Form 1099 box
earningtypename Optional string Earning type name
postactualcost Optional boolean Post actual cost. Use false for No, true for Yes. (Default: false)
personalinfo Required object Primary contact info
contactlist Optional contactitem[] Contact list
paymethod Optional string Preferred payment method
paymentnotify Optional boolean Send automatic payment notification. Use false for No, true for Yes. (Default: false)
achenabled Optional boolean ACH enabled. Use false for No, true for Yes. (Default: false)
achbankroutingnumber Optional string ACH bank routing number.
achaccountnumber Optional string ACH bank account number.
achaccounttype Optional string ACH bank account type.
achremittancetype Optional string ACH bank account class.
customfields Optional customfield[] Custom fields
mergepaymentreq Optional boolean Merge payment requests. Use false for No, true for Yes. (Default: true)

personalinfo

Name Required Type Description
contactname Required string Contact name of an existing contact

birthdate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

startdate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

enddate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

contactitem

Name Required Type Description
category Required string Category
contactname Required string Contact name of an existing contact

Update Employee

update

<update>
    <EMPLOYEE>
        <RECORDNO>12</RECORDNO>
        <TITLE>CEO</TITLE>
    </EMPLOYEE>
</update>

Parameters

Name Required Type Description
EMPLOYEE Optional object The object to update

EMPLOYEE

Name Required Type Description
RECORDNO Required integer Record number of employee
PERSONALINFO Optional object Contact info
STARTDATE Optional string Start date in format mm/dd/yyyy
TITLE Optional string Title
SSN Optional string Social security number
EMPLOYEETYPE Optional string Employee type
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
BIRTHDATE Optional string Birth date in format mm/dd/yyyy
ENDDATE Optional string End date in format mm/dd/yyyy
TERMINATIONTYPE Optional string Termination type. Use voluntary, involuntary, deceased, disability, or retired
SUPERVISORID Optional string Manager employee ID
GENDER Optional string Gender
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID
CLASSID Optional string Class ID
CURRENCY Optional string Default currency code
EARNINGTYPENAME Optional string Earning type name
POSTACTUALCOST Optional boolean Post actual cost. Use false for No, true for Yes. (Default: false)
NAME1099 Optional string Form 1099 name
FORM1099TYPE Optional string Form 1099 type
FORM1099BOX Optional string Form 1099 box
SUPDOCFOLDERNAME Optional string Attachment folder name
PAYMETHODKEY Optional string Preferred payment method
PAYMENTNOTIFY Optional boolean Send automatic payment notification. Use false for No, true for Yes. (Default: false)
ACHENABLED Optional boolean ACH enabled. Use false for No, true for Yes. (Default: false)
ACHBANKROUTINGNUMBER Optional string ACH bank routing number.
ACHACCOUNTNUMBER Optional string ACH bank account number.
ACHACCOUNTTYPE Optional string ACH bank account type.
ACHREMITTANCETYPE Optional string ACH bank account class.
Custom fields Optional varies This object supports custom fields.

PERSONALINFO

Name Required Type Description
CONTACTNAME Required string Contact name

Update Employee (Legacy)

update_employee

<update_employee employeeid="E1234">
    <title>CEO</title>
    <personalinfo>
        <contactname>Bill Jones (EE1234)</contactname>
    </personalinfo>
</update_employee>

Parameters

Name Required Type Description
employeeid Required string The employee ID to update
ssn Optional string Social security number
title Optional string Title
locationid Optional string Location ID
departmentid Optional string Department ID
classid Optional string Class ID
supervisorid Optional string Manager employee ID
birthdate Optional object Birth date
startdate Optional object Start date
enddate Optional object End date
terminationtype Optional string Termination type. Use voluntary, involuntary, deceased, disability, or retired.
employeetype Optional string Employee type
gender Optional string Gender
status Optional string Status. Use active for Active otherwise use inactive for Inactive.
currency Optional string Default currency code
name1099 Optional string Form 1099 name
form1099type Optional string Form 1099 type
form1099box Optional string Form 1099 box
earningtypename Optional string Earning type name
postactualcost Optional boolean Post actual cost. Use false for No, true for Yes.
personalinfo Required object Primary contact info
contactlist Optional contactitem[] Contact list
paymethod Optional string Preferred payment method
paymentnotify Optional boolean Send automatic payment notification. Use false for No, true for Yes.
achenabled Optional boolean ACH enabled. Use false for No, true for Yes.
achbankroutingnumber Optional string ACH bank routing number.
achaccountnumber Optional string ACH bank account number.
achaccounttype Optional string ACH bank account type.
achremittancetype Optional string ACH bank account class.
customfields Optional customfield[] Custom fields
mergepaymentreq Optional boolean Merge payment requests. Use false for No, true for Yes.

personalinfo

Name Required Type Description
contactname Required string Contact name of an existing contact

birthdate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

startdate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

enddate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

contactitem

Name Required Type Description
category Required string Category
contactname Required string Contact name of an existing contact

Delete Employee

delete

<delete>
    <object>EMPLOYEE</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use EMPLOYEE
keys Required string The employee RECORDNO to delete

Delete Employee (Legacy)

delete_employee

<delete_employee employeeid="E1234"></delete_employee>

Parameters

Name Required Type Description
employeeid Required string The employee ID to delete

Create Employee Cost Rate (Legacy)

create_employeerate

<create_employeerate>
    <employeeid>E1234</employeeid>
    <ratestartdate>
        <year>2016</year>
        <month>2</month>
        <day>1</day>
    </ratestartdate>
    <billingrate></billingrate>
    <salaryrate>75000.00</salaryrate>
</create_employeerate>

Parameters

Name Required Type Description
employeeid Required string Employee ID
ratestartdate Required object Start date
billingrate Optional currency Hourly rate. Do not use if salaryrate is set.
salaryrate Optional currency Annual salary. Do not use if billingrate is set.
customfields Optional customfield[] Custom fields

ratestartdate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

Update Employee Cost Rate (Legacy)

update_employeerate

<update_employeerate key="1234">
    <ratestartdate>
        <year>2016</year>
        <month>9</month>
        <day>15</day>
    </ratestartdate>
    <billingrate></billingrate>
    <salaryrate>80000.00</salaryrate>
</update_employeerate>

Parameters

Name Required Type Description
key Required integer Record number of rate to update
ratestartdate Optional object Start date
billingrate Optional currency Hourly rate. Do not use if salaryrate is set.
salaryrate Optional currency Annual salary. Do not use if billingrate is set.
customfields Optional customfield[] Custom fields

ratestartdate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

Delete Employee Cost Rate (Legacy)

delete_employeerate

<delete_employeerate key="1234"/>

Parameters

Name Required Type Description
key Required string Record number of rate to delete

Provide feedback