Supported Record Types
The following table outlines the record types that are currently supported by the Payroll Web Service. The columns denote the actions that can be performed on each record type.
| Record Type | NetSuite Name (ID if different) | description | get | list | search | add | update | delete | functions |
|---|---|---|---|---|---|---|---|---|---|
| employee | employee | employee record |  | | employeeSync | ||||
| department | department | department record | | | |||||
| classification | classification | classification record |
| | |||||
| location | location | location record | | | |||||
| payrate | Pay Component Sub Type (customrecord_pr_pcst) | pay rate for a given time period | | | |||||
| timeentry | Time Entry (timebill) | time representation for an employee for a date, pay rate and duration | | | | | |||
| subsidiary | subsidiary | subsidiary (NetSuite One World Only) | | | |||||
| taxscale | customrecord_payg_calc_type | The ATO tax scales | | | |||||
| workingweek | custentity_pr_working_week | Employee Working Week | | ||||||
| leaverequest | customrecord_pr_leave_request | Leave Request record | | | | getleaverequests updateleaverequest | |||
| payslippdf | customrecord_pr_document | PDF Payslip | | | |||||
| tfndeclaration | support planned for upcoming release | ||||||||
Employee
| Record Type: employee | |||
|---|---|---|---|
| Request Field | Description | NetSuite ID | Notes |
| id | unique numeric identifier for the employee record | internalid | first employee added to the account gets the -5 internal id (can't check positive) |
| externalid | unique identifier for the employee record set by external system | externalid | is unique but can be alphanumeric |
| salutation | Mr, Mrs etc | salutation | |
| firstname | first name of employee | firstname | |
| middlename | middle name of employee | middlename | |
| lastname | last name of employee | lastname | |
| email address of employee | |||
| jobtitleid | internal id of employee job title | custentity_pr_position_title | internalid of the employees job title (job titles are automatically matched and added in sync employee function) |
| gender | employee gender | gender | defaults to b if not set, either m for male or f for female |
| phone | phone | phone | |
| mobilephone | mobilephone | mobilephone | mobile phone |
| supervisor | employees immediate supervisor | supervisor | internalid of the employee's supervisor |
| hiredate | start date | hiredate | employee's start date (YYYY-MM-DD) |
| birthdate | date of birth | birthdate | employee's date of birth (YYYY-MM-DD) |
| releasedate | termination date | terminationdate | employee termination date (YYYY-MM-DD) |
| maritalstatus | marital status | maritalstatus | internalid of the employees marital status (Setup > Accounting > Employee Related Lists) |
| subsidiary | subsidiary of the employee | subsidiary | this field will be automatically set on all records associated to the employee |
| department | department | department | |
| classification | classification | classification | |
| location | location | location | |
Note: the employee fields listed are as returned from the get and getList operation, see syncEmployee request for a full list of fields that can be set and updated.
Department / Class / Location / Subsidiary
| Record Type: department / classification / location / subsidiary | |||
|---|---|---|---|
| Request Field | Description | NetSuite ID | Notes |
| inactive | whether the record is inactive | isinactive | set to T for inactive, F otherwise |
| id | unique record identifier | internalid | autonumber |
| externalid | external unique record identifier | externalid | primary key from external system |
| namenohierarchy | name of the record (e.g Sales, Accounting / Brisbane) | namenohierarchy | the name of the record |
| name | full name of the record | name | full name of the record with parent relationship (e.g NSW : Brisbane ) |
Pay Rate
| Record Type: payrate | |||
|---|---|---|---|
| Request Field | Description | NetSuite ID | Notes |
| inactive | whether the record is inactive | isinactive | set to T for inactive, F otherwise |
| id | unique numeric identifier for the record | internalid | The internalid for a given pay rate (note this can be different between accounts) |
| externalid | external unique record identifier | externalid | primary key from external system |
| name | name | name | For example Normal Time / Overtime etc. |
| showintimeentry | when setting a payrate on time entry only those rates available to show in time entry can be set | custrecord_pr_pcst_time_entry | set to T for available in time entry, F otherwise |
Time Entry
| Record Type: timeentry | |||
|---|---|---|---|
| Request Field | Description | NetSuite ID | Notes |
| id | internal id | internalid | |
| externalid | external unique record identifier | externalid | primary key from external system |
| employee | internal id of the employee | employee | |
| subsidiary | employee's subsidiary id | subsidiary | employee's subsidiary |
| reportingsubsidiary | internal id of subsidiary time was incurred in | custcol_pr_reportingsubsidiary | used for reporting only. |
| date | date of timeentry | date | start date e.g 2014-02-02 |
| startdatetime | start date and time of time entry | custcol_pr_time_startdt | field used for reporting only e.g 2014-02-10T08:40:35 |
| enddatetime | end date and time of time entry | custcol_pr_time_enddt | field used for reporting only e.g 2014-02-10T08:40:35 |
| duration | duration in hours | hours | system expects a decimal so you would sent 1.5 to record 1 hour and 30 minutes |
| payrateid | internal id of the pay rate | custcol_pr_pcst | |
| ispaid | returns true if time has been included in a payrun | custcol_pr_payrun | returned in search should not be set. |
| memo | description of work | memo | |
| department | internalid of department | department | if not set will default from employee |
| classification | internalid of classification | classification | if not set will default from employee |
| location | internalid of location | location | if not set will default from employee |
Payslip PDF
| Record Type: payslippdf | ||||||||
|---|---|---|---|---|---|---|---|---|
| Request Field | Description | NetSuite ID | Notes | |||||
| inactive | Whether the record is inactive | isinactive | Set to T for inactive, F otherwise | |||||
| id | Unique numeric identifier for the record | internalid | ||||||
| externalid | External unique record identifier | externalid | null if not set | |||||
| lastmodified | Last modified date of Payslip PDF | lastmodified | Formatted according to integration user's preferences | |||||
| name | Name of the Payslip | name | ||||||
| employee | Employee the payslip belongs to | custrecord_pr_prd_employee | ||||||
| file | File object including base64 encoded file binary content | custrecord_pr_prd_document | EXAMPLE:
| |||||