PayBills – Developer Support

MFA Protected Endpoint

Starting April 1st, 2017 use of this endpoint requires an MFA Trusted Session. Please review the MFA Workflow in order establish an MFA Trusted Session prior to using this endpoint.

Note: Developers who joined the Developer Program and used this endpoint prior to March 31st, 2017 will not require an MFA Trusted Session to use this endpoint and can continue using this endpoint as they normally would.

About PayBills

Use this API to issue Bill.com payments (one or more bills and one or more bill credits) to a designated vendor. These are paid from a specified bank account.

The user that uses this API MUST be verified ("pay bills" function enabled in the assigned user role - Administrator, Payer, customized). If not, an error is returned.

This is how the payment is processed in the Bill.com system:

If a process date is not specified, payment is sent on the next bank work day.

The earliest available process date is the next business day, not including holidays.
Payments will not process on weekends or bank holidays
The process date for a payment cannot be changed/edited once a payment is scheduled

If vendor is setup for ePayment, funds are transferred by ACH. Otherwise, a check is sent (via UPS) to vendor's address.
Any memo information entered in description field is included on the check or a bank descriptor for ePayment.

Example

NOTE: To apply a vendor credit, the nested billCredits array must include billId, vendorCreditId and amount applied to the specified bill. The nested billPays array must include billId and amount applied to the specified bill.

Request

<API_URL_EndPoint>/PayBills.json

data={
 "vendorId" : "00901AYXJFMTDDO4xat5",
 "processDate" : "2017-01-19",
 "billPays" : [ {
   "billId" : "00n01ZWAMLTSFBS5ao2z",
   "amount" : 100.00
 }, { 
   "billId" : "00n01FSFJWBRPEQ5ao4q",
   "amount" : 99.00
} ],
 "billCredits" : [ {
   "billId" : "00n01FSFJWBRPEQ5ao4q",
   "vendorCreditId" : "vcr01HPCWEVWUAR1d9bv",
   "amount" : 1.00
 } ]
}

Response

{
 "response_status" : 0,
 "response_message" : "Success",
 "response_data" : {
 "sentPays" : [ {
 "entity" : "SentPay",
 "id" : "stp01WJWSEQDTWFuxzud",
 "processDate" : "2017-01-19",
 "amount" : 166.00,
 "status" : "1",
 "description" : "Acct #12198649-Multiple inv. (details on stub)",
 "txnNumber" : "VNGJHAWGCMQCBBFCVNWF",
 "name" : "P17011801 - 5611696",
 "vendorId" : "00901AYXJFMTDDO4xat5",
 "isOnline" : true,
 "paymentType" : "0",
 "chartOfAccountId" : "0ca01JSZETHAFXE62xr3",
 "syncReference" : null,
 "toPrintCheck" : false,
 "createdTime" : "2017-01-18T18:44:12.000+0000",
 "updatedTime" : "2017-01-18T18:44:12.000+0000",
 "bankAccountId" : "bac01PKPPVUUEPZGdj0y",
 "billPays" : [ {
   "entity" : "BillPay",
     "id" : "blp01GPBBKBKIF1qvmhz",
     "billId" : "00n01ZWAMLTSFBS5ao2z",
     "name" : "P17011801 - 5611696",
     "paymentStatus" : "1",
     "amount" : 100.00,
     "description" : "Acct #12198649-Multiple inv. (details on stub)",
     "processDate" : "2017-01-19",
     "createdTime" : "2017-01-18T18:44:12.000+0000",
     "updatedTime" : "2017-01-18T18:44:12.000+0000",
     "paymentType" : "0",
     "syncReference" : null,
     "toPrintCheck" : false,
     "chartOfAccountId" : "0ca01JSZETHAFXE62xr3"
   }, {
   "entity" : "BillPay",
     "id" : "blp01JWKRENZIS1qvmi0",
     "billId" : "00n01FSFJWBRPEQ5ao4q",
     "name" : "P17011801 - 5611696",
     "paymentStatus" : "1",
     "amount" : 66.00,
     "description" : "Acct #12198649-Multiple inv. (details on stub)",
     "processDate" : "2017-01-19",
     "createdTime" : "2017-01-18T18:44:12.000+0000",
     "updatedTime" : "2017-01-18T18:44:12.000+0000",
     "paymentType" : "0",
     "syncReference" : null,
     "toPrintCheck" : false,
     "chartOfAccountId" : "0ca01JSZETHAFXE62xr3"
 } ],
 "billCredits" : [ {
   "entity" : "BillCredit",
   "id" : "bcr01IMMIHDAECJ10t7u",
   "isActive" : "1",
   "billId" : "00n01FSFJWBRPEQ5ao4q",
   "sentPayId" : "stp01WJWSEQDTWFuxzud",
   "vendorCreditId" : "vcr01HPCWEVWUAR1d9bv",
   "amount" : 0.90,
   "createdTime" : "2017-01-18T18:44:12.000+0000",
   "updatedTime" : "2017-01-18T18:44:12.000+0000"
 } ],
 "voidRequests" : [ ]
 } ]
 }
}

Resources

Parameters

Field Name	Description	Required?
vendorId	Vendor to be paid.	Yes
bankAccountId	Bank account to withdraw money.If account ID not provided, use default primary payables bank account.	No
processDate	Process date for paid bills. Funds are withdrawn on this date. If process date not passed, next available business date is used.	No
billPays	Array of one or more bills to be paid. Object contains fields described above in billPay object definition.	Yes
billId amount	The Id of the bill to be paid. The amount of the bill to be paid.	Yes
billCredits	Array of one or more vendor credits to be applied. Object contains fields as described above in billCredit object definition.	No
billId vendorCreditId amount	The Id of the bill to be paid. The id of the vendorCredit. The amount of the vendor credit to be applied.	Yes (only if a billCredit)
description	Memo for payment description.	No