Get started with the Custom Fields API

Note

Note: The transactions and entities available for custom fields depend on your product. See Feature support by product. The information in this section is for QuickBooks Online Essentials, Plus, and Advanced and Intuit Enterprise Suite.

The following information, with links to more detailed pages, will get you started with developing your own custom fields.

Develop with GraphQL

For detailed information on how to develop using the GraphQL query language, including endpoints, authentication, required headers, and testing, see Learn about GraphQL. For information on how to develop QuickBooks Online apps using GraphQL, including best practices and an FAQ, see Develop with GraphQL.

Authorize your app

Authorize your app as described here.

Scopes

app-foundations.custom-field-definitions.read: Allows access to read custom field definitions data.
app-foundations.custom-field-definitions: Allows access to read and write custom field definitions data.
com.intuit.quickbooks.accounting: For Accounting REST API access.

Endpoints

Production endpoint: https://qb.api.intuit.com/graphql
Accounting REST API: https://quickbooks.api.intuit.com/v3/company/{realmId}/{entityname}?minorversion=70&include=enhancedAllCustomFields

Note

Note: The Custom Fields API is currently not available in sandbox.

Required headers

Content-type: application/json
Authorization: Bearer access_token