Contract is a dimension that can be defined by the company and set on transactions to expand report functionality and insight.


List Contracts

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CONTRACT
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
STATE Optional string State. Use I for In progress, R for Renewed, C for Cancelled, N for Not renewed
BILLINGFREQUENCY Optional string Billing frequency. Use M for Monthly or Q for Quarterly
RENEWTERMPERIOD Optional string Renewal term period. Use Y for Years, M for Months, D for Days

Get Contract

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACT
keys Required string The contract 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 Contract by Name

readByName

<readByName>
    <object>CONTRACT</object>
    <keys>C1000</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use CONTRACT
keys Required string The contract CONTRACTID 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

create

<create>
    <CONTRACT>
        <CONTRACTID>CTRC-003</CONTRACTID>
        <CUSTOMERID>C-103</CUSTOMERID>
        <NAME>North central contract</NAME>
        <BEGINDATE>04/01/2017</BEGINDATE>
        <ENDDATE>12/31/2017</ENDDATE>
        <BILLINGFREQUENCY>Monthly</BILLINGFREQUENCY>
        <TERMNAME>Net 30</TERMNAME>
        <LOCATIONID>US</LOCATIONID>
        <CURRENCY>USD</CURRENCY>
        <EXCHRATETYPE>Intacct Daily Rate</EXCHRATETYPE>
    </CONTRACT>
</create>

Parameters

Name Required Type Description
CONTRACT Optional object The object to create

CONTRACT

Name Required Type Description
CONTRACTID Optional string The contract ID to create. Required if company does not use auto-numbering.
CUSTOMERID Required string Customer ID
NAME Required string Contract name
BILLTOCONTACTNAME Optional string Bill to contact name. Leave blank to use customer’s default.
DESCRIPTION Optional string Description
SHIPTOCONTACTNAME Optional string Ship to contact name. Leave blank to use customer’s default.
BEGINDATE Required string Start date in format mm/dd/yyyy
ENDDATE Required string End date in format mm/dd/yyyy
BILLINGFREQUENCY Required string Billing frequency. Use Monthly or Quarterly (Default: Monthly)
TERMNAME Required string Payment term
PRCLIST Optional string Billing price list
MEAPRCLIST Optional string Fair value price list
SUPDOCID Optional string Attachments ID
LOCATIONID Required string Location ID
DEPARTMENTID Optional string Department ID
PROJECTID Optional string Project ID
VENDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
CLASSID Optional string Class ID
CURRENCY Optional string Transaction currency. Required if company is configured for multi-currency.
EXCHRATETYPE Optional string Exchange rate type. Required if company is configured for multi-currency (Leave blank to use Intacct Daily Rate)
RENEWAL Optional boolean Renewal. Use false for No, true for Yes. (Default: false)
RENEWALMACRO Optional string Renewal template
RENEWTERMLENGTH Optional integer Term length. Only used if RENEWAL is true
RENEWTERMPERIOD Optional string Period. Only used if RENEWAL is true. Use either Years, Months, Days (Default: Months)

Update Contract

update

<update>
    <CONTRACT>
        <CONTRACTID>CTRC-003</CONTRACTID>
        <NAME>North central contract for services</NAME>
        <DEPARTMENTID>300</DEPARTMENTID>
    </CONTRACT>
</update>

Parameters

Name Required Type Description
CONTRACT Optional object The object to update

CONTRACT

Name Required Type Description
RECORDNO Optional integer Record number of contract. Required if not using CONTRACTID.
CONTRACTID Optional string The contract ID to update. Required if not using RECORDNO.
CUSTOMERID Optional string Customer ID
NAME Optional string Contract name
BILLTOCONTACTNAME Optional string Bill to contact name
DESCRIPTION Optional string Description
SHIPTOCONTACTNAME Optional string Ship to contact name
BEGINDATE Optional string Start date in format mm/dd/yyyy
ENDDATE Optional string End date in format mm/dd/yyyy
BILLINGFREQUENCY Optional string Billing frequency. Use Monthly or Quarterly
TERMNAME Optional string Payment term
PRCLIST Optional string Billing price list
MEAPRCLIST Optional string Fair value price list
SUPDOCID Optional string Attachments ID
LOCATIONID Optional string Location ID
DEPARTMENTID Optional string Department ID
PROJECTID Optional string Project ID
VENDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
CLASSID Optional string Class ID
CURRENCY Optional string Transaction currency.
EXCHRATETYPE Optional string Exchange rate type.
RENEWAL Optional boolean Renewal. Use false for No, true for Yes.
RENEWALMACRO Optional string Renewal template
RENEWTERMLENGTH Optional integer Term length. Only used if RENEWAL is true
RENEWTERMPERIOD Optional string Period. Only used if RENEWAL is true. Use either Years, Months, Days (Default: Months)

Delete Contract

delete

<delete>
    <object>CONTRACT</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use CONTRACT
keys Required string The contract RECORDNO to delete

List Contract Expenses

readByQuery

<readByQuery>
    <object>CONTRACTEXPENSE</object>
    <fields>*</fields>
    <query>TYPE = 'C'</query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use CONTRACTEXPENSE
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
TYPE Required string Type. Use C for Contract expenses.
STATE Optional string State. Use P for In progress, C for Cancelled

Get Contract Expense

read

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

Parameters

Name Required Type Description
object Required string Use CONTRACTEXPENSE
keys Required string The contract expense 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 Contract Expense

create

<create>
    <CONTRACTEXPENSE>
        <CONTRACTID>CTRC-003</CONTRACTID>
        <ITEMID>SUPP</ITEMID>
        <POSTINGDATE>05/01/2017</POSTINGDATE>
        <AMOUNT>400.00</AMOUNT>
        <LOCATIONID>US</LOCATIONID>
        <TEMPLATENAME>SL Man (Exp)</TEMPLATENAME>
    </CONTRACTEXPENSE>
</create>

Parameters

Name Required Type Description
CONTRACTEXPENSE Optional object The object to create

CONTRACTEXPENSE

Name Required Type Description
CONTRACTID Required string Contract ID
ITEMID Required string Item ID
POSTINGDATE Required string Posting date in format mm/dd/yyyy
EXCH_RATE_DATE Optional string Exchange rate date in format mm/dd/yyyy. Leave blank to use posting date.
EXCHANGE_RATE Optional currency Exchange rate value.
AMOUNT Required currency Amount
LOCATIONID Required string Location ID
DEPARTMENTID Optional string Department ID
PROJECTID Optional string Project ID
VENDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
CLASSID Optional string Class ID
TEMPLATENAME Optional string 606 expense template
STARTDATE Optional string 606 expense start date in format mm/dd/yyyy. Leave blank to use contract/line start date
ENDDATE Optional string 606 expense end date in format mm/dd/yyyy. Leave blank to use contract/line end date
TEMPLATE2NAME Optional string Legacy expense template
START2DATE Optional string Legacy expense start date in format mm/dd/yyyy. Leave blank to use contract/line start date
END2DATE Optional string Legacy expense end date in format mm/dd/yyyy. Leave blank to use contract/line end date

Update Contract Expense

update

<create>
    <CONTRACTEXPENSE>
        <RECORDNO>123</RECORDNO>
        <DEPARTMENTID>500</DEPARTMENTID>
    </CONTRACTEXPENSE>
</create>

Parameters

Name Required Type Description
CONTRACTEXPENSE Optional object The object to update

CONTRACTEXPENSE

Name Required Type Description
RECORDNO Optional integer Record number of contract expense to update.
ITEMID Optional string Item ID
POSTINGDATE Optional string Posting date in format mm/dd/yyyy
EXCH_RATE_DATE Optional string Exchange rate date in format mm/dd/yyyy
EXCHANGE_RATE Optional currency Exchange rate value.
AMOUNT Optional currency Amount
LOCATIONID Optional string Location ID
DEPARTMENTID Optional string Department ID
PROJECTID Optional string Project ID
VENDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
CLASSID Optional string Class ID
TEMPLATENAME Optional string 606 expense template
STARTDATE Optional string 606 expense start date in format mm/dd/yyyy. Leave blank to use contract/line start date
ENDDATE Optional string 606 expense end date in format mm/dd/yyyy. Leave blank to use contract/line end date
TEMPLATE2NAME Optional string Legacy expense template
START2DATE Optional string Legacy expense start date in format mm/dd/yyyy. Leave blank to use contract/line start date
END2DATE Optional string Legacy expense end date in format mm/dd/yyyy. Leave blank to use contract/line end date

Delete Contract Expense

delete

<delete>
    <object>CONTRACTEXPENSE</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use CONTRACTEXPENSE
keys Required string The contract expense RECORDNO to delete

Provide feedback