Employees

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 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 query 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": "100",
      • "href": "/objects/company-config/employee/32"
      },
    • {
      • "key": "52",
      • "id": "Emp2",
      • "href": "/objects/company-config/employee/52"
      },
    • {
      • "key": "17",
      • "id": "16",
      • "href": "/objects/company-config/employee/17"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
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 & Expenses), the employee and user must be associated with the same Sage Intacct contact.


SecurityOAuth2 
Request 
Request Body schema: application/json
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
 
 Example:  "A"
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 end date.


 
 Example:  "2026-04-30"
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 system can merge payment requests.


 
 Example:  true
sendAutomaticPaymentNotification
boolean
 Default:  false
Set to true to indicate system can send automatic payment notifications.


 
 Example:  true
object
Manager of the employee.


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "jsmith"
name
string or null
 
 Example:  "johnsmith"
gender
string or null
 Default:  null
Gender


 Enum: "female" "male" null  
 Example:  "female"
object
Department that the employee is associated with.


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "HR"
object
Class that the employee is associated with.


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "A"
defaultCurrency
string or null
Currency


 
 Example:  "USD"
object
employeeType


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "hourly"
object
earningType


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "hourly"
href
string
 
 Example:  "/objects/company-config/earning-type/1"
SSN
string or null
Employee social security number. Do not include dashes.


 
 Example:  "078051120"
object
This is a mapping for position and employee


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "permanent"
terminationType
string or null
 Default:  null
Termination type


 Enum: "deceased" "disability" "involuntary" null "retired" "voluntary"  
 Example:  "voluntary"
object
Form 1099 information for 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


 
enabled
boolean
Enable ACH.


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


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


 
 Example:  "11111111111"
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
Placeholder resource.


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


 
 Array 
bankAccountNumber
string
Bank account number for the bank file payment.


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


 
 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. Supported countries - Australia (AU) and South Africa (ZA).


 
 Example:  "Supplier Inc"
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"
object
Employee to reimburse for expenses incurred.


 
preferredPaymentMethod
string or null
 Default:  null
Preferred payment method


 Enum: "ach" "cash" "eft" null "printedCheck"  
 Example:  "cash"
object
Attachment folder name


 
key
string
 
 Example:  "1"
id
string or null
 
 Example:  "test"
href
string
 
 Example:  "/objects/company-config/folder/1"
Array of objects
costRates


 
 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 attached to employee object.


 
 Array 
key
string
 
 Example:  "7"
id
string
 
 Example:  "Care giver"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "jSmith",
  • "SSN": "650125930",
  • "jobTitle": "Accountants",
  • "status": "active",
  • "startDate": "2021-04-30",
  • "birthDate": "1984-04-13",
  • "endDate": "2026-04-30",
  • "gender": "female",
  • "name": "John Smith",
  • "terminationType": "voluntary",
  • "defaultCurrency": "USD",
  • "manager": {
    • "id": "11"
    },
  • "location": {
    • "id": "1"
    },
  • "department": {
    • "id": "3"
    },
  • "class": {
    • "id": "1"
    },
  • "earningType": {
    • "id": "Salaries"
    },
  • "isPostActualCostWithVariance": false,
  • "employeeType": {
    • "id": "2nd Level Employee"
    },
  • "primaryContact": {
    • "id": "Imam"
    },
  • "attachmentFolder": {
    • "id": "Attachment_hh",
    • "key": "1"
    },
  • "preferredPaymentMethod": "Cash",
  • "filePaymentService": "ACH",
  • "ach": {
    • "enabled": "true",
    • "bankRoutingNumber": "121000358",
    • "accountNumber": "54545454545454",
    • "accountType": "Checking Account",
    • "remittanceType": "personal(PPD)"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "52",
    • "id": "Emp3",
    • "href": "/objects/company-config/employee/52"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
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 for the employee.


 
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": "2026-04-30",
    • "status": "active",
    • "employeeType": {
      • "id": "2nd Level Employee",
      • "name": "2nd Level Employee",
      • "key": "6",
      • "href": "/objects/company-config/employee-type/6"
      },
    • "gender": "female",
    • "terminationType": "voluntary",
    • "name": "Smith",
    • "primaryContact": {
      • "id": "AMoore",
      • "companyName": "Sage",
      • "prefix": "Mr",
      • "firstName": "Andy",
      • "lastName": "Moore",
      • "middleName": "Robert",
      • "printAs": "Andy Moore",
      • "phone1": "9134598676",
      • "phone2": "null",
      • "mobile": "9133132299",
      • "pager": "null",
      • "fax": "9134598677",
      • "email1": "[email protected]",
      • "email2": "null",
      • "URL1": "http://andy.exampledomain.com",
      • "URL2": "null",
      • "mailingAddress": {
        },
      • "key": "68",
      • "href": "/objects/company-config/contact/68"
      },
    • "attachmentFolder": {
      • "id": "Admin Default Folder",
      • "key": "6",
      • "href": "/objects/company-config/folder/6"
      },
    • "defaultCurrency": "USD",
    • "form1099": {
      • "isForm1099": "true",
      • "type": "A",
      • "box": "D"
      },
    • "earningType": {
      • "key": "1",
      • "id": "Salaries",
      • "name": "Salaries",
      • "href": "/objects/company-config/earning-type/1"
      },
    • "isPostActualCostWithVariance": false,
    • "class": {
      • "id": "1",
      • "name": "class",
      • "key": "1"
      },
    • "preferredPaymentMethod": "Cash",
    • "filePaymentService": "ACH",
    • "ach": {
      • "enabled": "true",
      • "bankRoutingNumber": "121000358",
      • "accountNumber": "54545454545454",
      • "accountType": "Checking Account",
      • "remittanceType": "personal(PPD)"
      },
    • "canSendPaymentNotification": true,
    • "placeholderResource": false,
    • "mergePaymentRequests": true,
    • "employeePosition": {
      • "key": "1",
      • "id": "position"
      },
    • "audit": {
      • "createdDateTime": "2022-04-01T16:20:00Z",
      • "modifiedDateTime": "2022-04-01T16:20:00Z",
      • "createdBy": "1",
      • "modifiedBy": "95"
      },
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "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 for the employee.


 
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 end date.


 
 Example:  "2026-04-30"
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 system can merge payment requests.


 
 Example:  true
sendAutomaticPaymentNotification
boolean
 Default:  false
Set to true to indicate system can send automatic payment notifications.


 
 Example:  true
object
Manager of the employee.


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "jsmith"
name
string or null
 
 Example:  "johnsmith"
gender
string or null
 Default:  null
Gender


 Enum: "female" "male" null  
 Example:  "female"
object
Department that the employee is associated with.


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "HR"
object
Class that the employee is associated with.


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "A"
defaultCurrency
string or null
Currency


 
 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
 
 Example:  "A"
object
The mailing address of the contact.


 
object
employeeType


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "hourly"
object
earningType


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "hourly"
href
string
 
 Example:  "/objects/company-config/earning-type/1"
SSN
string or null
Employee social security number. Do not include dashes.


 
 Example:  "078051120"
object
This is a mapping for position and employee


 
key
string or null
 
 Example:  "1"
id
string or null
 
 Example:  "permanent"
terminationType
string or null
 Default:  null
Termination type


 Enum: "deceased" "disability" "involuntary" null "retired" "voluntary"  
 Example:  "voluntary"
object
Form 1099 information for 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


 
enabled
boolean
Enable ACH.


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


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


 
 Example:  "11111111111"
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
Placeholder resource.


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


 
 Array 
bankAccountNumber
string
Bank account number for the bank file payment.


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


 
 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. Supported countries - Australia (AU) and South Africa (ZA).


 
 Example:  "Supplier Inc"
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"
object
Employee to reimburse for expenses incurred.


 
preferredPaymentMethod
string or null
 Default:  null
Preferred payment method


 Enum: "ach" "cash" "eft" null "printedCheck"  
 Example:  "cash"
object
Attachment folder name


 
key
string
 
 Example:  "1"
id
string or null
 
 Example:  "test"
href
string
 
 Example:  "/objects/company-config/folder/1"
Array of objects
costRates


 
 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 attached to employee object.


 
 Array 
key
string
 
 Example:  "7"
id
string
 
 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 for the employee.


 
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
    }
}
Query employees
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "company-config/employee"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "company-config/employee",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "jobTitle"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "9",
      • "id": "djones",
      • "name": "David Jones",
      • "jobTitle": "Sales Director"
      },
    • {
      • "key": "22",
      • "id": "sryburn",
      • "name": "Suzanne Ryburn",
      • "jobTitle": "Sales Manager"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}