List Billing Price Lists

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTPRICELIST
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 fo Inactive

Get Billing Price List

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACTPRICELIST
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 Price List by Name

readByName

<readByName>
    <object>CONTRACTPRICELIST</object>
    <keys>Billing Price List</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use CONTRACTPRICELIST
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 Price List

create

<create>
    <CONTRACTPRICELIST>
        <NAME>Billing price list</NAME>
    </CONTRACTPRICELIST>
</create>

Parameters

Name Required Type Description
CONTRACTPRICELIST Optional object The object to create

CONTRACTPRICELIST

Name Required Type Description
NAME Required string Billing price list name
DESCRIPTION Optional string Description
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)

Update Billing Price List

update

<update>
    <CONTRACTPRICELIST>
        <NAME>Billing price list</NAME>
        <DESCRIPTION>hello world</DESCRIPTION>
    </CONTRACTPRICELIST>
</update>

Parameters

Name Required Type Description
CONTRACTPRICELIST Optional object The object to update

CONTRACTPRICELIST

Name Required Type Description
RECORDNO Optional integer Record number of object. Required if not using NAME.
NAME Optional string Billing price list name. Required if not using RECORDNO
DESCRIPTION Optional string Description
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive

Delete Billing Price List

delete

<delete>
    <object>CONTRACTPRICELIST</object>
    <keys>112</keys>
</delete>

Parameters

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

List Billing Price List Entries

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTITEMPRICELIST
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
ITMPRCLSTTYP Optional string Price type. Use R for Range or T for Tiered
ISTIEREDSTEP Optional string Tier pricing. Use F for Volume, S for Step, or A for Absolute
QTYRSTPRD Optional string Reset usage quantity. Use AER for After each renewal or AEI for After each invoice
ISQTYRECUR Optional boolean Quantity is recurring. Use T for true or F for false
FLTAMTFREQ Optional string Flat amount frequency. Use OT for One-time, BS for Use billing template, or INCLV for Include with every invoice
ROUNDUP Optional string Rounding. Use S for Standard, U for Round Up, or D for Round Down

Get Billing Price List Entry

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACTITEMPRICELIST
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.

Create Billing Price List Entry

create

Create a range price type

<create>
    <CONTRACTITEMPRICELIST>
        <PRICELISTNAME>Billing price list</PRICELISTNAME>
        <ITEMID>SFTW</ITEMID>
        <ITMPRCLSTTYP>Range</ITMPRCLSTTYP>
        <CURRENCY>USD</CURRENCY>
        <QTYRSTPRD>After each renewal</QTYRSTPRD>
        <FLTAMTFREQ>One-time</FLTAMTFREQ>
        <VARUNITDIVSR>1</VARUNITDIVSR>
        <CONTRACTITEMPRICELISTENTRIES>
            <CONTRACTITEMPRICELISTENTRY>
                <STARTDATE>01/01/2017</STARTDATE>
                <VALUE>2500.00</VALUE>
                <INCLUDEDUNITS>100</INCLUDEDUNITS>
                <VARUNITRATE>0</VARUNITRATE>
            </CONTRACTITEMPRICELISTENTRY>
        </CONTRACTITEMPRICELISTENTRIES>
    </CONTRACTITEMPRICELIST>
</create>

Create a tiered price type

<create>
    <CONTRACTITEMPRICELIST>
        <PRICELISTNAME>Billing price list</PRICELISTNAME>
        <ITEMID>DWNL</ITEMID>
        <ITMPRCLSTTYP>Tiered</ITMPRCLSTTYP>
        <ISTIEREDSTEP>Volume</ISTIEREDSTEP>
        <CURRENCY>USD</CURRENCY>
        <VARUNITDIVSR>1</VARUNITDIVSR>
        <CONTRACTITEMPRICELISTENTRIES>
            <CONTRACTITEMPRICELISTENTRY>
                <STARTDATE>01/01/2017</STARTDATE>
                <VALUE>24.99</VALUE>
                <INCLUDEDUNITS>100</INCLUDEDUNITS>
                <CONTRACTITEMPRCLSTENTYTIERS>
                    <CONTRACTITEMPRCLSTENTYTIER>
                        <BEGINQTY>0</BEGINQTY>
                        <TIERRATE>31.25</TIERRATE>
                    </CONTRACTITEMPRCLSTENTYTIER>
                </CONTRACTITEMPRCLSTENTYTIERS>
            </CONTRACTITEMPRICELISTENTRY>
        </CONTRACTITEMPRICELISTENTRIES>
    </CONTRACTITEMPRICELIST>
</create>

Parameters

Name Required Type Description
CONTRACTITEMPRICELIST Optional object The object to create

CONTRACTITEMPRICELIST

Name Required Type Description
PRICELISTNAME Required string Price list name
ITEMID Required string Item ID
ITMPRCLSTTYP Required string Price type. Use Range or Tiered (Default: Range)
ISTIEREDSTEP Optional string Tier pricing. Use Volume, Step, or Absolute (Default: Volume). Only used if Price type is Tiered
CURRENCY Optional string Currency. Required if company is enabled for multi-currency.
QTYRSTPRD Optional string Reset usage quantity. Use After each renewal or After each invoice (Default: After each renewal)
ISQTYRECUR Optional boolean Quantity is recurring. Use true or false (Default: false)
FLTAMTFREQ Optional string Flat amount frequency. Use One-time, Use billing template, or Include with every invoice
VARUNITDIVSR Optional decimal Variable unit divisor. Required if Price type is Range
ROUNDUP Optional string Rounding. Use either Standard, Round Up, or Round Down (Default: Standard)
CONTRACTITEMPRICELISTENTRIES Optional array[CONTRACTITEMPRICELISTENTRY] Billing price list entry details

CONTRACTITEMPRICELISTENTRY

Name Required Type Description
STARTDATE Required string Start date in format mm/dd/yyyy.
VALUE Required currency Flat amount
INCLUDEDUNITS Required number Included units
VARUNITRATE Optional decimal Variable unit rate. Only used if Price type is Range
CONTRACTITEMPRCLSTENTYTIERS Optional array[CONTRACTITEMPRCLSTENTYTIER] Tiers

CONTRACTITEMPRCLSTENTYTIER

Name Required Type Description
BEGINQTY Required decimal Begin quantity. Use 0 for first tier.
TIERRATE Required currency Tier rate

Delete Billing Price List Entry

delete

<delete>
    <object>CONTRACTITEMPRICELIST</object>
    <keys>112</keys>
</delete>

Parameters

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

List Billing Price List Entry Details

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTITEMPRICELISTENTRY
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 Billing Price List Entry Detail

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACTITEMPRICELISTENTRY
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.

List Billing Price List Entry Detail Tiers

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTITEMPRCLSTENTYTIER
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 Billing Price List Entry Detail Tier

read

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

Parameters

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