Employees

An employee object represents someone who executes work for a company and is associated with financial transactions such as timesheet entries or expenses. If the employee is also a user in Sage Intacct (which is required if they will be entering time or expenses), the employee and user must be associated with the same Sage Intacct contact.

List employees

get/objects/company-config/employee

Returns a collection with a key, ID, and link for each employee. This operation is mostly for use in testing; use the query service to find employees that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "32",
      • "id": "jsmith",
      • "href": "/objects/company-config/employee/32"
      },
    • {
      • "key": "52",
      • "id": "rdas",
      • "href": "/objects/company-config/employee/52"
      },
    • {
      • "key": "17",
      • "id": "ajones",
      • "href": "/objects/company-config/employee/17"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an employee
post/objects/company-config/employee
Creates a new employee. If the employee is also a user in Sage Intacct (which is required if they will be entering time or expenses), set the primaryContact to the same contact that is associated with the user.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Employee to create


required
object
The contact object that represents the employee.


 
key
string
System-assigned unique key of the contact.


 
 Example:  "12345"
id
string or null
Unique ID of the contact.


 
 Example:  "rkincaid"
object
The mailing address of the contact.


 
id
string
Unique ID of the employee.


 
 Example:  "jsmith"
name
string
Name of the employee.


 
 Example:  "John Smith"
startDate
string or null <date> 
Employment start date.


 
 Example:  "2021-04-30"
jobTitle
string or null
Job title.


 
 Example:  "VP Sales"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
birthDate
string or null <date> 
Employee date of birth.


 
 Example:  "1984-04-13"
endDate
string or null <date> 
Employment termination date.


 
 Example:  "2026-04-01"
postActualCostWithVariance
boolean
 Default:  false
Set to true to indicate that the actual cost with variance is posted when earning type is salary.


 
 Example:  false
mergePaymentRequests
boolean
 Default:  true
Set to true to indicate that the system can merge payment requests.


 
 Example:  true
sendAutomaticPaymentNotification
boolean
 Default:  false
Set to true to indicate that the system can send automatic payment notifications when the employee is issued an expense reimbursement.


 
 Example:  true
object
Manager of the employee.


 
key
string or null
System-assigned unique key of the manager.


 
 Example:  "1"
id
string or null
Manager ID.


 
 Example:  "jsmith"
name
string or null
Manager name.


 
 Example:  "johnsmith"
gender
string or null
 Default:  null
Gender.


 Enum: "female" "male" null  
 Example:  "female"
object
The department that the employee works for.


 
key
string or null
Department key.


 
 Example:  "1"
id
string or null
Department ID.


 
 Example:  "HR"
object
Class that the employee is associated with.


 
key
string or null
Class key.


 
 Example:  "1"
id
string or null
Class ID.


 
 Example:  "A"
defaultCurrency
string or null
Currency to use for the employee's expense reports and payments, if different from the company's base currency. Only used if the company uses multiple transaction currencies.


 
 Example:  "USD"
object
Defines the status of employee, such as full time, part time, or contractor.


 
key
string or null
Employee type key.


 
 Example:  "1"
id
string or null
Employee type name.


 
 Example:  "hourly"
object
An earning type specifies the GL accounts that the employee's labor costs are posted to.


 
key
string or null
Earning type key.


 
 Example:  "1"
id
string or null
Earning type name.


 
 Example:  "Overtime pay"
SSN
string or null
Employee social security number. Do not include dashes.


 
 Example:  "078051120"
object
Reference to an employee position. Only used for construction.


 
key
string or null
Employee position key.


 
 Example:  "1"
id
string or null
Employee position ID.


 
 Example:  "SV001"
terminationType
string or null
 Default:  null
Termination status, if the employee has left the company.


 Enum: "deceased" "disability" "involuntary" null "retired" "voluntary"  
 Example:  "voluntary"
object
Form 1099 information for the employee.


 
name
string or null
Employee name as it appears on the 1099 form.


 
 Example:  "John Smith"
type
string or null
Type of form 1099.


 
 Example:  "MISC"
box
string or null
Box value of form 1099.


 
 Example:  "3"
object
ACH details if the employee is paid by ACH.


 
enabled
boolean
Enable ACH.


 
 Example:  false
bankRoutingNumber
string or null
ACH bank routing number.


 
 Example:  "325070760"
accountNumber
string or null
Account number.


 
 Example:  "3123123456"
accountType
string or null
Account type.


 Enum: "checkingAccount" null "savingsAccount"  
 Example:  "checkingAccount"
remittanceType
string or null
Account classification.


 Enum: "businessCCD" "businessCTX" null "personalPPD"  
 Example:  "personalPPD"
isPlaceholderResource
boolean
 Default:  false
Set to true to mark this employee as a placeholder resource. Only used for the Projects application.


 
 Example:  false
filePaymentService
string or null
 Default:  "none"
File payment service type.


 Enum: "ach" "bankFile" "none" null  
 Example:  "ach"
object
 
paymentCountryCode
string or null
Bank file payment country code. Required when filePaymentService is bankFile.


 Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "an" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" null "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "xk" "ye" "yt" "za" "zm" "zw"  
 Example:  "us"
paymentCurrency
string or null
Bank file payment currency.


 
 Example:  "EUR"
Array of objects
Bank file setup for the employee.


 
 Array 
bankAccountNumber
string
Bank account number for bank file payments.


 
 Example:  "IE26SCT666666"
bankAccountName
string
Bank account name for bank file payments.


 
 Example:  "Jane Blogs Corp."
bsbNumber
string or null
Bank branch number for the employee bank. Supported countries - Australia (AU).


 
 Example:  "047-359"
sortCode
string or null
Sort code for the bank file payment. Supported countries - United Kingdom (GB).


 
 Example:  "204718"
paymentReference
string or null
Payment reference number to connect the bank file and the expenses to be reimbursed. Used when the bank file does not have a reference number or when a payment contains multiple reference numbers. Supported countries - Australia (AU) and South Africa (ZA).


 
 Example:  "ZG8609"
branchCode
string or null
Branch code for the employee bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "213456"
bankAccountType
string or null
Account type to which employee payments are made. The available account types are determined by the bank file format that was selected for the associated checking account. Supported countries - South Africa (ZA).


 
 Example:  "4"
bankAccountCode
string or null
Account code for the employee bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "ACME345624"
printPaymentProof
boolean or null
 Default:  true
Specify whether to print the proof of payment when the bank file payment batch is authorized. Supported countries - South Africa (ZA).


 
 Example:  true
businessIdCode
string or null
Creditor bank identifier code for the bank account. Supported countries - All European countries where Generic-SEPA file format is supported.


 
 Example:  "AIBKIE2D491"
creditorCode
string or null
Creditor code for the bank account. Supported countries - Canada (CA).


 
 Example:  "1234567891234567"
secondaryIdentifier
string or null
Bank number, as assigned by the account CAD financial institution.  Supported countries - Canada (CA).


 
 Example:  "00710423598"
accountClassification
string or null
 Default:  "ccd"
Specifies the account classification for ACH transactions. Support countries - United States (US).


    

  • ppd: Prearranged Payment and Deposit for transactions with individual or consumer accounts. 
    • 

  • ccd: Corporate Credit or Debit for transactions with business or corporate accounts.
    • 



 Enum: "ccd" null "ppd"  
 Example:  "ccd"
object
Employee that the bank file setup is for.


 
preferredPaymentMethod
string or null
 Default:  null
Preferred payment method.


 Enum: "ach" "cash" "eft" null "printedCheck"  
 Example:  "cash"
object
Attachment folder for storing documents related to the employee.


 
key
string
Folder key.


 
 Example:  "1"
id
string or null
Folder ID.


 
 Example:  "RK495"
href
string
URL endpoint for the folder.


 
 Example:  "/objects/company-config/folder/1"
Array of objects
Employee cost rates.


 
 Array 
hourlyRate
string <decimal-precision-2> 
Normal hourly rate amount.


 
 Example:  "50"
annualSalary
string or null
Annual salary amount.


 
 Example:  "100000"
startDate
string <date> 
Start date of hourly rate or annual salary.


 
 Example:  "2023-04-01"
endDate
string <date> 
End date of of hourly rate or annual salary.


 
 Example:  "2023-04-01"
Array of objects
Array of positions and skills associated with an employee.


 
 Array 
key
string
Position skill key.


 
 Example:  "7"
id
string
Position skill ID.


 
 Example:  "Care giver"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "jSmith",
  • "SSN": "650125930",
  • "jobTitle": "Accountants",
  • "startDate": "2021-04-30",
  • "birthDate": "1984-04-01",
  • "name": "John Smith",
  • "defaultCurrency": "USD",
  • "manager": {
    • "id": "rkincaid"
    },
  • "location": {
    • "id": "WA"
    },
  • "department": {
    • "id": "ACCT"
    },
  • "earningType": {
    • "id": "Salaried"
    },
  • "postActualCostWithVariance": false,
  • "employeeType": {
    • "id": "Full Time"
    },
  • "primaryContact": {
    • "id": "rkincaid"
    },
  • "attachmentFolder": {
    • "key": "232"
    },
  • "preferredPaymentMethod": "cash"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "52",
    • "id": "Emp3",
    • "href": "/objects/company-config/employee/52"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an employee
get/objects/company-config/employee/{key}
Returns detailed information for a specified employee.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key of an employee.


 
 Example:  63
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "63",
    • "id": "jSmith",
    • "SSN": "650125930",
    • "jobTitle": "Accountant",
    • "location": {
      • "id": "1",
      • "key": "1",
      • "name": "United States of America",
      • "href": "/objects/company-config/location/1"
      },
    • "department": {
      • "id": "3",
      • "key": "3",
      • "name": "Engineering",
      • "href": "/objects/company-config/department/3"
      },
    • "manager": {
      • "key": "24",
      • "id": "11",
      • "name": "jsmith",
      • "href": "/objects/company-config/employee/24"
      },
    • "birthDate": "1984-04-13",
    • "startDate": "2021-04-30",
    • "endDate": null,
    • "status": "active",
    • "employeeType": {
      • "id": "Full Time",
      • "key": "6",
      • "href": "/objects/company-config/employee-type/6"
      },
    • "gender": "male",
    • "terminationType": null,
    • "name": "jsmith",
    • "primaryContact": {
      • "mailingAddress": {
        },
      • "URL1": "http://smith.com",
      • "URL2": null,
      • "companyName": "Sage",
      • "email1": "[email protected]",
      • "email2": null,
      • "fax": "9134598677",
      • "firstName": "John",
      • "id": "jsmith",
      • "lastName": "Smith",
      • "middleName": null,
      • "mobile": "9133132299",
      • "pager": null,
      • "phone1": "9134598676",
      • "phone2": null,
      • "prefix": "Mr",
      • "printAs": "John Smith",
      • "key": "68",
      • "href": "/objects/company-config/contact/68"
      },
    • "attachmentFolder": {
      • "id": "Admin Default Folder",
      • "key": "6",
      • "href": "/objects/company-config/folder/6"
      },
    • "defaultCurrency": "USD",
    • "form1099": {
      • "name": "John Smith",
      • "type": "A",
      • "box": "D"
      },
    • "earningType": {
      • "key": "1",
      • "id": "Salaries",
      • "href": "/objects/company-config/earning-type/1"
      },
    • "postActualCostWithVariance": false,
    • "audit": {
      • "createdDateTime": "2022-04-01T16:20:00Z",
      • "modifiedDateTime": "2022-04-01T16:20:00Z",
      • "createdBy": "1",
      • "modifiedBy": "95"
      },
    • "class": {
      • "id": null,
      • "name": null,
      • "key": null
      },
    • "preferredPaymentMethod": "cash",
    • "bankFile": {
      • "paymentCurrency": "EUR",
      • "paymentCountryCode": "gb"
      },
    • "filePaymentService": "none",
    • "ach": {
      • "enabled": false,
      • "bankRoutingNumber": null,
      • "accountNumber": null,
      • "accountType": null,
      • "remittanceType": null
      },
    • "sendAutomaticPaymentNotification": true,
    • "isPlaceholderResource": false,
    • "mergePaymentRequests": true,
    • "employeePosition": {
      • "key": "1",
      • "id": "writer"
      },
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "employeeRates": [ ],
    • "positionSkills": [ ],
    • "bankFileSetup": [ ],
    • "href": "/objects/company-config/employee/63"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an employee
patch/objects/company-config/employee/{key}
Updates an existing employee by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key of an employee.


 
 Example:  63
Request Body schema: application/json
name
string
Name of the employee.


 
 Example:  "John Smith"
startDate
string or null <date> 
Employment start date.


 
 Example:  "2021-04-30"
jobTitle
string or null
Job title.


 
 Example:  "VP Sales"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
birthDate
string or null <date> 
Employee date of birth.


 
 Example:  "1984-04-13"
endDate
string or null <date> 
Employment termination date.


 
 Example:  "2026-04-01"
postActualCostWithVariance
boolean
 Default:  false
Set to true to indicate that the actual cost with variance is posted when earning type is salary.


 
 Example:  false
mergePaymentRequests
boolean
 Default:  true
Set to true to indicate that the system can merge payment requests.


 
 Example:  true
sendAutomaticPaymentNotification
boolean
 Default:  false
Set to true to indicate that the system can send automatic payment notifications when the employee is issued an expense reimbursement.


 
 Example:  true
object
Manager of the employee.


 
key
string or null
System-assigned unique key of the manager.


 
 Example:  "1"
id
string or null
Manager ID.


 
 Example:  "jsmith"
name
string or null
Manager name.


 
 Example:  "johnsmith"
gender
string or null
 Default:  null
Gender.


 Enum: "female" "male" null  
 Example:  "female"
object
The department that the employee works for.


 
key
string or null
Department key.


 
 Example:  "1"
id
string or null
Department ID.


 
 Example:  "HR"
object
Class that the employee is associated with.


 
key
string or null
Class key.


 
 Example:  "1"
id
string or null
Class ID.


 
 Example:  "A"
defaultCurrency
string or null
Currency to use for the employee's expense reports and payments, if different from the company's base currency. Only used if the company uses multiple transaction currencies.


 
 Example:  "USD"
object
The contact object that represents the employee.


 
key
string
System-assigned unique key of the contact.


 
 Example:  "12345"
id
string or null
Unique ID of the contact.


 
 Example:  "rkincaid"
object
The mailing address of the contact.


 
object
Defines the status of employee, such as full time, part time, or contractor.


 
key
string or null
Employee type key.


 
 Example:  "1"
id
string or null
Employee type name.


 
 Example:  "hourly"
object
An earning type specifies the GL accounts that the employee's labor costs are posted to.


 
key
string or null
Earning type key.


 
 Example:  "1"
id
string or null
Earning type name.


 
 Example:  "Overtime pay"
SSN
string or null
Employee social security number. Do not include dashes.


 
 Example:  "078051120"
object
Reference to an employee position. Only used for construction.


 
key
string or null
Employee position key.


 
 Example:  "1"
id
string or null
Employee position ID.


 
 Example:  "SV001"
terminationType
string or null
 Default:  null
Termination status, if the employee has left the company.


 Enum: "deceased" "disability" "involuntary" null "retired" "voluntary"  
 Example:  "voluntary"
object
Form 1099 information for the employee.


 
name
string or null
Employee name as it appears on the 1099 form.


 
 Example:  "John Smith"
type
string or null
Type of form 1099.


 
 Example:  "MISC"
box
string or null
Box value of form 1099.


 
 Example:  "3"
object
ACH details if the employee is paid by ACH.


 
enabled
boolean
Enable ACH.


 
 Example:  false
bankRoutingNumber
string or null
ACH bank routing number.


 
 Example:  "325070760"
accountNumber
string or null
Account number.


 
 Example:  "3123123456"
accountType
string or null
Account type.


 Enum: "checkingAccount" null "savingsAccount"  
 Example:  "checkingAccount"
remittanceType
string or null
Account classification.


 Enum: "businessCCD" "businessCTX" null "personalPPD"  
 Example:  "personalPPD"
isPlaceholderResource
boolean
 Default:  false
Set to true to mark this employee as a placeholder resource. Only used for the Projects application.


 
 Example:  false
filePaymentService
string or null
 Default:  "none"
File payment service type.


 Enum: "ach" "bankFile" "none" null  
 Example:  "ach"
object
 
paymentCountryCode
string or null
Bank file payment country code. Required when filePaymentService is bankFile.


 Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "an" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" null "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "xk" "ye" "yt" "za" "zm" "zw"  
 Example:  "us"
paymentCurrency
string or null
Bank file payment currency.


 
 Example:  "EUR"
Array of objects
Bank file setup for the employee.


 
 Array 
bankAccountNumber
string
Bank account number for bank file payments.


 
 Example:  "IE26SCT666666"
bankAccountName
string
Bank account name for bank file payments.


 
 Example:  "Jane Blogs Corp."
bsbNumber
string or null
Bank branch number for the employee bank. Supported countries - Australia (AU).


 
 Example:  "047-359"
sortCode
string or null
Sort code for the bank file payment. Supported countries - United Kingdom (GB).


 
 Example:  "204718"
paymentReference
string or null
Payment reference number to connect the bank file and the expenses to be reimbursed. Used when the bank file does not have a reference number or when a payment contains multiple reference numbers. Supported countries - Australia (AU) and South Africa (ZA).


 
 Example:  "ZG8609"
branchCode
string or null
Branch code for the employee bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "213456"
bankAccountType
string or null
Account type to which employee payments are made. The available account types are determined by the bank file format that was selected for the associated checking account. Supported countries - South Africa (ZA).


 
 Example:  "4"
bankAccountCode
string or null
Account code for the employee bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "ACME345624"
printPaymentProof
boolean or null
 Default:  true
Specify whether to print the proof of payment when the bank file payment batch is authorized. Supported countries - South Africa (ZA).


 
 Example:  true
businessIdCode
string or null
Creditor bank identifier code for the bank account. Supported countries - All European countries where Generic-SEPA file format is supported.


 
 Example:  "AIBKIE2D491"
creditorCode
string or null
Creditor code for the bank account. Supported countries - Canada (CA).


 
 Example:  "1234567891234567"
secondaryIdentifier
string or null
Bank number, as assigned by the account CAD financial institution.  Supported countries - Canada (CA).


 
 Example:  "00710423598"
accountClassification
string or null
 Default:  "ccd"
Specifies the account classification for ACH transactions. Support countries - United States (US).


    

  • ppd: Prearranged Payment and Deposit for transactions with individual or consumer accounts. 
    • 

  • ccd: Corporate Credit or Debit for transactions with business or corporate accounts.
    • 



 Enum: "ccd" null "ppd"  
 Example:  "ccd"
object
Employee that the bank file setup is for.


 
preferredPaymentMethod
string or null
 Default:  null
Preferred payment method.


 Enum: "ach" "cash" "eft" null "printedCheck"  
 Example:  "cash"
object
Attachment folder for storing documents related to the employee.


 
key
string
Folder key.


 
 Example:  "1"
id
string or null
Folder ID.


 
 Example:  "RK495"
href
string
URL endpoint for the folder.


 
 Example:  "/objects/company-config/folder/1"
Array of objects
Employee cost rates.


 
 Array 
hourlyRate
string <decimal-precision-2> 
Normal hourly rate amount.


 
 Example:  "50"
annualSalary
string or null
Annual salary amount.


 
 Example:  "100000"
startDate
string <date> 
Start date of hourly rate or annual salary.


 
 Example:  "2023-04-01"
endDate
string <date> 
End date of of hourly rate or annual salary.


 
 Example:  "2023-04-01"
Array of objects
Array of positions and skills associated with an employee.


 
 Array 
key
string
Position skill key.


 
 Example:  "7"
id
string
Position skill ID.


 
 Example:  "Care giver"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "inactive",
  • "endDate": "2023-04-01",
  • "terminationType": "voluntary"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "52",
    • "id": "Emp2",
    • "href": "/objects/company-config/employee/52"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an employee
delete/objects/company-config/employee/{key}
Deletes an employee. 


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key of an employee.


 
 Example:  63
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}