Vendors are companies or individuals that are paid for goods and services.


List Vendors

readByQuery

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

Parameters

Name Required Type Description
object Required string Use VENDOR
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)

query

Name Required Type Description
STATUS Optional string Status. Use T for Active and F for Inactive.
ONETIME Optional string One-time use. Use T for one-time use or F otherwise.

Get Vendor

read

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

Parameters

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

Get Vendor by Name

readByName

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

Parameters

Name Required Type Description
object Required string Use VENDOR
keys Required string The vendor VENDORID to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Create Vendor

create

<create>
    <VENDOR>
        <VENDORID>V1234</VENDORID>
        <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>
        <VENDTYPE>SaaS</VENDTYPE>
        <PARENTID>V5678</PARENTID>
        <GLGROUP>Group</GLGROUP>
        <TAXID>12-3456789</TAXID>
        <NAME1099>INTACCT CORP</NAME1099>
        <FORM1099TYPE>MISC</FORM1099TYPE>
        <FORM1099BOX>3</FORM1099BOX>
        <SUPDOCID>A1234</SUPDOCID>
        <APACCOUNT>2000</APACCOUNT>
        <CREDITLIMIT>1234.56</CREDITLIMIT>
        <ONHOLD>false</ONHOLD>
        <DONOTCUTCHECK>false</DONOTCUTCHECK>
        <COMMENTS>my comment</COMMENTS>
        <CURRENCY>USD</CURRENCY>
        <CONTACTINFO>
            <CONTACTNAME>primary</CONTACTNAME>
        </CONTACTINFO>
        <PAYTO>
            <CONTACTNAME>pay to</CONTACTNAME>
        </PAYTO>
        <RETURNTO>
            <CONTACTNAME>return to</CONTACTNAME>
        </RETURNTO>
        <PAYMETHODKEY>Printed Check</PAYMETHODKEY>
        <MERGEPAYMENTREQ>true</MERGEPAYMENTREQ>
        <PAYMENTNOTIFY>true</PAYMENTNOTIFY>
        <BILLINGTYPE>openitem</BILLINGTYPE>
        <PAYMENTPRIORITY>Normal</PAYMENTPRIORITY>
        <TERMNAME>N30</TERMNAME>
        <DISPLAYTERMDISCOUNT>false</DISPLAYTERMDISCOUNT>
        <ACHENABLED>true</ACHENABLED>
        <ACHBANKROUTINGNUMBER>123456789</ACHBANKROUTINGNUMBER>
        <ACHACCOUNTNUMBER>1111222233334444</ACHACCOUNTNUMBER>
        <ACHACCOUNTTYPE>Checking Account</ACHACCOUNTTYPE>
        <ACHREMITTANCETYPE>CTX</ACHREMITTANCETYPE>
        <VENDORACCOUNTNO>9999999</VENDORACCOUNTNO>
        <DISPLAYACCTNOCHECK>false</DISPLAYACCTNOCHECK>
        <OBJECTRESTRICTION>Restricted</OBJECTRESTRICTION>
        <RESTRICTEDLOCATIONS>100#~#200</RESTRICTEDLOCATIONS>
        <RESTRICTEDDEPARTMENTS>D100#~#D200</RESTRICTEDDEPARTMENTS>
        <CUSTOMFIELD1>Hello</CUSTOMFIELD1>
    </VENDOR>
</create>

Parameters

Name Required Type Description
VENDOR Optional object The object to create

VENDOR

Name Required Type Description
VENDORID Optional string The vendor 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)
VENDTYPE Optional string Vendor type ID
PARENTID Optional string Parent vendor ID
GLGROUP Optional string GL group name
TAXID Optional string Tax ID
NAME1099 Optional string Form 1099 name
FORM1099TYPE Optional string Form 1099 type
FORM1099BOX Optional string Form 1099 box
SUPDOCID Optional string Attachments ID
APACCOUNT Optional string Default expense GL account number
CREDITLIMIT Optional currency Credit limit
ONHOLD Optional boolean On hold. Use false for No, true for Yes. (Default: false)
DONOTCUTCHECK Optional boolean Do not pay. Use false for No, true for Yes. (Default: false)
COMMENTS Optional string Comments
CURRENCY Optional string Default currency code
CONTACTINFO Optional object Primary contact. If blank system will use DISPLAYCONTACT.
PAYTO Optional object Pay to contact. If blank system will use DISPLAYCONTACT.
RETURNTO Optional object Return to contact. If blank system will use DISPLAYCONTACT.
PAYMETHODKEY Optional string Preferred payment method
MERGEPAYMENTREQ Optional boolean Merge payment requests. Use false for No, true for Yes. (Default: true)
PAYMENTNOTIFY Optional boolean Send automatic payment notification. Use false for No, true for Yes. (Default: false)
BILLINGTYPE Optional string Payment term
PAYMENTPRIORITY Optional string Payment priority
TERMNAME Optional string Payment term
DISPLAYTERMDISCOUNT Optional boolean Display term discount on check stub. Use false for No, true for Yes. (Default: true)
ACHENABLED Optional boolean ACH enabled. Use false for No, true for Yes. (Default: false)
ACHBANKROUTINGNUMBER Optional string ACH bank routing number.
ACHACCOUNTNUMBER Optional string ACH bank account number.
ACHACCOUNTTYPE Optional string ACH bank account type.
ACHREMITTANCETYPE Optional string ACH bank account class.
VENDORACCOUNTNO Optional string Vendor account number
DISPLAYACCTNOCHECK Optional boolean Display location assigned account number on check stub. Use false for No, true for Yes. (Default: false)
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](V[VENDORID])
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

PAYTO

Name Required Type Description
CONTACTNAME Required string Pay to contact name

RETURNTO

Name Required Type Description
CONTACTNAME Required string Return to contact name

Update Vendor

update

<update>
    <VENDOR>
        <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>
        <VENDTYPE>SaaS</VENDTYPE>
        <PARENTID>V5678</PARENTID>
        <GLGROUP>Group</GLGROUP>
        <TAXID>12-3456789</TAXID>
        <NAME1099>INTACCT CORP</NAME1099>
        <FORM1099TYPE>MISC</FORM1099TYPE>
        <FORM1099BOX>3</FORM1099BOX>
        <SUPDOCID>A1234</SUPDOCID>
        <APACCOUNT>2000</APACCOUNT>
        <CREDITLIMIT>1234.56</CREDITLIMIT>
        <ONHOLD>false</ONHOLD>
        <DONOTCUTCHECK>false</DONOTCUTCHECK>
        <COMMENTS>my comment</COMMENTS>
        <CURRENCY>USD</CURRENCY>
        <CONTACTINFO>
            <CONTACTNAME>primary</CONTACTNAME>
        </CONTACTINFO>
        <PAYTO>
            <CONTACTNAME>pay to</CONTACTNAME>
        </PAYTO>
        <RETURNTO>
            <CONTACTNAME>return to</CONTACTNAME>
        </RETURNTO>
        <PAYMETHODKEY>Printed Check</PAYMETHODKEY>
        <MERGEPAYMENTREQ>true</MERGEPAYMENTREQ>
        <PAYMENTNOTIFY>true</PAYMENTNOTIFY>
        <BILLINGTYPE>openitem</BILLINGTYPE>
        <PAYMENTPRIORITY>Normal</PAYMENTPRIORITY>
        <TERMNAME>N30</TERMNAME>
        <DISPLAYTERMDISCOUNT>false</DISPLAYTERMDISCOUNT>
        <ACHENABLED>true</ACHENABLED>
        <ACHBANKROUTINGNUMBER>123456789</ACHBANKROUTINGNUMBER>
        <ACHACCOUNTNUMBER>1111222233334444</ACHACCOUNTNUMBER>
        <ACHACCOUNTTYPE>Checking Account</ACHACCOUNTTYPE>
        <ACHREMITTANCETYPE>CTX</ACHREMITTANCETYPE>
        <VENDORACCOUNTNO>9999999</VENDORACCOUNTNO>
        <DISPLAYACCTNOCHECK>false</DISPLAYACCTNOCHECK>
        <OBJECTRESTRICTION>Restricted</OBJECTRESTRICTION>
        <RESTRICTEDLOCATIONS>100#~#200</RESTRICTEDLOCATIONS>
        <RESTRICTEDDEPARTMENTS>D100#~#D200</RESTRICTEDDEPARTMENTS>
        <CUSTOMFIELD1>Hello</CUSTOMFIELD1>
    </VENDOR>
</update>

Parameters

Name Required Type Description
VENDOR Optional object The object to update

VENDOR

Name Required Type Description
RECORDNO Required integer Record number of vendor
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. 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)
VENDTYPE Optional string Vendor type ID
PARENTID Optional string Parent vendor ID
GLGROUP Optional string GL group name
TAXID Optional string Tax ID
NAME1099 Optional string Form 1099 name
FORM1099TYPE Optional string Form 1099 type
FORM1099BOX Optional string Form 1099 box
SUPDOCID Optional string Attachments ID
APACCOUNT Optional string Default expense GL account number
CREDITLIMIT Optional currency Credit limit
ONHOLD Optional boolean On hold. Use false for No, true for Yes. (Default: false)
DONOTCUTCHECK Optional boolean Do not pay. Use false for No, true for Yes. (Default: false)
COMMENTS Optional string Comments
CURRENCY Optional string Default currency code
CONTACTINFO Optional object Primary contact. If blank system will use DISPLAYCONTACT.
PAYTO Optional object Pay to contact. If blank system will use DISPLAYCONTACT.
RETURNTO Optional object Return to contact. If blank system will use DISPLAYCONTACT.
PAYMETHODKEY Optional string Preferred payment method
MERGEPAYMENTREQ Optional boolean Merge payment requests. Use false for No, true for Yes. (Default: true)
PAYMENTNOTIFY Optional boolean Send automatic payment notification. Use false for No, true for Yes. (Default: false)
BILLINGTYPE Optional string Payment term
PAYMENTPRIORITY Optional string Payment priority
TERMNAME Optional string Payment term
DISPLAYTERMDISCOUNT Optional boolean Display term discount on check stub. Use false for No, true for Yes. (Default: true)
ACHENABLED Optional boolean ACH enabled. Use false for No, true for Yes. (Default: false)
ACHBANKROUTINGNUMBER Optional string ACH bank routing number.
ACHACCOUNTNUMBER Optional string ACH bank account number.
ACHACCOUNTTYPE Optional string ACH bank account type.
ACHREMITTANCETYPE Optional string ACH bank account class.
VENDORACCOUNTNO Optional string Vendor account number
DISPLAYACCTNOCHECK Optional boolean Display location assigned account number on check stub. Use false for No, true for Yes. (Default: false)
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

PAYTO

Name Required Type Description
CONTACTNAME Required string Pay to contact name

RETURNTO

Name Required Type Description
CONTACTNAME Required string Return to contact name

Delete Vendor

delete

<delete>
    <object>VENDOR</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use VENDOR
keys Required string The vendor RECORDNO to delete

Provide feedback