Release Notes
System Status
Start typing to search…

New v3 API endpoints for organization-level operations

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.

OperationAPI endpoint
Get organization detailsGET /v3/organizations/{organizationId}
Update an organizationPATCH /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.

OperationAPI endpoint
Create a userPOST /v3/users
Get user detailsGET /v3/users/{userId}
Update a userPATCH /v3/users/{userId}
Archive a userPOST /v3/users/{userId}/archive
Restore an archived userPOST /v3/users/{userId}/restore
Get list of user rolesGET /v3/roles
Get user role detailsGET /v3/roles/{roleId}

See Organizations and Users for more information.

New v3 API endpoints for BILL partners

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.

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.