List Records

readByQuery

List a standard object’s records

<readByQuery>
    <object>VENDOR</object>
    <fields>*</fields>
    <query>STATUS = 'T'</query>
    <pagesize>100</pagesize>
</readByQuery>

List a custom object’s records

<readByQuery>
    <object>api_test_record</object>
    <fields>*</fields>
    <query>id &gt;= 10000</query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string The object integration name to list.
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)
docparid Optional string Used for SODOCUMENT and PODOCUMENT records to indicate the document type. You must use this to take advantage of any custom fields on the specified document type.

Get Record

Read

Get standard object record

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

Get custom object record

<read>
    <object>api_test_record</object>
    <keys>10001</keys>
    <fields>*</fields>
</read>

Get multiple standard object records

<read>
    <object>VENDOR</object>
    <keys>1,2,3,9</keys>
    <fields>*</fields>
</read>

Get multiple custom object records

<read>
    <object>api_test_record</object>
    <keys>10001,10009,10015</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string The object integration name to get.
keys Required string The object record key(s) to read. Standard objects use the RECORDNO otherwise custom objects use the id. Keys must be comma separated, max count of 100 keys.
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.
docparid Optional string Used for SODOCUMENT and PODOCUMENT records to indicate the document type. You must use this to take advantage of any custom fields on the specified document type.

Get Record by Name

readByName

<readByName>
    <object>VENDOR</object>
    <keys>V1234</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string The object integration name to get.
keys Required string The record name to get. For custom object use name. This field varies for standard objects.
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.
docparid Optional string Used for SODOCUMENT and PODOCUMENT records to indicate the document type. You must use this to take advantage of any custom fields on the specified document type.

Create Record

create

Create a standard object record

<create>
    <VENDOR>
        <VENDORID>Unit - A-1208</VENDORID>
        <NAME>this is the name8</NAME>
        <VCF_BILL_SITEID3>FOOBAR8</VCF_BILL_SITEID3>
    </VENDOR>
</create>

Create a custom object record

<create>
    <api_test_record>
        <name>foobar1</name>
        <api_checkbox>true</api_checkbox>
        <api_currency>4.99</api_currency>
        <api_date>2009-05-26</api_date>
        <api_datetime>2009-05-26T12:01:01Z</api_datetime>
        <api_time>12:01:01</api_time>
        <api_decimal>10.3844</api_decimal>
        <api_email>noreply@intacct.com</api_email>
        <api_integer>123</api_integer>
        <api_percent>50.01</api_percent>
        <api_picklist>green</api_picklist>
        <api_picklistmulti>red,green</api_picklistmulti>
        <api_radio>green</api_radio>
        <api_checkboxes>red,green</api_checkboxes>
        <api_text>This is sample text 2</api_text>
        <api_textarea>This is text area
            this is a new line itext area</api_textarea>
        <api_url>https://www.intacct.com</api_url>
    </api_test_record>
</create>

Create multiple standard and custom object records

<create>
    <VENDOR>
        <VENDORID>Unit - A-1208</VENDORID>
        <NAME>this is the name8</NAME>
        <VCF_BILL_SITEID3>FOOBAR8</VCF_BILL_SITEID3>
    </VENDOR>
    <CUSTOMER>
        <CUSTOMERID>XML121</CUSTOMERID>
        <NAME>XML Customer 111</NAME>
    </CUSTOMER>
    <asset>
        <serial_number>123456789</serial_number>
        <date_placed_in_servi>08/10/2009</date_placed_in_servi>
        <date_of_disposition>10/12/2009</date_of_disposition>
        <asset_cost>123.45</asset_cost>
        <salvage_percentage>0.01</salvage_percentage>
        <Rasset_class>No class</Rasset_class>
    </asset>
</create>

Parameters

Name Required Type Description
OBJECTNAME Optional object[] The object(s) to create. Max 100 records. Records of different types can be used.

Update Record

update

Update a standard object record

<update>
    <VENDOR>
        <RECORDNO>202</RECORDNO>
        <VCF_BILL_SITEID3>foobar 2</VCF_BILL_SITEID3>
    </VENDOR>
</update>

Update a custom object record

<update>
    <api_test_record>
        <id>34923</id>
        <name>updated hello world</name>
    </api_test_record>
</update>

Update multiple standard and custom object records

<update>
    <CUSTOMER>
        <RECORDNO>141</RECORDNO>
        <NAME>XML Customer 190</NAME>
    </CUSTOMER>
    <VENDOR>
        <RECORDNO>202</RECORDNO>
        <VCF_BILL_SITEID3>foobar 2</VCF_BILL_SITEID3>
    </VENDOR>
    <asset>
        <id>1355196</id>
        <serial_number>123456789</serial_number>
        <asset_cost>499.95</asset_cost>
    </asset>
</update>

Parameters

Name Required Type Description
OBJECTNAME Optional object[] The object(s) to update. Max 100 records. Records of different types can be used.

Delete Record

delete

Delete a standard object record

<delete>
    <object>VENDOR</object>
    <keys>1</keys>
</delete>

Delete a custom object record

<delete>
    <object>api_test_record</object>
    <keys>41145</keys>
</delete>

Delete multiple standard object records

<delete>
    <object>VENDOR</object>
    <keys>1,2,3,4</keys>
</delete>

Delete multiple custom object records

<delete>
    <object>api_test_record</object>
    <keys>41145,41146,41147</keys>
</delete>

Parameters

Name Required Type Description
object Required string The object integration name to delete
keys Required string The object record key(s) to delete. Standard objects use the RECORDNO otherwise custom objects use the id. Keys must be comma separated, max count of 100 keys.

File Type Fields on Custom Objects

Setting an object to a file type field enables three fields for use on your object.

OBJECT

<MY_ACH_OBJECT>
    <ACHEFTFILE_contenttype>text/plain</ACHEFTFILE_contenttype>
    <ACHEFTFILE_filename>helloworld.txt</ACHEFTFILE_filename>
    <ACHEFTFILE>aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ==</ACHEFTFILE>
</MY_ACH_OBJECT>

Parameters

Name Required Type Description
FIELDNAME_contenttype Required string MIME type of file
FIELDNAME_filename Required string Filename of file
FIELDNAME Required string Base64 encoded data of the file

This will retrieve records related to one or more records by a given relationship.

readRelated

<readRelated>
    <object>asset</object>
    <keys>1160471</keys>
    <relation>Rasset_class</relation>
    <fields>*</fields>
</readRelated>

Parameters

Name Required Type Description
object Required string The custom object integration name to get.
relation Required string The name of relation to follow from the given keys.
keys Required string The custom object record id to get. Keys must be comma separated, max count of 100 keys.
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