latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Data
Gets the status of push communication records.
get/data/pushStatus
Query parameters
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'shopify' | 'square' | 'plaid' | 'myob' | 'zohoBooks' | 'byod'
pushCommunicationIdstring
batchIdstring
Response
Example response
{
"meta": {
"count": 1,
"businessName": "Railz"
},
"data": [
{
"serviceName": "quickbooks",
"dataType": "balanceSheet",
"requestedOn": "2021-03-17T07:58:39.781Z",
"completedOn": "2021-03-17T07:58:39.781Z",
"status": "success",
"responseCode": 200,
"validation": {
"errors": [
{
"field": "customerName",
"message": "Must have a length between 1 and 500 characters."
}
]
},
"pushCommunicationId": "60473b57f0cdd1683ca71f60",
"sourceObjectId": "144",
"sourceObjectIds": [
"144",
"154"
]
}
]
}