Update Oct 2, 2015: The change described here will be effective November 14, 2015.
Update Nov 15, 2015: The change described here will be effective November 19, 2015.
Note: This is a reminder of an announcement we made in late 2014.
What action is required?
You must ensure your application can accommodate the new long RealmId format that will be in production by the end of calendar year 2015.
RealmIds are the numeric identifiers that Intuit Identity Services use to identify a QuickBooks company record. The current format is a 10-digit integer. At the current rate, we will run out of IDs in about a year in the production environment. To address this, we are changing the RealmId type from Integer to Long (64-bit).
Note: Existing RealmIds will be unchanged. Only new RealmIds will get the Long type.
Benefits of the Long RealmId
- Gives us a wider range for RealmIds, so we will not run out of IDs.
- The new ID generation will include patterns that cannot be predicted easily, greatly improving security.
Modifying your code
Intuit has documented the RealmId as a string for 3rd-party developers. The underneath implementation will change from integer to long. Depending on how you define the RealmId, you might need to modify your code. You need to modify your code if any of these scenarios applies:
- If you define RealmId as int or Integer, change it to long or Long, and ensure the validation for the long RealmIds.
- If you define RealmId as String and validate the string, make sure the validation logic (checking the string length) accommodates the maximum string size as 19 (positive RealmIds only) instead of 10.
- If you have a database table to store IDs, make sure it can hold 64-bit numbers.
If you have any questions, concerns or comments, please share them on our developer forums.