The system generates a billing schedule based on one of the following:

  • The contract line billing template and the billing template start and end dates
  • The contract billing frequency, contract line start and end dates, and the contract line flat/fixed amount frequency

List Contract Billing Schedules

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTBILLINGSCHEDULE
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
CONTRACTID Optional string Contract ID
LINENO Optional integer Line number from the contract

Get Contract Billing Schedule

read

<read>
    <object>CONTRACTBILLINGSCHEDULE</object>
    <keys>5</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use CONTRACTBILLINGSCHEDULE
keys Required string 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 Contract Billing Schedule Entries

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTBILLINGSCHEDULEENTRY
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
POSTED Optional boolean Use T or F
STATE Optional string Use O for open, T for terminated, P for posted

Get Contract Billing Schedule Entry

read

<read>
    <object>CONTRACTBILLINGSCHEDULEENTRY</object>
    <keys>5</keys>
    <fields>*</fields>
</read>

Parameters

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

Update Contract Billing Schedule Entry

NEW!

update

Update the date for an entry:

<update>
    <CONTRACTBILLINGSCHEDULE>
        <RECORDNO>57</RECORDNO>
        <CONTRACTBILLINGSCHEDULEENTRIES>
            <CONTRACTBILLINGSCHEDULEENTRY>
                <RECORDNO>1133</RECORDNO>
                <POSTINGDATE>2017-01-09</POSTINGDATE>
            </CONTRACTBILLINGSCHEDULEENTRY>
        </CONTRACTBILLINGSCHEDULEENTRIES>
    </CONTRACTBILLINGSCHEDULE>
</update>

Change the amounts for two entries (the total amount for the schedule must remain the same):

<update>
    <CONTRACTBILLINGSCHEDULE>
        <RECORDNO>57</RECORDNO>
        <CONTRACTBILLINGSCHEDULEENTRIES>
            <CONTRACTBILLINGSCHEDULEENTRY>
                <RECORDNO>1133</RECORDNO>
                <AMOUNT>50</AMOUNT>
            </CONTRACTBILLINGSCHEDULEENTRY>
            <CONTRACTBILLINGSCHEDULEENTRY>
                <RECORDNO>1134</RECORDNO>
                <AMOUNT>150</AMOUNT>
            </CONTRACTBILLINGSCHEDULEENTRY>
        </CONTRACTBILLINGSCHEDULEENTRIES>
    </CONTRACTBILLINGSCHEDULE>
</update>

Parameters

Name Required Type Description
CONTRACTBILLINGSCHEDULEENTRY Required string Object to update
RECORDNO Required string RECORDNO of the parent contract billing schedule
CONTRACTBILLINGSCHEDULEENTRIES Required CONTRACTBILLINGSCHEDULEENTRY[1...n] Contract billing schedule entries

CONTRACTBILLINGSCHEDULEENTRY[1...n]

Name Required Type Description
CONTRACTBILLINGSCHEDULEENTRY Required string Object to update
RECORDNO Required string RECORDNO of the schedule entry. Only required for updating an entry.
POSTINGDATE Optional string Scheduled billing date. Required for a new entry.
AMOUNT Optional string Amount for the entry. Required for a new entry.

Provide feedback