1. Developer Support
  2. Payables
  3. Vendor Management

Vendor

About Vendor

A Vendor provides goods or services to the organization. 

If any vendors are part of the Bill.com network (have a Bill.com Receivables account), their bills are delivered as eBills and paid electronically.

If a vendor is not part of the Bill.com network, Bill.com prints and mails the checks or sends an electronic payment (according to your vendor configuration). Therefore, it is important that you update the vendor details if any one of the following change: nameOnCheck, address1, address2, address3, address4, addressCity, addressState, addressZip, or addressCountry

Note: Vendors not in the Bill.com network can be invited to join (via UI or API call).

Vendor address information 

Vendor Name is the only required parameter to create a Vendor. However, to pay by check, or make network connections, the following address parameters are required:

  • address1
  • addressCity
  • addressState
  • addressZip
  • addressCountry

Create

Request

<API_URL_EndPoint>/Crud/Create/Vendor.json

data={
  "obj" : {
    "entity" : "Vendor",
    "isActive" : "1",
    "name" : "Happy Music Supplies",
    "shortName" : "Happy",
    "nameOnCheck" : "Happy Music",
    "companyName" : "Happy Music Supplies",
    "accNumber" : "1566",
    "taxId" : "123412341234",
    "track1099" : false,
    "address1" : "1234 Happy Lane",
    "address2" : "Building 14",
    "address3" : "",
    "address4" : "",
    "addressCity" : "Santa Clara",
    "addressState" : "CA",
    "addressZip" : "95050",
    "addressCountry" : "USA",
    "email" : "happy@happymusic.org",
    "fax" : "123-123-1235",
    "phone" : "123-123-1234",
    "paymentEmail" : "happy@happymusic.org",
    "paymentPhone" : "123-123-1234",
    "description" : "Supplier of musical tuners.",
    "contactFirstName" : "Happy",
    "contactLastName" : "Helper",
    "accountType" : "0"
  }
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "Vendor",
    "id" : "00901GYCSRGZVFZ2r8ar",
    "isActive" : "1",
    "name" : "Happy Music Supplies",
    "shortName" : "Happy",
    "nameOnCheck" : "Happy Music",
    "companyName" : "Happy Music Supplies",
    "accNumber" : "1566",
    "taxId" : "123412341234",
    "track1099" : false,
    "address1" : "1234 Happy Lane",
    "address2" : "Building 14",
    "address3" : null,
    "address4" : null,
    "addressCity" : "Santa Clara",
    "addressState" : "CA",
    "addressZip" : "95050",
    "addressCountry" : "USA",
    "email" : "happy@happymusic.org",
    "fax" : "123-123-1235",
    "phone" : "123-123-1234",
    "payBy" : "0",
    "paymentEmail" : "happy@happymusic.org",
    "paymentPhone" : "123-123-1234",
    "description" : "Supplier of musical tuners.",
    "createdTime" : "2016-12-13T22:13:21.000+0000",
    "updatedTime" : "2016-12-13T22:13:21.000+0000",
    "contactFirstName" : "Happy",
    "contactLastName" : "Helper",
    "mergedIntoId" : "00000000000000000000",
    "accountType" : "0"
  }
}

Read

Request

<API_URL_EndPoint>/Crud/Read/Vendor.json

data={
   "id" : "00901GYCSRGZVFZ2r8ar"
}

Response

{
   "response_status" : 0,
   "response_message" : "Success",
   "response_data" : {
       "entity" : "Vendor",
       "id" : "00901FLEDIKRCILHfyui",
       "isActive" : "1",
       "name" : "Sample Vendor 1",
       "nameOnCheck" : null,
       "accNumber" : null,
       "taxId" : null,
       "track1099" : false,
       "address1" : null,
       "address2" : null,
       "address3" : null,
       "address4" : null,
       "addressCity" : null,
       "addressState" : null,
       "addressZip" : null,
       "addressCountry" : null,
       "email" : null,
       "fax" : null,
       "phone" : null,
       "payBy" : "0",
       "description" : null,
       "createdTime" : "2012-11-14T20:48:04.000+0000",
       "updatedTime" : "2012-11-14T20:48:04.000+0000"
   }
}

Update

Note: To change the isActive field, use Delete and Undelete calls. The field can not be changed with Update.

Request 

<API_URL_EndPoint>/Crud/Update/Vendor.json

data={
  "obj" : {
    "entity" : "Vendor",
    "id" : "00901GYCSRGZVFZ2r8ar",
    "isActive" : "1",
    "name" : "Happy Music Supplies",
    "shortName" : "Happy",
    "nameOnCheck" : "Happy Music",
    "companyName" : "Happy Music Supplies, Inc.",
    "accNumber" : "1566",
    "taxId" : "123412341234",
    "track1099" : false,
    "address1" : "1234 Happy Lane",
    "address2" : "Building 14",
    "address3" : "Room 18",
    "address4" : null,
    "addressCity" : "Santa Clara",
    "addressState" : "CA",
    "addressZip" : "95050",
    "addressCountry" : "USA",
    "email" : "happy@happymusic.org",
    "fax" : "123-123-1235",
    "phone" : "123-123-1234",
    "paymentEmail" : "happy@happymusic.org",
    "paymentPhone" : "123-123-1234",
    "description" : "Supplier of musical tuners & toys.",
    "contactFirstName" : "Happy",
    "contactLastName" : "Helper",
    "accountType" : "0"
  }
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "Vendor",
    "id" : "00901GYCSRGZVFZ2r8ar",
    "isActive" : "1",
    "name" : "Happy Music Supplies",
    "shortName" : "Happy",
    "nameOnCheck" : "Happy Music",
    "companyName" : "Happy Music Supplies, Inc.",
    "accNumber" : "1566",
    "taxId" : "123412341234",
    "track1099" : false,
    "address1" : "1234 Happy Lane",
    "address2" : "Building 14",
    "address3" : "Room 18",
    "address4" : null,
    "addressCity" : "Santa Clara",
    "addressState" : "CA",
    "addressZip" : "95050",
    "addressCountry" : "USA",
    "email" : "happy@happymusic.org",
    "fax" : "123-123-1235",
    "phone" : "123-123-1234",
    "payBy" : "0",
    "paymentEmail" : "happy@happymusic.org",
    "paymentPhone" : "123-123-1234",
    "description" : "Supplier of musical tuners & toys.",
    "createdTime" : "2016-12-13T22:13:21.000+0000",
    "updatedTime" : "2016-12-13T23:00:26.000+0000",
    "contactFirstName" : "Happy",
    "contactLastName" : "Helper",
    "mergedIntoId" : "00000000000000000000",
    "accountType" : "0"
  }
}

Delete

Request

<API_URL_EndPoint>/Crud/Delete/Vendor.json

data={
   "id" : "00901GYCSRGZVFZ2r8ar"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "Vendor",
    "id" : "00901GYCSRGZVFZ2r8ar",
    "isActive" : "2",
    "name" : "Happy Music Supplies",
    "shortName" : "Happy",
    "nameOnCheck" : "Happy Music",
    "companyName" : "Happy Music Supplies",
    "accNumber" : "1566",
    "taxId" : "123412341234",
    "track1099" : false,
    "address1" : "1234 Happy Lane",
    "address2" : "Building 14",
    "address3" : null,
    "address4" : null,
    "addressCity" : "Santa Clara",
    "addressState" : "CA",
    "addressZip" : "95050",
    "addressCountry" : "USA",
    "email" : "happy@happymusic.org",
    "fax" : "123-123-1235",
    "phone" : "123-123-1234",
    "payBy" : "0",
    "paymentEmail" : "happy@happymusic.org",
    "paymentPhone" : "123-123-1234",
    "description" : "Supplier of musical tuners.",
    "createdTime" : "2016-12-13T22:13:21.000+0000",
    "updatedTime" : "2016-12-13T22:13:21.000+0000",
    "contactFirstName" : "Happy",
    "contactLastName" : "Helper",
    "mergedIntoId" : "00000000000000000000",
    "accountType" : "0"
  }
}

Undelete

Request

<API_URL_EndPoint>/Crud/Undelete/Vendor.json

data={
   "id" : "00901GYCSRGZVFZ2r8ar"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "Vendor",
    "id" : "00901GYCSRGZVFZ2r8ar",
    "isActive" : "1",
    "name" : "Happy Music Supplies",
    "shortName" : "Happy",
    "nameOnCheck" : "Happy Music",
    "companyName" : "Happy Music Supplies",
    "accNumber" : "1566",
    "taxId" : "123412341234",
    "track1099" : false,
    "address1" : "1234 Happy Lane",
    "address2" : "Building 14",
    "address3" : null,
    "address4" : null,
    "addressCity" : "Santa Clara",
    "addressState" : "CA",
    "addressZip" : "95050",
    "addressCountry" : "USA",
    "email" : "happy@happymusic.org",
    "fax" : "123-123-1235",
    "phone" : "123-123-1234",
    "payBy" : "0",
    "paymentEmail" : "happy@happymusic.org",
    "paymentPhone" : "123-123-1234",
    "description" : "Supplier of musical tuners.",
    "createdTime" : "2016-12-13T22:13:21.000+0000",
    "updatedTime" : "2016-12-13T22:13:21.000+0000",
    "contactFirstName" : "Happy",
    "contactLastName" : "Helper",
    "mergedIntoId" : "00000000000000000000",
    "accountType" : "0"
  }
}

Resources

Parameters

 

 

 

 

Was this article helpful?
4 out of 9 found this helpful