GET v1/QuickBooks/SyncStatus/{id}

Retrieves the latest sync status event for QuickBooks

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id	string	Required

Body Parameters

None.

Response Information

Resource Description

QuickBooks sync status

QuickBooksSyncStatusDTO

Name	Description	Type	Additional information
ID	The ID of the sync status in the database.	globally unique identifier	None.
Success	Indicates if the sync was successful.	boolean	None.
StatusMessage	The message returned from the sync.	string	None.
TriggeredEntityId	The ID of the that triggered the sync.	integer	None.
SyncStarted	The date/time the sync started.	date	None.
SyncFinished	The date/time the sync finished.	date	None.
PendingTransactionsToSync	Count of transactions that are currently pending for entities that have previously been synced.	integer	None.
SyncEvents	Count of transactions synced by this sync request.	integer	None.
ExternalEntities	Count of entities synced by this sync request.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "19905a42-6c1f-47c4-89e6-e64197ead574",
  "Success": true,
  "StatusMessage": "sample string 3",
  "TriggeredEntityId": 4,
  "SyncStarted": "2026-08-25T17:22:56.6536659+00:00",
  "SyncFinished": "2026-08-25T17:22:56.6536659+00:00",
  "PendingTransactionsToSync": 6,
  "SyncEvents": 7,
  "ExternalEntities": 8
}

application/xml, text/xml

Sample:

<QuickBooksSyncStatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Finance.QBIntegration">
  <ExternalEntities>8</ExternalEntities>
  <ID>19905a42-6c1f-47c4-89e6-e64197ead574</ID>
  <PendingTransactionsToSync>6</PendingTransactionsToSync>
  <StatusMessage>sample string 3</StatusMessage>
  <Success>true</Success>
  <SyncEvents>7</SyncEvents>
  <SyncFinished>2026-08-25T17:22:56.6536659+00:00</SyncFinished>
  <SyncStarted>2026-08-25T17:22:56.6536659+00:00</SyncStarted>
  <TriggeredEntityId>4</TriggeredEntityId>
</QuickBooksSyncStatusDTO>