RArailz
Data
Data

GET /data/pushStatus

Changed on

Gets the status of push communication records.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
Example:Railz
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"
      ]
    }
  ]
}

Changes

  • 5cdfae3fa1faRevision changes
    • warning

      added the new dynamics365Finance enum value to the // response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the // response property for the response status

    • warning

      added the new freshbooks enum value to the // response property for the response status

    • warning

      added the new myob enum value to the // response property for the response status

    • warning

      added the new oracleNetsuite enum value to the // response property for the response status

    • warning

      added the new quickbooks enum value to the // response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the // response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the // response property for the response status

    • warning

      added the new sageIntacct enum value to the // response property for the response status

    • warning

      added the new wave enum value to the // response property for the response status

    • warning

      added the new xero enum value to the // response property for the response status

    • warning

      added the new zohoBooks enum value to the // response property for the response status

    • info

      added the new optional query request parameter batchId

    • info

      added the new enum value byod to the query request parameter serviceName

    • info

      added the new enum value dynamics365Finance to the query request parameter serviceName

    • info

      added the new enum value zohoBooks to the query request parameter serviceName

    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status