v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

vendors

Create multiple vendors

Create multiple vendors with one API request. You can create up to 20 vendors with one POST /v3/vendors/bulk request.

In your bulk vendor creation request, all your vendors must be successfully created for a successful response. If any vendor creation is not successful, the entire request fails and none of the vendors in the request are created.

Requirements for enabling vendor payments

Vendor address details are required for paying a vendor by check or for inviting the vendor to join the BILL network.

line1
city
zipOrPostalCode
country
payeeName

Note: A vendor can be enrolled to accept virtual card payments even without being connected in the BILL network. See Virtual card FAQ in the BILL Help Center for more information.

Requirements for enabling electronic payments to vendors

Vendor bank account details are required for paying a vendor with electronic payment methods.

paymentInformation details about bank accounts are required for adding a vendor bank account.

payeeName
bankCountry (for international vendors)
paymentCurrency (for international vendors)
nameOnAccount
accountNumber
routingNumber (empty for an IBAN accountNumber)
type (for international vendors)

regulatoryFields and paymentPurpose are additional required fields for enabling electronic payments to international vendors (not United States) in specific countries.

Note: When you add a vendor bank account in the production environment, BILL requires 2 business days to complete a one-time verification of the bank account. To pay such a vendor, you must set a processDate that is 2 business days from the current date.

See Vendors in the Guides section for more information, sample requests, and responses.

post/v3/vendors/bulk

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}

devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

namestring required

Vendor name

shortNamestring

Vendor short name

accountNumberstring

User account number set by the vendor. Set this field as the billing statement account number for vendor services such as utility or credit card bills.

When you pay the vendor, this value appears on the check memo or electronic payment record.

accountType'NONE' | 'BUSINESS' | 'PERSON'

Vendor account type

emailstring

Vendor email address

phonestring

Vendor phone number

billCurrency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD'

Bill currency. Three-letter abbreviation in the ISO 4217 format.

The billCurrency value is the currency in which vendor bills are presented. The value is also the currency used in the invoices you receive from the vendor.

Note: When the vendor bill currency is not USD (For example, EUR), the payment processDate for this vendor must be the next US business day.

See <a href="https://help.bill.com/hc/en-us/articles/360007172671">Country information for international payments</a> in the BILL Help Center for the list of countries that accept international payments with BILL.

Example request

[
  {
    "name": "Happy Music Supplies",
    "accountType": "BUSINESS",
    "email": "info@happymusicsupplies.org",
    "phone": "9876543210",
    "address": {
      "line1": "123 Main Street",
      "city": "San Jose",
      "stateOrProvince": "CA",
      "zipOrPostalCode": "95002",
      "country": "US"
    },
    "paymentInformation": {
      "payeeName": "Happy Music Supplies",
      "bankAccount": {
        "nameOnAccount": "Bill Vendorson",
        "accountNumber": "111222333",
        "routingNumber": "074000010"
      }
    },
    "billCurrency": "USD"
  }
]

Response

Create multiple vendors response

Example response

{
  "vendors": [
    {
      "paymentInformation": {
        "bankAccount": {
          "nameOnAccount": "Bill Vendorson",
          "accountNumber": "111222333",
          "routingNumber": "074000010",
          "type": "CHECKING",
          "ownerType": "BUSINESS",
          "paymentCurrency": "USD"
        }
      }
    }
  ]
}