An expense template defines the schedule to recognize an expense amount for a contract or contract line over the contract term.


List Expense Templates

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACTEXPENSETEMPLATE
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.
METHOD Optional string Recognition method. Use S for Straight line, D for Daily rate, or P for Predefined percentages.
POSTINGTYPE Optional string Default posting type. Use A for Automatic, M for Manual

Get Expense Template

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACTEXPENSETEMPLATE
keys Required string Expense template 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 Expense Template by Name

readByName

<readByName>
    <object>CONTRACTEXPENSETEMPLATE</object>
    <keys>10-20-30-40exp</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use CONTRACTEXPENSETEMPLATE
keys Required string Expense template 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 Expense Template

create

<create>
    <CONTRACTEXPENSETEMPLATE>
        <NAME>BasicExp</NAME>
        <DESCRIPTION>Basic straight line</DESCRIPTION>
        <METHOD>Straight line</METHOD>
        <POSTINGTYPE>Manual</POSTINGTYPE>
    </CONTRACTEXPENSETEMPLATE>
</create>

Create an expense template based on predefined percentages:

<create>
    <CONTRACTEXPENSETEMPLATE>
        <NAME>10-20-30-40exp</NAME>
        <DESCRIPTION>Increasing percentages at 2, 4, 6, and 8 months</DESCRIPTION>
        <METHOD>Predefined percentages</METHOD>
        <CONTRACTEXPENSETEMPLATEENTRIES>
            <CONTRACTEXPENSETEMPLATEENTRY>
                <PERIODOFFSET>2</PERIODOFFSET>
                <PERIODPERCENT>40</PERIODPERCENT>
            </CONTRACTEXPENSETEMPLATEENTRY>
            <CONTRACTEXPENSETEMPLATEENTRY>
                <PERIODOFFSET>4</PERIODOFFSET>
                <PERIODPERCENT>30</PERIODPERCENT>
            </CONTRACTEXPENSETEMPLATEENTRY>
            <CONTRACTEXPENSETEMPLATEENTRY>
                <PERIODOFFSET>6</PERIODOFFSET>
                <PERIODPERCENT>20</PERIODPERCENT>
            </CONTRACTEXPENSETEMPLATEENTRY>
            <CONTRACTEXPENSETEMPLATEENTRY>
                <PERIODOFFSET>8</PERIODOFFSET>
                <PERIODPERCENT>10</PERIODPERCENT>
            </CONTRACTEXPENSETEMPLATEENTRY>
        </CONTRACTEXPENSETEMPLATEENTRIES>
    </CONTRACTEXPENSETEMPLATE>
</create>

Parameters

Name Required Type Description
CONTRACTEXPENSETEMPLATE Required object Object to create

CONTRACTEXPENSETEMPLATE

Name Required Type Description
NAME Required string Expense template name
DESCRIPTION Optional string Description
METHOD Optional string Amortization method. Use Straight line, Daily rate, or Predefined percentages. (Default: Straight line)
POSTINGTYPE Optional string Default posting type. Use Automatic or Manual. (Default: Manual)
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive. (Default: active)
CONTRACTEXPENSETEMPLATEENTRIES Optional CONTRACTEXPENSETEMPLATEENTRY[1…n] Template details for Predefined percentages.

CONTRACTEXPENSETEMPLATEENTRY

Name Required Type Description
PERIODOFFSET Optional integer Number of months offset for the Predefined percentages recognition method
PERIODPERCENT Optional number Percentage to recognize. Must add up to 100 percent.

Update Expense Template

update

<update>
    <CONTRACTEXPENSETEMPLATE>
        <NAME>10-20-30-40exp</NAME>
        <DESCRIPTION>New description</DESCRIPTION>
    </CONTRACTEXPENSETEMPLATE>
</update>

Parameters

Name Required Type Description
CONTRACTEXPENSETEMPLATE Required object Object to update

CONTRACTEXPENSETEMPLATE

Name Required Type Description
RECORDNO Optional integer Record number of expense template. Required if not using NAME.
NAME Optional string Expense template name. Required if not using RECORDNO.
DESCRIPTION Optional string Description
METHOD Optional string Amortization method. Use Straight line, Daily rate, or Predefined percentages. (Default: Straight line)
POSTINGTYPE Optional string Default posting type. Use Automatic or Manual. (Default: Manual)
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive. (Default: active)
CONTRACTEXPENSETEMPLATEENTRIES Optional CONTRACTREVENUETEMPLATEENTRY[1…n] Template details for Predefined percentages. When updating template details, you are providing a complete new set of entries (existing entries are deleted).

CONTRACTEXPENSETEMPLATEENTRY

When updating template details, you are providing a complete new set of entries (existing entries are deleted).

Name Required Type Description
PERIODOFFSET Optional integer Number of months offset for the Predefined percentages recognition method
PERIODPERCENT Optional number Percentage to recognize. Must add up to 100 percent.

Delete Expense Template

delete

<delete>
    <object>CONTRACTEXPENSETEMPLATE</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use CONTRACTEXPENSETEMPLATE
keys Required string Expense template RECORDNO to delete

Provide feedback