Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Intuit Customers API

A Customer object represents a consumer of the service or product that the business offers. The Customer entity allows you to categorize customers into jobs and sub-customers.

Intuit Customers API is one of 11 APIs that Intuit publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 2 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, release notes, and 2 JSON Schemas.

This API exposes 4 operations across 3 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 75.

Requests are made against 2 base URLs: https://quickbooks.api.intuit.com/v3/company/{realmId}, https://sandbox-quickbooks.api.intuit.com/v3/company/{realmId}.

4 operations 3 paths 18 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
75
Servers
https://quickbooks.api.intuit.com/v3/company/{realmId}
https://sandbox-quickbooks.api.intuit.com/v3/company/{realmId}
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Intuit Customers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — Intuit uses OAuth 2.0 for authorization. Apps must be registered on the Intuit Developer portal to obtain client credentials. Access tokens have a 60-minute li…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Customers 4

A Customer object represents a consumer of the service or product that the business offers. The Customer entity allows you to categorize customers into jobs and sub-customers.

GET
/query
Query Entities
queryEntities 2 params → 200400401500
POST
/customer
Create a Customer
createCustomer 1 param body → 200400401500
GET
/customer/{customerId}
Read a Customer
readCustomer 2 params → 200400401404500
POST
/customer/{customerId}
Update a Customer
updateCustomer 3 params body → 200400401404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Invoice (36 properties), Customer (35 properties), Item (30 properties), Payment (18 properties). Each schema is shown below with its type and property counts.

QueryResponse
object
Response wrapper for query operations. Contains the array of matching entities along with pagination metadata.
2 properties
Customer
object
A Customer represents a consumer of the service or product that the business offers. Customers can be organized as sub-customers (jobs) within a parent custome…
35 properties 1 required
Payment
object
A Payment records a payment received from a customer. Payments can be applied to one or more outstanding invoices, or left as unapplied credit.
18 properties 2 required
CustomField
object
Custom field defined for the entity
4 properties
ReferenceType
object
A reference type used throughout the API to link entities. Contains the ID value and optionally the display name of the referenced entity.
2 properties 1 required
Invoice
object
An Invoice represents a sales form where the customer pays for a product or service later. It creates an accounts receivable transaction.
36 properties 2 required
EmailAddress
object
Email address
1 property
CustomerResponse
object
2 properties
Item
object
An Item represents a product or service that a company buys, sells, or re-sells. Items are used in line items on invoices, sales receipts, bills, and other tra…
30 properties 2 required
InvoiceLine
object
A line item on an invoice
7 properties 2 required
TelephoneNumber
object
Telephone number
1 property
Error
object
Error response from the API
2 properties
PhysicalAddress
object
Physical (mailing) address
12 properties
PaymentLine
object
A line item on a payment showing how it is applied
2 properties 2 required
LinkedTxn
object
A reference to a linked transaction such as an invoice, payment, or credit memo
2 properties 2 required
TxnTaxDetail
object
Tax details for a transaction
3 properties
SalesItemLineDetail
object
Detail for a sales item line
10 properties
MetaData
object
Metadata about when the entity was created and last updated
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

intuit-customers-api-openapi.yml Raw ↑

Other APIs Intuit publishes across the network.

Intuit APIs
QuickBooks Payments API
QuickBooks Payroll and Time API
QuickBooks Desktop API
QuickBooks Projects API
QuickBooks Custom Fields API
QuickBooks Sales Tax API
Intuit Invoices API
Intuit Items API
Intuit Payments API