User – Developer Support

About User

An organization has many Users, that look into administration, clerical, approval, and many more tasks. These APIs are used to manage the Users within the organization.

Before you begin: Make sure to know the User Role Profile IDs. You need to assign a User Profile when creating a new User.

partnerUserGroupType

This parameter is only used by select Bill.com partners.

username

This parameter is not required for direct API calls. It is only used for partner API calls.

Create

Request

<API_URL_EndPoint>/Crud/Create/User.json

data={
  "obj" : {
    "entity" : "User",
    "isActive" : "1",
    "profileId" : "0po01INEVZKMWAXAev9n",
    "firstName" : "Samuel C.",
    "lastName" : "Clerk",
    "email" : "something@something.com",
    "timezoneId" : "3"
  }
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "User",
    "id" : "00601STLLWAGAADSegoa",
    "isActive" : "1",
    "createdTime" : "2016-12-13T21:42:30.000+0000",
    "updatedTime" : "2016-12-13T21:42:30.000+0000",
    "loginId" : "00501NHFSIGZBEEJ9vam",
    "profileId" : "0po01INEVZKMWAXAev9n",
    "firstName" : "Samuel C.",
    "lastName" : "Clerk",
    "email" : "something@something.com",
    "timezoneId" : "3",
    "partnerUserGroupType" : "0"
  }
}

Read

Request

<API_URL_EndPoint>/Crud/Read/User.json

data={
   "id" : "00601STLLWAGAADSegoa"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "User",
    "id" : "00601STLLWAGAADSegoa",
    "isActive" : "1",
    "createdTime" : "2016-12-13T21:42:30.000+0000",
    "updatedTime" : "2016-12-13T21:42:30.000+0000",
    "loginId" : "00501NHFSIGZBEEJ9vam",
    "profileId" : "0po01INEVZKMWAXAev9n",
    "firstName" : "Samuel C.",
    "lastName" : "Clerk",
    "email" : "something@something.com",
    "timezoneId" : "3",
    "partnerUserGroupType" : "0"
  }
}

Update

Request

<API_URL_EndPoint>/Crud/Update/User.json

data={
  "obj" : {
    "entity" : "User",
    "id" : "00601STLLWAGAADSegoa",
    "isActive" : "1",
    "profileId" : "0po01INEVZKMWAXAev9n",
    "firstName" : "Samuel Calhoun",
    "lastName" : "Clerk",
    "email" : "something@something.com",
    "timezoneId" : "3"
  }
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "User",
    "id" : "00601STLLWAGAADSegoa",
    "isActive" : "1",
    "createdTime" : "2016-12-13T21:42:30.000+0000",
    "updatedTime" : "2016-12-13T21:49:34.000+0000",
    "loginId" : "00501NHFSIGZBEEJ9vam",
    "profileId" : "0po01INEVZKMWAXAev9n",
    "firstName" : "Samuel Calhoun",
    "lastName" : "Clerk",
    "email" : "something@something.com",
    "timezoneId" : "3",
    "partnerUserGroupType" : "0"
  }
}

Delete

Once the User is deleted, the object marked as inactive ["isActive" : "2"].

Note: Bills or Vendor Credits that need approval have to be assigned to an active user. Therefore, if the user you are deleting is an approver, make sure to create new User before deleting the user who is an approver and assign the new user ID in the approval flow.

Request

<API_URL_EndPoint>/Crud/Delete/User.json

data={
   "id" : "00601STLLWAGAADSegoa"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "User",
    "id" : "00601STLLWAGAADSegoa",
    "isActive" : "2",
    "createdTime" : "2016-12-13T21:42:30.000+0000",
    "updatedTime" : "2016-12-13T21:42:30.000+0000",
    "loginId" : "00501NHFSIGZBEEJ9vam",
    "profileId" : "0po01INEVZKMWAXAev9n",
    "firstName" : "Samuel C.",
    "lastName" : "Clerk",
    "email" : "something@something.com",
    "timezoneId" : "3",
    "partnerUserGroupType" : "0"
  }
}

Undelete

There are circumstances when a deleted User must be restored in order to perform Bill.com transactions. Once the User is undeleted, the object marked as active ["isActive" : "1"].

Request

<API_URL_EndPoint>/Crud/Undelete/User.json

data={
   "id" : "00601STLLWAGAADSegoa"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "User",
    "id" : "00601STLLWAGAADSegoa",
    "isActive" : "1",
    "createdTime" : "2016-12-13T21:42:30.000+0000",
    "updatedTime" : "2016-12-13T21:42:30.000+0000",
    "loginId" : "00501NHFSIGZBEEJ9vam",
    "profileId" : "0po01INEVZKMWAXAev9n",
    "firstName" : "Samuel C.",
    "lastName" : "Clerk",
    "email" : "something@something.com",
    "timezoneId" : "3",
    "partnerUserGroupType" : "0"
  }
}

Resources

Parameters