# PaycometRestApi.HeartbeatApi

All URIs are relative to *https://rest.paycomet.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**heartbeat**](HeartbeatApi.md#heartbeat) | **POST** /v1/heartbeat | Check the system

<a name="heartbeat"></a>
# **heartbeat**
> InlineResponse2008 heartbeat(opts)

Check the system

Get heartbeat of API

### Example
```javascript
import {PaycometRestApi} from 'paycomet_rest_api';

let apiInstance = new PaycometRestApi.HeartbeatApi();
let opts = { 
  'body': new PaycometRestApi.V1HeartbeatBody(), // V1HeartbeatBody | 
  'PAYCOMET_API_TOKEN': "PAYCOMET_API_TOKEN_example" // String | PAYCOMET API key (Query privilege required)
};
apiInstance.heartbeat(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**V1HeartbeatBody**](V1HeartbeatBody.md)|  | [optional] 
 **PAYCOMET_API_TOKEN** | **String**| PAYCOMET API key (Query privilege required) | [optional] 

### Return type

[**InlineResponse2008**](InlineResponse2008.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json