QuickBooks: What is the purpose of the "realm_id" property?

Edited

The realm_id is a QuickBooks-specific property.

We store this on a specific settings field for the QuickBooks connection when it's returned from QuickBooks.

The setting can be accessed via the API directly and used on the Proxy API as a variable in the URL for unsupported endpoints. e.g., https://quickbooks.api.intuit.com/v3/company/{realm_id}/...

Example case for fetching all the customers for a certain QuickBooks client with the realm_id .


The x-apideck-downstream-url for a Proxy API request would look like this:

https://sandbox-quickbooks.api.intuit.com/v3/company/{realm_id}/query?minorversion=63&query=select * from Customer 

The {realm_id} is a setting managed in Vault and automatically injected when executing a Proxy request.

Was this article helpful?

Sorry about that! Care to tell us more?

Thanks for the feedback!

There was an issue submitting your feedback
Please check your connection and try again.