List Billing Templates

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTBILLINGTEMPLATE
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 Set a custom page size between 1 and 1000 items (Default: 100)

query

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

Get Billing Template

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACTBILLINGTEMPLATE
keys Required string The record 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 Billing Template by Name

readByName

<readByName>
    <object>CONTRACTBILLINGTEMPLATE</object>
    <keys>Contract Billing Template</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use CONTRACTBILLINGTEMPLATE
keys Required string The record 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 Billing Template

create

<create>
    <CONTRACTBILLINGTEMPLATE>
        <NAME>40-30-20-10AA</NAME>
        <DESCRIPTION>Declining percentages at 2, 4, 6, and 8 months</DESCRIPTION>
        <TEMPLATEENTRY>
            <PERIODOFFSET>2</PERIODOFFSET>
            <PERCENTBILLED>40</PERCENTBILLED>
        </TEMPLATEENTRY>
        <TEMPLATEENTRY>
            <PERIODOFFSET>4</PERIODOFFSET>
            <PERCENTBILLED>30</PERCENTBILLED>
        </TEMPLATEENTRY>
        <TEMPLATEENTRY>
            <PERIODOFFSET>6</PERIODOFFSET>
            <PERCENTBILLED>20</PERCENTBILLED>
        </TEMPLATEENTRY>
        <TEMPLATEENTRY>
            <PERIODOFFSET>8</PERIODOFFSET>
            <PERCENTBILLED>10</PERCENTBILLED>
        </TEMPLATEENTRY>
    </CONTRACTBILLINGTEMPLATE>
</create>

Parameters

Name Required Type Description
CONTRACTBILLINGTEMPLATE Optional object The object to create

CONTRACTBILLINGTEMPLATE

Name Required Type Description
NAME Required string Billing template name
DESCRIPTION Optional string Description
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
TEMPLATEENTRY Optional TEMPLATEENTRY[] Template detail. Multiple TEMPLATEENTRY elements may be passed. Percent to bill’s must add up to 100.

TEMPLATEENTRY

Name Required Type Description
PERIODOFFSET Required integer Number of months offset
PERCENTBILLED Required decimal Percent to bill

Update Billing Template

update

<update>
    <CONTRACTBILLINGTEMPLATE>
        <NAME>40-30-20-10AA</NAME>
        <DESCRIPTION>Hello world</DESCRIPTION>
    </CONTRACTBILLINGTEMPLATE>
</update>

Parameters

Name Required Type Description
CONTRACTBILLINGTEMPLATE Optional object The object to update

CONTRACTBILLINGTEMPLATE

Name Required Type Description
RECORDNO Optional integer Record number of object. Required if not using NAME.
NAME Optional string Billing template name. Required if not using RECORDNO
DESCRIPTION Optional string Description
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
TEMPLATEENTRY Optional TEMPLATEENTRY[] Template detail. Multiple TEMPLATEENTRY elements may be passed. Percent to bill’s must add up to 100.

TEMPLATEENTRY

Name Required Type Description
PERIODOFFSET Required integer Number of months offset
PERCENTBILLED Required decimal Percent to bill

Delete Billing Template

delete

<delete>
    <object>CONTRACTBILLINGTEMPLATE</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use CONTRACTBILLINGTEMPLATE
keys Required string The record RECORDNO to delete

List Billing Template Details

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTBILLINGTEMPLATEENTRY
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 Set a custom page size between 1 and 1000 items (Default: 100)

Get Billing Template Detail

read

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

Parameters

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

Provide feedback