The customer object is a basic customer record in the Stax Bill system. It includes the Stax Bill generated ID that is used to uniquely identify the particular customer throughout the system.
A customer represents a billed entity in Stax Bill. It is associated with a list of subscription objects, payment method objects, invoice objects, and many other objects in the system. Directly associated with the customer object is the customer's basic contact information. If you have your own custom IDs for your customers it may be useful to leverage the reference field (in the UI this is called "Customer ID" by default) for easy navigation through your customer base. Keep in mind that reference is a custom string that Stax Bill does not enforce uniqueness. Only the Stax Bill generated id is guaranteed to be unique across your customer base as well as non-null values for portalUserName.
Customer Object Fields
| Property | Type | Description |
|---|---|---|
firstName | String | The first name of the Customer. [Max Length: 50 characters] |
middleName | String | The middle name of the Customer. [Max Length: 50 characters] |
lastName | String | The last name of the Customer. [Max Length: 50 characters] |
companyName | String | The company name associated with this Customer. [Max Length: 50 characters] |
suffix | String | The name suffix of the customer, for example Jr. or Sr. [Max Length: 50 characters] |
primaryEmail | String | The primary contact email for the Customer. Allows multiple entries in the format "[email protected]; [email protected]; [email protected]". Invoices and other email communications will be sent to this address(es). [Max Length: 255 characters] |
primaryPhone | String | The primary contact number for the Customer. [Max Length: 50 characters] |
secondaryEmail | String | The secondary contact email for the Customer. Allows multiple entries in the format "[email protected]; [email protected]; [email protected]". No communications are sent to this address [Max Length: 255 characters] |
secondaryPhone | String | The secondary contact number for the Customer. [Max Length: 50 characters] |
title | Enum:{Mr, Mrs, Ms, Miss, Dr} | The prefix-title of the customer. |
reference | String | This is a free form reference field where you can store a reference string for this customer. Generally, this is used to store the reference/Id of this customer in some external system to facilitate matching up the Fusebill Customer record to that system. [Max Length: 255 characters] |
status | Enum:{Draft, Active, Hold, Suspended, Cancelled} | The status of the customer. Most actions that can be done with this entity require it to be in active status |
customerAccountStatus | Enum:{Good, Collection, PoorStanding} | The accounting status of the Customer. This reflects the financial status of the Customer and relates to if the Customer has past-due unpaid invoices. Customers enter Poor Standing if they have at least one (1) unpaid, overdue invoice. . [Read Only] |
currency | 3 character ISO currency code | The Currency configured for this Customer. [Read Only] |
customerReference | Object (defined below) | This is used to store additional data related to this customer, including sales tracking codes. |
customerAcquisition | Object (defined below) | This is used to store different details about how this customer was acquired. Generally, this is used to store marketing channel information. |
monthlyRecurringRevenue | Decimal | The calculated MRR value for this Customer. This is calculated based on the expected income of thier current Subscriptions. Only recurring charges are included in this calculation. One-time goods and physical goods purchases, which do not recur, are not included. [Read Only] |
netMonthlyRecurringRevenue | Decimal | The net MRR of the customer. Calculated by considering any discounts on the customer's active subscription products. [Read Only] |
salesforceId | String | The Salesforce Account Id associated with this Customer. This field is only populated if you are using the Fusebill Salesforce plugin. |
salesforceAccountType | Enum: {Company, Person} | This will dictate how the Salesforce account name will be created. Your options are: 1)"Company" where the company name and Fusebill Id will be combined and used as the account name 2)"Person" where the first and last names will be combined to populate the account name field. 3) NULL, the account level default will be used |
salesforceSynchStatus | Enum:{Enabled, Disabled} | This setting controls if the account will synchronize the Fusebill account with Salesforce. [Read Only] |
netsuiteId | String | If you are using a Netsuite integration this is the number which uniquely identifies the customer in Netsuite. [Read Only] |
netsuiteSynchStatus | Enum:{Enabled, Disabled} | This setting controls if the account will synchronize the Fusebill account with NetSuite. [Read Only] |
netsuiteCustomerType | Enum:{Individual, Company} | Identifies the entity type of the customer record in NetSuite. This field is only populated if you are using the Fusebill NetSuite plugin. [Read Only] |
portalUserName | String | If the customer has login credentials this field contains the username. [Max Length: 50 characters] [Read Only After Set] |
parentId | Integer | The Parent ID relates to the Fusebill hierarchy feature. If hierarchy is enabled, this is the id of the parent customer. |
quickBooksLatchType | Enum:{CreateNew, LatchExisting, DoNothing} | Indicates how Fusebill is handling latching for this customer object and the possible corresponding customer in QuickBooks Online. This is for the QuickBooks Online plugin. |
quickBooksId | Integer | The name ID of this customer in QuickBooks Online. For the QuickBooks Online plugin. |
hubSpotId | Integer | The ID of this customer in HubSpot |
hubSpotCompanyId | Integer | The ID of this customer in HubSpot if it represents a company |
geotabId | String | The Geotab Reseller Customer ID associated with this Fusebill customer entity [Max Length: 255 characters] |
modifiedTimestamp | Timestamp | The timestamp of the last time this object was modified. [Read Only] |
createdTimestamp | Timestamp | The timestamp of when this customer was created as draft. [Read Only] |
id | Integer | The Fusebill generated ID that uniquely identifies this customer. [Read Only] |
uri | String | Full path to a particular customer object. [Read Only] |
Customer Reference Fields
| Property | Type | Description |
|---|---|---|
reference1 | String | An optional open field to hold any alpha-numeric value on the customer. [Max Length: 255 characters] |
reference2 | String | An optional open field to hold any alpha-numeric value on the customer. [Max Length: 255 characters] |
reference3 | String | An optional open field to hold any alpha-numeric value on the customer. [Max Length: 255 characters] |
salesTrackingCodes | Object (defined below) | A collection of up to 5 SalesTrackingCode objects |
SalesTrackingCode Fields
| Property | Type | Description |
|---|---|---|
type | String | Identification of the sales tracking code type being set. The sales tracking code type can be configured under the sales tracking code section under your account settings By default the accepted values are "Sales Tracking Code 1", "Sales Tracking Code 2" ... up to "Sales Tracking Code 5". If you rename your sales tracking code, those names or the default names can be used. [Max Length: 255 characters] |
code | String | The specific sales tracking code value. The code must exist under the appropriate salestrackingcode type being referenced [Max Length: 255 characters] |
name | String | Display name [Max Length: 255 characters] |
id | Integer | The Fusebill generated ID for the Sales Tracking Code [Read Only] |
uri | String | The full path to the Sales Tracking Code object [Read Only] |
Customer Acquisition Fields
| Property | Type | Description |
|---|---|---|
adContent | String | Typically used to set the content description for the campaign ad. For all campaigns, or for a particular campaign, this appears as Ad Content under the Segment pull-down in the Analytics Reports. [Max Length: 255 characters] |
campaign | String | This variable is used to define the name of your campaign, which appears in the Analytics reports on the top-level campaign report. [Max Length: 255 characters] |
keyword | String | These are the words that visitors use to find your Website when using a search engine. Google Analytics provides a list of keywords that have been searched by users who find your Website. This information shows you what searchers are actually looking for when they find your Website. This also allows you to discover potential new keywords to target. [Max Length: 255 characters] |
landingPage | String | The first page a visitor views during a session; also known as the entrance page. [Max Length: 255 characters] |
medium | String | Typically used to define the type of the campaign, such as a banner ad, email campaign, or click ad. For all campaigns, or for a particular campaign, this appears as Keyword under the Segment pull-down in the Analytics Reports. [Max Length: 255 characters] |
source | String | The source variable is typically used to define where the campaign is originating from, such as a website name or a company. For all campaigns, or for a particular campaign, this appears as Source under the Segment pull-down in the Analytics Reports. [Max Length: 255 characters] |
id | Integer | The Fusebill generated ID for the customer this customer acquisition belongs to [Read Only] |
uri | String | The full path to the customer object this customer acquisition belongs to [Read Only] |