A Customer is any company to which you sell goods and services. Other Intacct applications use customer information—not only for record-keeping purposes, but also for printing names and addresses on forms, such as invoices, and for determining the location of the Ship To contact so that sales can be computed correctly


List Customers

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CUSTOMER
fields Required string Comma separated list of fields on the object to list. Use * to return all fields.
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)

Get Customer

read

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

Parameters

Name Required Type Description
object Required string Use CUSTOMER
keys Required string The customer RECORDNO to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Get Customer by Name

readByName

<readByName>
    <object>CUSTOMER</object>
    <keys>C1234</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use CUSTOMER
keys Required string The customer CUSTOMERID to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Create Customer

create

<create>
    <CUSTOMER>
        <CUSTOMERID>C1234</CUSTOMERID>
        <NAME>Intacct Corp</NAME>
        <DISPLAYCONTACT>
            <PRINTAS>Intacct Corporation</PRINTAS>
            <COMPANYNAME>Intacct Corp.</COMPANYNAME>
            <TAXABLE>true</TAXABLE>
            <TAXGROUP>CA</TAXGROUP>
            <PREFIX>Mr</PREFIX>
            <FIRSTNAME>Bill</FIRSTNAME>
            <LASTNAME>Smith</LASTNAME>
            <INITIAL>G</INITIAL>
            <PHONE1>12</PHONE1>
            <PHONE2>34</PHONE2>
            <CELLPHONE>56</CELLPHONE>
            <PAGER>78</PAGER>
            <FAX>90</FAX>
            <EMAIL1>noreply@intacct.com</EMAIL1>
            <EMAIL2>noreplyagain@intacct.com</EMAIL2>
            <URL1>www.intacct.com</URL1>
            <URL2>us.intacct.com</URL2>
            <MAILADDRESS>
                <ADDRESS1>300 Park Ave</ADDRESS1>
                <ADDRESS2>Ste 1400</ADDRESS2>
                <CITY>San Jose</CITY>
                <STATE>CA</STATE>
                <ZIP>95110</ZIP>
                <COUNTRY>United States</COUNTRY>
            </MAILADDRESS>
        </DISPLAYCONTACT>
        <ONETIME>false</ONETIME>
        <STATUS>active</STATUS>
        <HIDEDISPLAYCONTACT>false</HIDEDISPLAYCONTACT>
        <CUSTTYPE>SaaS</CUSTTYPE>
        <PARENTID>C5678</PARENTID>
        <GLGROUP>Group</GLGROUP>
        <TERRITORYID>NE</TERRITORYID>
        <SUPDOCID>A1234</SUPDOCID>
        <TERMNAME>N30</TERMNAME>
        <OFFSETGLACCOUNTNO>1200</OFFSETGLACCOUNTNO>
        <ARACCOUNT>4000</ARACCOUNT>
        <SHIPPINGMETHOD>USPS</SHIPPINGMETHOD>
        <RESALENO>123</RESALENO>
        <TAXID>12-3456789</TAXID>
        <CREDITLIMIT>1234.56</CREDITLIMIT>
        <ONHOLD>false</ONHOLD>
        <DELIVERYOPTIONS>Print</DELIVERYOPTIONS>
        <CUSTMESSAGEID>hello</CUSTMESSAGEID>
        <COMMENTS>my comment</COMMENTS>
        <CURRENCY>USD</CURRENCY>
        <ARINVOICEPRINTTEMPLATEID>temp1</ARINVOICEPRINTTEMPLATEID>
        <OEQUOTEPRINTTEMPLATEID>temp2</OEQUOTEPRINTTEMPLATEID>
        <OEORDERPRINTTEMPLATEID>temp3</OEORDERPRINTTEMPLATEID>
        <OELISTPRINTTEMPLATEID>temp4</OELISTPRINTTEMPLATEID>
        <OEINVOICEPRINTTEMPLATEID>temp5</OEINVOICEPRINTTEMPLATEID>
        <OEADJPRINTTEMPLATEID>temp6</OEADJPRINTTEMPLATEID>
        <OEOTHERPRINTTEMPLATEID>temp7</OEOTHERPRINTTEMPLATEID>
        <CONTACTINFO>
            <CONTACTNAME>primary</CONTACTNAME>
        </CONTACTINFO>
        <BILLTO>
            <CONTACTNAME>bill to</CONTACTNAME>
        </BILLTO>
        <SHIPTO>
            <CONTACTNAME>ship to</CONTACTNAME>
        </SHIPTO>
        <OBJECTRESTRICTION>Restricted</OBJECTRESTRICTION>
        <RESTRICTEDLOCATIONS>100#~#200</RESTRICTEDLOCATIONS>
        <RESTRICTEDDEPARTMENTS>D100#~#D200</RESTRICTEDDEPARTMENTS>
        <CUSTOMFIELD1>Hello</CUSTOMFIELD1>
    </CUSTOMER>
</create>

Parameters

Name Required Type Description
CUSTOMER Optional object The object to create

CUSTOMER

Name Required Type Description
CUSTOMERID Optional string The customer ID to create. Required if company does not use auto-numbering.
NAME Required string Name
DISPLAYCONTACT Required object Contact info
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
ONETIME Optional boolean One time. Use false for No, true for Yes. (Default: false)
HIDEDISPLAYCONTACT Optional boolean Exclude from contact list. Use false for No, true for Yes. (Default: false)
CUSTTYPE Optional string Customer type ID
CUSTREPID Optional string Sales rep employee ID
PARENTID Optional string Parent customer ID
GLGROUP Optional string GL group name
TERRITORYID Optional string Territory ID
SUPDOCID Optional string Attachments ID
TERMNAME Optional string Payment term
OFFSETGLACCOUNTNO Optional string Offset AR GL account number
ARACCOUNT Optional string Default revenue GL account number
SHIPPINGMETHOD Optional string Shipping method
RESALENO Optional string Resale number
TAXID Optional string Tax ID
CREDITLIMIT Optional currency Credit limit
ONHOLD Optional boolean On hold. Use false for No, true for Yes. (Default: false)
DELIVERYOPTIONS Optional string Delivery method. Use either Print, E-Mail, or Print#~#E-Mail for both.
CUSTMESSAGEID Optional string Default invoice message
COMMENTS Optional string Comments
CURRENCY Optional string Default currency code
ARINVOICEPRINTTEMPLATEID Optional string Print option - AR invoice template name
OEQUOTEPRINTTEMPLATEID Optional string Print option - OE quote template name
OEORDERPRINTTEMPLATEID Optional string Print option - OE order template name
OELISTPRINTTEMPLATEID Optional string Print option - OE list template name
OEINVOICEPRINTTEMPLATEID Optional string Print option - OE invoice template name
OEADJPRINTTEMPLATEID Optional string Print option - OE adjustment template name
OEOTHERPRINTTEMPLATEID Optional string Print option - OE other template name
CONTACTINFO Optional object Primary contact. If blank system will use DISPLAYCONTACT.
BILLTO Optional object Bill to contact. If blank system will use DISPLAYCONTACT.
SHIPTO Optional object Ship to contact. If blank system will use DISPLAYCONTACT.
OBJECTRESTRICTION Optional object Restriction type. Use Unrestricted, RootOnly, or Restricted. (Default Unrestricted)
RESTRICTEDLOCATIONS Optional string Restricted location ID’s. Use if OBJECTRESTRICTION is Restricted. Implode multiple ID’s with #~#.
RESTRICTEDDEPARTMENTS Optional string Restricted department ID’s. Use if OBJECTRESTRICTION is Restricted. Implode multiple ID’s with #~#.
Custom fields Optional varies This object supports custom fields.

DISPLAYCONTACT

Name Required Type Description
PRINTAS Required string Print as
CONTACTNAME Optional string If left blank, system will create the name as [NAME](C[CUSTOMERID])
COMPANYNAME Optional string Company name
TAXABLE Optional boolean Taxable. Use false for No, true for Yes. (Default: true)
TAXGROUP Optional string Contact tax group name
PREFIX Optional string Prefix
FIRSTNAME Optional string First name
LASTNAME Optional string Last name
INITIAL Optional string Middle name
PHONE1 Optional string Primary phone number
PHONE2 Optional string Secondary phone number
CELLPHONE Optional string Cellular phone number
PAGER Optional string Pager number
FAX Optional string Fax number
EMAIL1 Optional string Primary email address
EMAIL2 Optional string Secondary email address
URL1 Optional string Primary URL
URL2 Optional string Secondary URL
MAILADDRESS Optional object Mail address

MAILADDRESS

Name Required Type Description
ADDRESS1 Optional string Address line 1
ADDRESS2 Optional string Address line 2
CITY Optional string City
STATE Optional string State/province
ZIP Optional string Zip/postal code
COUNTRY Optional string Country

CONTACTINFO

Name Required Type Description
CONTACTNAME Required string Primary contact name

BILLTO

Name Required Type Description
CONTACTNAME Required string Bill to contact name

SHIPTO

Name Required Type Description
CONTACTNAME Required string Ship to contact name

Update Customer

update

<update>
    <CUSTOMER>
        <RECORDNO>12</RECORDNO>
        <NAME>Intacct Corp</NAME>
        <DISPLAYCONTACT>
            <PRINTAS>Intacct Corporation</PRINTAS>
            <COMPANYNAME>Intacct Corp.</COMPANYNAME>
            <TAXABLE>true</TAXABLE>
            <TAXGROUP>CA</TAXGROUP>
            <PREFIX>Mr</PREFIX>
            <FIRSTNAME>Bill</FIRSTNAME>
            <LASTNAME>Smith</LASTNAME>
            <INITIAL>G</INITIAL>
            <PHONE1>12</PHONE1>
            <PHONE2>34</PHONE2>
            <CELLPHONE>56</CELLPHONE>
            <PAGER>78</PAGER>
            <FAX>90</FAX>
            <EMAIL1>noreply@intacct.com</EMAIL1>
            <EMAIL2>noreplyagain@intacct.com</EMAIL2>
            <URL1>www.intacct.com</URL1>
            <URL2>us.intacct.com</URL2>
            <MAILADDRESS>
                <ADDRESS1>300 Park Ave</ADDRESS1>
                <ADDRESS2>Ste 1400</ADDRESS2>
                <CITY>San Jose</CITY>
                <STATE>CA</STATE>
                <ZIP>95110</ZIP>
                <COUNTRY>United States</COUNTRY>
            </MAILADDRESS>
        </DISPLAYCONTACT>
        <ONETIME>false</ONETIME>
        <STATUS>active</STATUS>
        <HIDEDISPLAYCONTACT>false</HIDEDISPLAYCONTACT>
        <CUSTTYPE>SaaS</CUSTTYPE>
        <PARENTID>C5678</PARENTID>
        <GLGROUP>Group</GLGROUP>
        <TERRITORYID>NE</TERRITORYID>
        <SUPDOCID>A1234</SUPDOCID>
        <TERMNAME>N30</TERMNAME>
        <OFFSETGLACCOUNTNO>1200</OFFSETGLACCOUNTNO>
        <ARACCOUNT>4000</ARACCOUNT>
        <SHIPPINGMETHOD>USPS</SHIPPINGMETHOD>
        <RESALENO>123</RESALENO>
        <TAXID>12-3456789</TAXID>
        <CREDITLIMIT>1234.56</CREDITLIMIT>
        <ONHOLD>false</ONHOLD>
        <DELIVERYOPTIONS>Print#~#E-Mail</DELIVERYOPTIONS>
        <CUSTMESSAGEID>hello</CUSTMESSAGEID>
        <COMMENTS>my comment</COMMENTS>
        <CURRENCY>USD</CURRENCY>
        <ARINVOICEPRINTTEMPLATEID>temp1</ARINVOICEPRINTTEMPLATEID>
        <OEQUOTEPRINTTEMPLATEID>temp2</OEQUOTEPRINTTEMPLATEID>
        <OEORDERPRINTTEMPLATEID>temp3</OEORDERPRINTTEMPLATEID>
        <OELISTPRINTTEMPLATEID>temp4</OELISTPRINTTEMPLATEID>
        <OEINVOICEPRINTTEMPLATEID>temp5</OEINVOICEPRINTTEMPLATEID>
        <OEADJPRINTTEMPLATEID>temp6</OEADJPRINTTEMPLATEID>
        <OEOTHERPRINTTEMPLATEID>temp7</OEOTHERPRINTTEMPLATEID>
        <CONTACTINFO>
            <CONTACTNAME>primary</CONTACTNAME>
        </CONTACTINFO>
        <BILLTO>
            <CONTACTNAME>bill to</CONTACTNAME>
        </BILLTO>
        <SHIPTO>
            <CONTACTNAME>ship to</CONTACTNAME>
        </SHIPTO>
        <OBJECTRESTRICTION>Restricted</OBJECTRESTRICTION>
        <RESTRICTEDLOCATIONS>100#~#200</RESTRICTEDLOCATIONS>
        <RESTRICTEDDEPARTMENTS>D100#~#D200</RESTRICTEDDEPARTMENTS>
        <CUSTOMFIELD1>Hello</CUSTOMFIELD1>
    </CUSTOMER>
</update>

Parameters

Name Required Type Description
CUSTOMER Optional object The object to update

CUSTOMER

Name Required Type Description
RECORDNO Required integer Record number of customer
NAME Optional string Name
DISPLAYCONTACT Optional object Contact info
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
ONETIME Optional boolean One time customer. Use false for No, true for Yes. (Default: false)
HIDEDISPLAYCONTACT Optional boolean Exclude from contact list. Use false for No, true for Yes. (Default: false)
CUSTTYPE Optional string Customer type ID
CUSTREPID Optional string Sales rep employee ID
PARENTID Optional string Parent customer ID
GLGROUP Optional string GL group name
TERRITORYID Optional string Territory ID
SUPDOCID Optional string Attachments ID
TERMNAME Optional string Payment term
OFFSETGLACCOUNTNO Optional string Offset AR GL account number
ARACCOUNT Optional string Default revenue GL account number
SHIPPINGMETHOD Optional string Shipping method
RESALENO Optional string Resale number
TAXID Optional string Tax ID
CREDITLIMIT Optional currency Credit limit
ONHOLD Optional boolean On hold. Use false for No, true for Yes. (Default: false)
DELIVERYOPTIONS Optional string Delivery method. Use either Print, E-Mail, or Print#~#E-Mail for both.
CUSTMESSAGEID Optional string Default invoice message
COMMENTS Optional string Comments
CURRENCY Optional string Default currency code
ARINVOICEPRINTTEMPLATEID Optional string Print option - AR invoice template name
OEQUOTEPRINTTEMPLATEID Optional string Print option - OE quote template name
OEORDERPRINTTEMPLATEID Optional string Print option - OE order template name
OELISTPRINTTEMPLATEID Optional string Print option - OE list template name
OEINVOICEPRINTTEMPLATEID Optional string Print option - OE invoice template name
OEADJPRINTTEMPLATEID Optional string Print option - OE adjustment template name
OEOTHERPRINTTEMPLATEID Optional string Print option - OE other template name
CONTACTINFO Optional object Primary contact
BILLTO Optional object Bill to contact
SHIPTO Optional object Ship to contact
OBJECTRESTRICTION Optional object Restriction type. Use Unrestricted, RootOnly, or Restricted. (Default Unrestricted)
RESTRICTEDLOCATIONS Optional string Restricted location ID’s. Use if OBJECTRESTRICTION is Restricted. Implode multiple ID’s with #~#.
RESTRICTEDDEPARTMENTS Optional string Restricted department ID’s. Use if OBJECTRESTRICTION is Restricted. Implode multiple ID’s with #~#.
Custom fields Optional varies This object supports custom fields.

DISPLAYCONTACT

Name Required Type Description
PRINTAS Optional string Print as
COMPANYNAME Optional string Company name
TAXABLE Optional boolean Taxable. Use false for No, true for Yes. (Default: true)
TAXGROUP Optional string Contact tax group name
PREFIX Optional string Prefix
FIRSTNAME Optional string First name
LASTNAME Optional string Last name
INITIAL Optional string Middle name
PHONE1 Optional string Primary phone number
PHONE2 Optional string Secondary phone number
CELLPHONE Optional string Cellular phone number
PAGER Optional string Pager number
FAX Optional string Fax number
EMAIL1 Optional string Primary email address
EMAIL2 Optional string Secondary email address
URL1 Optional string Primary URL
URL2 Optional string Secondary URL
MAILADDRESS Optional object Mail address

MAILADDRESS

Name Required Type Description
ADDRESS1 Optional string Address line 1
ADDRESS2 Optional string Address line 2
CITY Optional string City
STATE Optional string State/province
ZIP Optional string Zip/postal code
COUNTRY Optional string Country

CONTACTINFO

Name Required Type Description
CONTACTNAME Required string Primary contact name

BILLTO

Name Required Type Description
CONTACTNAME Required string Bill to contact name

SHIPTO

Name Required Type Description
CONTACTNAME Required string Ship to contact name

Delete Customer

delete

<delete>
    <object>CUSTOMER</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use CUSTOMER
keys Required string The customer RECORDNO to delete

Provide feedback