Payroll Reporting

Payroll Report Checks
Payroll Report Timecards
Payroll Report Gross Pay
Payroll Report Tax Setup
Payroll Report Taxes
Payroll Report Pay Modifiers
Payroll Report PTO Activities

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 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	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 `#~#`.

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