CRM.createNewCustomerInfo

This message is used to create a new customer with given information. Possible to create multiple customers in one message.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" apiName="CRM.createNewCustomerInfo" apiCategory="crm" locale="en-US" requestTimestamp="xxx">
     <parameters>
        <session id="7771475779004844"/>
        <user value="xxx"/> <password value="xxx"/>
        <customer
            customerCode='0'
            customerCardCode='0'
            alias='water'
            password='0'
            firstName='water'
            middleName=''
            lastName='guo'
            sex='m'
            customerStatus='0'
            address1=''
            address2=''
            city=''
            prov=''
            zipCode=''
            country=''
            dateOfBirth='2006-01-01 00:00:00'
            homePhone=''
            businessPhone=''
            cellPhone=''
            fax=''
            email=''
            creditCardInformation=''
            notes=''
            dateCreated='2006-01-01 00:00:00'
            startDate='2006-01-01 00:00:00'
            expiryDate='2006-01-01 00:00:00'
            lastModified='2006-01-01 00:00:00'
            customerLevel='0'
            customerGroups=''
            customerTypeId='-1'
            parentCustomerId='0'
            custValue1=''
            custValue2=''
            custValue3=''
            custValue4=''
            custValue5=''
            custValue6=''
            custValue7=''
            custValue8=''
            custValue9=''
            custValue10=''
            custValueText1=''
            customerSystemType='1'> 
                <picturePath value="1000000"/>
                <useOverrideCreditLimit value="0"/>
                <overrideCreditLimitAmount value="0"/>
        </customer>
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Acceptable Values	Notes
customer			no
	customerCode	string	no	AlphaNumeric 1-64 char	Customer Code
	customerCardCode	string	no	AlphaNumeric 1-64 char	Customer Card Code
	alias	string	no, can be blank	AlphaNumeric 0-20 char	Alias
	password	string	no, can be blank	AlphaNumeric 0-20 char	Password
	firstName	string	no, can be blank	AlphaNumeric 0-50 char	First Name of Customer. Can include apostrophe character as long as double quotes are used in request eg "O'Brien"
	middleName	string	no, can be blank	AlphaNumeric 0-50 char	Middle Name of Customer. Can include apostrophe character as long as double quotes are used in request eg "O'Brien"
	lastName	string	no, can be blank	AlphaNumeric 0-50 char	Last Name of Customer. Can include apostrophe character as long as double quotes are used in request eg "O'Brien"
	sex	string	no, can be blank	M, F, G	Sex of Customer, if left blank will default to G (Gender Neutral)
	customerStatus	int	no, can be blank	0-15	Suspended Customer = 1 Suspended Account = 2 Suspended Points Account = 4 Suspended Meal Plan Account = 8 ie. If a customer is suspended then the Customer Status = 1 If a customer is suspended with a suspended Account then the Customer Status = 1 + 2 = 3
	address1	string	no, can be blank	AlphaNumeric 0-32 char	Address
	address2	string	no, can be blank	AlphaNumeric 0-32 char	Address
	city	string	no, can be blank	AlphaNumeric 0-16 char	City
	prov	string	no, can be blank	AlphaNumeric 0-16 char	Province
	zipCode	string	no, can be blank	AlphaNumeric 0-10 char	Zip Code
	country	string	no, can be blank	AlphaNumeric 0-16 char	Country
	dateOfBirth	Timestamp	no, can be blank	YYYY-MM-DD HH:MM:SS.sss	Date of Birth
	homePhone	string	no, can be blank	AlphaNumeric 0-16 char	Home Phone Number
	businessPhone	string	no, can be blank	AlphaNumeric 0-16 char	Business Phone Number
	cellPhone	string	no, can be blank	AlphaNumeric 0-16 char	Cell Phone Number
	fax	string	no, can be blank	AlphaNumeric 0-16 char	Fax Number
	email	string	no, can be blank	AlphaNumeric 0-50 char	Email Address
	creditCardInformation	string	no, can be blank	AlphaNumeric 0-100 char	Credit Card Information
	notes	string	no, can be blank	AlphaNumeric 0-200 char	Extra Information
	dateCreated	Timestamp	no	YYYY-MM-DD HH:MM:SS.sss	Entry Date
	startDate	Timestamp	no	YYYY-MM-DD HH:MM:SS.sss	Start Date for Customer, prior to this date the customer will not be active
	expiryDate	Timestamp	no	YYYY-MM-DD HH:MM:SS.sss	Expiry Date for Customer, after this date the customer will not be active
	lastModified	Timestamp	no	YYYY-MM-DD HH:MM:SS.sss	Last Modified Time
	customerLevel	integer	no, default to 0		Customer level
	customerGroups	integer	no	Site Dependent	Customer Group Id (Defined in Customer Database)
	customerTypeId	integer	no	Site Dependent	Customer Type Id (Defined in Customer Database)
	parentCustomerId	integer	no		Default to 0
	custValue1	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 1
	custValue2	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 2
	custValue3	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 3
	custValue4	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 4
	custValue5	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 5
	custValue6	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 6
	custValue7	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 7
	custValue8	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 8
	custValue9	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 9
	custValue10	string	no, can be blank	AlphaNumeric 0-32 char	Extra Custom value 10
	custValueText1	string	no, can be blank	AlphaNumeric 0-200 char	Extra Text value 1
	customerSystemType	int	no	1 or 2	1 - Customers 2 - GiftCards
picturePath			yes
	value	String	no		Customer picture path
UseOverrideCreditLimit			no
	value	int	no	0 or 1	Yes = 1 No = 0
OverrideCreditLimitAmount			no
	value	double	no		Override Credit Limit Amount

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="CRM.createNewCustomerInfo"
          apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx"/>;

    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
		
    <data>
         <customer id = "2000001" />
    </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
customer			no	Info of customer just created
	id		no	Customer id

CRM.updateCustomerInfo

This message is used to update existing customer(s) with given information. Possible to create multiple customer in one message.

Password cannot be changed from this api call for security reasons

Request Message

<?xml version="1.0" encoding="UTF-8"?>
<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" apiName="CRM.updateCustomerInfo" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx">
  <parameters>
      <session id="TESTWS1523553333528"/>
      <user value="TESTWS"/> <password value="TESTWS"/>
      <customer
          customerId='54000001'
          customerCode='123'
          customerCardCode='123'
          alias='Shadab'
          firstName='King'
          middleName='Royalty'
          lastName='Patel'
          sex='m'
          customerStatus='0'
          address1='1 v roard'
          address2=''
          city='Toronto'
          prov='ON'
          zipCode='M1G1C2'
          country='Canada'
          dateOfBirth='2006-01-01 00:00:00'
          homePhone='123-123-1234'
          businessPhone='123-123-1234'
          cellPhone='123-123-1234'
          fax='123-123-1234'
          email='sp@gmail.com'
          creditCardInformation=''
          notes='na'
          startDate='2006-01-01 00:00:00'
          expiryDate='2026-01-01 00:00:00'
          customerLevel='0'
          customerGroups='|-1|'
          customerTypeId='-10001'
          parentCustomerId='0'
          custValue1='1'
          custValue2='1'
          custValue3='1'
          custValue4='1'
          custValue5='1'
          custValue6='1'
          custValue7='1'
          custValue8='1'
          custValue9='1'
          custValue10='1'
          custValueText1='1'
          accountId1='54000001'
          pointsAccountId='54000001'
          useOverrideCreditLimit="0"
          overrideCreditLimitAmount="0">
      </customer>
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
customer			no
	customerId	integer	no	Customer Id
	customerCode	string	yes	Customer Code
	customerCardCode	string	yes	Customer Card Code
	alias	string	yes	Alias
	firstName	string	yes	First Name of Customer. Can include apostrophe character as long as double quotes are used in request eg "O'Brien"
	middleName	string	yes	Middle Name of Customer. Can include apostrophe character as long as double quotes are used in request eg "O'Brien"
	lastName	string	yes	Last Name of Customer. Can include apostrophe character as long as double quotes are used in request eg "O'Brien"
	sex	string	yes	Sex of Customer
	customerStatus	int	yes	Suspended Customer = 1 Suspended Account = 2 Suspended Points Account = 4 ie. If a customer is suspended then the Customer Status = 1 If a customer is suspended with a suspended Account then the Customer Status = 1 + 2 = 3
	address1	string	yes	Address
	address2	string	yes	Address
	city	string	yes	City
	prov	string	yes	Province
	zipCode	string	yes	Zip Code
	country	string	yes	Country
	dateOfBirth	Timestamp	yes	Date of Birth
	homePhone	string	yes	Home Phone Number
	businessPhone	string	yes	Business Phone Number
	cellPhone	string	yes	Cell Phone Number
	fax	string	yes	Fax Number
	email	string	yes	Email Address
	creditCardInformation	string	yes	Credit Card Information
	notes	string	yes	Extra Information
	startDate	Timestamp	yes	Start Date for Customer
	expiryDate	Timestamp	yes	Expiry Date for Customer
	customerLevel	integer	yes	Customer level
	customerGroups	integer	yes	Customer Group Id (Defined in Customer Database)
	customerTypeId	integer	yes	Customer Type Id (Defined in Customer Database)
	parentCustomerId	integer	yes	Default to 0
	custValue1	string	yes	Extra Custom value 1
	custValue2	string	yes	Extra Custom value 2
	custValue3	string	yes	Extra Custom value 3
	custValue4	string	yes	Extra Custom value 4
	custValue5	string	yes	Extra Custom value 5
	custValue6	string	yes	Extra Custom value 6
	custValue7	string	yes	Extra Custom value 7
	custValue8	string	yes	Extra Custom value 8
	custValue9	string	yes	Extra Custom value 9
	custValue10	string	yes	Extra Custom value 10
	custValueText1	string	yes	Extra Text value 1
	accountId1	integer	yes	AccountReceivableId, either accountId1 or accountReceivableId has to be used
	accountId2	integer	yes	AccountReceivableId2
	accountId3	integer	yes	AccountReceivableId3
	accountId4	integer	yes	AccountReceivableId4
	pointsAccountId	integer	yes	pointsAccountId, either this attribute or Element pointsAccountId has to be used
	useOverrideCreditLimit	int	yes	Either this attribute or Element useOverrideCreditLimit has to be used Yes = 1 No = 0
	overrideCreditLimitAmount	double	yes	Override Credit Limit Amount, either this attribute or Element overrideCreditLimitAmount has to be used
picturePath			yes
	value	String	no	Customer picture path
accountReceivableId			yes
	value	integer	no	accountReceivableId
pointsAccountId			yes
	value	integer	no	pointsAccountId
useOverrideCreditLimit			yes
	value	int	no	Yes = 1 No = 0
overrideCreditLimitAmount			yes
	value	double	no	Override Credit Limit Amount

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="updateCustomerInfo"
          apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx"/>;

    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;	
    <data />
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

CRM.getCustomerInfo

This message is used to query one customer by customer code or customer id.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getCustomerInfo" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		[<customerCode value="2000010"/>]
		[<customerId value="2000001"/>]
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
customerCode			yes	Customer code to inquery
	value	integer	no	CustomerCode to inquery
	includingAccountDetails	string	yes	"yes"/"no", it's mainly used for new AMS which has all accounts details (ARs, Points, Meal Plans)
customerId			yes	Customer id to inquery
	value	integer	no	CustomerCode to inquery
	includingAccountDetails	string	yes	"yes"/"no", it's mainly used for new AMS which has all accounts details (ARs, Points, Meal Plans)

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getCustomerInfo" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<customer
			customerId='2000001'
			pointsAccountId="21000002"
			customerCode='0'
			customerCardCode='0'
			alias='water'
			password='0'
			firstName='water'
			middleName=''
			lastName='guo'
			sex='m'
			customerStatus='0'
			address1=''
			address2=''
			city=''
			prov=''customerLevel
			zipCode=''
			country=''
			dateOfBirth='2006-01-01 00:00:00'
			homePhone=''
			businessPhone=''
			cellPhone=''
			fax=''
			email=''
			creditCardInformation=''
			notes=''
			dateCreated='2006-01-01 00:00:00'
			startDate='2006-01-01 00:00:00'
			expiryDate='2006-01-01 00:00:00'
			lastModified='2006-01-01 00:00:00'
			customerLevel='0'
			customerGroups=''
			customerTypeId='-1'
			customerTypeId2='null'
			customerTypeId3='null'
			customerTypeId4='null'
			parentCustomerId='0'
			custValue1=''
			custValue2=''
			custValue3=''
			custValue4=''
			custValue5=''
			custValue6=''
			custValue7=''
			custValue8=''
			custValue9=''
			custValue10=''
			custValueText1=''
			customerSystemType='1'
			accountId1='21000003'
			accountId2='null'
			accountId3='null'
			accountId4='null'
			isDeleted='0'>
			<loadAllowed value="no" />
			<paymentMethodDetails saveCard="no" creditCardType="" creditCardExpiry="" creditCardLast4="" />
			<autoloadDetails subscriptionStatus="yes" thresholdAmount="10.0" loadAmount="55.0" />
			<notificationDetails lowBalanceNotification="yes" loadAccountNotification="yes" />
		</customer>
	</data>
</response>;

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
customer			no	This element encapsulates customer information
	customerId	integer	no	Customer Id
	pointsAccountId	integer	no	Customer Points Account id
	customerCode	string	no	Customer Code
	customerCardCode	string	no	Customer Card Code
	alias	string	no, can be blank	Alias
	password	string	no, can be blank	Password
	firstName	string	no, can be blank	First Name of Customer
	middleName	string	no, can be blank	Middle Name of Customer
	lastName	string	no, can be blank	Last Name of Customer
	sex	string	no, can be blank	Sex of Customer
	customerStatus	int	no, can be blank	Suspended Customer = 1 Suspended Account = 2 Suspended Points Account = 4 ie. If a customer is suspended then the Customer Status = 1 If a customer is suspended with a suspended Account then the Customer Status = 1 + 2 = 3
	address1	string	no, can be blank	Address
	address2	string	no, can be blank	Address
	city	string	no, can be blank	City
	prov	string	no, can be blank	Province
	zipCode	string	no, can be blank	Zip Code
	country	string	no, can be blank	Country
	dateOfBirth	Timestamp	no, can be blank	Date of Birth
	homePhone	string	no, can be blank	Home Phone Number
	businessPhone	string	no, can be blank	Business Phone Number
	cellPhone	string	no, can be blank	Cell Phone Number
	fax	string	no, can be blank	Fax Number
	email	string	no, can be blank	Email Address
	creditCardInformation	string	no, can be blank	Credit Card Information
	notes	string	no, can be blank	Extra Information
	dateCreated	Timestamp	no	Entry Date
	startDate	Timestamp	no	Start Date for Customer
	expiryDate	Timestamp	no	Expiry Date for Customer
	lastModified	Timestamp	no	Last Modified Time
	customerLevel	integer	no, default to 0	Customer level
	customerGroups	integer	no	Customer Group Id (Defined in Customer Database)
	customerTypeId	integer	no	Customer Type Id (Defined in Customer Database) for account 1 (primary account)
	customerTypeId2	integer	no	Customer Type Id (Defined in Customer Database) for account 2
	customerTypeId3	integer	no	Customer Type Id (Defined in Customer Database) for account 3
	customerTypeId4	integer	no	Customer Type Id (Defined in Customer Database) for account 4
	parentCustomerId	integer	no	Default to 0
	custValue1	string	no, can be blank	Extra Custom value 1
	custValue2	string	no, can be blank	Extra Custom value 2
	custValue3	string	no, can be blank	Extra Custom value 3
	custValue4	string	no, can be blank	Extra Custom value 4
	custValue5	string	no, can be blank	Extra Custom value 5
	custValue6	string	no, can be blank	Extra Custom value 6
	custValue7	string	no, can be blank	Extra Custom value 7
	custValue8	string	no, can be blank	Extra Custom value 8
	custValue9	string	no, can be blank	Extra Custom value 9
	custValue10	string	no, can be blank	Extra Custom value 10
	custValueText1	string	no, can be blank	Extra Text value 1
	customerSystemType	int	no	1 - Customers 2 - GiftCards
	accountId1	integer	no	Customer Account 1 id (primary account)
	accountId2	integer	no	Customer Account 2 id
	accountId3	integer	no	Customer Account 3 id
	accountId4	integer	no	Customer Account 4 id
	isDeleted	int	no	Deleted = 1 No = 0
loadAllowed			no	This element encapsulates if primary customer type allow AMS auto load or not
	value	String	no	'yes' - customer primary type allow AMS load (both manual and auto) 'no' - customer primary type doesn't allow any AMS load
paymentMethodDetails			no	Payment method wrapper - saveCard = 'no' if no saved payment method
	saveCard	String	no	'yes' for card found 'no' for card deleted or missing
	creditCardType	String	no	VISA, MASTERCARD, AMERICAN EXPRESS, DISCOVER if found "" otherwise
	creitCardExpiry	Integer	no	Credit card expiry date in MMYY if exist "" otherwise
	creditCardLast4	Integer	no	Last 4 digits of the credit card '1234' "" otherwise
autoloadDetails			no	Customer auto load details wrapper - subscriptionStatus = 'no' if no saved auto load details
	subscriptionStatus	String	no	'yes' for account is subscribed for auto load 'no' for account is not subscribed for auto load or not found
	thresholdAmount	Float	no	Threshold amount to trigger auto load/low balance email notification if found "" otherwise
	loadAmount	Float	no	Load amount for auto load "" otherwise
notificationDetails			no	Customer email notification wrapper - default value is 'no' if no email notification saved
	lowBalanceNotification	String	no	'yes' for enabling customer to receive an email notification when account balance below threshold amount 'no' for disabling email notification for low balance by default
	loadAccountNotification	String	no	'yes' for enabling customer to receive an email notification when account is successfully loaded with money (manual or auto) 'no' for disabling email notification for account load by default

CRM.getCustomerSubsetInfo

This message is used to retrieve a list of customer by given condition. Note that all conditions are in the relation of logical "or".

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getCustomerSubsetInfo" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		[<email value="abc@gmail.com"/>]
		[<businessPhone value="1234567890"/>]
		[<homePhone value="1234567890"/>]
		[<cellPhone value="1234567890"/>]
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
email			yes
	value	String	no	Email to search
businessPhone			yes
	value	integer	no	businessPhone to search
homePhone			yes
	value	integer	no	homePhone to search
cellPhone			yes
	value	integer	no	cellPhone to search

Response Message

<error code="0"
          localizedDescription="description in localized language" 
          defaultDescription="description in English" />;

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
customer			no
	customerId	integer	no	Customer Id
	customerCode	string	no	Customer Code
	customerCardCode	string	no	Customer Card Code
	firstName	string	no, can be blank	First Name of Customer
	lastName	string	no, can be blank	Last Name of Customer
	customerStatus	int	no, can be blank	Suspended Customer = 1 Suspended Account = 2 Suspended Points Account = 4 ie. If a customer is suspended then the Customer Status = 1 If a customer is suspended with a suspended Account then the Customer Status = 1 + 2 = 3
	homePhone	string	no, can be blank	Home Phone Number
	expiryDate	Timestamp	no	Expiry Date for Customer
	parentCustomerId	integer	no	Default to 0
	customerSystemType	int	no	1 - Customers 2 - GiftCards
	accountReceivableId	int	no
	pointsAccountId	int	no
	isDeleted	int	no	1 - Deleted 0 - Not Deleted

CRM.getCustomerIdList

This message is used to retrieve a list of customer by given condition. Note that all conditions are in the relation of logical "or".

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getCustomerIdList" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters

Response Message

<response apiVersion="1.20" apiName="CRM.getCustomerIdList" apiCategory="crm" requestTimestamp="xxx" sessionId="ADMIN7771620067631603">
	<error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
	<data>
		<customers>
			<id>96204926</id>
            <id>96204927</id>
            <id>96204928</id>
            <id>96204929</id>
            <id>96204930</id>
            <id>96204931</id>
            <id>96204932</id>
		</customers>
	</data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
customers			no	List of customers
id			yes	Customer ID information enclosed in the element

CRM.getAccountBalance

This message is used to retrieve the account balance by account receive id.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getAccountBalance" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<accountReceivableId value="2000010"/>
	</parameters>
</request>


tested:
<request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" apiVersion="1.0" clientId="POS" apiName="CRM.getAccountBalance" apiCategory="crm" requestTimestamp="2020-08-31 17:33:07Z" apiKey="NOT_USED" locale="en-US"><termIP value="127.0.0.1" />
    <parameters><session id="MOBILEAPP1598895183873" />
    <accountReceivableId value="132107145" />
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	wraps all parameters
accountReceivableId			no
	value	integer	no	accountReceivableId

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getAccountBalance" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<balance value="0.0"/>
	</data>
</response>;

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
balance			no
	value	double	no	Account balance

CRM.getPointsBalance

This message is used to get the point balance by pointsAccountId.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getPointsBalance" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<pointsAccountId value="2000010"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
pointsAccountId			no
	value	integer	no	pointsAccountId

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getPointsBalance" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<balance value="0.0"/>
	</data>
</response>;

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
balance			no
	value	double	no	Account balance

CRM.getPointsTransaction

This message is used to get a list of transactions within a given time period.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getPointsTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<pointsAccountId value="2000010"/>
		<startDttm value="2006-05-05 11:51:47.99"/>
		<endDttm value="2007-05-05 11:51:47.99"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
pointsAccountId			no
	value	integer	no	pointsAccountId
startDttm			no
	value	Timestamp	no	Start time to query
endDttm			no
	value	Timestamp	no	End time to query

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getPointsTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<PointsTransaction
			customerId="1001"
			numPoints="140"
			transStatus="1"
			transType="20"
			transDttm="2007-04-10 03:33:00"
			transId="100044"
			terminalId="10"
			empId="777"
			notes="Collect 20 points"/> 
	</data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
PointsTransaction			no
	customerId	integer	no	Customer Id
	numPoints	integer	no	Number of points
	transStatus	integer	no	Success = 1 Failed = 2
	transType	integer	no	Collect Points = 10 Void Points Collection = 11 Redeem Points = 20 Void Points Redemption = 21 Credit Points Redemption = 30 Void Credit Points Redemption = 31 Manual Entry = 40
	transDttm	Timestamp	no	Transaction Time
	transId	integer	no	transaction id. -1 for BO transaction
	terminalId	integer	no	terminal id. -1 for BO transaction
	empId	integer	no	Employee Id. -1 for BO transaction

CRM.addPointsTransaction

This message is used to add a point transaction (modify points for customer).

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.addPointsTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<customerId value = "20001"/>
		<pointsAccountId value = "12345"/>
		<numPoints value = "50"/>
		<transType value = "20"/>
		<notes value = "Collecting 50 points for Points Account 12345"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
customerId			no
	value	integer	no	Customer id
pointsAccountId			no
	value	integer	no	Points Account ID
numPoints			no
	value	integer	no	Number of Points to add
transType			no
	value	integer	no	Transaction Type Collect Points = 10 Void Points Collection = 11 Redeem Points = 20 Void Points redemption = 21 Credit Poitns Redemption = 30 Void Credit Points Redemption = 31 Manual Entry = 40
notes			yes
	value	String	yes	Notes

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.addPointsTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data/>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

CRM.addAccountTransactionToDB

This message is used to add an account transaction for a customer.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.addAccountTransactionToDB" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<customerId value = "20001"/>
		<accountId value="2000010"/>
		<amount value="100"/>
		<authType value="0"/>
		<notes value = "Collecting 50 points for Points Account 12345"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
customerId			no
	value	integer	no	Customer id
accountId			no
	value	integer	no	Account ID
amount			no
	value	double	no	Transaction amount
authType			no
	value	integer	no	Authorize type Sale = 1 Credit = 2 Void = 4
notes			yes
	value	String	yes	Notes

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.addAccountTransactionToDB" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data/>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

CRM.authorizePayment

This message is used to authorize a payment.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.authorizePayment" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<scanStr value="-22000002"/>
		<amount value="10.00"/>
		<chargedTip value="0"/>
		<plu value="500000030"/>
		<transNotes value="note"/>
		<allowCustType value="|22000003|"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
scanStr			no
	value	String	no	Customer id or Customer Code
amount			no
	value	double	no	Transaction amount
chargedTip			no
	value	double	no	Charged tips amount
plu			no
	value	String	no	Product PLU number
transNotes			yes
	value	String	yes	Transaction Notes
allowCustTypes			yes
	value	BitSetString	yes	customerTypeId1

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.authorizePayment" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<transId value="10023"/>
		<authCode value="10023"/>
		<statusCode value="343"/>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
transId			no
	value	integer	no	Transaction id
authCode			no
	value	String	no	Authorization code
statusCode			no
	value	Integer	no	Status of authorization -1: Insufficient Fund -2: membership not exist -3: membership expired -4: can not find available account type -5: scanStr format is invalid. -9: system error (Including Database Exception -999: session id is invalid >0: success

CRM.voidTransaction

This message is used to void an account transaction.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.voidTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<transId value="3000576"/>
		<authCode value="3000729"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
transId			no
	value	integer	no	The transactionId get from the customer receipt (which was get from a successful authorizedPayment transaction)
authCode			no
	value	String	no	The payment authorization code (from the customer receipt).

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.voidTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<statusCode value="1"/>
		<reason value=""/>
		<amount value=""/>
		<date value=""/>
		<time value=""/>
		<membershipId value=""/>
		<accountReceivableId value=""/>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	Rhis element encapsulates a custom data structure as the result of the call.
statusCode			no
	value	integer	no	1 - successful -1 - failed
reason			no
	value	String	no	Detail transaction information. ie "Transaction xxx voided"
amount			no
	value	double	no	Voided amount if success
date			no
	value	String	no	Voided date
time			no
	value	String	no	Voided time
membershipId			no
	value	integer	no	customer id
accountReceivableId			no
	value	integer	no	Account Receivable Id

CRM.getCurrentTransactions

This message is used to retrieve current transactions.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getCurrentTransactions" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getCurrentTransactions" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<numberOfBatched value="17"/>
		<batchId value="0"/>
		<transactions>
			<transId value="3000399"/>
				<date value="2010-07-20"/>
				<time value="12:45:35"/>
				<amount value="0.0"/>
				<authcodeOrReason value=""/>
				<customerReferenceNotes value=""/>
			</transId>
			<transId value="3000311"/>
				<date value="2010-07-21"/>
				<time value="10:32:32"/>
				<amount value="0.0"/>
				<authcodeOrReason value=""/>
				<customerReferenceNotes value=""/>
			</transId>
		</transactions>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
numberOfBatched			no
	value	integer	no	The number of current transactions
batchId			no
	value	integer	no	batch id
transactions			no	Transasction list
transId			no	Transasction list
	value	integer	no	trans id
date			no
	value	String	no	Date
time			no
	value	String	no	Time
amount			no
	value	double	no	Transaction amount
authcodeOrReason			no
	value	String	no
customerReferenceNotes			no
	value	String	no

CRM.closeBatch

This message is used to close a batch of transactions.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.closeBatch" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<closeBeforeDttm value="2006-05-05 11:51:47.99"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
closeBeforeDttm			yes
	value	Timestampt	yes	Close transaction before this specified time. Default to now.

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.closeBatch" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<numberOfBatched value="17"/>
		<batchId value="0"/>
		<transactions>
			<transId value="3000399"/>
				<date value="2010-07-20"/>
				<time value="12:45:35"/>
				<amount value="0.0"/>
				<authcodeOrReason value=""/>
				<customerReferenceNotes value=""/>
			</transId>
			<transId value="3000311"/>
				<date value="2010-07-21"/>
				<time value="10:32:32"/>
				<amount value="0.0"/>
				<authcodeOrReason value=""/>
				<customerReferenceNotes value=""/>
			</transId>
		</transactions>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
numberOfBatched			no
	value	integer	no	The number of current transactions
batchId			no
	value	integer	no	batch id
transactions			no	Transasction list
transId			no	Transasction list
	value	integer	no	trans id
date			no
	value	String	no	Date
time			no
	value	String	no	Time
amount			no
	value	double	no	Transaction amount
authcodeOrReason			no
	value	String	no
customerReferenceNotes			no
	value	String	no

CRM.batchReport

This message is used to retrieve report.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.batchReport" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<from value="2010-08-01 00:00:00"/>
		<to  value="2010-08-30 23:59:00"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
from			no
	value	Timestamp	no	Begin Time
to			no
	value	Timestamp	no	End time

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.batchReport" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<numberOfBatches value="17"/>
		<batches>
			<batchId value="2">
			<empId value="22000017"/>
			<date value="2010-08-16"/>
			<time value="16:16:57"/>
			<batchAmount value="0.0"/>
			<numberofTransactions value="2"/>
		</batchId>
			<batchId value="3">
			<empId value="22000017"/>
			<date value="2010-08-16"/>
			<time value="16:19:30"/>
			<batchAmount value="0.0"/>
			<numberofTransactions value="2"/>
		</batchId>
		</batches>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
numberOfBatches			no
	value	integer	no	The number of numberOfBatches
batches			no	Batch list
batchId			no	Transasction list
	value	integer	no	Batch id
empId			no
	value	integer	no	Employee id
date			no
	value	String	no	Date
time			no
	value	String	no	Time
batchAmount			no
	value	double	no	Batch amount
numberofTransactions			no
	value	integer	no	Transaction number in the batch

CRM.transactionReport

This message is used to retrieve a report of transactions in batch.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.transactionReport" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<creditTransOnly value="0"/>
		<batchId value="2"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
creditTransOnly			no
	value	integer	no	1 - credit transaction only 0 - all transactions
batchId			no
	value	integer	no	batch id

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.transactionReport" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<numberOfTransaction  value="17"/>
		<batchId value="0"/>
		<transactions>
			<transId value="3000399"/>
				<date value="2010-07-20"/>
				<time value="12:45:35"/>
				<amount value="0.0"/>
				<authcodeOrReason value=""/>
				<customerReferenceNotes value=""/>
			</transId>
			<transId value="3000311"/>
				<date value="2010-07-21"/>
				<time value="10:32:32"/>
				<amount value="0.0"/>
				<authcodeOrReason value=""/>
				<customerReferenceNotes value=""/>
			</transId>
		</transactions>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
numberOfTransaction			no
	value	integer	no	The number of current transactions
batchId			no
	value	integer	no	batch id
transactions			no	Transasction list
transId			no	Transasction list
	value	integer	no	trans id
date			no
	value	String	no	Date
time			no
	value	String	no	Time
amount			no
	value	double	no	Transaction amount
authcodeOrReason			no
	value	String	no
customerReferenceNotes			no
	value	String	no

CRM.refundTransaction

This message is used to refund some transaction with specified transaction id.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.refundTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<transId value="3000576"/>
		<authCode value="3000729"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
transId			no
	value	integer	no	Transaction Id
authCode			no
	value	String	no	The payment authorization code (from the customer receipt)

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.refundTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<statusCode value="1"/>
		<reason value="Transaction 3000597 Refund Approved"/>
		<amount value="-10.0"/>
		<date value="2010-08-17 02:15:43"/>
		<time value="null"/>
		<membershipId value="22000005"/>
		<accountReceivableId value="22000005"/>
		<refundTransId value="3000600"/>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
StatusCode			no
	value	integer	no	1 - successful -1 - failed
reason			no
	value	String	no	Detail transaction information. ie "Transaction xxx refunded"
amount			no	Transasction list
	value	double	no	Refunded amount if success
date			no
	value	String	no	Date
time			no
	value	String	no	Time
membershipId			no
	value	double	no	Customer Id
authcodeOrReason			no
	value	String	no	Account Receivable Id

CRM.searchTransactionByNotes

This message is used to retrieve a list of transactions by the keyword of transaction notes.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.searchTransactionByNotes" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
		<user value="xxx"/> <password value="xxx"/>
		<transNoteKeyword value="udon"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
transNoteKeyword			no
	value	String	no	Transaction note keyword to search

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.searchTransactionByNotes" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<numberOfTransaction  value="17"/>
		<transNoteKeyword value="udon"/>
		<transactions>
			<transId value="3000399"/>
				<date value="2010-07-20"/>
				<time value="12:45:35"/>
				<amount value="0.0"/>
				<authcodeOrReason value=""/>
				<customerReferenceNotes value=""/>
			</transId>
			<transId value="3000311"/>
				<date value="2010-07-21"/>
				<time value="10:32:32"/>
				<amount value="0.0"/>
				<authcodeOrReason value=""/>
				<customerReferenceNotes value=""/>
			</transId>
		</transactions>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
numberOfTransaction			no
	value	integer	no	The number of current transactions
transNoteKeyword			no
	value	String	no	Search keyword
transactions			no	Transasction list
transId			no	Transasction list
	value	integer	no	trans id
date			no
	value	String	no	Date
time			no
	value	String	no	Time
amount			no
	value	double	no	Transaction amount
authcodeOrReason			no
	value	String	no
customerReferenceNotes			no
	value	String	no

CRM.creditAccount

This message is used to authorize a payment.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" apiName="CRM.creditAccount" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx">
    <parameters>
        <session id="..." />
        <scanStr value="20000012" />
        <amount value="5" />
        <chargedTip value="0" />
        <plu value="20000010" />
        <merchantNotes value="merchantNotes" />
        <allowCustType value="|20000006|" />
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
scanStr			no
	value	String	no	Customer Code, Customer Card Code (Global Options Setting)
amount			no
	value	double	no	Transaction amount
chargedTip			no
	value	double	no	Charged tips amount
plu			no
	value	String	no	Product PLU number
merchantNotes			no
	value	String	no	TransItemOptionInfo.customizeOptionName
allowCustType			no
	value	BitSetString	yes	Customer Type ID

Response Message

<response apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.creditAccount" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <error code="0"
           localizedDescription="description in localized language" 
           defaultDescription="description in English" />;
	<data>
		<transId value="10023"/>
		<authCode value="10023"/>
		<statusCode value="343"/>
		<accountReceivableId value="22000005"/>
		<transDate value="2010-08-17 02:12:20"/>
	</data >
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
transId			no
	value	integer	no	Transaction id
authCode			no
	value	String	no	Authorization code
statusCode			no
	value	Integer	no	Status of authorization -1: Insufficient Fund -2: membership not exist -3: membership expired -4: can not find available account type -5: scanStr format is invalid. -9: system error (Including Database Exception -999: session id is invalid >=0: success
transDate			no
	value	Timestamp	no	Transaction date
accountReceivableId			no
	value	integer	no	credit account id

CRM.getAccountTransactions

This message is used get the list of transactions completed for the particular customer, for a particular account, which are completed between the startDttm and endDttm.

Request Message

 <request apiCategory="crm" apiKey="" apiName="CRM.getAccountTransactions" apiVersion="1.00" clientId="0" requestTimestamp="2017-09-19 19:51:58.093">
 	<parameters>
		<accountId value="907000001"/>
		<customerId value="907000001"/>
		<endDttm value="2017-09-19 19:51:58.093"/>
		<startDttm value="2017-08-20 19:51:58.093"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
accountId			no
	value	integer	no	Account Id for the customer
customerId			no
	value	interger	no	Customer Id
endDttm			no
	value	Timestamp	no	This attribute determines the latest date for the transaction completion.
startDttm			no
	value	Timestamp	no	This attribute determines the earliest date for transaction completion

Response Message

<response apiVersion="1.20" apiName="CRM.getAccountTransactions" apiCategory="crm" requestTimestamp="2017-09-19 19:51:58.093" sessionId="unassigned1505843518549">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <accountTransactions>
      <accountTransaction customerId="907000001" accountId="907000001" amount="-8.00" transDttm="2017-09-19 19:51:11" transId="1000003" terminalName="Primary">
        <receipt>Receipt Header
Close Date: Sep 19, 2017 19:51:11
Date: Sep 19, 2017 19:51:58
Table: Cas-1000003
TableTransId: 1000003
TransId: 1000003
Server:  Admin

8  mars                               8.00

Subtotal                              8.00
Total                                 8.00
On Acnt:#907000001                   -8.00
 Viktor Meszaros - Default Type
Balance                               0.00
Account Charges: 
  Default Type                        8.00

     Receipt Footer
------------------------------------------</receipt>
      </accountTransaction>
      <accountTransaction customerId="907000001" accountId="907000001" amount="-1.00" transDttm="2017-09-19 19:50:39" transId="1000002" terminalName="Primary">
        <receipt>Receipt Header
Close Date: Sep 19, 2017 19:50:39
Date: Sep 19, 2017 19:51:58
Table: Cas-1000002
TableTransId: 1000002
TransId: 1000002
Server:  Admin

1  mars                               1.00

Subtotal                              1.00
Total                                 1.00
On Acnt:#907000001                   -1.00
 Viktor Meszaros - Default Type
Balance                               0.00
Account Charges: 
  Default Type                        1.00

     Receipt Footer
------------------------------------------</receipt>
      </accountTransaction>
      <accountTransaction customerId="907000001" accountId="907000001" amount="100.00" transDttm="2017-09-19 19:50:18" transId="1000001" terminalName="Primary">
        <receipt>Receipt Header
Close Date: Sep 19, 2017 19:50:18getCustomerInfo
Date: Sep 19, 2017 19:51:58
Table: Cas-1000001
TableTransId: 1000001
TransId: 1000001
Server:  Admin

1  AccountCredit                    100.00

Subtotal                            100.00
Total                               100.00
AcntCredit:#907000001               100.00
 Viktor Meszaros - Default Type
Cash                               -100.00
Balance                               0.00

     Receipt Footer
------------------------------------------</receipt>
      </accountTransaction>
    </accountTransactions>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
accountTransactions				This element contains the list of account transactions
accountTransaction				This element contains all the transaction information
	customerId	integer	no	Customer Id
	accountId	integer	no	Account id of the customer
	amount	String	no	Total amount credited to the account
	transDttm	Timestamp	no	Time of transaction
	transId	integer	no	Transaction Id
	terminalName	String	no	Terminal name where the transaction took place
receipt		String	no	Entire receipt of the transaction in string format

CRM.getCustomerSummary

This message is used to retrieve customer summary.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiName="CRM.getCustomerSummary" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
	<parameters>
		<session id="xxx"/>
        <customerId value="">
		<user value="xxx"/> <password value="xxx"/>
		<scanStr value="-22000002"/>
	</parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
customerId			yes
	value	String		This field will override the scanStr field if both are provided. It means if customerId is invalid and scanStr is valid, it will use the customerId and return user not found.
scanStr			yes
	value	String		Customer id or Customer Code

Response Message

<response apiVersion="1.20" apiName="CRM.getCustomerSummary" apiCategory="crm" requestTimestamp="xxx" sessionId="ROMEOJULIET1692892791013">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <statusCode value="0" />
    <statusDesc value="Customer Found" />
    <customerId value="71000006" />
    <customerCode value="007" />
    <customerCardCode value="077" />
    <alias value="" />
    <password value="test123" />
    <firstName value="James" />
    <middleName value="" />
    <lastName value="Bond" />
    <sex value="Gender-Neutral" />
    <address1 value="" />
    <address2 value="" />
    <city value="" />
    <prov value="" />
    <zipCode value="" />
    <country value="" />
    <dateOfBirth value="1900-01-01 17:45:14.1" />
    <homePhone value="" />
    <businessPhone value="" />
    <cellPhone value="" />
    <fax value="" />
    <email value="bond@mi6.com" />
    <creditCardInformation value="1" />
    <notes value="" />
    <dateCreated value="2021-01-03 22:21:39.62" />
    <startDate value="2021-01-03 00:00:00.0" />
    <lastModified value="2023-01-31 17:45:14.106" />
    <customerLevel value="1" />
    <custValue1 value="cust1" />
    <custValue2 value="cust2" />
    <custValue3 value="cust3" />
    <custValue4 value="cust4" />
    <custValue5 value="cust5" />
    <custValue6 value="cust6" />
    <custValue7 value="cust7" />
    <custValue8 value="cust8" />
    <custValue9 value="cust9" />
    <custValue10 value="cust10" />
    <customerStatus value="" />
    <customerType1Id value="71000004" />
    <customerType2Id value="71000001" />
    <customerType3Id value="-999999" />
    <customerType4Id value="-999999" />
    <customerType1Name value="Payroll FT" />
    <customerType2Name value="Charge Account" />
    <customerType3Name value="" />
    <customerType4Name value="" />
    <aggregateBal value="11388.22" />
    <customerType1Bal value="-36.01" />
    <customerType2Bal value="924.23" />
    <customerType3Bal value="-999999.0" />
    <customerType4Bal value="-999999.0" />
    <customerType1Status value="1" />
    <customerType2Status value="1" />
    <customerType3Status value="-999999" />
    <customerType4Status value="-999999" />
    <mealPlanName value="" />
    <mealPlanDesc value="" />
    <mealPlanBal value="-999999" />
  </data>
</response>

CRM.getCustomerType

CRM.createTableTransaction

This message is used to create a table transaction.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
apiName="CRM.createTableTransaction" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <parameters>
        <session id="xxx"/>
        <user value="xxx"/> <password value="xxx"/>
        <tableName value="xxx"/>
		<transactionTime value="2020-01-01 00:00:00"/>
		<customerId value="10000000"/>
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
tableName	value	String	no	Table name
transactionTime	value	String	yes	Start time of transaction
customerId	value	String	yes	Customer ID associated with the transaction

Response Message

<response apiVersion="1.20" apiName="CRM.createTableTransaction" apiCategory="crm" requestTimestamp="xxx" sessionId="777771593464936991">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <tableTransaction ID="36000233" isTableClosed="false" bills="Date: Jun 29, 2020 17:20:34 Table: xxx TableTransId: 36000233 Server: Admin Subtotal 0.00 Total 0.00 
		Balance 0.00 ********************Order#: xxx********************" serverId="132000001" startServerId="132000001" tableName="xxx" tableTransactionOwner="-132" 
		tableType="2" transactionType="1" startTime="2020-01-01 00:00:00.000" pickupTime="2020-06-29 17:20:34.374" closeTime="2022-01-01 23:59:59.999" saleType="254"
		hasPlaytOrder="false" isBillPrinted="false" paymentTotal="0.0" priceModTotal="0.0">
      <receipt>
        <line col1="Date: Jun 29, 2020 17:20:34" col2="" />
        <line col1="Table: xxx" col2="" />
        <line col1="TableTransId: 36000233" col2="" />
        <line col1="Server:  Admin" col2="" />
        <line col1="" col2="" />
        <line col1="" col2="" />
        <line col1="" col2="" />
        <line col1="" col2="" />
        <line col1="Subtotal 0.00" col2="" />
        <line col1="Total 0.00" col2="" />
        <line col1="Balance 0.00" col2="" />
        <line col1="" col2="" />
        <line col1="" col2="" />
        <line col1="********************" col2="" />
        <line col1="Order#: xxx" col2="" />
        <line col1="********************" col2="" />
      </receipt>
      <firstTransId value="36000233" />
    </tableTransaction>
  </data>
</response>

CRM.getAccountTransV2

This message is used to get customer account activities for the specified account(s) including AR, points, and meal plan.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
apiName="CRM.getAccountTransV2" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
 <parameters>
 <swipe value="777"/>
 <customer id="23000001"/>
 <transDate from="2020-10-11 13:11:09.948" />
 <accounts>
 <account id="23000001" type="account" />
 </accounts>
 </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
customer			no	Customer Info
	id	integer	no	Customer Id
page			yes	Page Info
	page	integer	yes	Page number, if negative, use 0 instead
	size	integer	yes	Page size, if negative, use 100 instead
transDate	from	Timestamp	yes	Start timestamp for transaction search, if missing, default to past 30 days
	to	Timestamp	yes	End timestamp for transaction search, if missing, default to now
accounts			no	Accounts Info, list of account(s)
account	id	integer	no	For AR account, use "accountReceivableId". For Points, use "pointsAccountId". For Meal Plan, use associated "customerTypeId"
	type	String	no	For AR, use keyword "account". For Points, use keyword "point". For Meal Plan, use keyword "meal_plan".

Response Message

<response apiVersion="1.20" apiName="CRM.getAccountTransV2" apiCategory="crm" requestTimestamp="xxx" sessionId="unassigned1607711406211">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <accountTransList>
      <page current="0" size="100" totalElements="24" totalPages="1" last="yes" />
      <content>
        <accountTrans id="457" amount="-1.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-12-04 01:09:23.757" transId="1000920" terminal="Primary" employee="Admin Admin" />
        <accountTrans id="456" amount="10.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-12-03 17:17:48.291" />
        <accountTrans id="451" amount="-1.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-11-04 23:29:34.632" transId="1000859" terminal="TermId: 132000060" employee="Unassigned " />
        <accountTrans id="450" amount="-1.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-11-04 23:25:19.275" transId="1000858" terminal="TermId: 132000060" employee="Unassigned " />
        <accountTrans id="449" amount="-1.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-11-04 23:20:21.782" transId="1000857" terminal="TermId: 132000060" employee="Unassigned " />
        <accountTrans id="448" amount="-2.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-11-04 15:34:56.175" transId="1000855" terminal="Primary" employee="Admin Admin" />
        <accountTrans id="447" amount="-5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 12:55:10.133" transId="1000812" terminal="Primary" employee="Admin 2" />
        <accountTrans id="445" amount="-5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 12:53:35.879" transId="1000811" terminal="Primary" employee="Admin 2" />
        <accountTrans id="446" amount="5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 12:53:35.879" transId="1000811" terminal="Primary" employee="Admin 2" />
        <accountTrans id="443" amount="-5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 00:36:32.747" transId="1000811" terminal="Primary" employee="Admin 2" />
        <accountTrans id="444" amount="5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 00:36:32.747" transId="1000811" terminal="Primary" employee="Admin 2" />
        <accountTrans id="441" amount="-5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 00:34:41.855" transId="1000811" terminal="Primary" employee="Admin 2" />
        <accountTrans id="442" amount="5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 00:34:41.855" transId="1000811" terminal="Primary" employee="Admin 2" />
        <accountTrans id="439" amount="-5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 00:19:02.265" transId="1000811" terminal="Primary" employee="Admin 2" />
        <accountTrans id="440" amount="2.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 00:19:02.265" transId="1000811" terminal="Primary" employee="Admin Admin" />
        <accountTrans id="438" amount="-2.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 00:15:03.091" transId="1000811" terminal="Primary" employee="Admin Admin" />
        <accountTrans id="437" amount="-2.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-19 00:14:06.868" transId="1000810" terminal="Primary" employee="Admin 2" />
        <accountTrans id="435" amount="-5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-16 19:41:20.602" transId="1000807" terminal="Primary" employee="Admin 2" />
        <accountTrans id="436" amount="5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-16 19:41:20.602" transId="1000807" terminal="Primary" employee="Admin 2" />
        <accountTrans id="433" amount="-5.0" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-16 19:27:21.566" transId="1000807" terminal="Primary" employee="Admin 2" />
        <accountTrans id="434" amount="2.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-16 19:27:21.566" transId="1000807" terminal="Primary" employee="Admin Admin" />
        <accountTrans id="432" amount="-2.5" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-16 19:26:24.401" transId="1000807" terminal="Primary" employee="Admin Admin" />
        <accountTrans id="431" amount="2.6" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-12 22:21:19.453" transId="1000802" terminal="Primary" employee="Unassigned " />
        <accountTrans id="430" amount="3.3" accountId="23000001" accountType="1" sharedTrans="no" transDate="2020-10-12 16:46:37.378" transId="1000790" terminal="Primary" employee="Unassigned " />
      </content>
    </accountTransList>
  </data>
</response>

CRM.getAccountTransReceipt

This message is used to retrieve the receipt info for specified transaction (using transId) with associated customer.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
apiName="CRM.getAccountTransReceipt" apiCategory="crm" locale="en-US" requestTimestamp="xxx" sessionId="xxx" >
    <parameters>
        <swipe value="777"/>
        <customerId value="23000001"/>
        <transaction value="1000920" />
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Wraps all parameters
transaction	value	Integer	no	Transaction Id
customerId	value	Integer	no	Customer Id

Response Message

<response apiVersion="1.20" apiName="CRM.getAccountTransReceipt" apiCategory="crm" requestTimestamp="xxx" sessionId="unassigned1607711449802">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <receipt>Receipt Header
Close Date: Dec 04, 2020 01:09:38
Date: Dec 11, 2020 13:30:51
Table: Cas-1000920
TableTransId: 1000920
TransId: 1000920
Server:  Admin

1  Bin                                3.00
    50% off                          -1.50

Subtotal                              1.50
Total                                 1.50
On Acnt:#23000001                    -1.50
 bin wen - Points Type
Balance                               0.00
Account Charges: 
  Points Type                         1.50

     Receipt Footer
------------------------------------------</receipt>
  </data>
</response>

CRM.processMealPlanPayment

Purpose

This request allows the API user to perform a meal plan payment from their active customer account on an existing transaction.

Conditions

Transactions need to be valid, and cannot be closed, in order for payments to be processed.

The meal plan account must be linked with the customer account that is associated with the current transaction.

Usage and Process

Prerequisite steps:

Create transaction with CRM.createTableTransaction api
Add items to transaction with CRM.addItemToTrans api
Link customer to transaction with CRM.setCustomerId api

To use this API:

Users will need to provide at least one of the following criteria: { customerId, customerCode, customerCardCode } (Should be same customerId that was linked to transaction previously)
In addition, a corresponding tableTransId and transId must be provided.

The API will first attempt to retrieve transaction information. Once transaction information is found api will attempt to find customer information using the provided input, and attempt to retrieve valid meal plan account information.

If a customer account is set up to share meal plan accounts with either a parent or child the api will deduct from the shared meal plan balance.

For a successful meal plan payment:

The response will return the meal plan payment information under <mealPlanPayment> tag including meal plan name, description and updated remaining balance (count).
The full transaction information will be returned
TableTransId and TransId fields will also be returned

Request Message

Example:

<request apiVersion="1.00" apiKey="NOT_USED" clientId="POS" apiName="CRM.processMealPlanPayment" apiCategory="crm" locale="en-US" requestTimestamp="xxx">
    <parameters>
        <session id="{{SessionID}}"/>
        <!-- ONE OF customerId/customerCode/customerCardCode Should be present in the authenticateCustomer API -->
        <customerId value="{{CustomerId}}"/>
        <!--<customerCode value="007"/>-->
        <!--<customerCardCode value="007"/>-->
        <tableTransId value="{{TableTransId}}"/>
        <transId value="{{TableTransId}}"/>
        <!-- OPTIONAL -->
        <!--<closeTable/>-->
        <!-- OPTIONAL -->
        <!--<paymentTerminalId value="1"/>-->
        <!-- OPTIONAL -->
		<!--<closeTermId value="1"/>-->
    </parameters>
</request>

request:

Element	Attribute	Data Type	Optional	Notes
request				Request root element
	apiVersion	Float	no	Current API Version "1.00"
	apiKey	String	no	For future usage "NOT_USED"
	clientId	String	no	Identifier for web service client
	apiName	String	no	Name of this API
	apiCategory	String	no	Category of this API
	locale	String	no	Supported locale is "en-US"
	requestTimestamp	Timestamp	no	Timestamp of request for logging purpose
parameters			no	Parameters element contains a list of parameter element
session	id	String	no	Current session ID
customerId	value	Integer	yes	Customer Identifier At least one of customerId/customerCode/customerCardCode required. If multiple fields are present, it will use only one field in the order: customerId, customerCode, customerCardCode
customerCode	value	String	yes	Customer Identifier
customerCardCode	value	String	yes	Customer Identifier
tableTransId	value	Integer	no	Table Transaction ID to make payment to
transId	value	Integer	no	Transaction ID to make payment to
paymentTerminalId	value	Integer	yes	Optional. If specified payment will be processed as specified terminal
closeTable			yes	Optional. If this element exists, transaction will be closed if possible. (If there is outstanding balance on the transaction, it cannot be closed)
closeTermId	value	Integer	yes	Optional. Specifies Terminal Id to close transaction from

Response Message

Example:

<response apiVersion="1.20" apiName="CRM.processMealPlanPayment" apiCategory="crm" requestTimestamp="xxx" sessionId="MOBILEAPP1620316324977">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <mealPlanPayment>
      <tableTransId value="1000429" />
      <mealPlanName value="Meal Plan 2" />
      <mealPlanDesc value="MP2" />
      <mealPlanCount value="999" />
      <transId value="1000429" />
      <closeTransStatus value="Table transaction successfully closed" />
      <tableTransaction closeTime="2021-05-06 11:55:34.918" headCount="1" ID="1000429" bills="Close Date: May 06, 2021 11:55:34&#xA;Date: May 06, 2021 11:55:35&#xA;Table: Test&#xA;TableTransId: 1000429&#xA;TransId: 1000429&#xA;Server:  MOBILEAPP&#xA;&#xA;1  Pound Cake                         4.25&#xA;    1  &#xA;    100% discount                    -4.25&#xA;&#xA;Subtotal                              0.00&#xA;Total                                 0.00&#xA;Meal Plan                            -0.00&#xA;Balance                               0.00&#xA;&#xA;Eligible Meals: 999&#xA;some notes&#xA;" serverId="25000005" startServerId="25000005" startTime="2021-05-06 11:52:09.699" tableName="Test" tableTransactionOwner="-25" tableType="6" transactionType="1">
        <seats>
          <tableSeat ID="1000429" seatNumber="1" seatState="3">
            <displayTransaction customerId="25000003" grantTotal="0.0" gratuityAmount="0.0" groupLeaderTransId="1000429" ID="1000429" numberOfBillPrinted="0" paymentBalance="0.0" printBillStringTransOnly="Close Date: May 06, 2021 11:55:34&#xA;Date: May 06, 2021 11:55:35&#xA;Table: Test&#xA;TableTransId: 1000429&#xA;TransId: 1000429&#xA;Server:  MOBILEAPP&#xA;&#xA;1  Pound Cake                         4.25&#xA;    100% discount                    -4.25&#xA;&#xA;Subtotal                              0.00&#xA;Total                                 0.00&#xA;Meal Plan                            -0.00&#xA;Balance                               0.00&#xA;&#xA;Eligible Meals: 999&#xA;some notes&#xA;" subtotal="0.0" taxTotal="0.0">
              <tenderedList>
                <payments />
              </tenderedList>
              <items>
                <transactionItem enteredServerId="25000005" enteredTime="2021-05-06 11:52:20.55" ID="1000709" itemTotalWithNoMods="4.25" menuComboTagGrp="" menuItemId="25000030" menuItemName="Pound Cake" optionsTotal="0.0" priceModsTotal="-4.25" printPriority="1" quantity="1 " timeChargedMinutes="-2" totalItemPrice="4.25" transactionItemType="1">
                  <options>
                    <option note=" " id="1000710" menuItemId="0" menuItemName="Error" quantity="1 " totalItemPrice="0.0" />
                  </options>
                  <priceModifiers>
                    <priceModifier absolute="0.0" employee="25000005" fixedPrice="0.0" ID="1000351" maxDiscountAmount="-1.0" overrideEmployee="25000005" percentage="-1.0" price="-4.25" applyType="6" priceModifierId="25000022" name="100% discount" />
                  </priceModifiers>
                </transactionItem>
                <transactionItem enteredServerId="25000005" enteredTime="2021-05-06 11:52:20.55" ID="1000066" itemTotalWithNoMods="0.0" menuComboTagGrp="1000066" menuItemId="20000008" menuItemName="Combo#01" optionsTotal="0.0" priceModsTotal="0.0" printPriority="1" quantity="1 " timeChargedMinutes="-2" totalItemPrice="0.0" transactionItemType="1">
                  <options />
                  <priceModifiers />
                </transactionItem>
                <transactionItem enteredServerId="25000005" enteredTime="2022-06-22 14:49:34.679" ID="1000064" itemTotalWithNoMods="4.0" menuComboTagGrp="1000066" menuItemId="20000001" menuItemName="Rice" optionsTotal="0.0" priceModsTotal="0.0" printPriority="1" quantity="1 " timeChargedMinutes="-2" totalItemPrice="4.0" transactionItemType="1">
                  <options />
                  <priceModifiers />
                </transactionItem>
                <transactionItem enteredServerId="25000005" enteredTime="2021-05-06 11:52:20.55" ID="1000065" itemTotalWithNoMods="1.0" menuComboTagGrp="1000066" menuItemId="20000007" menuItemName="Chips" optionsTotal="0.0" priceModsTotal="0.0" printPriority="1" quantity="1 " timeChargedMinutes="-2" totalItemPrice="1.0" transactionItemType="1">
                  <options />
                  <priceModifiers />
                </transactionItem>
              </items>
              <taxes />
            </displayTransaction>
          </tableSeat>
        </seats>
      </tableTransaction>
    </mealPlanPayment>
  </data>
</response>

response:

Element	Attribute	Data Type	Optional	Notes
response			no	Root element
responseHeader			no	ResponseHeader child element
	apiVersion	Float	no	Indicates the API compability level
	clientId	String	yes	The identifier of the caller
	apiName	String	no	The API name, aka the Web Service function to invoke.
	apiCategory	String	no	The API category, used to segregate API calls based on functionalities.
	requestTimestamp	Timestamp	no	A stamp of when this request was made
	responseTimestamp	Timestamp	no	A stamp of when this response is generated
error			no	Error element contains error code and error descriptions
	code	Integer	no	Returned Error code
	localizedDescription	String	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	String		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
tableTransId	value	Integer	no
transId	value	Integer	no
mealPlanName	value	String	no	Returns the meal plan name for the meal plan account used (if found)
mealPlanDesc				Returns the meal plan description for the meal plan account used (if found)
mealPlanCount				Returns the updated meal plan count (balance) of the meal plan account used (if found)
closeTransStatus	value	String	yes	If "closeTable" option present, returns status of close
tableTransaction				See below for details

Related Articles

Filter by label

There are no items with the selected labels at this time.

See Also:

Troubleshooting Articles

Browser not supported