Filter sets help you narrow your focus when creating previews for contract invoice runs.


List Contract Invoice Filter Sets

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

ReadByQuery

Name Required Type Description
object Required string Use GENINVOICEFILTERS
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 Contract Invoice Filter Set

read

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

Parameters

Name Required Type Description
object Required string Use GENINVOICEFILTERS
keys Required string RECORDNO of the contract invoice filter set 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 Contract Invoice Filter Set

create

<create>
    <GENINVOICEFILTERS>
        <NAME>My filter</NAME>
        <CONTRACTID>CTRC-003</CONTRACTID>
        <INCLUDECONTRACTS>true</INCLUDECONTRACTS>
        <INCLUDECONTRACTUSAGE>true</INCLUDECONTRACTUSAGE>
    </GENINVOICEFILTERS>
</create>

Parameters

Name Required Type Description
GENINVOICEFILTERS Required string Object to create

GENINVOICEFILTERS

Name Required Type Description
NAME Required string Name for the filter set
DESCRIPTION Optional string Description
SETASOFDATE Optional string Dynamic As of date based on current date. Use Today, Yesterday, End of this week, End of last week, Beginning of this month, End of this month, or End of last month. (Default: today’s date)
DOCPARID Optional string Transaction definition to use. Definition must be enabled for Contracts.
CONTRACTID Optional string Contract ID
CONTRACTGROUPID Optional string Contract group ID
CURRENCY Optional currency Currency code
PROJECTID Optional string Project ID
PROJECTTYPEID Optional string Project type ID
PROJECTMANAGERID Optional string Project manager ID
EMPLOYEEID Optional string Employee ID
CUSTOMERID Optional string Customer ID
CUSTOMERTYPEID Optional string Customer type ID
ITEMID Optional string Item ID
ITEMGROUPID Optional string Item group ID
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID
STATUS Optional string Status for the filter set itself. Use active for an Active filter set or inactive for an Inactive filter set (Default: Active). An inactive filter set cannot be used to generate invoice previews until it is reactivated.
INCLUDECONTRACTS Optional Boolean Use true to include Contract transactions. (Default: false)
INCLUDECONTRACTUSAGE Optional Boolean Use true to include Contract usage transactions. (Default: false)

Update Contract Invoice Filter Set

update

<update>
    <GENINVOICEFILTERS>
        <RECORDNO>1</RECORDNO>
        <CONTRACTID>CTRC-003</CONTRACTID>
        <INCLUDECONTRACTS>true</INCLUDECONTRACTS>
    </GENINVOICEFILTERS>
</update>

Parameters

Name Required Type Description
GENINVOICEFILTERS Required string Object to update

GENINVOICEFILTERS

Name Required Type Description
KEYS Required string RECORDNO for the filter set to delete
DESCRIPTION Optional string Description
SETASOFDATE Optional string Dynamic As of date based on current date. Use Today, Yesterday, End of this week, End of last week, Beginning of this month, End of this month, or End of last month. (Default: today’s date)
DOCPARID Optional string Transaction definition to use. Definition must be enabled for Contracts.
CONTRACTID Optional string Contract ID
CONTRACTGROUPID Optional string Contract group ID
CURRENCY Optional currency Currency code
PROJECTID Optional string Project ID
PROJECTTYPEID Optional string Project type ID
PROJECTMANAGERID Optional string Project manager ID
EMPLOYEEID Optional string Employee ID
CUSTOMERID Optional string Customer ID
CUSTOMERTYPEID Optional string Customer type ID
ITEMID Optional string Item ID
ITEMGROUPID Optional string Item group ID
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID
STATUS Optional string Status for the filter set itself. Use active for an Active filter set or inactive for an Inactive filter set (Default: Active). An inactive filter set cannot be used to generate invoice previews until it is reactivated.
INCLUDECONTRACTS Optional Boolean Use true to include Contract transactions.
INCLUDECONTRACTUSAGE Optional Boolean Use true to include Contract usage transactions.

Delete Contract Invoice Filter Set

delete

<delete>
    <object>GENINVOICEFILTERS</object>
    <keys>1</keys>
</delete>

Parameters

Name Required Type Description
GENINVOICEFILTERS Required string Object to delete

GENINVOICEFILTERS

Name Required Type Description
KEYS Required string RECORDNO for the filter set to delete

Provide feedback