Returns sales information for gift certificates with an expiration date during the specified date range and a sale date during the specified date range.
GetGiftCertificatesByExpirationDate(StartDate AS Date, EndDate AS Date, ExpireFrom AS Date, ExpireTo AS Date, IncludeBalanceOnly AS Boolean)
XML String
StartDate = Start date for the sale date search.
EndDate = End date for the sale date search.
ExpireFrom = Start date for the expiration date search.
ExpireTo = End date for the expiration date search.
IncludeBalanceOnly = Select to include gift certificates with a balance remaining in the results.
XML String has the following structure:
|
Field |
Type |
Length |
Description |
|
iId |
Integer |
4 |
Primary Key - Unique Identifier |
|
iLocationId |
Integer |
4 |
Not used |
|
cGiftNumber |
String |
12 |
Gift certificate number. |
|
cInvoiceNo |
String |
12 |
Transaction number. |
|
iHeaderId |
Integer |
4 |
Transaction Header Id. Foreign Key to Transaction Header iId. |
|
iPurchBy |
Integer |
4 |
Purchased By Client Id. Foreign Key to Client iId. |
|
iPurchFor |
Integer |
4 |
Purchased For Client Id. Foreign Key to Client iId. |
|
iGiftTypeId |
Integer |
4 |
Gift Certificate Type Id. Foreign Key to Gift Certificate Types iId. |
|
iEmpId |
Integer |
4 |
Id of Employee who sold the gift certificate. Foreign Key to Employee iId. |
|
nPrice |
Decimal |
8 |
Gift certificate price. |
|
nOrigAmt |
Decimal |
8 |
Original value of gift certificate. |
|
nAmtLeft |
Decimal |
8 |
Amount remaining on gift certificate. |
|
nTip |
Decimal |
8 |
Original tip value on gift certificate. |
|
nTipLeft |
Decimal |
8 |
Tip amount remaining on gift certificate. |
|
dExpiration |
Date |
8 |
Expiration date. |
|
dValidFrom |
DateTime |
8 |
Valid from date. |
|
iRefById |
Integer |
4 |
Referral Id of how client heard about the gift certificate. Foreign Key to Client Referrals iId. |
|
lGiftCard |
Boolean |
1 |
Indicates whether the gift certificate is a gift card. |
|
iGId |
Integer |
4 |
Global Id for gift certificate record. |
|
lOffsiteGc |
Boolean |
1 |
Indicates whether the gift certificate was purchased from another location |
|
tDateTime |
DateTime |
8 |
Date/time sold. |
|
iClientId |
Integer |
4 |
Paying Client Id for the entire transaction. Foreign Key to Clients iId. |
|
lMailOrder |
Boolean |
1 |
Indicates whether the gift certificate was a mail order. |
|
iLoginId |
Integer |
4 |
User login that sold the gift certificate. Foreign Key to User Logins iId. |