added
New v3 API endpoints for BILL partners
April 22nd, 2024
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
sessionId
generated with API partner login - An
appKey
header 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.