CustomerService class
URL: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/customer A customer is a consumer of the service or product that your business offers. An individual customer can have an underlying nested structure, with a parent customer (the top-level object) having zero or more sub-customers and jobs associated with it. Sub-customer examples: Members of a team or league: the team itself is the parent customer and the members are sub-customers. Properties managed by a property management company: the management company is the parent customer and the properties are the sub-customers. Job examples: Tracking a kitchen remodel: the home owner is the parent customer and individual kitchen remodel tasks are jobs. Tracking car repairs: the car owner is the parent customer and individual car repairs are jobs. Use the Customer resource to create parent customer objects, sub-customer objects, and job objects according to your business requirements. Use the ParentRef and Job attributes in the customer object to designate whether the object is a parent, nested job or nested sub-customer. First, create parent customer objects: Set Job to false (default) and do not define ParentRef. Then, create sub-customer and job objects: Set Job to true and set ParentRef to reference parent customer object. Going forward, specify an individual parent customer object, sub-customer object, or job object in sales transactions via the transaction's CustomerRef attribute, based on your business requirements.See QuickBooks product documentation for more about sub-customers and jobs.
Constructors
- CustomerService({required String baseUrl, required AuthenticationService authenticationService, int minorVersion = 63})
Properties
- authenticationService → AuthenticationService
-
final
- baseUrl → String
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- minorVersion → int
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createCustomer(
{required Customer customer, String? realmId, String? authToken}) → Future< Customer> - The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required during object create.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
queryCustomer(
{required String query, String? realmId, String? authToken}) → Future< List< Customer> > - Returns the results of the query.
-
readCustomer(
{required String customerId, String? realmId, String? authToken}) → Future< Customer> - Retrieves the details of a Customer object that has been previously created.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateCustomer(
{required Customer customer, String? realmId, String? authToken}) → Future< Customer> - Sparse updating provides the ability to update a subset of properties for a given object; only elements specified in the request are updated. Missing elements are left untouched. The ID of the object to update is specified in the request body.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited