ApexERPHost

<back to all web services

CouponXReceiptsQuery

Requires Authentication
The following routes are available for this service:
GET/Coupons/CouponXReceipts/Query
CouponXReceiptsQuery Parameters:
NameParameterData TypeRequiredDescription
coupon_typeequeryint?No
CouponStqueryint?No
coupon_codeequerystringNo
pos_nummqueryint?No
activate_starttqueryDateTime?No
activate_enddqueryDateTime?No
spend_starttqueryDateTime?No
spend_enddqueryDateTime?No
validFrom_starttqueryDateTime?No
validFrom_enddqueryDateTime?No
valid_starttqueryDateTime?No
valid_enddqueryDateTime?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CouponXReceiptsAuto Parameters:
NameParameterData TypeRequiredDescription
coupon_idformintNo
coupon_codeformstringNo
coupon_typeformintNo
from_dateformDateTime?No
expiration_dateformDateTimeNo
voidedformboolNo
usedformboolNo
use_dateformDateTime?No
coupon_dataformstringNo
coupon_statusformint?No
activate_idformGuid?No
spend_idformGuid?No
check_sum_fromformdecimal?No
check_sum_toformdecimal?No
discount_amount_limitformdecimal?No
discount_sum_limitformdecimal?No
single_coupon_per_checkformint?No
activate_opdateformDateTime?No
activate_pos_numformint?No
activate_batch_numformint?No
activate_receipt_numformint?No
spend_opdateformDateTime?No
spend_pos_numformint?No
spend_batch_numformint?No
spend_receipt_numformint?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Coupons/CouponXReceipts/Query HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			coupon_id: 0,
			coupon_code: String,
			coupon_type: 0,
			from_date: 0001-01-01,
			expiration_date: 0001-01-01,
			voided: False,
			used: False,
			use_date: 0001-01-01,
			coupon_data: String,
			coupon_status: 0,
			activate_id: 00000000000000000000000000000000,
			spend_id: 00000000000000000000000000000000,
			check_sum_from: 0,
			check_sum_to: 0,
			discount_amount_limit: 0,
			discount_sum_limit: 0,
			single_coupon_per_check: 0,
			activate_opdate: 0001-01-01,
			activate_pos_num: 0,
			activate_batch_num: 0,
			activate_receipt_num: 0,
			spend_opdate: 0001-01-01,
			spend_pos_num: 0,
			spend_batch_num: 0,
			spend_receipt_num: 0
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}