List Usage Data

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTUSAGE
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
USAGETYPE Optional string Usage type. Use T for Billing, F for Revenue, C for Cancelled, or U for Excess

Get Usage Data

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACTUSAGE
keys Required string The data 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.

Create Usage Data

create

<create>
    <CONTRACTUSAGE>
        <CONTRACTID>CTRC-003</CONTRACTID>
        <CONTRACTLINENO>2</CONTRACTLINENO>
        <USAGEDATA>04/01/2017</USAGEDATA>
        <QUANTITY>55.00</QUANTITY>
    </CONTRACTUSAGE>
</create>

Parameters

Name Required Type Description
CONTRACTUSAGE Optional object The object to create

CONTRACTUSAGE

Name Required Type Description
CONTRACTID Required string Contract ID.
CONTRACTLINENO Optional integer Contract line number. Required if not using Item ID
ITEMID Optional string Item ID. Required if not using Contract line number. If the Item ID is unique in the contract lines, the system will find the appropriate line number for you. If it is not unique you must instead pass the contract line number.
USAGEDATE Required string Usage data in format mm/dd/yyyy
QUANTITY Required number Quantity

Update Usage Data

update

<update>
    <CONTRACTUSAGE>
        <RECORDNO>12345</RECORDNO>
        <USAGEDATA>04/01/2017</USAGEDATA>
        <QUANTITY>85.00</QUANTITY>
    </CONTRACTUSAGE>
</update>

Parameters

Name Required Type Description
CONTRACTUSAGE Optional object The object to update

CONTRACTUSAGE

Name Required Type Description
RECORDNO Required integer Record number of usage data
USAGEDATE Optional string Usage data in format mm/dd/yyyy
QUANTITY Optional number Quantity

Delete Usage Data

delete

<delete>
    <object>CONTRACTUSAGE</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use CONTRACTUSAGE
keys Required string The contract RECORDNO to delete

Provide feedback