Earning types help configure the system to post project labor costs to one or more general ledger journals.


List Earning Types

readByQuery

<readByQuery>
    <object>EARNINGTYPE</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use EARNINGTYPE
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Earning Type

read

<read>
    <object>EARNINGTYPE</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use EARNINGTYPE
keys Required string Earning type RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Get Earning Type by Name

readByName

<readByName>
    <object>EARNINGTYPE</object>
    <keys>TEST</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use EARNINGTYPE
keys Required string Earning type name to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Earning Type (Legacy)

create_earningtype

<create_earningtype>
    <name>Full Time</name>
    <method>Salary</method>
    <billableacctno></billableacctno>
    <nonbillableacctno></nonbillableacctno>
    <ratemultiplier></ratemultiplier>
</create_earningtype>

Parameters

Name Required Type Description
name Required string Earning type name to create
method Required string Method. Use salary or hourly (Default: salary)
billableacctno Required string Billable account number
nonbillableacctno Required string Non-billable account number
ratemultiplier Optional number Rate multiplier
customfields Optional customfield[] Custom fields

Update Earning Type (Legacy)

update_earningtype

<update_earningtype key="Full Time">
    <method>Salary</method>
    <billableacctno></billableacctno>
    <nonbillableacctno></nonbillableacctno>
    <ratemultiplier></ratemultiplier>
</update_earningtype>

Parameters

Name Required Type Description
key Required string Earning type name to update
method Optional string Method. Use salary or hourly.
billableacctno Optional string Billable account number
nonbillableacctno Optional string Non-billable account number
ratemultiplier Optional number Rate multiplier
customfields Optional customfield[] Custom fields

Delete Earning Type (Legacy)

delete_earningtype

<delete_earningtype key="Full Time"></delete_earningtype>

Parameters

Name Required Type Description
key Required string Earning type name to delete

Provide feedback