In this topic:

Creating a Collector Run with run type ‘On Demand’

To view the charge information, you need to create a Collector Run. In the request body, specify its type, collector operations, and start and end dates.

Note: You can also create an automatic collector run when creating a run mode with the "run_type" property set to "COLLECTOR_AUTO".

In the response body you will receive the ID of the Collector Run which is a sequence number of all your Collector runs. You can view the full history of Collector runs through JSS.

Note: If we run the collector through JSS, it is viewable when using the following endpoint: GET /collector-run

Create a collector

POST https://example.gotransverse.com/calypso/3/collector-runs

Request

{
  "type": "AUTO",
  "collector_operations": [
     "INSERT_SERVICES"
   ],
  "data_fetch_from_date": "2017-01-01",
  "data_fetch_to_date": "2020-01-01",
  "overlap_fetch_time": 86400
}

Response

{
  "id": 10,
  "type": "AUTO",
  "collector_operations": [
     "INSERT_SERVICES"
   ],
  "data_fetch_from_date": "2017-01-01T06:00:00Z",
  "data_fetch_to_date": "2018-10-04T14:51:44Z",
  "overlap_fetch_time": 86400,
  "tenant_id": 2201,
  "run_trigger_type": "ON_DEMAND",
  "status": "NOT_STARTED",
  "num_errors": 0
}

Ensure the collector run is successfully completed

Before you start using the General Ledger, make sure the collector run is successfully completed. To do it, retrieve the details on your collector run and check whether the status is COMPLETE.

GET https://example.gotransverse.com/calypso/3/collector-runs

Response

{
  "id": 10,
  "type": "AUTO",
  "collector_operations": [
    "INSERT_SERVICES"
  ],
  "data_fetch_from_date": "2017-01-01T06:00:00Z",
  "data_fetch_to_date": "2018-10-04T14:51:44Z",
  "overlap_fetch_time": 86400,
  "tenant_id": 2201,
  "run_trigger_type": "ON_DEMAND",
  "status": "COMPLETE",
  "num_errors": 0,
  "date_started": "2018-10-04T14:51:44Z",
  "date_ended": "2018-10-04T14:51:47Z"
}

Now, proceed with running a General Ledger.

Top