NEW!

Contract types let you group contracts in meaningful ways to provide additional insight into your business.

After creating a contract type, you can create or update a contract with that type.


List Contract Types

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTTYPE
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)

query

Name Required Type Description
STATUS Optional string Status. Use T for Active, F for Inactive

Get Contract Type

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACTTYPE
keys Required string Contract 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 Contract Type by Name

readByName

<readByName>
    <object>CONTRACTTYPE</object>
    <keys>Annually</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use CONTRACTTYPE
keys Required string Contract 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 Contract Type

create

<create>
    <CONTRACTTYPE>
        <NAME>Annually</NAME>
        <PARENT>
            <NAME>Auto-renewal</NAME>
        </PARENT>
        <STATUS>active</STATUS>
        <DESCRIPTION>Annual cycle</DESCRIPTION>
    </CONTRACTTYPE>
</create>

Parameters

Name Required Type Description
CONTRACTTYPE Required object Object to create

CONTRACTTYPE

Name Required Type Description
NAME Required string Contract type name
DESCRIPTION Optional string Description
PARENT Optional object Parent contract type
STATUS Optional string Status. Use active for Active or inactive for Inactive. (Default: active)

PARENT

Name Required Type Description
NAME Required string Parent contract type name

Update Contract Type

update

<update>
    <CONTRACTTYPE>
        <RECORDNO>1</RECORDNO>
        <STATUS>inactive</STATUS>
    </CONTRACTTYPE>
</update>

Parameters

Name Required Type Description
CONTRACTTYPE Required object Object to update

CONTRACTTYPE

Name Required Type Description
RECORDNO Required integer Record number of Contract type
NAME Optional string Contract type name
DESCRIPTION Optional string Description
PARENT Optional object Parent contract type
STATUS Optional string Status. Use active for Active or inactive for Inactive.

PARENT

Name Required Type Description
NAME Required string Parent contract type name

Delete Contract Type

delete

<delete>
    <object>CONTRACTTYPE</object>
    <keys>2</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use CONTRACTTYPE
keys Required string Contract type RECORDNO to delete

Provide feedback