Create a vendor

post

https://gateway.stage.bill.com/connect/v3/vendors

Create a new vendor.

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.

Body Params

name

string

required

length between 1 and 100

Vendor name

shortName

string

length ≤ 40

Vendor short name

accountNumber

string

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

string

enum

Vendor account type

Allowed:

string

Vendor email address

phone

string

Vendor phone number

address

object

required

Vendor address information

paymentInformation

object

Vendor payment information

additionalInfo

object

Vendor additional information

billCurrency

string

enum

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 Country information for international payments in the BILL Help Center for the list of countries that accept international payments with BILL.

autoPay

object

Vendor auto-pay information.

When you enable vendor auto-pay, BILL automatically pays the vendor when a bill is created for the vendor.

Note: Enabling vendor autoPay requires an MFA-trusted API session. See MFA setup for information about the BILL MFA process.

Headers

sessionId

string | null

API session ID generated with /v3/login

devKey

string | null

Developer key generated with your BILL developer account

Responses

201Create a vendor response

4XXList of errors.

5XXList of errors.