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


Get Vendor Object Definition

lookup

List all the fields and relationships for the vendor object:

<lookup>
    <object>VENDOR</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use VENDOR

List Vendors

query

For each vendor owed more than 100.00, list the record number, pay-to contact name, and total due:

<query>
    <object>VENDOR</object>
    <select>
        <field>RECORDNO</field>
        <field>PAYTOCONTACT.CONTACTNAME</field>
        <field>TOTALDUE</field>
    </select>
    <filter>
        <greaterthan>
            <field>TOTALDUE</field>
            <value>100</value>
        </greaterthan>
    </filter>
</query>

Parameters

Name Required Type Description
object Required string Use VENDOR
select Required sequence One or more field names and an optional aggregate function such as count or sum. Returning all fields is not supported.
filter Optional object Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
        <field>RECORDNO</field>
        <descending/>
</order>
options Optional object Set the caseinsensitive element to true for a case-insensitive query:
    <caseinsensitive>true</caseinsensitive>
In a multi-entity company, set the showprivate element to true to query data in private entities:
   <showprivate>true</showprivate>
pagesize Optional integer Custom page size between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

List Vendors (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use VENDOR
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. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

query Fields

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 Vendor 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 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 Vendor VENDORID 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 Vendor

Release Changes
2020 Release 2 Added RETAINAGEPERCENTAGE
2018 Release 4 Added DEFAULT_LEAD_TIME

create

<create>
    <VENDOR>
        <VENDORID>V1234</VENDORID>
        <NAME>SaaS Company Inc</NAME>
        <DISPLAYCONTACT>
            <PRINTAS>SaaS Company Inc</PRINTAS>
            <COMPANYNAME>SaaS Co</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></EMAIL2>
            <URL1></URL1>
            <URL2></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>SAAS CO INC</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 Required object Object to create

VENDOR

Name Required Type Description
VENDORID Optional string Vendor VENDORID 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 or 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
DEFAULT_LEAD_TIME Optional integer Default lead time in days for replenishment purposes. Can be overridden by lead time specified on an item with that vendor, or lead time specified for on an item with a warehouse/vendor combination with that vendor. (Default: 1)
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
OFFSETGLACCOUNTNO Optional string AP account number
CREDITLIMIT Optional currency Credit limit
RETAINAGEPERCENTAGE Optional numeric Default retainage percentage for vendors. (Construction subscription)
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.
CONTACT_LIST_INFO Optional CONTACT_LIST_INFO[] Contact list. Multiple CONTACT_LIST_INFO elements may then be passed.
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 Vendor billing type
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
DISPLOCACCTNOCHECK Optional boolean Display location assigned account number on check stub. Use false for No, true for Yes. (Default: false)
VENDOR_ACCTNO_LOC_HEAD Optional VENDOR_ACCTNO_LOC_HEAD[] Vendor location assigned account numbers. Multiple VENDOR_ACCTNO_LOC_HEAD elements may then be passed.
OBJECTRESTRICTION Optional string 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 Custom fields. For a multi-pick-list custom field, implode multiple field values with #~#.

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
ISOCOUNTRYCODE Optional string ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided.

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

CONTACT_LIST_INFO

Name Required Type Description
CATEGORYNAME Required string Category
CONTACT Optional object Category

CONTACT

Name Required Type Description
NAME Required string Contact name

VENDOR_ACCTNO_LOC_HEAD

Name Required Type Description
LOCATION Required string Location ID
ACCOUNTNO Required string Account number

Create Vendor (Legacy)

Release Changes
2020 Release 2 Added retainagepercentage

create_vendor

<create_vendor>
    <vendorid>V1234</vendorid>
    <name>SaaS Company Inc</name>
    <contactinfo>
        <contact>
            <contactname>SaaS Company Inc(VV1234)</contactname>
            <printas>SaaS Company Inc</printas>
        </contact>
    </contactinfo>
</create_vendor>

Parameters

Name Required Type Description
vendorid Required string Vendor ID to create. Leave blank if company uses auto-numbering.
name Required string Name
parentid Optional string Parent vendor ID
termname Optional string Payment term
glaccountno Optional string Default expense GL account number
vendtype Optional string Vendor type ID
taxid Optional string Tax ID
creditlimit Optional currency Credit limit
retainagepercentage Optional numeric Default retainage percentage for vendors. (Construction subscription)
paymethod Optional string Preferred payment method
billingtype Optional string Vendor billing type
vendoraccountno Optional string Vendor account number
displocacctnocheck Optional boolean Display location assigned account number on check stub. Use false for No, true for Yes. (Default: false)
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
status Optional string Status. Use active for Active or inactive for Inactive (Default: active)
currency Optional string Default currency code
onetime Optional boolean One time. Use false for No, true for Yes. (Default: false)
primary Optional object Primary contact. If blank system will use the corresponding contactinfo.
returnto Optional object Return to contact. If blank system will use the corresponding contactinfo.
payto Optional object Pay to contact. If blank system will use the corresponding contactinfo.
contactinfo Optional object Contact info
contactto1099 Optional object 1099 contact. If blank system will use the corresponding contactinfo.
contactlist Optional contactitem[0...n] Contact list
name1099 Optional string Form 1099 name
form1099type Optional string Form 1099 type
form1099box Optional string Form 1099 box
customfields Optional customfield[0...n] Custom fields
paymentnotify Optional boolean Send automatic payment notification. Use false for No, true for Yes. (Default: false)
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
displaytermdiscount Optional boolean Display term discount on check stub. Use false for No, true for Yes. (Default: true)
visibility Optional object Restrictions
supdocid Optional string Attachments ID
mergepaymentreq Optional boolean Merge payment requests. Use false for No, true for Yes. (Default: true)
offsetglaccountno Optional string AP account number

primary

Name Required Type Description
contactname Required string Contact name of an existing contact

returnto

Name Required Type Description
contactname Required string Contact name of an existing contact

payto

Name Required Type Description
contactname Required string Contact name of an existing contact

contactinfo

Name Required Type Description
contact Required object New contact to create corresponding with the vendor

contact

Name Required Type Description
contactname Required string Contact name
printas Required string Print as
taxable Optional boolean Taxable. Use false for No, true for Yes. (Default: true)
companyname Optional string Company name
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
status Optional string Status. Use active for Active or inactive for Inactive (Default: active)
mailaddress Optional object Mail address
taxid Optional string Tax ID

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
isocountrycode Optional string ISO country code. When ISO country codes are enabled in a company, both country and isocountrycode must be provided.
latitude Optional string Latitude
longitude Optional string Longitude

contactto1099

Name Required Type Description
contactname Required string Contact name of an existing contact

contactitem

Name Required Type Description
category Required string Category
contactname Required string Contact name of an existing contact

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

visibility

visibility_type Required string Restriction type. Use Unrestricted, RootOnly, or Restricted. (Default Unrestricted)
restricted_locs Optional locationid[0...n] Restricted location ID’s
restricted_depts Optional departmentid[0...n] Restricted department ID’s

Update Vendor

Release Changes
2020 Release 2 Added RETAINAGEPERCENTAGE
2018 Release 4 Added DEFAULT_LEAD_TIME

Warning: When updating a vendor that has an existing list of contacts (CONTACT_LIST_INFO elements), you must re-supply the complete set of existing contacts each time or they will be deleted. This is true even if you are making a simple update, such as changing the text for the COMMENTS element. To add a new contact to the list of contacts, supply all the originals along with the new one. To delete a contact, supply only the ones that you want to keep.

update

Updates a vendor:

<update>
    <VENDOR>
        <RECORDNO>12</RECORDNO>
        <NAME>SaaS Company Inc</NAME>
        <DISPLAYCONTACT>
            <PRINTAS>SaaS Company Inc</PRINTAS>
            <COMPANYNAME>SaaS Co</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></EMAIL1>
            <EMAIL2></EMAIL2>
            <URL1></URL1>
            <URL2></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>SAAS CO INC</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>

Updates a vendor with a new payment term while retaining the contact list:

<update>
    <VENDOR>
        <RECORDNO>59</RECORDNO>
        <TERMNAME>NET15</TERMNAME>
        <CONTACT_LIST_INFO>
            <CATEGORYNAME>Home</CATEGORYNAME>
            <CONTACT>
                <NAME>Despereaux, Pierre</NAME>
            </CONTACT>
        </CONTACT_LIST_INFO>
        <CONTACT_LIST_INFO>
            <CATEGORYNAME>Office</CATEGORYNAME>
            <CONTACT>
                <NAME>Aeronet Communications Corporation</NAME>
            </CONTACT>
        </CONTACT_LIST_INFO>
    </VENDOR>
</update>

Parameters

Name Required Type Description
VENDOR Required object Object to update

VENDOR

Name Required Type Description
RECORDNO Optional integer Record number of vendor to update. Required if not using VENDORID.
VENDORID Optional string Vendor ID. Required if not using RECORDNO.
NAME Optional string Name
DISPLAYCONTACT Optional object Contact info
STATUS Optional string Status. Use active for Active or 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
DEFAULT_LEAD_TIME Optional integer Default lead time in days for inventory replenishment purposes. (Default: 1)
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
OFFSETGLACCOUNTNO Optional string AP account number
CREDITLIMIT Optional currency Credit limit
RETAINAGEPERCENTAGE Optional numeric Default retainage percentage. (Construction subscription)
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.
CONTACT_LIST_INFO Optional CONTACT_LIST_INFO[] Contact list. Multiple CONTACT_LIST_INFO elements may be passed. When performing any update on a vendor that has an existing list of contacts, you must re-supply the complete set of existing contacts each time or they will be deleted. This is true even if you are making a simple update, such as changing the text for the COMMENTS element. To add a new contact to the list of contacts, supply all the originals along with the new one. To delete a contact, supply only the ones that you want to keep.
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 Vendor billing type
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
DISPLOCACCTNOCHECK Optional boolean Display location assigned account number on check stub. Use false for No, true for Yes. (Default: false)
VENDOR_ACCTNO_LOC_HEAD Optional VENDOR_ACCTNO_LOC_HEAD[] Vendor location assigned account numbers. Multiple VENDOR_ACCTNO_LOC_HEAD elements may then be passed.
OBJECTRESTRICTION Optional string 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 Custom fields. For a multi-pick-list custom field, implode multiple field values with #~#.

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
ISOCOUNTRYCODE Optional string ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided.

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

CONTACT_LIST_INFO

Name Required Type Description
CATEGORYNAME Required string Category
CONTACT Optional object Category

CONTACT

Name Required Type Description
NAME Required string Contact name

VENDOR_ACCTNO_LOC_HEAD

Name Required Type Description
LOCATION Required string Location ID
ACCOUNTNO Required string Account number

Update Vendor (Legacy)

Release Changes
2020 Release 2 Added retainagepercentage

update_vendor

<update_vendor vendorid="V1234">
    <name>SaaS Company Inc</name>
    <termname>N15</termname>
</update_vendor>

Parameters

Name Required Type Description
vendorid Required string Vendor ID to update
name Optional string Name
parentid Optional string Parent vendor ID
termname Optional string Payment term
glaccountno Optional string Default expense GL account number
vendtype Optional string Vendor type ID
taxid Optional string Tax ID
creditlimit Optional currency Credit limit
retainagepercentage Optional numeric Default retainage percentage for vendors. (Construction subscription)
paymethod Optional string Preferred payment method
billingtype Optional string Vendor billing type
vendoraccountno Optional string Vendor account number
displocacctnocheck Optional boolean Display location assigned account number on check stub. Use false for No, true for Yes.
onhold Optional boolean On hold. Use false for No, true for Yes.
donotcutcheck Optional boolean Do not pay. Use false for No, true for Yes.
comments Optional string Comments
status Optional string Status. Use active for Active or inactive for Inactive.
currency Optional string Default currency code
primary Optional object Primary contact. If blank system will use the corresponding contactinfo.
returnto Optional object Return to contact. If blank system will use the corresponding contactinfo.
payto Optional object Pay to contact. If blank system will use the corresponding contactinfo.
contactinfo Optional object Contact info
contactto1099 Optional object 1099 contact. If blank system will use the corresponding contactinfo.
contactlist Optional contactitem[0...n] Contact list
name1099 Optional string Form 1099 name
form1099type Optional string Form 1099 type
form1099box Optional string Form 1099 box
customfields Optional customfield[0...n] Custom fields
paymentnotify Optional boolean Send automatic payment notification. Use false for No, true for Yes.
achenabled Optional boolean ACH enabled. Use false for No, true for Yes.
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
displaytermdiscount Optional boolean Display term discount on check stub. Use false for No, true for Yes.
visibility Optional object Restrictions
supdocid Optional string Attachments ID
mergepaymentreq Optional boolean Merge payment requests. Use false for No, true for Yes.
offsetglaccountno Optional string AP account number

primary

Name Required Type Description
contactname Required string Contact name of an existing contact

returnto

Name Required Type Description
contactname Required string Contact name of an existing contact

payto

Name Required Type Description
contactname Required string Contact name of an existing contact

contactinfo

Name Required Type Description
contact Required object New contact to create corresponding with the vendor

contact

Name Required Type Description
contactname Required string Contact name
printas Required string Print as
taxable Optional boolean Taxable. Use false for No, true for Yes. (Default: true)
companyname Optional string Company name
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
status Optional string Status. Use active for Active or inactive for Inactive (Default: active)
mailaddress Optional object Mail address
taxid Optional string Tax ID

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
isocountrycode Optional string ISO country code. When ISO country codes are enabled in a company, both country and isocountrycode must be provided.
latitude Optional string Latitude
longitude Optional string Longitude

contactto1099

Name Required Type Description
contactname Required string Contact name of an existing contact

contactitem

Name Required Type Description
category Required string Category
contactname Required string Contact name of an existing contact

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

visibility

visibility_type Required string Restriction type. Use Unrestricted, RootOnly, or Restricted. (Default Unrestricted)
restricted_locs Optional locationid[0...n] Restricted location ID’s
restricted_depts Optional departmentid[0...n] Restricted department ID’s

Delete Vendor

delete

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

Parameters

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

Delete Vendor (Legacy)

delete_vendor

<delete_vendor vendorid="V1234"></delete_vendor>

Parameters

Name Required Type Description
vendorid Required string Vendor ID to delete

Create Location Specific Vendor Account Number (Legacy)

create_vendorentityaccountno

<create_vendorentityaccountno>
    <vendorid>V1234</vendorid>
    <accountno>9876543210</accountno>
    <locationid>100</locationid>
</create_vendorentityaccountno>

Parameters

Name Required Type Description
vendorid Required string Vendor ID
accountno Required string Vendor account number
locationid Required string Location ID

Provide feedback