website logo
Product Overview
NetSuite
Payments
QuickBooks
Xero
Navigate through spaces
⌘K
Guided Wizard
Guided Wizard Settings
Bill Configuration
Custom Guided Wizard
Button URL Structure
Button URL Generator
Support
Global API
API Overview
Request
Response
Code Examples
Technical Resources
Breadwinner Setup
Requirements
ERD / Object Structure
Getting Help
Version History
Docs powered by
Archbee
Global API
Request

Customer

2min

When requesting a Customer, use the requestJSON to pass the Customer data, and the response will have responseJSON which stores the Customers response returned by QuickBooks.

The Customer object has the following properties.

Customer

Field Name

Data Type

Description

Active

Boolean

If true, this entity is currently enabled for use by QuickBooks

AlternatePhone

Common Data Types



BillAdd

Common Data Types



BillWithParent

Boolean

If true, this Customer object is billed with its parent. If false, or null the customer is not to be billed with its parent. This attribute is valid only if this entity is a Job or sub Customer.

CompanyName

String

Contact/Vendor Company name

CurrencyRef

Common Data Types



Reference to the currency in which all amounts associated with this customer are expressed. Once set, it cannot be changed. It is a type of value_name. check below for value_name fields

DisplayName*

String

The name of the person or organization as displayed. Must be unique across all Customer and Vendor (max length = 255)

DefaultTaxCodeRef

Common Data Types

Reference to a default tax code associated with this Customer object

EmailAddress

String

Email address of contact/vendor

FamilyName

String

Family name or the last name of the person

GivenName

String

Given name or first name of a person

Id

String

Unique identifier for this object and ReadOnly field

Job

Boolean

If true, this is a Job or sub-customer. If false or null, this is a top level customer, not a Job or sub-customer.

Notes

String

Free form text describing the Customer.

Metadata

Common Data Types

Descriptive information about the entity. The MetaData values are set by Data Services and are read only

MiddleName

String



Mobile

Common Data Types

Mobile phone number

MobileNumber

String

Mobile Number of contact/vendor

ParentRef

Common Data Types

A reference to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer

PaymentMethodRef

Common Data Types

Type of value_name. check below for value_name fields

Phone

String

Phone number of contact/vendor

PrimaryEmailAddr

Common Data Types

EmailAddress

PrimaryPhone

Common Data Types

Primary phone number

PrintOnCheckName

String

Name of the person or organization as printed on a check

ResaleNum

String

Resale number or some additional info about the customer

Salesforce_Account_Id

String

To link the Customer with the Salesforce Account

SalesTermRef

Common Data Types

Reference to a SalesTerm associated with this Customer object

Suffix

String



SyncToken

String

Version number of the object, It is used to lock an object for use by one app at a time and ReadOnly field

Title

String

Title of the person

WebAddr

Common Data Types

Website address

Updated 12 Sep 2023
Did this page help you?
PREVIOUS
Request
NEXT
Read
Docs powered by
Archbee
TABLE OF CONTENTS
Customer
Docs powered by
Archbee