https://wiki.cliquesoft.org/index.php?title=webBooks-Business_Configuration-APIs&feed=atom&action=historywebBooks-Business Configuration-APIs - Revision history2024-03-29T13:43:20ZRevision history for this page on the wikiMediaWiki 1.24.4https://wiki.cliquesoft.org/index.php?title=webBooks-Business_Configuration-APIs&diff=5545&oldid=prevDigitalpipe: Created page with "==Business Configuration== In order to process any of these API's, all requests should be directed to the 'modules/webbooks/business_configuration.php' file. The type of request..."2015-03-26T19:58:39Z<p>Created page with "==Business Configuration== In order to process any of these API's, all requests should be directed to the 'modules/webbooks/business_configuration.php' file. The type of request..."</p>
<p><b>New page</b></p><div>==Business Configuration==<br />
In order to process any of these API's, all requests should be directed to the 'modules/webbooks/business_configuration.php' file. The type of request will be specified per section below.<br />
<br />
<br />
===Load the interface===<br />
To load the modules default HTML interface (themes/default/webbooks.business_configuration.html), the below parameters should be passed to the appropriate php file via a GET request. Loading an alternative screen relies on the symlinks set in the users data directory (e.g. data/_guest/_theme/{images|layout|styles}).<br />
<pre><br />
action=init<br />
target=screen<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
</pre><br />
<br />
This will return the raw contents as it is found in the file, replacing all occurrences of the variable ${UN} anywhere.<br />
<br />
<br />
===Populate the form===<br />
To populate all the various values of the interface form objects, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=init<br />
target=values<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<general><br />
<business name="STRING" type="STRING" fein="INTEGER" salesTax="INTEGER" salesTaxRate="DECIMAL" unemploymentTax="INTEGER" unemploymentTaxRate="DECIMAL" founded="DATE" foundedCountry="STRING\" fiscalYear="DATE" timezone="INTEGER" beginTime="INTEGER" endTime="INTEGER" phone="INTEGER" fax="INTEGER" website="STRING" merchant="STRING" merchantID="STRING" OPoID="STRING" bbn="{0|1}" payDay="DATE" payTerm="{weekly|biweekly|bimonthly|monthly}" commissionDay="DATE" commissionTerm="{weekly|biweekly|bimonthly|monthly}" /><br />
<address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" /><br />
<address type="bill" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" /><br />
<address type="ship" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" /><br />
</general><br />
<employees><br />
<employee id=\"".$empl['id']."\" name=\"".$empl['name']."\" /><br />
<br />
...repeated for each employee of the organization...<br />
</employees><br />
<departments><br />
<dept id="INTEGER" name="STRING" /><br />
<br />
...repeated for each created department...<br />
</departments><br />
<positions><br />
<pos id="INTEGER" name="STRING" /><br />
<br />
...repeated for each created position...<br />
</positions><br />
<freights><br />
<freight id="INTEGER" name="STRING" /><br />
<br />
...repeated for each freight account of the organization...<br />
</freights><br />
<banks><br />
<bank id="INTEGER" name="STRING" /><br />
<br />
...repeated for each bank account of the organization...<br />
</banks><br />
<cards><br />
<card id="INTEGER" name="STRING" /><br />
<br />
...repeated for each employee credit card of the organization...<br />
</cards><br />
<locations><br />
<location id="INTEGER" name="STRING" OPoID="STRING" phone="INTEGER" fax="INTEGER" website="STRING" timezone="INTEGER" beginTime="INTEGER" endTime="INTEGER" founded="DATE" foundedCountry="STRING" status="STRING" salesTax="INTEGER" salesTaxRate="DECIMAL" rating="DECIMAL" /><br />
<address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" /><br />
<br />
...repeated for each additional location of the organization...<br />
</locations><br />
<vendors><br />
<vendor id="INTEGER" name="STRING" OPoID="STRING" phone="INTEGER" fax="INTEGER" website="STRING" timezone="INTEGER" beginTime="INTEGER" endTime="INTEGER" founded="DATE" foundedCountry="STRING" status="STRING" salesTax="INTEGER" salesTaxRate="DECIMAL" rating="DECIMAL" /><br />
<address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" /><br />
<br />
...repeated for each vendor of the organization...<br />
</vendors><br />
<providers><br />
<provider id="INTEGER" name="STRING" OPoID="STRING" phone="INTEGER" fax="INTEGER" website="STRING" timezone="INTEGER" beginTime="INTEGER" endTime="INTEGER" founded="DATE" foundedCountry="STRING" status="STRING" salesTax="INTEGER" salesTaxRate="DECIMAL" rating="DECIMAL" /><br />
<address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" /><br />
<br />
...repeated for each service provider of the organization...<br />
</providers><br />
<data><br />
<entry id="INTEGER" title="STRING" filename="STRING" /><br />
...repeated for each custom data field on the 'Data' tab...<br />
<br />
<file filename="STRING" /><br />
...repeated for each file uploaded through the 'Data' tab...<br />
</data><br />
</pre><br />
<br />
NOTE: The <system> tag has only one mandatory value (socialURI) when the software is not working in a HOSTED mode, otherwise all the other values will be returned as well.<br />
<br />
<br />
===Save the configuration===<br />
To save all the various values of the interface form objects, the below parameters will need to be passed via a POST request:<br />
<pre><br />
action=save<br />
target=system<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
decrypt=(the decryption string for the account)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The general business information has been saved successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Load a department===<br />
To load the associated information of a selected department, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=load<br />
target=department<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
deptID=(the ID of the department to load)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<departments><br />
<dept id="INTEGER" name="STRING" /><br />
</departments><br />
</pre><br />
<br />
<br />
===Create a department===<br />
To create a new department for the organization, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=new<br />
target=department<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
name=(the name of the department to create)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The department has been created successfully!</msg><data id="INTEGER"></data></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Delete a department===<br />
To delete a existing department from the organization, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=delete<br />
target=department<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
deptID=(the ID of the department to delete)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The department has been deleted successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Update a department===<br />
To update a existing department of the organization, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=update<br />
target=department<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
deptID=(the ID of the department to update)<br />
name=(the updated name of the department)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The department has been updated successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Load a job position===<br />
To load the associated information of a selected job position, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=load<br />
target=position<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
posID=(the ID of the position to load)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<positions><br />
<pos id="INTEGER" name="STRING" type="{part-time|full-time|contractor|call|internship|volunteer}" pay="{hourly|salary|salary+ot|commission|commission+base|job}" base="DECIMAL" ot="DECIMAL" pto="DECIMAL" sick="DECIMAL" mileage="DECIMAL" cola="DECIMAL" perDiem="DECIMAL" dept="INTEGER" /><br />
</positions><br />
</pre><br />
<br />
<br />
===Create a job position===<br />
To create a new job position for the organization, the below parameters will need to be passed via a POST request:<br />
<pre><br />
action=new<br />
target=position<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
sJobTitle_BusinessConfiguration=(the title of the position to create)<br />
sDept_BusinessConfiguration=(the ID of the department that the job position belongs to)<br />
sJobType_BusinessConfiguration={part-time|full-time|contractor|call|internship|volunteer}<br />
sJobPay_BusinessConfiguration={hourly|salary|salary+ot|commission|commission+base|job}<br />
nJobPay_BusinessConfiguration=(the base pay of the job position)<br />
nJobOTRate_BusinessConfiguration=(the overtime pay rate of the job position)<br />
nCOLA_BusinessConfiguration=(the rate of cost of living annual increase in pay for the job position)<br />
sJobPTO_BusinessConfiguration=(the rate of personal time off the job position gives the employee per pay cycle)<br />
sJobSick_BusinessConfiguration=(the rate of sick leave the job position gives the employee per pay cycle)<br />
nMileage_BusinessConfiguration=(the amount of reimbursement for mileage incurred on business travel)<br />
nPerDiem_BusinessConfiguration=(the per diem amount of reimbursement for expenses incurred on business travel)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The department has been created successfully!</msg><data id="INTEGER"></data></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Delete a job position===<br />
To delete a existing job position from the organization, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=delete<br />
target=position<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
posID=(the ID of the job position to delete)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The position has been deleted successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Update a job position===<br />
To update a existing job position of the organization, the below parameters will need to be passed via a POST request:<br />
<pre><br />
action=update<br />
target=position<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
sJobTitle_BusinessConfiguration=(the title of the position to create)<br />
sDept_BusinessConfiguration=(the ID of the department that the job position belongs to)<br />
sJobType_BusinessConfiguration={part-time|full-time|contractor|call|internship|volunteer}<br />
sJobPay_BusinessConfiguration={hourly|salary|salary+ot|commission|commission+base|job}<br />
nJobPay_BusinessConfiguration=(the base pay of the job position)<br />
nJobOTRate_BusinessConfiguration=(the overtime pay rate of the job position)<br />
nCOLA_BusinessConfiguration=(the rate of cost of living annual increase in pay for the job position)<br />
sJobPTO_BusinessConfiguration=(the rate of personal time off the job position gives the employee per pay cycle)<br />
sJobSick_BusinessConfiguration=(the rate of sick leave the job position gives the employee per pay cycle)<br />
nMileage_BusinessConfiguration=(the amount of reimbursement for mileage incurred on business travel)<br />
nPerDiem_BusinessConfiguration=(the per diem amount of reimbursement for expenses incurred on business travel)<br />
sJobList_BusinessConfiguration=(the ID of the job position to update)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The position has been updated successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Load a credit card===<br />
To load the associated information of a selected credit card, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=load<br />
target=card<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
decrypt=(the decryption string for the account)<br />
acctID=(the ID of the credit card to load)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<cards><br />
<card id="INTEGER" name="STRING" number="INTEGER" employee="INTEGER" type="{amex|dc|mc|visa}" month="INTEGER" year="INTEGER" cvv2="INTEGER" /><br />
</cards><br />
</pre><br />
<br />
<br />
===Create a credit card===<br />
To create a new credit card for the organization, the below parameters will need to be passed via a POST request:<br />
<pre><br />
action=new<br />
target=card<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
decrypt=(the decryption string for the account)<br />
sCreditCardDesc_BusinessConfiguration=(the description of the credit card to create)<br />
nCreditCardNumber_BusinessConfiguration=(the credit card number)<br />
sCreditCardEmployee_BusinessConfiguration=(the ID of the employee that will be responsible for the credit card)<br />
sCreditCardType_BusinessConfiguration={amex|dc|mc|visa}<br />
nCreditCardMonth_BusinessConfiguration=(the expiration month for the credit card)<br />
nCreditCardYear_BusinessConfiguration=(the expiration year for the credit card)<br />
nCreditCardCVV2_BusinessConfiguration=(the CVV2 number of the credit card)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The credit card has been created successfully!</msg><data id="INTEGER"></data></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Delete a credit card===<br />
To delete a existing credit card from the organization, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=delete<br />
target=card<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
acctID=(the ID of the credit card to delete)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The credit card has been deleted successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Update a credit card===<br />
To update a existing job position of the organization, the below parameters will need to be passed via a POST request:<br />
<pre><br />
action=update<br />
target=card<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
decrypt=(the decryption string for the account)<br />
sCreditCardDesc_BusinessConfiguration=(the description of the credit card to create)<br />
nCreditCardNumber_BusinessConfiguration=(the credit card number)<br />
sCreditCardEmployee_BusinessConfiguration=(the ID of the employee that will be responsible for the credit card)<br />
sCreditCardType_BusinessConfiguration={amex|dc|mc|visa}<br />
nCreditCardMonth_BusinessConfiguration=(the expiration month for the credit card)<br />
nCreditCardYear_BusinessConfiguration=(the expiration year for the credit card)<br />
nCreditCardCVV2_BusinessConfiguration=(the CVV2 number of the credit card)<br />
sCardList_BusinessConfiguration=(the ID of the credit card to update)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The credit card has been updated successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Load a location|vendor|provider===<br />
To load the associated information of a selected additional location, vendor, or service provider, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=load<br />
target={Location|Vendor|Provider}<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
decrypt=(the decryption string for the account)<br />
acctID=(the ID of the additional location, vendor, or service provider to load)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<{Location|Vendor|Provider}s><br />
<{Location|Vendor|Provider} id="INTEGER" name="STRING" OPoID="STRING" phone="INTEGER" fax="INTEGER" website="STRING" commerceURI="STRING" commerceSID="STRING" timezone="INTEGER" beginTime="INTEGER" endTime="INTEGER" founded="STRING" foundedCountry="STRING" status="{opened|closed|re-opened}" salesTax="INTEGER" salesTaxRate="DECIMAL" rating="DECIMAL" /><br />
<address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" /><br />
<contact id="INTEGER" name="STRING" /><br />
<br />
...repeated for each contact associated with the location, vendor, or provider...<br />
<freight id="INTEGER" name="STRING" /><br />
<br />
...repeated for each freight account associated with the location, vendor, or provider...<br />
<bank id="INTEGER" name="STRING" /><br />
<br />
...repeated for each bank account associated with the location, vendor, or provider...<br />
</{Location|Vendor|Provider}s><br />
</pre><br />
<br />
<br />
===Create a location|vendor|provider===<br />
To create a new additional location, vendor, or service provider for the organization, the below parameters will need to be passed via a POST request:<br />
<pre><br />
action=new<br />
target={Location|Vendor|Provider}<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
decrypt=(the decryption string for the account)<br />
s{Location|Vendor|Provider}Desc_BusinessConfiguration=(the description of the location, vendor, or provider to create)<br />
s{Location|Vendor|Provider}OPoID_BusinessConfiguration=[for future use]<br />
s{Location|Vendor|Provider}CommerceURI_BusinessConfiguration=[the commerce URI of the location, vendor, or provider]<br />
s{Location|Vendor|Provider}CommerceSID_BusinessConfiguration=[the commerce SID of the location, vendor, or provider]<br />
n{Location|Vendor|Provider}Phone_BusinessConfiguration=(the expiration month for the credit card)<br />
n{Location|Vendor|Provider}Fax_BusinessConfiguration=(the expiration year for the credit card)<br />
s{Location|Vendor|Provider}Website_BusinessConfiguration=(the CVV2 number of the credit card)<br />
s{Location|Vendor|Provider}MainAddr1_BusinessConfiguration=(the main address line 1 of the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainAddr2_BusinessConfiguration=(the main address line 2 of the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainCity_BusinessConfiguration=(the city of the main address for the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainState_BusinessConfiguration=(the state of the main address for the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainZip_BusinessConfiguration=(the zip of the main address for the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainCountry_BusinessConfiguration=(the country of the main address for the location, vendor, or provider)<br />
s{Location|Vendor|Provider}Timezone_BusinessConfiguration=(the timezone of the location, vendor, or provider)<br />
n{Location|Vendor|Provider}BeginHour_BusinessConfiguration=(the opening hour of the location, vendor, or provider)<br />
n{Location|Vendor|Provider}BeginMin_BusinessConfiguration=(the opening minute of the location, vendor, or provider)<br />
s{Location|Vendor|Provider}BeginHalf_BusinessConfiguration={am|pm}<br />
n{Location|Vendor|Provider}EndHour_BusinessConfiguration=(the closing hour of the location, vendor, or provider)<br />
n{Location|Vendor|Provider}EndMin_BusinessConfiguration=(the closing minute of the location, vendor, or provider)<br />
s{Location|Vendor|Provider}EndHalf_BusinessConfiguration={am|pm}<br />
e{Location|Vendor|Provider}Founded_BusinessConfiguration=(the date indicating when the location, vendor, or provider was founded)<br />
s{Location|Vendor|Provider}Country_BusinessConfiguration=(the country where the location, vendor, or provider was founded)<br />
sLocationStatus_BusinessConfiguration={opened|closed|re-opened}<br />
sLocationSalesTax_BusinessConfiguration=[the sales tax number of the additional location]<br />
nLocationSalesTaxRate_BusinessConfiguration=[the sales tax rate of the additional location]<br />
s{Vendor|Provider}Merchant_BusinessConfiguration=[the merchant of the vendor or service provider]<br />
s{Vendor|Provider}MerchantID_BusinessConfiguration=[the merchant ID of the vendor or service provider]<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The {Location|Vendor|Provider} has been created successfully!</msg><data id="INTEGER"></data></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Delete a location|vendor|provider===<br />
To delete a existing additional location, vendor, or service provider from the organization, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=delete<br />
target={Location|Vendor|Provider}<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
acctID=(the ID of the additional location, vendor, and service provider to delete)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The {Location|Vendor|Provider} has been deleted successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Update a location|vendor|provider===<br />
To update a existing additional location, vendor, or service provider of the organization, the below parameters will need to be passed via a POST request:<br />
<pre><br />
action=update<br />
target=card<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
decrypt=(the decryption string for the account)<br />
s{Location|Vendor|Provider}Desc_BusinessConfiguration=(the description of the location, vendor, or provider to create)<br />
s{Location|Vendor|Provider}OPoID_BusinessConfiguration=[for future use]<br />
s{Location|Vendor|Provider}CommerceURI_BusinessConfiguration=[the commerce URI of the location, vendor, or provider]<br />
s{Location|Vendor|Provider}CommerceSID_BusinessConfiguration=[the commerce SID of the location, vendor, or provider]<br />
n{Location|Vendor|Provider}Phone_BusinessConfiguration=(the expiration month for the credit card)<br />
n{Location|Vendor|Provider}Fax_BusinessConfiguration=(the expiration year for the credit card)<br />
s{Location|Vendor|Provider}Website_BusinessConfiguration=(the CVV2 number of the credit card)<br />
s{Location|Vendor|Provider}MainAddr1_BusinessConfiguration=(the main address line 1 of the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainAddr2_BusinessConfiguration=(the main address line 2 of the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainCity_BusinessConfiguration=(the city of the main address for the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainState_BusinessConfiguration=(the state of the main address for the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainZip_BusinessConfiguration=(the zip of the main address for the location, vendor, or provider)<br />
s{Location|Vendor|Provider}MainCountry_BusinessConfiguration=(the country of the main address for the location, vendor, or provider)<br />
s{Location|Vendor|Provider}Timezone_BusinessConfiguration=(the timezone of the location, vendor, or provider)<br />
n{Location|Vendor|Provider}BeginHour_BusinessConfiguration=(the opening hour of the location, vendor, or provider)<br />
n{Location|Vendor|Provider}BeginMin_BusinessConfiguration=(the opening minute of the location, vendor, or provider)<br />
s{Location|Vendor|Provider}BeginHalf_BusinessConfiguration={am|pm}<br />
n{Location|Vendor|Provider}EndHour_BusinessConfiguration=(the closing hour of the location, vendor, or provider)<br />
n{Location|Vendor|Provider}EndMin_BusinessConfiguration=(the closing minute of the location, vendor, or provider)<br />
s{Location|Vendor|Provider}EndHalf_BusinessConfiguration={am|pm}<br />
e{Location|Vendor|Provider}Founded_BusinessConfiguration=(the date indicating when the location, vendor, or provider was founded)<br />
s{Location|Vendor|Provider}Country_BusinessConfiguration=(the country where the location, vendor, or provider was founded)<br />
sLocationStatus_BusinessConfiguration={opened|closed|re-opened}<br />
sLocationSalesTax_BusinessConfiguration=[the sales tax number of the additional location]<br />
nLocationSalesTaxRate_BusinessConfiguration=[the sales tax rate of the additional location]<br />
s{Vendor|Provider}Merchant_BusinessConfiguration=[the merchant of the vendor or service provider]<br />
s{Vendor|Provider}MerchantID_BusinessConfiguration=[the merchant ID of the vendor or service provider]<br />
s{Location|Vendor|Provider}List_BusinessConfiguration=(the ID of the location, vendor, or provider to update)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The {Location|Vendor|Provider} has been updated successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Send commerce info===<br />
To send the commerce info to an existing additional location, vendor, or service provider, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=email<br />
target=pairing<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
email=(the email address of the recipient at the additional location, vendor, and service provider)<br />
sid=(the commerce SID to send to the additional location, vendor, or service provider)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The commerce pairing info has been emailed successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre><br />
<br />
<br />
===Pair a location|vendor|provider===<br />
To pair your software with an existing additional location, vendor, or service provider, the below parameters will need to be passed via a GET request:<br />
<pre><br />
action=pair<br />
target=software<br />
username=(the username for the account)<br />
SID=(the security identifier for the account)<br />
decrypt=(the decryption string for the account)<br />
id=(the ID of the additional location, vendor, and service provider to pair with)<br />
</pre><br />
<br />
This will return all the information in the following XML layout:<br />
<pre><br />
<s><msg>The software has been paired successfully!</msg></s><br />
<br />
OR<br />
<br />
<f><msg>...</msg></f><br />
</pre></div>Digitalpipe