# QuickBooks Customer API

**Canonical:** https://apis.io/apis/quickbooks/quickbooks-customer-api/  
**Provider:** QuickBooks — https://apis.io/providers/quickbooks/  
**Base URL:** https://quickbooks.api.intuit.com  
**Documentation:** https://developer.intuit.com/app/developer/qbo/docs/develop

QuickBooks Customer API is one of 82 APIs that [QuickBooks](https://apis.io/providers/quickbooks/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 12 JSON Schema definitions. Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, an AsyncAPI specification, and 12 JSON Schemas.

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.

## Operations (3)

| Method | Path | Summary |
|---|---|---|
| GET | `/v3/company/{realmID}/query` | Query an entity with a SELECT statement |
| POST | `/v3/company/{realmID}/customer` | Create a customer / Full update a customer / Sparse update a customer |
| GET | `/v3/company/{realmID}/customer/{customerId}` | Read a customer |

## Machine-readable artifacts (23)

- **OpenAPI** — https://artifacts.apis.io/quickbooks/openapi/quickbooks-customer-api-openapi.yml
- **Documentation** — https://developer.intuit.com/app/developer/qbo/docs/develop
- **APIReference** — https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/account
- **GettingStarted** — https://developer.intuit.com/app/developer/qbo/docs/get-started
- **Authentication** — https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0
- **AsyncAPI** — https://artifacts.apis.io/quickbooks/asyncapi/quickbooks-online-webhooks-asyncapi.yml
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-invoiceresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-salesreceiptresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-estimateresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-refundreceiptresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-customerresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-creditmemoresponse-schema.json
- **Documentation** — https://developer.intuit.com/app/developer/qbpayments/docs/develop
- **APIReference** — https://developer.intuit.com/app/developer/qbpayments/docs/api/resources/all-entities/charges
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-chargeresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-card-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-bankaccount-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-echeckresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-chargerequest-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-bankaccountrequest-schema.json
- **Documentation** — https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account
- **Sandbox** — https://sandbox-quickbooks.api.intuit.com/v3/company/{realmId}
- **API Explorer** — https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/account

## Other QuickBooks APIs (12)

- [QuickBooks Online GraphQL API](https://apis.io/apis/quickbooks/graphql/)
- [QuickBooks Workforce Payroll API](https://apis.io/apis/quickbooks/payroll/)
- [QuickBooks Account API](https://apis.io/apis/quickbooks/quickbooks-account-api/)
- [QuickBooks Account List Detail API](https://apis.io/apis/quickbooks/quickbooks-accountlistdetail-api/)
- [QuickBooks AP Aging Detail API](https://apis.io/apis/quickbooks/quickbooks-apagingdetail-api/)
- [QuickBooks AP Aging Summary API](https://apis.io/apis/quickbooks/quickbooks-apagingsummary-api/)
- [QuickBooks AR Aging Detail API](https://apis.io/apis/quickbooks/quickbooks-aragingdetail-api/)
- [QuickBooks AR Aging Summary API](https://apis.io/apis/quickbooks/quickbooks-aragingsummary-api/)
- [QuickBooks Attachable API](https://apis.io/apis/quickbooks/quickbooks-attachable-api/)
- [QuickBooks Balance Sheet API](https://apis.io/apis/quickbooks/quickbooks-balancesheet-api/)
- [QuickBooks Batch API](https://apis.io/apis/quickbooks/quickbooks-batch-api/)
- [QuickBooks Bill API](https://apis.io/apis/quickbooks/quickbooks-bill-api/)

## Tags

Customers

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/quickbooks/quickbooks-customer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/quickbooks/.