Get started with the Custom Fields API

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

The Custom Fields API is available to Silver, Gold, and Platinum partners only and is not available to Builder tier partners. To upgrade your tier, visit the Intuit Developer Portal. If you’re already on a paid tier and don’t have access, open a support ticket.

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.

The Custom Fields API is a Premium API available to Silver, Gold, and Platinum partners.

To get access:

1. Upgrade to the Silver tier or higher on the Intuit Developer Portal.
2. Once your tier is active, go to your app’s Permissions page in the Developer Portal. Enable the app-foundations.custom-field-definitions.read and app-foundations.custom-field-definitions scopes under Restricted scopes as you need.
3. Add the enabled scopes to your OAuth authorization requests.

If you’re already on a paid tier and still don’t have access, open a support ticket.

Authorize your app as described here.

• 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.

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

• Content-type: application/json
• Authorization: Bearer access_token