Report Settings

Report Settings

Get Report Settings

get

This allows you to determine if you are enrolled for the nightly batch report. This will get the email addresses of those enrolled in the report, and the time the report will be run. The report will be your last closed batch.

Query parameters

typeanyOptional

type

Header parameters

api-keyanyRequired

apiKeyValue

Responses

200

OK

application/xmlapplication/json

401

Unauthorized

403

Forbidden

404

Not Found

get

/rest/v2/settings/terminal/report

HTTPcURLJavaScriptPython

GET /rest/v2/settings/terminal/report HTTP/1.1
Host: gateway-sb.clearent.net/
Accept: */*

<?xml version="1.0"?>
<object>
	<payloadType>text</payloadType>
	<terminal-settings>
		<batch-time-utc>09:30</batch-time-utc>
		<business-phone>text</business-phone>
		<commerce-type>ECOMMERCE</commerce-type>
		<enable-auto-close-batch>true</enable-auto-close-batch>
		<enable-tip>true</enable-tip>
		<merchant-id>000000843334</merchant-id>
		<merchant-name>Test Merchant</merchant-name>
		<service-fee>text</service-fee>
		<service-fee-program-type>text</service-fee-program-type>
		<service-fee-state>text</service-fee-state>
		<service-fee-type>text</service-fee-type>
		<terminal-id>10018001</terminal-id>
		<terminal-name>Waterloo location 1</terminal-name>
		<time-zone>Central/US</time-zone>
	</terminal-settings>
</object>

Update Report Settings

post

Header parameters

api-keyanyRequired

apiKeyValue

Body

application/xmlapplication/json

enabledbooleanOptional

Enable/Disable report from running

Example: true

report-timestringOptional

No longer supported. Batch reports are now sent immediately after batch out. To be removed from API in future.

Example: 09:51:00

typestring · enumOptional

report type

Example: LAST_CLOSED_BATCHPossible values:

Responses

200

OK

application/xmlapplication/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/rest/v2/settings/terminal/report

HTTPcURLJavaScriptPython

POST /rest/v2/settings/terminal/report HTTP/1.1
Host: gateway-sb.clearent.net/
Content-Type: application/xml
Accept: */*
Content-Length: 117

"<?xml version=1.0?>
<emails>
	<email>
		<address>[email protected]</address>
	</email>
</emails>
<enabled>true</enabled>
<report-time>09:51:00</report-time>
<type>LAST_CLOSED_BATCH</type>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<payloadType>text</payloadType>
	<terminal-settings>
		<batch-time-utc>09:30</batch-time-utc>
		<business-phone>text</business-phone>
		<commerce-type>ECOMMERCE</commerce-type>
		<enable-auto-close-batch>true</enable-auto-close-batch>
		<enable-tip>true</enable-tip>
		<merchant-id>000000843334</merchant-id>
		<merchant-name>Test Merchant</merchant-name>
		<service-fee>text</service-fee>
		<service-fee-program-type>text</service-fee-program-type>
		<service-fee-state>text</service-fee-state>
		<service-fee-type>text</service-fee-type>
		<terminal-id>10018001</terminal-id>
		<terminal-name>Waterloo location 1</terminal-name>
		<time-zone>Central/US</time-zone>
	</terminal-settings>
</object>

Update Report Settings

put

Header parameters

api-keyanyRequired

apiKeyValue

Body

application/xmlapplication/json

enabledbooleanOptional

Enable/Disable report from running

Example: true

report-timestringOptional

No longer supported. Batch reports are now sent immediately after batch out. To be removed from API in future.

Example: 09:51:00

typestring · enumOptional

report type

Example: LAST_CLOSED_BATCHPossible values:

Responses

200

OK

application/xmlapplication/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

put

/rest/v2/settings/terminal/report

HTTPcURLJavaScriptPython

PUT /rest/v2/settings/terminal/report HTTP/1.1
Host: gateway-sb.clearent.net/
Content-Type: application/xml
Accept: */*
Content-Length: 117

"<?xml version=1.0?>
<emails>
	<email>
		<address>[email protected]</address>
	</email>
</emails>
<enabled>true</enabled>
<report-time>09:51:00</report-time>
<type>LAST_CLOSED_BATCH</type>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<payloadType>text</payloadType>
	<terminal-settings>
		<batch-time-utc>09:30</batch-time-utc>
		<business-phone>text</business-phone>
		<commerce-type>ECOMMERCE</commerce-type>
		<enable-auto-close-batch>true</enable-auto-close-batch>
		<enable-tip>true</enable-tip>
		<merchant-id>000000843334</merchant-id>
		<merchant-name>Test Merchant</merchant-name>
		<service-fee>text</service-fee>
		<service-fee-program-type>text</service-fee-program-type>
		<service-fee-state>text</service-fee-state>
		<service-fee-type>text</service-fee-type>
		<terminal-id>10018001</terminal-id>
		<terminal-name>Waterloo location 1</terminal-name>
		<time-zone>Central/US</time-zone>
	</terminal-settings>
</object>