About Customer
In order to send an invoice for goods/services, a Customer entity must be created. Although the basic required parameters can create the customer in the Bill.com account, it is recommended to enter as much information as is available.
Note: In situations where more than one customer contact needs to be added, use the CustomerContact API.
Create
Request
<API_URL_EndPoint>/Crud/Create/Customer.json
data={
"obj" : {
"entity" : "Customer",
"isActive" : "1",
"name" : "Diamond",
"shortName" : "Diamond",
"parentCustomerId" : "",
"companyName" : "Diamond Industrial Inc.",
"contactFirstName" : "George",
"contactLastName" : "Smith",
"accNumber" : "212",
"billAddress1" : "123 South North Street",
"billAddress2" : "Suite 123",
"billAddress3" : "",
"billAddress4" : "",
"billAddressCity" : "Santa Clara",
"billAddressState" : "CA",
"billAddressCountry" : "USA",
"billAddressZip" : "95051",
"shipAddress1" : "6868 First Second Avenue",
"shipAddress2" : "Office 10",
"shipAddress3" : "",
"shipAddress4" : "",
"shipAddressCity" : "Saint George",
"shipAddressState" : "AL",
"shipAddressCountry" : "USA",
"shipAddressZip" : "35000",
"email" : "diamond@com.com",
"phone" : "123-123-1234",
"altPhone" : "123-123-1256",
"fax" : "123-123-1235",
"description" : "Industrial diamond company",
"printAs" : "",
"accountType" : "1"
}
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "Customer",
"id" : "0cu01QRJUQPTKMMYijuo",
"isActive" : "1",
"createdTime" : "2016-12-09T21:38:40.000+0000",
"updatedTime" : "2016-12-09T21:38:40.000+0000",
"name" : "Diamond",
"shortName" : "Diamond",
"parentCustomerId" : "00000000000000000000",
"companyName" : "Diamond Industrial Inc.",
"contactFirstName" : "George",
"contactLastName" : "Smith",
"accNumber" : "212",
"billAddress1" : "123 South North Street",
"billAddress2" : "Suite 123",
"billAddress3" : null,
"billAddress4" : null,
"billAddressCity" : "Santa Clara",
"billAddressState" : "CA",
"billAddressCountry" : "USA",
"billAddressZip" : "95051",
"shipAddress1" : "6868 First Second Avenue",
"shipAddress2" : "Office 10",
"shipAddress3" : null,
"shipAddress4" : null,
"shipAddressCity" : "Saint George",
"shipAddressState" : "AL",
"shipAddressCountry" : "USA",
"shipAddressZip" : "35000",
"email" : "diamond@com.com",
"phone" : "123-123-1234",
"altPhone" : "123-123-1256",
"fax" : "123-123-1235",
"description" : "Industrial diamond company",
"printAs" : null,
"mergedIntoId" : "00000000000000000000",
"hasAuthorizedToCharge" : false,
"accountType" : "1"
}
}Read
Request
<API_URL_EndPoint>/Crud/Read/Customer.json
data={
"id" : "0cu01QRJUQPTKMMYijuo"
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "Customer",
"id" : "0cu01QRJUQPTKMMYijuo",
"isActive" : "1",
"createdTime" : "2016-12-09T21:38:40.000+0000",
"updatedTime" : "2016-12-09T21:38:40.000+0000",
"name" : "Diamond",
"shortName" : "Diamond",
"parentCustomerId" : "00000000000000000000",
"companyName" : "Diamond Industrial Inc.",
"contactFirstName" : "George",
"contactLastName" : "Smith",
"accNumber" : "212",
"billAddress1" : "123 South North Street",
"billAddress2" : "Suite 123",
"billAddress3" : null,
"billAddress4" : null,
"billAddressCity" : "Santa Clara",
"billAddressState" : "CA",
"billAddressCountry" : "USA",
"billAddressZip" : "95051",
"shipAddress1" : "6868 First Second Avenue",
"shipAddress2" : "Office 10",
"shipAddress3" : null,
"shipAddress4" : null,
"shipAddressCity" : "Saint George",
"shipAddressState" : "AL",
"shipAddressCountry" : "USA",
"shipAddressZip" : "35000",
"email" : "diamond@com.com",
"phone" : "123-123-1234",
"altPhone" : "123-123-1256",
"fax" : "123-123-1235",
"description" : "Industrial diamond company",
"printAs" : null,
"mergedIntoId" : "00000000000000000000",
"hasAuthorizedToCharge" : false,
"accountType" : "1"
}
}Update
Request
<API_URL_EndPoint>/Crud/Update/Customer.json
data={
"obj" : {
"entity" : "Customer",
"id" : "0cu01QRJUQPTKMMYijuo",
"isActive" : "1",
"createdTime" : "2016-12-09T21:38:40.000+0000",
"updatedTime" : "2016-12-09T21:43:05.000+0000",
"name" : "Diamond Industrial Division",
"shortName" : "Diamond",
"parentCustomerId" : "00000000000000000000",
"companyName" : "Diamond Industrial Division, Inc.",
"contactFirstName" : "Sam",
"contactLastName" : "Carter",
"accNumber" : "212",
"billAddress1" : "123 South North Street",
"billAddress2" : "Suite 123",
"billAddress3" : null,
"billAddress4" : null,
"billAddressCity" : "Santa Clara",
"billAddressState" : "CA",
"billAddressCountry" : "USA",
"billAddressZip" : "95051",
"shipAddress1" : "6868 First Second Avenue",
"shipAddress2" : "Office 10",
"shipAddress3" : null,
"shipAddress4" : null,
"shipAddressCity" : "Saint George",
"shipAddressState" : "AL",
"shipAddressCountry" : "USA",
"shipAddressZip" : "35000",
"email" : "samcarter@diamond.com",
"phone" : "123-123-1234",
"altPhone" : "123-123-1256",
"fax" : "123-123-1235",
"description" : "Industrial diamond company",
"printAs" : null,
"mergedIntoId" : "00000000000000000000",
"hasAuthorizedToCharge" : false,
"accountType" : "1"
}
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "Customer",
"id" : "0cu01QRJUQPTKMMYijuo",
"isActive" : "2",
"createdTime" : "2016-12-09T21:38:40.000+0000",
"updatedTime" : "2016-12-09T21:46:31.000+0000",
"name" : "Diamond Industrial Division",
"shortName" : "Diamond",
"parentCustomerId" : "00000000000000000000",
"companyName" : "Diamond Industrial Division, Inc.",
"contactFirstName" : "Sam",
"contactLastName" : "Carter",
"accNumber" : "212",
"billAddress1" : "123 South North Street",
"billAddress2" : "Suite 123",
"billAddress3" : null,
"billAddress4" : null,
"billAddressCity" : "Santa Clara",
"billAddressState" : "CA",
"billAddressCountry" : "USA",
"billAddressZip" : "95051",
"shipAddress1" : "6868 First Second Avenue",
"shipAddress2" : "Office 10",
"shipAddress3" : null,
"shipAddress4" : null,
"shipAddressCity" : "Saint George",
"shipAddressState" : "AL",
"shipAddressCountry" : "USA",
"shipAddressZip" : "35000",
"email" : "samcarter@diamond.com",
"phone" : "123-123-1234",
"altPhone" : "123-123-1256",
"fax" : "123-123-1235",
"description" : "Industrial diamond company",
"printAs" : null,
"mergedIntoId" : "00000000000000000000",
"hasAuthorizedToCharge" : false,
"accountType" : "1"
}
}Delete
Request
<API_URL_EndPoint>/Crud/Delete/Customer.json
data={
"id" : "0cu01QRJUQPTKMMYijuo"
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "Customer",
"id" : "0cu01QRJUQPTKMMYijuo",
"isActive" : "2",
"createdTime" : "2016-12-09T21:38:40.000+0000",
"updatedTime" : "2016-12-09T21:43:05.000+0000",
"name" : "Diamond",
"shortName" : "Diamond",
"parentCustomerId" : "00000000000000000000",
"companyName" : "Diamond Industrial Inc.",
"contactFirstName" : "George",
"contactLastName" : "Smith",
"accNumber" : "212",
"billAddress1" : "123 South North Street",
"billAddress2" : "Suite 123",
"billAddress3" : null,
"billAddress4" : null,
"billAddressCity" : "Santa Clara",
"billAddressState" : "CA",
"billAddressCountry" : "USA",
"billAddressZip" : "95051",
"shipAddress1" : "6868 First Second Avenue",
"shipAddress2" : "Office 10",
"shipAddress3" : null,
"shipAddress4" : null,
"shipAddressCity" : "Saint George",
"shipAddressState" : "AL",
"shipAddressCountry" : "USA",
"shipAddressZip" : "35000",
"email" : "diamond@com.com",
"phone" : "123-123-1234",
"altPhone" : "123-123-1256",
"fax" : "123-123-1235",
"description" : "Industrial diamond company",
"printAs" : null,
"mergedIntoId" : "00000000000000000000",
"hasAuthorizedToCharge" : false,
"accountType" : "1"
}
}Undelete
Request
<API_URL_EndPoint>/Crud/Undelete/Customer.json
data={
"id" : "0cu01QRJUQPTKMMYijuo"
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "Customer",
"id" : "0cu01QRJUQPTKMMYijuo",
"isActive" : "1",
"createdTime" : "2016-12-09T21:38:40.000+0000",
"updatedTime" : "2016-12-09T21:43:05.000+0000",
"name" : "Diamond",
"shortName" : "Diamond",
"parentCustomerId" : "00000000000000000000",
"companyName" : "Diamond Industrial Inc.",
"contactFirstName" : "George",
"contactLastName" : "Smith",
"accNumber" : "212",
"billAddress1" : "123 South North Street",
"billAddress2" : "Suite 123",
"billAddress3" : null,
"billAddress4" : null,
"billAddressCity" : "Santa Clara",
"billAddressState" : "CA",
"billAddressCountry" : "USA",
"billAddressZip" : "95051",
"shipAddress1" : "6868 First Second Avenue",
"shipAddress2" : "Office 10",
"shipAddress3" : null,
"shipAddress4" : null,
"shipAddressCity" : "Saint George",
"shipAddressState" : "AL",
"shipAddressCountry" : "USA",
"shipAddressZip" : "35000",
"email" : "diamond@com.com",
"phone" : "123-123-1234",
"altPhone" : "123-123-1256",
"fax" : "123-123-1235",
"description" : "Industrial diamond company",
"printAs" : null,
"mergedIntoId" : "00000000000000000000",
"hasAuthorizedToCharge" : false,
"accountType" : "1"
}
}Resources
Parameters