BulkData GetBulkAccounts Method
Retrieves the list of accounts, created at the organization, up to 96 hours in the past. Empty fields will not be returned.
Parameters
Name | Data Type | Is Required |
---|---|---|
OrgID | Long | Required |
Description | The organization’s ID number. | |
BeginDate | DateTime | Required |
Description | The beginning date of the date range for which to pull the list of new accounts. This date cannot be more then 96 hours in the past. | |
EndDate | DateTime | Optional |
Description | The end date of the date range for which to pull the list of new accounts. This will default to SYSDATE if left undefined. |
Returned Parameters
Name | Data Type |
---|---|
ACCOUNT_ID | Long |
Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. |
ACCOUNT_NAME | String |
Description | The name on the account. This may differ from the primary contact in some instances. |
ACCOUNT_TYPE_NUM | Integer |
Description | The numeric value for the account type of the account. |
ACCOUNT_TYPE_VAL | String |
Description | The textual value for the account type of the account. |
ACCOUNT_CLASS_NUM | Integer |
Description | The numeric value for the class of the account. |
ACCOUNT_CLASS_VAL | String |
Description | The textual value for the class of the account. |
ACCOUNT_DEMOGRAPHIC_NUM | Integer |
Description | The numeric value for the demographics of the account. |
ACCOUNT_DEMOGRAPHIC_VAL | String |
Description | The textual value for the demographics of the account |
FLEX_01 | String |
Description | A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application. |
FLEX_02 | String |
Description | A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application. |
FLEX_03 | String |
Description | A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application. |
FLEX_04 | String |
Description | A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application. |
FLEX_05 | String |
Description | A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application. |
SITE_ID | Long |
Description | The site to which the account belongs. |
SITE_NAME | String |
Description | The name of the site as it appears in the Store application. |
ACCOUNT_ADDRESS_ID | Long |
Description | If the account is set up for consolidated billing, this is the ID of the address record where the invoice is sent. |
CREATED_DATE | DateTime |
Description | The date the account was initially created. |
CREATED_BY_ID | Long |
Description | The user’s ID that created the account. |
CREATED_BY_NAME | String |
Description | The first and last name of the user that created the account. |
UPDATED_DATE | DateTime |
Description | The date that the account was last updated. |
UPDATED_BY_ID | Long |
Description | The user’s ID that most recently updated the account. |
UPDATED_BY_NAME | String |
Description | The first and last name of the user that most recently updated the account. |
ORG_ID | Long |
Description | The organization’s ID number. |
Example
We’ll assume you’ve got a web reference, let’s name it BulkData, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a user request object and a data request object. We can define and create those like this:
// Create request and response objects
BulkData.LookupUser_Request user_request = new BulkData.LookupUser_Request();
BulkData.BulkDataSoapClient service = new BulkData.BulkDataSoapClient();
BulkData.BulkData_Request request = new BulkData.BulkData_Request();
Here’s my sample code of the Request and user objects.
// request
user_request.Username = "user";
user_request.Password = "pass";
user_request.Channel = 999;
request.OrgID = 123546;
request.BeginDate = DateTime.Today.AddDays(-1);
request.BeginDate = DateTime.Today;
Finally we can call the method and pass across the login object and the request object to retrieve our data. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
BulkData.BulkAccounts_Response response;
response = service.GetBulkAccounts(user_request, request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods, see BulkData Methods.