Develop with the Project API

The Project API provides create, read, update, and delete operations using GraphQL. You can create client or server apps from the ground up, or start with a common use case. You can add transactions to your project by configuring the ID for the project while creating the transaction.

Before you can begin developing using the Project API, your company must support projects. Query the QuickBooks company preferences using the Accounting REST API Preferences and check for Preferences.OtherPrefs.ProjectsEnabled to determine if projects are supported for the company. Check if ProjectsEnabled is true.

The following shows an example response:

1
2
3
4

{
 "Name": "ProjectsEnabled",
 "Value": "true"
}

Step 1: Use the Accounting REST API to query the customer and get the customer.id value. See Customer Query in the API Explorer.

Step 2: Use ProjectManagementCreateProject (mutation) in the Project GraphQL API to create a project for the above customer.

Use projectManagementProject (query) to read a project by ID for a given date range using required filters. To get a list of projects, use projectManagementProjects (query).

For project update options, see the GraphQL API Explorer.

Use projectManagementDeleteProject (mutation) to delete a project by ID.

To test your app, use Postman. Fork our official collection specifically for the Project API here. For more information, see Set up and test queries in Postman.