You can now filter payments by the transactionNumber field. See Search operations with lists for more information about the complete list of fields you can filter and sort with.
You can now get a list of users with GET /v3/users. In the response, you get the list of users that belong to the organization you are signed in to. See GET /v3/users in the API reference for more information.
As a BILL partner, you now have the additional capability of getting a list of users that belong to any of your created organizations. See GET /v3/partner/users in the API reference for more information.
You can now set the transactionNumber field when you create a payment (POST /v3/payments) or bulk payment (POST /v3/payments/bulk).
You can set transactionNumber as a unique alphanumeric value for your system to track a payment transaction. The value must be 50 characters or fewer. If you do not set transactionNumber, BILL sets this field as a unique alphanumeric payment identification value.
See /v3/payments in the API reference for more information.
You can now get the BILL network connection status of a vendor when you create a vendor (POST /v3/vendors) or get vendor details (GET /v3/vendors or GET /v3/vendors/{vendorId}).
In the API response, networkStatus is now available for providing information about the BILL network connection status. This field can have one of four status values.
| Value | Description |
|---|---|
NOT_CONNECTED | Not connected with a vendor in the BILL network |
PENDING | Invitation is sent to the vendor in the BILL network |
CONNECTED | The vendor in the BILL network has accepted the invitation. You are connected with the vendor. |
CONNECTED_RPPS | Connected with a verified national vendor |
See Connecting with a BILL network vendor for more information.
As a BILL partner, you can now initiate the BILL risk verification process for your created organization with POST /v3/risk-verifications.
When you create an organization (POST /v3/partner/organizations) and then create a user for that organization (POST /v3/partner/users), it is important that you initiate risk verification.
BILL performs a KYC/KYB (Know You Customer/Know Your Business) check based on the provided organization information. When the check is complete, BILL approves the organization for BILL AP and AR operations.
See /v3/risk-verifications in the API reference for more information.
You can now set up bank accounts in your BILL organization with the API.
NOTE
Money movement to and from live bank accounts is not available in the API sandbox environment. When you set up a test bank account in sandbox, you can create and test payments.
Bank account operations
We have introduced a set of bank account API endpoints.
| Operation | API endpoint |
|---|---|
| Create a bank account | POST /v3/funding-accounts/banks |
| Verify a bank account | POST /v3/funding-accounts/banks/{bankAccountId}/verify |
| Get bank account details | GET /v3/funding-accounts/banks/{bankAccountId} |
| Get list of bank accounts | GET /v3/funding-accounts/banks |
| Update a bank account | PATCH /v3/funding-accounts/banks/{bankAccountId} |
| Archive a bank account | POST /v3/funding-accounts/banks/{bankAccountId}/archive |
See Bank account setup (v3 API) for more information.
You can now use the BILL webhooks to subscribe to and receive real time notifications, for events, such as create a vendor, update a vendor, or create a payment.
BILL webhooks API is currently in BETA
The BILL webhooks API is currently in BETA and is subject to improvements and changes. All improvements and changes will be documented.
When you subscribe to BILL events, you provide a location URL for where you want to receive notifications. BILL sends a notification to that URL each time a subscribed event is triggered.
NOTE
The base URL for the BILL webhook API is
https://gateway.stage.bill.com/connect-events.
Webhook operations
We have introduced a set of webhook API endpoints.
| Operation | API endpoint |
|---|---|
| Get events catalog | GET /v3/events/catalog |
| Get list of event notifications | GET /v3/events/subscription/{subscriptionId} |
| Resend an event | POST /v3/events/subscription/{subscriptionId}/event/{eventId} |
| Create a subscription | POST /v3/subscriptions |
| Send a test subscription event | POST /v3/subscriptions/{subscriptionId}/test |
| Get subscription details | GET /v3/subscriptions/{subscriptionId} |
| Get list of subscriptions | GET /v3/subscriptions |
| Update a subscription | PATCH /v3/subscriptions/{subscriptionId} |
| Replace a subscription | PUT /v3/subscriptions/{subscriptionId} |
| Delete a subscription | DELETE /v3/subscriptions/{subscriptionId} |
The events catalog includes events for vendors, bills, and payments.
vendor.createdvendor.updatedvendor.archivedvendor.restoredbill.createdbill.updatedbill.archivedbill.restoredpayment.updated
See Webhooks for more information.
You can now create a bulk payment with POST /v3/payments/bulk. You can pay up to 200 bills with one API request. Bulk payments at BILL follow a set of rules.
See Payments for more information.
When you sign in to your BILL developer account with /v3/login, you sign in as a user of the BILL organization. In the API response, userId is the BILL-generated ID of the signed-in user.
Organization operations
We have introduced a set of organization API endpoints for organization-level users.
| Operation | API endpoint |
|---|---|
| Get organization details | GET /v3/organizations/{organizationId} |
| Update an organization | PATCH /v3/organizations/{organizationId} |
User operations
As a user with the ADMINISTRATOR user role in a BILL organization, you can use the BILL API to create other users and also manage user access in the BILL organization.
We have introduced a set of user API endpoints for organization-level users.
| Operation | API endpoint |
|---|---|
| Create a user | POST /v3/users |
| Get user details | GET /v3/users/{userId} |
| Update a user | PATCH /v3/users/{userId} |
| Archive a user | POST /v3/users/{userId}/archive |
| Restore an archived user | POST /v3/users/{userId}/restore |
| Get list of user roles | GET /v3/roles |
| Get user role details | GET /v3/roles/{roleId} |
See Organizations and Users for more information.
We have introduced new capabilities for BILL partners. As a BILL partner, you can now perform partner-level operations, which includes creating an organization, and then creating and managing users for that organization.
Requirements
Partner-level API operations have two requirements.
- A
sessionIdgenerated with API partner login - An
appKeyheader value
Organizations and Users
We have introduced a set of partner-level API endpoints that can be accessed with a partner account sessionId.
| Operation | API endpoint |
|---|---|
| API partner login | POST /v3/partner/login |
| Create an organization | POST /v3/partner/organizations |
| Create a user | POST /v3/partner/users |
| API login as user Sign in to a created organization as a created user of that organization | POST /v3/partner/login-as-user |
| Get user details | GET /v3/partner/users/{userId} |
| Update a user | PATCH /v3/partner/users/{userId} |
| Archive a user | POST /v3/partner/users/{userId}/archive |
| Restore an archived user | POST /v3/partner/users/{userId}/restore |
| Get list of user roles | GET /v3/partner/roles |
| Get user role details | GET /v3/partner/roles/{roleId} |
After signing in as a user with POST /v3/partner/login-as-user, you can perform organization-level BILL API operations, such as creating a bill or paying a vendor. Note that all organization-level BILL API operations require a devKey and sessionId.
See BILL partner operations for more information.