Payroll Reporting

The payroll reporting objects allow a payroll application to submit data to Sage Intacct for reporting on construction payroll activities.

Payroll reporting entity relationship diagram

Payroll Report Checks

A PAYROLLREPORTCHECK object represents a direct-deposit employee paycheck and includes information such as the pay period start and end dates, the pay date, gross pay, net pay, etc.

Get Payroll Report Check Object Definition

lookup

List all the fields and relationships for the Payroll Report Check object:

<lookup>
    <object>PAYROLLREPORTCHECK</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTCHECK

Query and List Payroll Report Checks

query

List the recordno, check ID, and employee name of all payroll report checks:

<query>
    <object>PAYROLLREPORTCHECK</object>
    <select>
        <field>RECORDNO</field>
        <field>CHECKID</field>
        <field>EMPLOYEEID</field>
    </select>
</query>

Find a specific check by check ID, check type, and employee name :

<query>
    <object>PAYROLLREPORTCHECK</object>
    <filter>
        <and>
            <equalto>
                <field>CHECKID</field>
                <value>123-456-7880</value>
            </equalto>
            <equalto>
                <field>CHECKTYPE</field>
                <value>CalculatedCheck</value>
            </equalto>
            <equalto>
                <field>EMPLOYEEID</field>
                <value>ZBeeblebrox</value>
            </equalto>
        </and>
    </filter>
    <select>
        <field>RECORDNO</field>
        <field>CHECKID</field>
        <field>EMPLOYEEID</field>
        <field>GROSSPAY</field>
    </select>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTCHECK
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report Check

read

<read>
    <object>PAYROLLREPORTCHECK</object>
    <keys>66</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTCHECK
keys Required string Comma-separated list of RECORDNO of the payroll report checks to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report Check

A payroll report check object must have a unique combination of CHECKID, CHECKTYPE, and EMPLOYEEID.

create

<create>
    <PAYROLLREPORTCHECK>
        <EMPLOYEEID>ZBeeblebrox</EMPLOYEEID>
        <CHECKID>123-456-7881</CHECKID>
        <CHECKTYPE>CalculatedCheck</CHECKTYPE>
        <EXTERNALENTITYID>Young Bucks</EXTERNALENTITYID>
        <LEGALENTITYID>Top Level</LEGALENTITYID>
        <CHECKSTATUS>Pending</CHECKSTATUS>
        <REVISIONNUMBER>1</REVISIONNUMBER>
        <PAYROLLYEAR>2023</PAYROLLYEAR>
        <PAYPERIODNUMBER>01</PAYPERIODNUMBER>
    </PAYROLLREPORTCHECK>
</create>
Parameters
Name Required Type Description
PAYROLLREPORTCHECK Required object Type of object to create.

PAYROLLREPORTCHECK

Name Required Type Description
CHECKID Required string Check ID. This resembles a 16 byte GUID. Duplicate CHECKID values are allowed, but the combination of EMPLOYEEID, CHECKID, and CHECKTYPE must be unique.
CHECKTYPE Required string Check type, such as “CalculatedCheck” or “PayrollAdjustment,” etc.
EMPLOYEEID Required string EMPLOYEEID of the employee that the check is for.
LEGALENTITYID Required string Legal entity ID.
EXTERNALENTITYID Required string External payroll entity, typically an entity in Intacct. Use Top Level to indicate the top level (null) entity.
CHECKSTATUS Required string Check status, such as Pending, Approved or Voided.
REVISIONNUMBER Required decimal Check revision number.
PAYROLLYEAR Required decimal Payroll year.
PAYPERIODNUMBER Required decimal Pay period number.
WASPOSTED Optional Boolean Check posting status:
  • false - Check has not been posted (default)
  • true - Check has been posted
TIMECARDSWEREEXPORTED Optional Boolean Time card export status:
  • false - Time cards have not been exported (default)
  • true - Time cards have been exported
WASPAID Required Boolean Funds transfer status:
  • false - Funds have not been transferred (default)
  • true - Funds have been transferred to the employee's bank account
WASCHECKSTUBGENERATED Optional Boolean Check stub status:
  • false - Check stub has not been generated (default)
  • true - Check stub has been generated
WASADVICENOTICEGENERATED Optional Boolean Advice notice status:
  • false - Advice notice has not been posted (default)
  • true - Advice notice has been generated
CHECKDATE Optional date Check date. Many formats are supported, including:
  • yy-mm-dd
  • mm-dd (current year is assumed)
  • a month and day such as April 1 (current year is assumed)
  • A day of the week such as Friday (interpreted as the upcoming Friday)
PAYGROUPID Optional string Pay group identifier, such as “Weekly”, Bi-weekly”, “Monthly”, etc.
PERIODBEGINDATE Optional date Pay period begin date.
PERIODENDDATE Optional date Pay period end date.
ERRORMESSAGE Optional string Error message, if CHECKSTATUS = Error.
GROSSPAY Optional decimal Gross pay.
NETPAY Optional decimal Net pay.
EMPLOYEEISDISABLED Optional Boolean Employee disability status:
  • false - Employee is not disabled (default)
  • true - Employee is disabled
EMPLOYEEISFULLTIME Optional Boolean Employee full-time employment status:
  • false - Employee is not full-time (default)
  • true - Employee is full-time
EMPLOYEEISSEASONAL Optional Boolean Employee seasonal status:
  • false - Employee is not a seasonal employee (default)
  • true - Employee is a seasonal employee
EMPLOYEEISSTATUTORY Optional Boolean Employee statutory status:
  • false - Employee is not a statutory employee (default)
  • true - Employee is a statutory employee
EMPLOYEEACCEPTSELECTRONICW2 Optional Boolean Whether employee accepts electronic W2s:
  • false - Employee does not accept electronic W2 forms (default)
  • true - Employee accepts electronic W2 forms
EMPLOYEEETHNICITY Optional string Employee ethnicity
EMPLOYEEEEOJOBCATEGORY Optional string Employee EEO job category
EMPLOYEEEEOETHNICITY Optional string Employee EEO ethnicity
EMPLOYEECAEEOETHNICITY Optional string Employee CAEEO ethnicity
SOURCESYSTEM Optional string Source system
LOCATIONID Optional string LOCATIONID of an active location to associate with the check.
PROJECTID Optional string PROJECTID of an active project to associate with the check.
CUSTOMERID Optional string CUSTOMERID of an active customer to associate with the check.
VENDORID Optional string VENDORID of an active vendor to associate with the check.
ITEMID Optional string ITEMID of an active item to associate with the check.
TASKID Optional string TASKID of an active task to associate with the check.
CLASSID Optional string CLASSID of an active class to associate with the check.
COSTTYPEID Optional string COSTTYPEID of an active cost type to associate with the check.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Update a Payroll Report Check

update

<update>
    <PAYROLLREPORTCHECK>
        <RECORDNO>9</RECORDNO>
        <CHECKSTATUS>Approved</CHECKSTATUS>
        <REVISIONNUMBER>2</REVISIONNUMBER>
    </PAYROLLREPORTCHECK>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTCHECK Required object Type of object to update.

PAYROLLREPORTCHECK

Name Required Type Description
RECORDNO Required integer RECORDNO of the payroll report check to update.
CHECKID Optional string Check ID. This resembles a 16 byte GUID. Duplicate check IDs are allowed.
CHECKTYPE Optional string (enum) Check type.
  • CalculatedCheck
  • PayrollAdjustment
  • Void
EMPLOYEEID Optional string EMPLOYEEID of the employee that the check is for.
LEGALENTITYID Optional string Legal entity ID.
EXTERNALENTITYID Optional string External payroll entity, typically an entity in Intacct. Use Top Level to indicate the top level (null) entity.
CHECKSTATUS Optional string (enum) Check status, such as Pending, Approved or Voided.
WASPOSTED Optional Boolean Check posting status:
  • false - Check has not been posted (default)
  • true - Check has been posted
TIMECARDSWEREEXPORTED Optional Boolean Time card export status:
  • false - Time cards have not been exported (default)
  • true - Time cards have been exported
WASPAID Optional Boolean Funds transfer status:
  • false - Funds have not been transferred (default)
  • true - Funds have been transferred to the employee's bank account
WASCHECKSTUBGENERATED Optional Boolean Check stub status:
  • false - Check stub has not been generated (default)
  • true - Check stub has been generated
WASADVICENOTICEGENERATED Optional Boolean Advice notice status:
  • false - Advice notice has not been posted (default)
  • true - Advice notice has been generated
CHECKDATE Optional date Check date. Many formats are supported, including:
  • yy-mm-dd
  • mm-dd (current year is assumed)
  • a month and day such as April 1 (current year is assumed)
  • A day of the week such as Friday (interpreted as the upcoming Friday)
REVISIONNUMBER Optional decimal Check revision number.
PAYGROUPID Optional string Pay group identifier, such as “Weekly”, Bi-weekly”, “Monthly”, etc.
PAYPERIODNUMBER Optional decimal Pay period number.
PAYROLLYEAR Optional decimal Payroll year.
PERIODBEGINDATE Optional date Pay period begin date.
PERIODENDDATE Optional date Pay period end date.
ERRORMESSAGE Optional string Error message, if CHECKSTATUS = Error.
GROSSPAY Optional decimal Gross pay.
NETPAY Optional decimal Net pay.
EMPLOYEEISDISABLED Optional Boolean Employee disability status:
  • false - Employee is not disabled (default)
  • true - Employee is disabled
EMPLOYEEISFULLTIME Optional Boolean Employee full-time employment status:
  • false - Employee is not full-time (default)
  • true - Employee is full-time
EMPLOYEEISSEASONAL Optional Boolean Employee seasonal status:
  • false - Employee is not a seasonal employee (default)
  • true - Employee is a seasonal employee
EMPLOYEEISSTATUTORY Optional Boolean Employee statutory status:
  • false - Employee is not a statutory employee (default)
  • true - Employee is a statutory employee
EMPLOYEEACCEPTSELECTRONICW2 Optional Boolean Whether employee accepts electronic W2s:
  • false - Employee does not accept electronic W2 forms (default)
  • true - Employee accepts electronic W2 forms
EMPLOYEEETHNICITY Optional string Employee ethnicity
EMPLOYEEEEOJOBCATEGORY Optional string Employee EEO job category
EMPLOYEEEEOETHNICITY Optional string Employee EEO ethnicity
EMPLOYEECAEEOETHNICITY Optional string Employee CAEEO ethnicity
SOURCESYSTEM Optional string Source system
LOCATIONID Optional string LOCATIONID of an active location to associate with the check.
PROJECTID Optional string PROJECTID of an active project to associate with the check.
CUSTOMERID Optional string CUSTOMERID of an active customer to associate with the check.
VENDORID Optional string VENDORID of an active vendor to associate with the check.
ITEMID Optional string ITEMID of an active item to associate with the check.
TASKID Optional string TASKID of an active task to associate with the check.
CLASSID Optional string CLASSID of an active class to associate with the check.
COSTTYPEID Optional string COSTTYPEID of an active cost type to associate with the check.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Delete a Payroll Report Check

delete

<delete>
    <object>PAYROLLREPORTCHECK</object>
    <keys>66</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTCHECK
keys Required string RECORDNO of the payroll report check to delete.

Payroll Report Employees

A PAYROLLREPORTEMPLOYEE object represents employee setup information for use with reporting that help facilitate validation of payroll configuration as well as extended categorization of payroll data.

Get Payroll Report Employee Object Definition

lookup

List all the fields and relationships for the Payroll Report Employee object:

<lookup>
    <object>PAYROLLREPORTEMPLOYEE</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTEMPLOYEE

Query and List Payroll Report Employees

query

List the recordno, employee ID, and start date of all active full-time employees :

<query>
    <object>PAYROLLREPORTEMPLOYEE</object>
    <select>
        <field>RECORDNO</field>
        <field>EMPLOYEEID</field>
        <field>EFFECTIVEDATE</field>
    </select>
    <filter>
        <and>
            <equalto>
                <field>ACTIVERECORD</field>
                <value>true</value>
            </equalto>
            <equalto>
                <field>ISFULLTIME</field>
                <value>true</value>
            </equalto>
        </and>
    </filter>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTEMPLOYEE
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report Employee

read

<read>
    <object>PAYROLLREPORTEMPLOYEE</object>
    <keys>3086</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTEMPLOYEE
keys Required string Comma-separated list of RECORDNO of the payroll report employees to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report Employee

A payroll report employee object must have a unique EMPLOYEEID.

create

<create>
    <PAYROLLREPORTEMPLOYEE>
        <EMPLOYEEID>ZBeeblebrox</EMPLOYEEID>
        <EFFECTIVEDATE>23-04-01</EFFECTIVEDATE>
        <PAYGROUPID>44</PAYGROUPID>
    </PAYROLLREPORTEMPLOYEE>
</create>
Parameters
Name Required Type Description
PAYROLLREPORTEMPLOYEE Required object Type of object to create.

PAYROLLREPORTEMPLOYEE

Name Required Type Description
EMPLOYEEID Required string Employee ID.
EFFECTIVEDATE Required date Effective date for the employee.
EXPIRATIONDATE Optional date Expiration date for the employee.
ACTIVERECORD Optional Boolean Specifies whether the employee is active.
PAYGROUPID Required string Pay group identifier assigned for the employee.
ISDISABLED Optional Boolean Specifies whether the employee is disabled.
ISFULLTIME Optional Boolean Specifies whether the employee is full time.
ISSEASONAL Optional Boolean Specifies whether the employee is seasonal.
ISSTATUTORY Optional Boolean Specifies whether the employee is statutory.
EXCLUDEFROMCERTIFIEDPAYROLL Optional Boolean Specifies whether the employee is excluded from certified payroll reporting.
ACCEPTSELECTRONICW2 Optional Boolean Specifies whether the employee accepts electronic W2.
ETHNICITY Optional string The employee’s ethnicity.
EEOJOBCATEGORY Optional string The employee’s equal employment opportunity job category.
EEOETHNICITY Optional string The employee’s equal employment opportunity ethnicity.
CAEEOETHNICITY Optional string The employee’s California equal employment opportunity ethnicity.
STANDARDOCCUPATIONALCLASSIFICATIONCODE Optional string The employee’s standard occupational classification code used by U.S. federal agencies to classify workers into occupational categories.
ALASKAGEOGRAPHICCODE Optional string The employee’s code corresponding to specific Alaskan region.
DEFAULTTRADEID Optional string The employee’s default trade identifier.
PTOACCRUALBASISDATE Optional date The date that sets the years of service for PTO accrual.
PTOACCRUALSCHEDULES Optional string Concatenated string of PTO Accrual Schedule identifiers associated with this payroll report employee.
REVISIONNUMBER Optional string Revision number of the payroll report employee.
PAYROLLREPORTEMPLOYEETRADEDETAILS Optional array of PAYROLLREPORTEMPLOYEETRADEDETAIL Trade details that apply to the specified employee.
PAYROLLREPORTEMPLOYEETAXCLASSIFICATIONS Optional array of PAYROLLREPORTEMPLOYEETAXCLASSIFICATION Payroll tax details for the specified employee.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

PAYROLLREPORTEMPLOYEETRADEDETAIL

Name Required Type Description
PAYROLLEMPLOYEEKEY Required integer The unique key that identifies the payroll report employee.
EMPLOYEEID Optional string The employee ID of the payroll report employee.
TRADEID Optional string The identifier of the trade and unique in PAYROLLREPORTTRADE. Also referenced to identify the trade in PAYROLLREPORTTIMECARD.
TRADELEVELID Optional string The trade level identifier used in PAYROLLREPORTTIMECARD and identifies trade levels such as “Apprentice,” “Journeyman,” etc.
UNIONLOCALID Optional string Local union ID and referenced in PAYROLLREPORTPAYMODIFIER.

PAYROLLREPORTEMPLOYEETAXCLASSIFICATION

Name Required Type Description
PAYROLLEMPLOYEEKEY Required integer The unique key that identifies the payroll report employee.
EMPLOYEEID Optional string The employee ID of the payroll report employee.
TAXID Optional string User-defined unique ID, used to reference a PAYROLLREPORTTAXSETUP object from a PAYROLLREPORTTAX object.
TAXCATEGORYID Optional string Tax category ID, such as PA-EIT, PA-LST, SUT, WC
CLASSIFICATIONCODE Optional string Tax classification code.

Update a Payroll Report Employee

update

<update>
    <PAYROLLREPORTEMPLOYEE>
        <RECORDNO>38</RECORDNO>
        <PAYGROUPID>56</PAYGROUPID>
        <ACCEPTSELECTRONICW2>true</ACCEPTSELECTRONICW2>
    </PAYROLLREPORTEMPLOYEE>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTEMPLOYEE Required object Type of object to update.

PAYROLLREPORTEMPLOYEE

Name Required Type Description
RECORDNO Required integer RECORDNO of the payroll report employee to update.
EMPLOYEEID Required string Employee ID.
EFFECTIVEDATE Required date Effective date for the employee.
EXPIRATIONDATE Optional date Expiration date for the employee.
ACTIVERECORD Optional Boolean Specifies whether the employee is active.
PAYGROUPID Required string Pay group identifier assigned for the employee.
ISDISABLED Optional Boolean Specifies whether the employee is disabled.
ISFULLTIME Optional Boolean Specifies whether the employee is full time.
ISSEASONAL Optional Boolean Specifies whether the employee is seasonal.
ISSTATUTORY Optional Boolean Specifies whether the employee is statutory.
EXCLUDEFROMCERTIFIEDPAYROLL Optional Boolean Specifies whether the employee is excluded from certified payroll reporting.
ACCEPTSELECTRONICW2 Optional Boolean Specifies whether the employee accepts electronic W2.
ETHNICITY Optional string The employee’s ethnicity.
EEOJOBCATEGORY Optional string The employee’s equal employment opportunity job category.
EEOETHNICITY Optional string The employee’s equal employment opportunity ethnicity.
CAEEOETHNICITY Optional string The employee’s California equal employment opportunity ethnicity.
STANDARDOCCUPATIONALCLASSIFICATIONCODE Optional string The employee’s standard occupational classification code used by U.S. federal agencies to classify workers into occupational categories.
ALASKAGEOGRAPHICCODE Optional string The employee’s code corresponding to specific Alaskan region.
DEFAULTTRADEID Optional string The employee’s default trade identifier.
PTOACCRUALBASISDATE Optional date The date that sets the years of service for PTO accrual.
PTOACCRUALSCHEDULES Optional string Concatenated string of PTO Accrual Schedule identifiers associated with this payroll report employee.
REVISIONNUMBER Optional string Revision number of the payroll report employee.
PAYROLLREPORTEMPLOYEETRADEDETAILS Optional array of PAYROLLREPORTEMPLOYEETRADEDETAIL Trade details that apply to the specified employee.
PAYROLLREPORTEMPLOYEETAXCLASSIFICATIONS Optional array of PAYROLLREPORTEMPLOYEETAXCLASSIFICATION Payroll tax details for the specified employee.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

PAYROLLREPORTEMPLOYEETRADEDETAIL

Name Required Type Description
PAYROLLEMPLOYEEKEY Required integer The unique key that identifies the payroll report employee.
EMPLOYEEID Optional string The employee ID of the payroll report employee.
TRADEID Optional string The identifier of the trade and unique in PAYROLLREPORTTRADE. Also referenced to identify the trade in PAYROLLREPORTTIMECARD.
TRADELEVELID Optional string The trade level identifier used in PAYROLLREPORTTIMECARD and identifies trade levels such as “Apprentice,” “Journeyman,” etc.
UNIONLOCALID Optional string Local union ID and referenced in PAYROLLREPORTPAYMODIFIER.

PAYROLLREPORTEMPLOYEETAXCLASSIFICATION

Name Required Type Description
PAYROLLEMPLOYEEKEY Required integer The unique key that identifies the payroll report employee.
EMPLOYEEID Optional string The employee ID of the payroll report employee.
TAXID Optional string User-defined unique ID, used to reference a PAYROLLREPORTTAXSETUP object from a PAYROLLREPORTTAX object.
TAXCATEGORYID Optional string Tax category ID, such as PA-EIT, PA-LST, SUT, WC
CLASSIFICATIONCODE Optional string Tax classification code.

Delete a Payroll Report Employee

delete

<delete>
    <object>PAYROLLREPORTEMPLOYEE</object>
    <keys>3086</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTEMPMLOYEE
keys Required string RECORDNO of the payroll report employee to delete.

Payroll Report Trade

A PAYROLLREPORTTRADE object represents the employment trade details for individual employees. For use with reporting that helps facilitate validation of payroll information as well as extended categorization of payroll data.

Get Payroll Report Trade Object Definition

lookup

List all the fields and relationships for the Payroll Report Trade object:

<lookup>
    <object>PAYROLLREPORTTRADE</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTRADE

Query and List Payroll Report Trades

query

List the recordno, trade ID, and work classification of all active trades:

<query>
    <object>PAYROLLREPORTTRADE</object>
    <select>
        <field>RECORDNO</field>
        <field>TRADEID</field>
        <field>WORKCLASSIFICATION</field>
    </select>
    <filter>
        <and>
            <equalto>
                <field>WORKCLASSIFICATION</field>
                <value>non-exempt</value>
            </equalto>
        </and>
    </filter>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTRADE
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report Trade

read

<read>
    <object>PAYROLLREPORTTRADE</object>
    <keys>2011</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTRADE
keys Required string Comma-separated list of RECORDNO of the payroll report trades to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report Trade

A payroll report trade object must have a unique TRADEID.

create

    <create>
      <PAYROLLREPORTTRADE>
        <TRADEID>889</TRADEID>
        <WORKCLASSIFICATION>FF45</WORKCLASSIFICATION>
        <WORKCLASSIFICATIONCODE>67</WORKCLASSIFICATIONCODE>
        <REVISIONNUMBER>2</REVISIONNUMBER>
        <PAYROLLREPORTTRADELEVEL>
          <TRADEKEY>627</TRADEKEY>
          <TRADELEVELID>Apprentice</TRADELEVELID>
          <CLASSLEVEL>yu78</CLASSLEVEL>
          <CLASSPERSCENT>78</CLASSPERSCENT>
        </PAYROLLREPORTTRADELEVEL>
      </PAYROLLREPORTTRADE>
    </create>
Parameters
Name Required Type Description
PAYROLLREPORTTRADE Required object Type of object to create.

PAYROLLREPORTTRADE

Name Required Type Description
TRADEID Required string The identifier of the trade.
WORKCLASSIFICATION Optional string The general classification under which the trade falls.
WORKCLASSIFICATIONCCODE Optional string The unique code used for WORKCLASSIFICATION.
PAYROLLREPORTTRADELEVELS Optional array of PAYROLLREPORTTRADELEVEL The trade levels defined for a specified trade.
PAYROLLREPORTTRADETAXCLASSIFICATIONS Optional array of PAYROLLREPORTTRADETAXCLASSIFICATION The classifications details used for the trade taxes.
REVISIONNUMBER Optional decimal Revision number of the payroll report trade.

PAYROLLREPORTTRADELEVEL

Name Required Type Description
TRADEKEY Optional integer The key used to identify the PAYROLLREPORTTRADE.
TRADELEVELID Required string The trade level identifier used in PAYROLLREPORTTIMECARD and identifies trade levels such as “Apprentice,” “Journeyman,” etc.
CLASSLEVEL Optional string The professional class level of the trade, such as entry level or senior level.
CLASSPERCENT Optional currency The class percentage.

PAYROLLREPORTTRADETAXCLASSIFICATION

Name Required Type Description
RECORDNO Optional integer RECORDNO of the Payroll Report Trade Classification.
TRADEKEY Optional integer The trade level identifier used in PAYROLLREPORTTIMECARD and identifies trade levels such as “Apprentice,” “Journeyman,” etc.
TAXID Required string The tax identifier used for the trade classification, such as CA-SDI.
CLASSIFICATION Optional string The classification code used for the trade classification.

Update a Payroll Report Trade

update

<update>
    <PAYROLLREPORTTRADE>
        <RECORDNO>15</RECORDNO>
        <TRADEID>plumber-20</TRADEID>
    </PAYROLLREPORTTRADE>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTTRADE Required object Type of object to update.

PAYROLLREPORTTRADE

Name Required Type Description
RECORDNO Optional integer RECORDNO of the payroll report trade to update.
TRADEID Optional string The identifier of the trade.
WORKCLASSIFICATION Optional string The general classification under which the trade falls.
WORKCLASSIFICATIONCCODE Optional string The unique code used for WORKCLASSIFICATION.
PAYROLLREPORTTRADELEVELS Optional array of PAYROLLREPORTTRADELEVEL The trade levels defined for a specified trade.
PAYROLLREPORTTRADETAXCLASSIFICATIONS Optional array of PAYROLLREPORTTRADETAXCLASSIFICATION The classifications details used for the trade taxes.
REVISIONNUMBER Optional decimal Revision number of the payroll report trade.

PAYROLLREPORTTRADELEVEL

Name Required Type Description
TRADEKEY Optional integer The key used to identify the PAYROLLREPORTTRADE.
TRADELEVELID Required string The trade level identifier used in PAYROLLREPORTTIMECARD and identifies trade levels such as “Apprentice,” “Journeyman,” etc.
CLASSLEVEL Optional string The professional class level of the trade, such as entry level or senior level.
CLASSPERCENT Optional currency The class percentage.

PAYROLLREPORTTRADETAXCLASSIFICATION

Name Required Type Description
TRADEKEY Optional integer The trade level identifier used in PAYROLLREPORTTIMECARD and identifies trade levels such as “Apprentice,” “Journeyman,” etc.
TAXID Required string The tax identifier used for the trade classification, such as CA-SDI.
CLASSIFICATION Optional string The classification code used for the trade classification.

Delete a Payroll Report Trade

delete

<delete>
    <object>PAYROLLREPORTTRADE</object>
    <keys>2012</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTRADE
keys Required string RECORDNO of the payroll report trade to delete.

Payroll Report PTO Accrual Schedule

A PAYROLLREPORTPTOACCRUALSCHEDULE object represents the PTO accrual schedule for employees.

Get Payroll Report PTO Accrual Schedule Definition

lookup

List all the fields and relationships for the Payroll Report PTO Accrual schedule object:

<lookup>
    <object>PAYROLLREPORTPTOACCRUALSCHEDULE</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPTOACCRUALSCHEDULE

Query and List Payroll Report PTO Accrual Schedule

query

List the recordno, PTO accrual schedule ID, and effective date of all active PTO accrual schedules:

<query>
    <object>PAYROLLREPORTPTOACCRUALSCHEDULE</object>
    <select>
        <field>RECORDNO</field>
        <field>PTOACCRUALSCHEDULEID</field>
        <field>EFFECTIVEDATE</field>
    </select>
    <filter>
        <and>
            <equalto>
                <field>ACTIVERECORD</field>
                <value>true</value>
            </equalto>
        </and>
    </filter>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPTOACCRUALSCHEDULE
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report PTO Accrual Schedule

read

<read>
    <object>PAYROLLREPORTPTOACCRUALSCHEDULE</object>
    <keys>2011</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPTOACCRUALSCHEDULE
keys Required string Comma-separated list of RECORDNO of the PTO accrual schedule.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report PTO Accrual Schedule

A payroll report PTO accrual schedule object must have a unique PTOACCRUALSCHEDULEID.

create

        <create>
          <PAYROLLREPORTPTOACCRUALSCHEDULE>
            <PTOACCRUALSCHEDULEID>25-Q1-OCT</PTOACCRUALSCHEDULEID>
            <EFFECTIVEDATE>25-10-01</EFFECTIVEDATE>
            <PTOTYPEID>PTO</PTOTYPEID>
            <PAYROLLREPORTPTOACCRUALSCHEDULELINES>
                <PAYROLLREPORTPTOACCRUALSCHEDULELINE>
                    <MINIMUMYEARSOFSERVICE>10</MINIMUMYEARSOFSERVICE>
                    <PAYROLLREPORTPTOACCRUALSCHEDULERATES>
                        <PAYROLLREPORTPTOACCRUALSCHEDULERATE>
                        <WORKEDHOURSID>12</WORKEDHOURSID>
                        </PAYROLLREPORTPTOACCRUALSCHEDULERATE>
                    </PAYROLLREPORTPTOACCRUALSCHEDULERATES>
                </PAYROLLREPORTPTOACCRUALSCHEDULELINE>
            </PAYROLLREPORTPTOACCRUALSCHEDULELINES>
          </PAYROLLREPORTPTOACCRUALSCHEDULE>
        </create>
Parameters
Name Required Type Description
PAYROLLREPORTPTOACCRUALSCHEDULE Required object Type of object to create.

PAYROLLREPORTPTOACCRUALSCHEDULE

Name Required Type Description
PTOACCRUALSCHEDULEID Required string The unique ID of the PTO accrual schedule.
EFFECTIVEDATE Required date The date that the PTO accrual is effective.
EXPIRATIONDATE Optional date The date on which the PTO accrual expires.
PTOTYPEID Required string The unique ID of the type of PTO.
REVISIONNUMBER Optional decimal Revision number of the PTO accrual schedule.
ACTIVERECORD Optional boolean Indicates whether the PTO accrual schedule is active.
  • false - No
  • true - Yes
PAYROLLREPORTPTOACCRUALSCHEDULELINES Optional array of PAYROLLREPORTPTOACCRUALSCHEDULELINE The individual payroll PTO accrual schedule line items.

PAYROLLREPORTPTOACCRUALSCHEDULELINE

Name Required Type Description
RECORDNO Optional integer RECORDNO of the payroll report PTO accrual schedule line.
PTOACCRUALSCHEDULEKEY Optional integer The unique key that identifies the payroll report PTO accrual schedule.
PTOACCRUALSCHEDULEID Optional string The unique ID of the PTO accrual schedule the line belongs to.
MINIMUMYEARSOFSERVICE Required decimal The minimum number of service years required for the accrual.
MAXIMUMYEARSOFSERVICE Optional decimal The maximum number of service years that can be accrued.
MAXIMUMHOURSACCRUEDPERYEAR Optional decimal The maximum number of hours that an employee can accrue within a year.
PTOACCRUALSCHEDULELINEID Optional string The unique ID of the PTO accrual schedule line.
PAYROLLREPORTPTOACCRUALSCHEDULERATES Optional array of PAYROLLREPORTPTOACCRUALSCHEDULERATE The rate associated with a payroll PTO accrual schedule line.

PAYROLLREPORTPTOACCRUALSCHEDULERATE

Name Required Type Description
RECORDNO Optional integer RECORDNO of the payroll report PTO accrual schedule rate.
PTOACCRUALSCHEDULEID Optional string The unique ID of the PTO accrual schedule that the rate belongs to.
PTOACCRUALSCHEDULELINEID Optional string The unique ID of the PTO accrual schedule line that the rate belongs to.
PTOACCRUALSCHEDULELINEKEY Optional integer The unique key that identifies the payroll report PTO accrual schedule line.
WORKEDHOURSID Required string The unique ID of the hours worked for this rate.
HOURSACCRUEDPERHOURWORKED Optional decimal The quanity of PTO hours accrued per each hour worked.

Update a Payroll Report PTO Accrual Schedule

update

<update>
    <PAYROLLREPORTPTOACCRUALSCHEDULE>
        <RECORDNO>13</RECORDNO>
        <PTOTYPEID>56</PTOTYPEID>       
    </PAYROLLREPORTPTOACCRUALSCHEDULE>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTPTOACCRUALSCHEDULE Required object Type of object to update.

PAYROLLREPORTPTOACCRUALSCHEDULE

Name Required Type Description
RECORDNO Optional integer RECORDNO of the payroll report PTO accrual schedule.
PTOACCRUALSCHEDULEID Optional string The unique ID of the PTO accrual schedule.
EFFECTIVEDATE Optional date The date that the PTO accrual is effective.
EXPIRATIONDATE Optional date The date on which the PTO accrual expires.
PTOTYPEID Optional string The unique ID of the type of PTO.
REVISIONNUMBER Optional decimal Revision number of the PTO accrual schedule.
ACTIVERECORD Optional boolean Indicates whether the PTO accrual schedule is active.
  • false - No
  • true - Yes
PAYROLLREPORTPTOACCRUALSCHEDULELINES Optional array of PAYROLLREPORTPTOACCRUALSCHEDULELINE The individual payroll PTO accrual schedule line items.

PAYROLLREPORTPTOACCRUALSCHEDULELINE

Name Required Type Description
RECORDNO Optional integer RECORDNO of the payroll report PTO accrual schedule line.
PTOACCRUALSCHEDULEKEY Optional integer The unique key that identifies the payroll report PTO accrual schedule.
PTOACCRUALSCHEDULEID Optional string The unique ID of the PTO accrual schedule the line belongs to.
MINIMUMYEARSOFSERVICE Required decimal The minimum number of service years required for the accrual.
MAXIMUMYEARSOFSERVICE Optional decimal The maximum number of service years that can be accrued.
MAXIMUMHOURSACCRUEDPERYEAR Optional decimal The maximum number of hours that an employee can accrue within a year.
PTOACCRUALSCHEDULELINEID Optional string The unique ID of the PTO accrual schedule line.
PAYROLLREPORTPTOACCRUALSCHEDULERATES Optional array of PAYROLLREPORTPTOACCRUALSCHEDULERATE The rate associated with a payroll PTO accrual schedule line.

PAYROLLREPORTPTOACCRUALSCHEDULERATE

Name Required Type Description
RECORDNO Optional integer RECORDNO of the payroll report PTO accrual schedule rate.
PTOACCRUALSCHEDULEID Optional string The unique ID of the PTO accrual schedule that the rate belongs to.
PTOACCRUALSCHEDULELINEID Optional string The unique ID of the PTO accrual schedule line that the rate belongs to.
PTOACCRUALSCHEDULELINEKEY Optional integer The unique key that identifies the payroll report PTO accrual schedule line.
WORKEDHOURSID Required string The unique ID of the hours worked for this rate.
HOURSACCRUEDPERHOURWORKED Optional decimal The quanity of PTO hours accrued per each hour worked.

Delete a Payroll Report PTO Accrual Schedule

delete

<delete>
    <object>PAYROLLREPORTPTOACCRUALSCHEDULE</object>
    <keys>39</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPTOACCRUALSCHEDULE
keys Required string RECORDNO of the payroll report PTO accrual schedule to delete.

Payroll Report Timecards

A PAYROLLREPORTTIMECARD represents an employee timecard for a single day and includes information such as the project and task that the employee worked on and the cost type. The number of hours that an employee worked and the pay rate are recorded in PAYROLLREPORTGROSSPAY objects that are associated with a timecard by the TIMECARDID.

Get Payroll Report Timecard Object Definition

lookup

List all the fields and relationships for the Payroll Report Timecard object:

<lookup>
    <object>PAYROLLREPORTTIMECARD</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTIMECARD

Query and List Payroll Report Timecards

query

List all timecards associated with a specific payroll report check ID:

<query>
    <object>PAYROLLREPORTTIMECARD</object>
    <filter>
        <equalto>
            <field>CHECKID</field>
            <value>123-456-7880</value>
        </equalto>
    </filter>
    <select>
        <field>RECORDNO</field>
        <field>TIMECARDID</field>
        <field>CHECKID</field>
        <field>EMPLOYEEID</field>
    </select>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTIMECARD
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report Timecard

read

<read>
    <object>PAYROLLREPORTTIMECARD</object>
    <keys>66</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTIMECARD
keys Required string Comma-separated list of RECORDNO of the payroll report timecards to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report Timecard

create

<create>
    <PAYROLLREPORTTIMECARD>
        <TIMECARDID>2023-01-01-8976</TIMECARDID>
        <EMPLOYEEID>ZBeeblebrox</EMPLOYEEID>
        <CHECKID>123-456-7879</CHECKID>
        <PROJECTID>project-cre-1</PROJECTID>
        <TASKID>task-cre-01</TASKID>
        <COSTTYPEID>cost-type-CRE</COSTTYPEID>
        <LOCATIONID>LO-001</LOCATIONID>
        <HOMEUNIONID>2022</HOMEUNIONID>
        <WORKUNIONID>123456</WORKUNIONID>
        <TRADEID>100</TRADEID>
        <TRADELEVELID>1</TRADELEVELID>
        <WORKDATE>2023-01-21</WORKDATE>
    </PAYROLLREPORTTIMECARD>
</create>
Parameters
Name Required Type Description
PAYROLLREPORTTIMECARD Required object Type of object to create.

PAYROLLREPORTTIMECARD

Name Required Type Description
TIMECARDID Required string Timecard ID. Should be unique for the combination of EMPLOYEEID, CHECKID, and CHECKTYPE.
EMPLOYEEID Required string EMPLOYEEID of the employee that the timecard is for.
CHECKID Required string CHECKID of the PAYROLLREPORTCHECK in which this timecard is paid.
PROJECTID Optional string PROJECTID of an active project to associate with the check.
TASKID Optional string TASKID of an active task to associate with the check.
COSTTYPEID Optional string COSTTYPEID of an active cost type to associate with the check.
HOMEUNIOINID Optional string The union that the employee belongs to.
WORKUNIOINID Optional string The union where the employee did the work.
TRADEID Optional string Labor trade such as “Framer,” “Electrician,” “Painter,” etc.
TRADELEVELID Optional string “Apprentice,” “Journeyman,” etc.
WORKDATE Optional string The date on which the work was done.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Update a Payroll Report Timecard

update

<update>
    <PAYROLLREPORTTIMECARD>
        <RECORDNO>19</RECORDNO>
        <WORKDATE>2023-01-31</WORKDATE>
    </PAYROLLREPORTTIMECARD>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTTIMECARD Required object Type of object to update.

PAYROLLREPORTTIMECARD

Name Required Type Description
RECORDNO Required integer RECORDNO of the payroll report timecard to update.
TIMECARDID Optional string Timecard ID. Should be unique for the combination of EMPLOYEEID, CHECKID, and CHECKTYPE.
EMPLOYEEID Optional string EMPLOYEEID of the employee that the timecard is for.
CHECKID Optional string CHECKID of the PAYROLLREPORTCHECK in which this timecard is paid.
PROJECTID Optional string PROJECTID of an active project to associate with the check.
TASKID Optional string TASKID of an active task to associate with the check.
COSTTYPEID Optional string COSTTYPEID of an active cost type to associate with the check.
HOMEUNIOINID Optional string The union that the employee belongs to.
WORKUNIOINID Optional string The union where the employee did the work.
TRADEID Optional string Lobor trade such as “Framer,” “Electrician,” “Painter,” etc.
TRADELEVELID Optional string “Apprentice,” “Journeyman,” etc.
WORKDATE Optional string The date on which the work was done.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Delete a Payroll Report Timecard

delete

<delete>
    <object>PAYROLLREPORTTIMECARD</object>
    <keys>66</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTIMECARD
keys Required string RECORDNO of the payroll report timecard to delete.

Payroll Report Gross Pay

A PAYROLLREPORTGROSSPAY object represents the gross pay of a specific type earned by an employee during a pay period. The TIMECARDID value associates one or more PAYROLLREPORTGROSSPAY objects with a PAYROLLREPORTTIMECARD.

Get Payroll Report Gross Pay Object Definition

lookup

List all the fields and relationships for the Payroll Report Gross Pay object:

<lookup>
    <object>PAYROLLREPORTGROSSPAY</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTGROSSPAY

Query and List Payroll Report Gross Pay Objects

query

List all Payroll Report Gross Pay objects for a specified employee:

<query>
    <object>PAYROLLREPORTGROSSPAY</object>
    <filter>
        <equalto>
            <field>EMPLOYEEID</field>
            <value>ZBeeblebrox</value>
        </equalto>
    </filter>
    <select>
        <field>RECORDNO</field>
        <field>GROSSPAYID</field>
        <field>TIMECARDID</field>
        <field>CHECKID</field>
        <field>EMPLOYEEID</field>
    </select>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTGROSSPAY
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report Gross Pay Object

read

<read>
    <object>PAYROLLREPORTGROSSPAY</object>
    <keys>66</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTGROSSPAY
keys Required string Comma-separated list of RECORDNO of the payroll report gross pay objects to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report Gross Pay Object

create

<create>
    <PAYROLLREPORTGROSSPAY>
        <EMPLOYEEID>ZBeeblebrox</EMPLOYEEID>
        <TIMECARDID>2023-01-01-7869</TIMECARDID>
        <CHECKID>123-456-7880</CHECKID>
        <GROSSPAYID>Bonus</GROSSPAYID>
        <GROSSPAY>1000</GROSSPAY>
        <ISPREMIUM>false</ISPREMIUM>
    </PAYROLLREPORTGROSSPAY>
</create>
Parameters
Name Required Type Description
PAYROLLREPORTGROSSPAY Required object Type of object to create.

PAYROLLREPORTGROSSPAY

Name Required Type Description
GROSSPAYID Required string Gross pay ID, probably identifying the type of pay. Should be unique for the combination of EMPLOYEEID, CHECKID, CHECKTYPE and TIMECARDID.
EMPLOYEEID Required string EMPLOYEEID of the employee that the gross pay record is for. Should match the EMPLOYEEID set in the associated PAYROLLREPORTCHECK and PAYROLLREPORTTIMECARD objects.
CHECKID Required string CHECKID of the PAYROLLREPORTCHECK in which this gross pay is paid. Must match the CHECKID used in the associated PAYROLLREPORTTIMECARD.
TIMECARDID Required string TIMECARDID of the PAYROLLREPORTTIMECARD in which this gross pay is recorded.
GROSSPAY Required decimal Gross pay.
PAYRATE Optional decimal Hourly pay rate.
HOURS Optional decimal Number of hours.
ISPREMIUM Optional Boolean Set to true to indicate that the pay rate is modified from regular pay.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Update a Payroll Report Gross Pay Object

update

Change the hours recorded in a gross pay object:

<update>
    <PAYROLLREPORTGROSSPAY>
        <RECORDNO>197</RECORDNO>
        <HOURS>48</HOURS>
    </PAYROLLREPORTGROSSPAY>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTGROSSPAY Required object Type of object to update.

PAYROLLREPORTGROSSPAY

Name Required Type Description
RECORDNO Required integer RECORDNO of the payroll report gross pay object to update.
GROSSPAYID Optional string Gross pay ID, probably identifying the type of pay. Should be unique for the combination of EMPLOYEEID, CHECKID, CHECKTYPE and TIMECARDID.
EMPLOYEEID Optional string EMPLOYEEID of the employee that the gross pay record is for. Should match the EMPLOYEEID set in the associated PAYROLLREPORTCHECK and PAYROLLREPORTTIMECARD objects.
CHECKID Optional string CHECKID of the PAYROLLREPORTCHECK in which this gross pay is paid. Must match the CHECKID used in the associated PAYROLLREPORTTIMECARD.
TIMECARDID Optional string TIMECARDID of the PAYROLLREPORTTIMECARD in which this gross pay is recorded.
GROSSPAY Optional decimal Gross pay.
PAYRATE Optional decimal Hourly pay rate.
HOURS Optional decimal Number of hours.
ISPREMIUM Optional Boolean Set to true to indicate that the pay rate is modified from regular pay.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Delete a Payroll Report Gross Pay Object

delete

<delete>
    <object>PAYROLLREPORTGROSSPAY</object>
    <keys>66</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTGROSSPAY
keys Required string RECORDNO of the payroll report gross pay object to delete.

Payroll Report Tax Setup

Use PAYROLLREPORTTAXSETUP objects to define standard tax definitions that you can apply to PAYROLLREPORTTAX objects.

Get Payroll Report Tax Setup Object Definition

lookup

List all the fields and relationships for the Payroll Report Tax Setup object:

<lookup>
    <object>PAYROLLREPORTTAXSETUP</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTAXSETUP

Query and List Payroll Report Tax Setups

query

List all Tax Setup objects for the Federal reporting level:

<query>
    <object>PAYROLLREPORTTAXSETUP</object>
    <filter>
        <equalto>
            <field>REPORTINGLEVEL</field>
            <value>Federal</value>
        </equalto>
    </filter>
    <select>
        <field>RECORDNO</field>
        <field>TAXID</field>
        <field>REPORTAS</field>
    </select>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTAXSETUP
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report Tax Setup

Returns detailed information for one or more PAYROLLREPORTTAXSETUP objects specified by RECORDNO.

read

<read>
    <object>PAYROLLREPORTTAXSETUP</object>
    <keys>66</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTAXSETUP
keys Required string Comma-separated list of RECORDNO of the Payroll Report Tax Setups to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report Tax Setup

create

<create>
  <PAYROLLREPORTTAXSETUP>
    <TAXID>IL-SIT</TAXID>
    <TAXTYPE>PercentOfEarnings</TAXTYPE>
    <REPORTINGLEVEL>Federal</REPORTINGLEVEL>
    <TAXCATEGORYID>SUI</TAXCATEGORYID>
    <REPORTAS>Social Security</REPORTAS>
    <STATE>NY</STATE>
  </PAYROLLREPORTTAXSETUP>
</create>
Parameters
Name Required Type Description
PAYROLLREPORTTAXSETUP Required object Type of object to create.

PAYROLLREPORTTAXSETUP

Name Required Type Description
TAXID Required string User-defined unique ID, used to reference a PAYROLLREPORTTAXSETUP object from a PAYROLLREPORTTAX object.
TAXTYPE Optional string Tax calculation method used for this tax setup.
REPORTINGLEVEL Optional string (enum) Tax reporting level.
  • Federal (default)
  • State
  • Local
TAXCATEGORYID Optional string Additional tax categorization used to note taxes that follow specific rules, such as PA-EIT, PA-LST, SUT, WC.
REPORTAS Optional string Information for certified reporting.
STATE Optional string State or territory.

Update a Payroll Report Tax Setup

update

Change tax category ID:

<update>
  <PAYROLLREPORTTAXSETUP>
    <RECORDNO>14</RECORDNO>                   
    <TAXCATEGORYID>PA-EIT</TAXCATEGORYID>
  </PAYROLLREPORTTAXSETUP>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTTAXSETUP Required object Type of object to update.

PAYROLLREPORTTAXSETUP

Name Required Type Description
RECORDNO Required integer RECORDNO of the Payroll Report Tax Setup object to update.
TAXID Optional string User-defined unique ID, used to reference a PAYROLLREPORTTAXSETUP object from a PAYROLLREPORTTAX object.
TAXTYPE Optional string Tax calculation method used for this tax setup.
REPORTINGLEVEL Optional string (enum) Tax reporting level.
  • Federal (default)
  • State
  • Local
TAXCATEGORYID Optional string Additional tax categorization used to note taxes that follow specific rules, such as PA-EIT, PA-LST, SUT, WC.
REPORTAS Optional string Information for certified reporting.
STATE Optional string State or territory.

Delete a Payroll Report Tax Setup

delete

<delete>
    <object>PAYROLLREPORTTAXSETUP</object>
    <keys>3086</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTAXSETUP
keys Required string RECORDNO of the Payroll Report Tax Setup object to delete.

Payroll Report Taxes

A PAYROLLREPORTTAX object represents the taxed earnings by an employee and the various payroll taxes paid by the employer and employee during a pay period.

Get Payroll Report Tax Object Definition

lookup

List all the fields and relationships for the Payroll Report Tax object:

<lookup>
    <object>PAYROLLREPORTTAX</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTAX

Query and List Payroll Report Tax Objects

query

List all Medicare tax objects:

<query>
    <object>PAYROLLREPORTTAX</object>
    <filter>
        <equalto>
            <field>TAXID</field>
            <value>Medicare</value>
        </equalto>
    </filter>
    <select>
        <field>RECORDNO</field>
        <field>TIMECARDID</field>
        <field>CHECKID</field>
        <field>EMPLOYEEID</field>
        <field>EMPLOYERTAXAMOUNT</field>
    </select>
</query>

Find the total of all Medicare taxes paid by the employer:

<query>
    <object>PAYROLLREPORTTAX</object>
    <filter>
        <equalto>
            <field>TAXID</field>
            <value>Medicare</value>
        </equalto>
    </filter>
    <select>
        <sum>EMPLOYERTAXAMOUNT</sum>
    </select>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTAX
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report Tax Object

read

<read>
    <object>PAYROLLREPORTTAX</object>
    <keys>66</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTAX
keys Required string Comma-separated list of RECORDNO of the payroll report tax objects to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report Tax Object

create

<create>
    <PAYROLLREPORTTAX>
        <EMPLOYEEID>ZBeeblebrox</EMPLOYEEID>
        <CHECKID>123-456-7881</CHECKID>
        <TIMECARDID>Payroll-report-timecardID2</TIMECARDID>
        <TAXID>Medicare</TAXID>
        <TAXCATEGORYID>PA-LST</TAXCATEGORYID>
        <EMPLOYEETAXAMOUNT>9.95</EMPLOYEETAXAMOUNT>
        <EMPLOYERTAXAMOUNT>.05</EMPLOYERTAXAMOUNT>
    </PAYROLLREPORTTAX>
</create>
Parameters
Name Required Type Description
PAYROLLREPORTTAX Required object Type of object to create.

PAYROLLREPORTTAX

Name Required Type Description
TAXID Required string TAXID of the PAYROLLREPORTTAXSETUP that you want to use with this tax object.
EMPLOYEEID Required string EMPLOYEEID of the employee that the taxes apply to.
CHECKID Required string CHECKID of the PAYROLLREPORTCHECK where these taxes are applied.
TIMECARDID Required string TIMECARDID of the PAYROLLREPORTTIMECARD from which these taxes are calculated.
TAXCATEGORYID Required string Tax category ID, such as PA-EIT, PA-LST, SUT, WC
EMPLOYEETAXAMOUNT Required decimal Total tax calculated for the employee.
EMPLOYERTAXAMOUNT Required decimal Total tax calculated for the employer.
CLASSIFICATIONCODE Optional string Tax classification code.
TAXABLEEARNINGS Optional decimal Employee taxable earnings.
TAXEDEARNINGS Optional decimal The amount of employee earnings taxed.
EMPLOYEETAXEDEARNINGS Optional decimal Employee taxed earnings.
EMPLOYERTAXEDEARNINGS Optional decimal Employer taxed earnings.
SURTAXEARNINGS Optional decimal Surcharge on tax.
DEDUCTIONTAKEN Optional decimal Amount of deduction in earnings.
TAXABLEHOURS Optional decimal Number of work hours that are taxable.
TAXEDHOURS Optional decimal Number of hours for which tax is deducted.
EMPLOYEESURTAXAMOUNT Optional decimal Employee total surcharge.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Update a Payroll Report Tax Object

update

Update tax amounts paid:

<update>
  <PAYROLLREPORTTAX>
    <RECORDNO>195</RECORDNO>                   
      <EMPLOYEETAXAMOUNT>19.95</EMPLOYEETAXAMOUNT>
      <EMPLOYERTAXAMOUNT>.50</EMPLOYERTAXAMOUNT>
  </PAYROLLREPORTTAX>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTTAX Required object Type of object to update.

PAYROLLREPORTTAX

Name Required Type Description
RECORDNO Required integer RECORDNO of the payroll report tax object to update.
TAXID Optional string TAXID of the PAYROLLREPORTTAXSETUP that you want to use with this tax object.
EMPLOYEEID Optional string EMPLOYEEID of the employee that the taxes apply to.
CHECKID Optional string CHECKID of the PAYROLLREPORTCHECK where these taxes are applied.
TIMECARDID Optional string TIMECARDID of the PAYROLLREPORTTIMECARD from which these taxes are calculated.
CLASSIFICATIONCODE Optional string Tax classification code.
TAXCATEGORYID Optional string Tax category ID, such as PA-EIT, PA-LST, SUT, WC
TAXABLEEARNINGS Optional decimal Employee taxable earnings.
TAXEDEARNINGS Optional decimal The amount of employee earnings taxed.
EMPLOYEETAXEDEARNINGS Optional decimal Employee taxed earnings.
EMPLOYERTAXEDEARNINGS Optional decimal Employer taxed earnings.
SURTAXEARNINGS Optional decimal Surcharge on tax.
DEDUCTIONTAKEN Optional decimal Amount of deduction in earnings.
TAXABLEHOURS Optional decimal Number of work hours that are taxable.
TAXEDHOURS Optional decimal Number of hours for which tax is deducted.
EMPLOYEETAXAMOUNT Optional decimal Total tax calculated for the employee.
EMPLOYERTAXAMOUNT Optional decimal Total tax calculated for the employer.
EMPLOYEESURTAXAMOUNT Optional decimal Employee total surcharge.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Delete a Payroll Report Tax Object

delete

<delete>
    <object>PAYROLLREPORTTAX</object>
    <keys>66</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTTAX
keys Required string RECORDNO of the payroll report tax object to delete.

Payroll Report Pay Modifiers

A PAYROLLREPORTPAYMODIFIER object represents modifications to an employee’s pay during a pay period, such as contributions to retirement plans or reimbursements.

Get Payroll Report Pay Modifier Object Definition

lookup

List all the fields and relationships for the Payroll Report Pay Modifier object:

<lookup>
    <object>PAYROLLREPORTPAYMODIFIER</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPAYMODIFIER

Query and List Payroll Report Pay Modifiers

query

List a few fields from all pay modifier objects:

<query>
    <object>PAYROLLREPORTPAYMODIFIER</object>
    <select>
        <field>RECORDNO</field>
        <field>PAYMODIFIERID</field>
        <field>TIMECARDID</field>
        <field>CHECKID</field>
        <field>EMPLOYEEID</field>
    </select>
</query>

List all 401K pay modifiers for a specified employee:

<query>
    <object>PAYROLLREPORTPAYMODIFIER</object>
    <filter>
    <and>
        <equalto>
            <field>EMPLOYEEID</field>
            <value>JBeeblebrox</value>
        </equalto>
        <equalto>
            <field>PAYMODIFIERID</field>
            <value>401K</value>
        </equalto>
    </and>
    </filter>
    <select>
        <field>RECORDNO</field>
        <field>PAYMODIFIERID</field>
        <field>EMPLOYEEID</field>
        <field>PRETAXCONTRIBUTIONAMT</field>
        <field>PRETAXCATCHUPCONTRIBUTIONAMT</field>
    </select>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPAYMODIFIER
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report Pay Modifier

read

<read>
    <object>PAYROLLREPORTPAYMODIFIER</object>
    <keys>66</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPAYMODIFIER
keys Required string Comma-separated list of RECORDNO of the pay modifiers to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report Pay Modifier

create

<create>
    <PAYROLLREPORTPAYMODIFIER>
        <PAYMODIFIERID>401K</PAYMODIFIERID>
        <PAYMODIFIERTYPE>Section401K</PAYMODIFIERTYPE>
        <PAYMODIFIERCATEGORY>Deduction</PAYMODIFIERCATEGORY>
        <EMPLOYEEID>ZBeeblebrox</EMPLOYEEID>
        <CHECKID>123-456-7881</CHECKID>
        <TIMECARDID>Payroll-report-timecardID2</TIMECARDID>
        <PRETAXCONTRIBUTIONAMT>422.38</PRETAXCONTRIBUTIONAMT>
        <PRETAXCATCHUPCONTRIBUTIONAMT>105.00</PRETAXCATCHUPCONTRIBUTIONAMT>
    </PAYROLLREPORTPAYMODIFIER>
</create>
Parameters
Name Required Type Description
PAYROLLREPORTPAYMODIFIER Required object Type of object to create.

PAYROLLREPORTPAYMODIFIER

Name Required Type Description
PAYMODIFIERID Required string Pay modifier ID. Should be unique for the combination of EMPLOYEEID, CHECKID, CHECKTYPE and TIMECARDID.
EMPLOYEEID Required string EMPLOYEEID of the employee that these modifications apply to.
CHECKID Optional string CHECKID of the PAYROLLREPORTCHECK where these modifications are applied.
PAYMODIFIERTYPE Required string Pay modifier type, such as “Section401k” or “HourBased”.
PAYMODIFIERCATEGORY Required string Pay modifier category, such as “OtherEarnings”, “Deduction”, “Reimbursement”, or “NoncashCompensation”.
UNIONLOCALID Optional string Local union ID.
PRETAXCONTRIBUTIONAMT Optional decimal Contribution amount made before any taxes are withheld.
PRETAXCATCHUPCONTRIBUTIONAMT Optional decimal “Catch-up” contribution amount made before taxes are withheld (only available to individuals who are 50 or over at the end of the calendar year).
PRETAXMATCHAMT Optional decimal Employer matching pre-tax contribution.
PRETAXCATCHUPMATCHAMT Optional decimal Employer matching pre-tax “catch-up” contribution.
POSTTAXCONTRIBUTIONAMT Optional decimal Contribution amount made after taxes have been withheld.
POSTTAXCATCHUPCONTRIBUTIONAMT Optional decimal “Catch-up” contribution amount made after taxes have been withheld.
POSTTAXMATCHAMT Optional decimal Employer matching post-tax contribution.
POSTTAXCATCHUPMATCHAMT Optional decimal Employer matching post-tax “catch-up” contribution.
SUBJECTEARNINGS Optional decimal The amount that is subject to the modifier.
AMOUNT Optional decimal Amount of the pay modification.
ISCASHFRINGE Optional Boolean Set to true if this is a cash fringe benefit paid to the employee.
WORKEDHOURSID Optional string The name of an hourly pay type.
CONSUMEDHOURS Optional decimal Number of hours consumed.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Update a Payroll Report Pay Modifier

update

Set new contribution amounts:

<update>
    <PAYROLLREPORTPAYMODIFIER>
        <PRETAXCONTRIBUTIONAMT>422.39</PRETAXCONTRIBUTIONAMT>
        <PRETAXCATCHUPCONTRIBUTIONAMT>105.01</PRETAXCATCHUPCONTRIBUTIONAMT>
    </PAYROLLREPORTPAYMODIFIER>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTPAYMODIFIER Required object Type of object to update.

PAYROLLREPORTPAYMODIFIER

Name Required Type Description
RECORDNO Required integer RECORDNO of the pay modifier to update.
PAYMODIFIERID Optional string Pay modifier ID. Should be unique for the combination of EMPLOYEEID, CHECKID, CHECKTYPE and TIMECARDID.
EMPLOYEEID Optional string EMPLOYEEID of the employee that these modifications apply to.
CHECKID Optional string CHECKID of the PAYROLLREPORTCHECK where these modifications are applied.
PAYMODIFIERTYPE Optional string Pay modifier type:
  • Section401k
  • AmountBased
  • HourBased
PAYMODIFIERCATEGORY Optional string Pay modifier category:
  • OtherEarnings
  • Deduction
  • Reimbursement
  • NoncashCompensation
  • CompanyPaid
  • Section401k
UNIONLOCALID Optional string Local union ID.
PRETAXCONTRIBUTIONAMT Optional decimal Contribution amount made before any taxes are withheld.
PRETAXCATCHUPCONTRIBUTIONAMT Optional decimal “Catch-up” contribution amount made before taxes are withheld (only available to individuals who are 50 or over at the end of the calendar year).
PRETAXMATCHAMT Optional decimal Employer matching pre-tax contribution.
PRETAXCATCHUPMATCHAMT Optional decimal Employer matching pre-tax “catch-up” contribution.
POSTTAXCONTRIBUTIONAMT Optional decimal Contribution amount made after taxes have been withheld.
POSTTAXCATCHUPCONTRIBUTIONAMT Optional decimal “Catch-up” contribution amount made after taxes have been withheld.
POSTTAXMATCHAMT Optional decimal Employer matching post-tax contribution.
POSTTAXCATCHUPMATCHAMT Optional decimal Employer matching post-tax “catch-up” contribution.
SUBJECTEARNINGS Optional decimal The amount that is subject to the modifier.
AMOUNT Optional decimal Amount of the pay modification.
ISCASHFRINGE Optional Boolean Set to true if this is a cash fringe benefit paid to the employee.
WORKEDHOURSID Optional string The name of an hourly pay type.
CONSUMEDHOURS Optional decimal Number of hours consumed.
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Delete a Payroll Report Pay Modifier

delete

<delete>
    <object>PAYROLLREPORTPAYMODIFIER</object>
    <keys>66</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPAYMODIFIER
keys Required string RECORDNO of the pay modifier to delete.

Payroll Report PTO Activities

A PAYROLLREPORTPTOACTIVITY object records time off taken by an employee during a pay period.

Get Payroll Report PTO Activity Object Definition

lookup

List all the fields and relationships for the Payroll Report PTO Activity object:

<lookup>
    <object>PAYROLLREPORTPTOACTIVITY</object>
</lookup>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPTOACTIVITY

Query and List Payroll Report PTO Activity objects

query

List all COVID sick days reported on 2023 timecards:

<query>
    <object>PAYROLLREPORTPTOACTIVITY</object>
    <filter>
        <and>
            <equalto>
                <field>PTOACTIVITYID</field>
                <value>COVID Sick Days</value>
            </equalto>
            <like>
                <field>TIMECARDID</field>
                <value>2023%</value>
            </like>
        </and>
    </filter>
    <select>
        <field>RECORDNO</field>
        <field>EMPLOYEEID</field>
        <field>HOURS</field>
    </select>
</query>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPTOACTIVITY
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Get a Payroll Report PTO Activity Object

read

<read>
    <object>PAYROLLREPORTPTOACTIVITY</object>
    <keys>66</keys>
    <fields>*</fields>
</read>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPTOACTIVITY
keys Required string Comma-separated list of RECORDNO of the PTO activity objects to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Payroll Report PTO Activity Object

create

<create>
    <PAYROLLREPORTPTOACTIVITY>
        <PTOACTIVITYID>COVID Sick Days</PTOACTIVITYID>
        <EMPLOYEEID>ZBeeblebrox</EMPLOYEEID>
        <CHECKID>123-456-7881</CHECKID>
        <HOURS>8</HOURS>
        <WORKEDHOURSID>Regular</WORKEDHOURSID>
        <SOURCE>ManualEntry</SOURCE>
        <TIMECARDID>2023-01-01-7869</TIMECARDID>
        <ACCRUALSCHEDULEID>Personal Time</ACCRUALSCHEDULEID>
        <DEDUCTIONTAKEN>100.00</DEDUCTIONTAKEN>
    </PAYROLLREPORTPTOACTIVITY>
</create>
Parameters
Name Required Type Description
PAYROLLREPORTPTOACTIVITY Required object Type of object to create.

PAYROLLREPORTPTOACTIVITY

Name Required Type Description
PTOACTIVITYID Required string Type of PTO activity, for example: “Personal Time”.
EMPLOYEEID Required string EMPLOYEEID of the employee that took the time off.
CHECKID Required string CHECKID of the PAYROLLREPORTCHECK where this PTO time is applied.
HOURS Required decimal Number of PTO hours taken
WORKEDHOURSID Required string  
SOURCE Required string Source of the PTO entry:
  • ManualEntry
  • CheckProcessingAccrual
  • CheckProcessingUse
  • VoidOfAccrual
  • VoidOfUse
TIMECARDID Optional string TIMECARDID of the PAYROLLREPORTTIMECARD where this PTO time is applied.
ACCRUALSCHEDULEID Optional string ID of PTO accrual schedule, suchas “Personal Time.”
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Update a Payroll Report PTO Activity Object

update

Change the number of PTO hours recorded:

<update>
    <PAYROLLREPORTPTOACTIVITY>
        <RECORDNO>3884</RECORDNO>
        <HOURS>80</HOURS>
    </PAYROLLREPORTPTOACTIVITY>
</update>
Parameters
Name Required Type Description
PAYROLLREPORTPTOACTIVITY Required object Type of object to update.

PAYROLLREPORTPTOACTIVITY

Name Required Type Description
RECORDNO Required integer RECORDNO of the PTO activity object to update.
PTOACTIVITYID Optional string Type of PTO activity, for example: “Personal Time”.
EMPLOYEEID Optional string EMPLOYEEID of the employee that took the time off.
CHECKID Optional string CHECKID of the PAYROLLREPORTCHECK where this PTO time is applied.
TIMECARDID Optional string TIMECARDID of the PAYROLLREPORTTIMECARD where this PTO time is applied.
WORKEDHOURSID Optional string  
HOURS Optional decimal Number of PTO hours taken
SOURCE Optional string Source of the PTO entry: {::nomarkdown}<ul><li>ManualEntry</li><li>CheckProcessingAccrual</li><li>CheckProcessingUse</li><li>VoidOfAccrual</li><li>VoidOfUse</li>
ACCRUALSCHEDULEID Optional string ID of PTO accrual schedule, suchas “Personal Time.”
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Delete a Payroll Report PTO Activity

delete

<delete>
    <object>PAYROLLREPORTPTOACTIVITY</object>
    <keys>66</keys>
</delete>
Parameters
Name Required Type Description
object Required string Use PAYROLLREPORTPTOACTIVITY
keys Required string RECORDNO of the PTO activity object to delete.

Provide feedback