webBooks-Business Configuration-APIs

From Cliquesoft
Revision as of 12:58, 26 March 2015 by Digitalpipe (Talk | contribs) (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...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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 will be specified per section below.


Load the interface

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}).

action=init
target=screen
username=(the username for the account)
SID=(the security identifier for the account)

This will return the raw contents as it is found in the file, replacing all occurrences of the variable ${UN} anywhere.


Populate the form

To populate all the various values of the interface form objects, the below parameters will need to be passed via a GET request:

action=init
target=values
username=(the username for the account)
SID=(the security identifier for the account)

This will return all the information in the following XML layout:

   <general>
      <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}" />
      <address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" />
      <address type="bill" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" />
      <address type="ship" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" />
   </general>
   <employees>
      <employee id=\"".$empl['id']."\" name=\"".$empl['name']."\" />

      ...repeated for each employee of the organization...
   </employees>
   <departments>
      <dept id="INTEGER" name="STRING" />

      ...repeated for each created department...
   </departments>
   <positions>
      <pos id="INTEGER" name="STRING" />

      ...repeated for each created position...
   </positions>
   <freights>
      <freight id="INTEGER" name="STRING" />

      ...repeated for each freight account of the organization...
   </freights>
   <banks>
      <bank id="INTEGER" name="STRING" />

      ...repeated for each bank account of the organization...
   </banks>
   <cards>
      <card id="INTEGER" name="STRING" />

      ...repeated for each employee credit card of the organization...
   </cards>
   <locations>
      <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" />
      <address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" />

      ...repeated for each additional location of the organization...
   </locations>
   <vendors>
      <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" />
      <address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" />

      ...repeated for each vendor of the organization...
   </vendors>
   <providers>
      <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" />
      <address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" />

      ...repeated for each service provider of the organization...
   </providers>
   <data>
      <entry id="INTEGER" title="STRING" filename="STRING" />
      ...repeated for each custom data field on the 'Data' tab...

      <file filename="STRING" />
      ...repeated for each file uploaded through the 'Data' tab...
   </data>

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.


Save the configuration

To save all the various values of the interface form objects, the below parameters will need to be passed via a POST request:

action=save
target=system
username=(the username for the account)
SID=(the security identifier for the account)
decrypt=(the decryption string for the account)

This will return all the information in the following XML layout:

   <s><msg>The general business information has been saved successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Load a department

To load the associated information of a selected department, the below parameters will need to be passed via a GET request:

action=load
target=department
username=(the username for the account)
SID=(the security identifier for the account)
deptID=(the ID of the department to load)

This will return all the information in the following XML layout:

   <departments>
      <dept id="INTEGER" name="STRING" />
   </departments>


Create a department

To create a new department for the organization, the below parameters will need to be passed via a GET request:

action=new
target=department
username=(the username for the account)
SID=(the security identifier for the account)
name=(the name of the department to create)

This will return all the information in the following XML layout:

   <s><msg>The department has been created successfully!</msg><data id="INTEGER"></data></s>

   OR

   <f><msg>...</msg></f>


Delete a department

To delete a existing department from the organization, the below parameters will need to be passed via a GET request:

action=delete
target=department
username=(the username for the account)
SID=(the security identifier for the account)
deptID=(the ID of the department to delete)

This will return all the information in the following XML layout:

   <s><msg>The department has been deleted successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Update a department

To update a existing department of the organization, the below parameters will need to be passed via a GET request:

action=update
target=department
username=(the username for the account)
SID=(the security identifier for the account)
deptID=(the ID of the department to update)
name=(the updated name of the department)

This will return all the information in the following XML layout:

   <s><msg>The department has been updated successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Load a job position

To load the associated information of a selected job position, the below parameters will need to be passed via a GET request:

action=load
target=position
username=(the username for the account)
SID=(the security identifier for the account)
posID=(the ID of the position to load)

This will return all the information in the following XML layout:

   <positions>
      <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" />
   </positions>


Create a job position

To create a new job position for the organization, the below parameters will need to be passed via a POST request:

action=new
target=position
username=(the username for the account)
SID=(the security identifier for the account)
sJobTitle_BusinessConfiguration=(the title of the position to create)
sDept_BusinessConfiguration=(the ID of the department that the job position belongs to)
sJobType_BusinessConfiguration={part-time|full-time|contractor|call|internship|volunteer}
sJobPay_BusinessConfiguration={hourly|salary|salary+ot|commission|commission+base|job}
nJobPay_BusinessConfiguration=(the base pay of the job position)
nJobOTRate_BusinessConfiguration=(the overtime pay rate of the job position)
nCOLA_BusinessConfiguration=(the rate of cost of living annual increase in pay for the job position)
sJobPTO_BusinessConfiguration=(the rate of personal time off the job position gives the employee per pay cycle)
sJobSick_BusinessConfiguration=(the rate of sick leave the job position gives the employee per pay cycle)
nMileage_BusinessConfiguration=(the amount of reimbursement for mileage incurred on business travel)
nPerDiem_BusinessConfiguration=(the per diem amount of reimbursement for expenses incurred on business travel)

This will return all the information in the following XML layout:

   <s><msg>The department has been created successfully!</msg><data id="INTEGER"></data></s>

   OR

   <f><msg>...</msg></f>


Delete a job position

To delete a existing job position from the organization, the below parameters will need to be passed via a GET request:

action=delete
target=position
username=(the username for the account)
SID=(the security identifier for the account)
posID=(the ID of the job position to delete)

This will return all the information in the following XML layout:

   <s><msg>The position has been deleted successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Update a job position

To update a existing job position of the organization, the below parameters will need to be passed via a POST request:

action=update
target=position
username=(the username for the account)
SID=(the security identifier for the account)
sJobTitle_BusinessConfiguration=(the title of the position to create)
sDept_BusinessConfiguration=(the ID of the department that the job position belongs to)
sJobType_BusinessConfiguration={part-time|full-time|contractor|call|internship|volunteer}
sJobPay_BusinessConfiguration={hourly|salary|salary+ot|commission|commission+base|job}
nJobPay_BusinessConfiguration=(the base pay of the job position)
nJobOTRate_BusinessConfiguration=(the overtime pay rate of the job position)
nCOLA_BusinessConfiguration=(the rate of cost of living annual increase in pay for the job position)
sJobPTO_BusinessConfiguration=(the rate of personal time off the job position gives the employee per pay cycle)
sJobSick_BusinessConfiguration=(the rate of sick leave the job position gives the employee per pay cycle)
nMileage_BusinessConfiguration=(the amount of reimbursement for mileage incurred on business travel)
nPerDiem_BusinessConfiguration=(the per diem amount of reimbursement for expenses incurred on business travel)
sJobList_BusinessConfiguration=(the ID of the job position to update)

This will return all the information in the following XML layout:

   <s><msg>The position has been updated successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Load a credit card

To load the associated information of a selected credit card, the below parameters will need to be passed via a GET request:

action=load
target=card
username=(the username for the account)
SID=(the security identifier for the account)
decrypt=(the decryption string for the account)
acctID=(the ID of the credit card to load)

This will return all the information in the following XML layout:

   <cards>
      <card id="INTEGER" name="STRING" number="INTEGER" employee="INTEGER" type="{amex|dc|mc|visa}" month="INTEGER" year="INTEGER" cvv2="INTEGER" />
   </cards>


Create a credit card

To create a new credit card for the organization, the below parameters will need to be passed via a POST request:

action=new
target=card
username=(the username for the account)
SID=(the security identifier for the account)
decrypt=(the decryption string for the account)
sCreditCardDesc_BusinessConfiguration=(the description of the credit card to create)
nCreditCardNumber_BusinessConfiguration=(the credit card number)
sCreditCardEmployee_BusinessConfiguration=(the ID of the employee that will be responsible for the credit card)
sCreditCardType_BusinessConfiguration={amex|dc|mc|visa}
nCreditCardMonth_BusinessConfiguration=(the expiration month for the credit card)
nCreditCardYear_BusinessConfiguration=(the expiration year for the credit card)
nCreditCardCVV2_BusinessConfiguration=(the CVV2 number of the credit card)

This will return all the information in the following XML layout:

   <s><msg>The credit card has been created successfully!</msg><data id="INTEGER"></data></s>

   OR

   <f><msg>...</msg></f>


Delete a credit card

To delete a existing credit card from the organization, the below parameters will need to be passed via a GET request:

action=delete
target=card
username=(the username for the account)
SID=(the security identifier for the account)
acctID=(the ID of the credit card to delete)

This will return all the information in the following XML layout:

   <s><msg>The credit card has been deleted successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Update a credit card

To update a existing job position of the organization, the below parameters will need to be passed via a POST request:

action=update
target=card
username=(the username for the account)
SID=(the security identifier for the account)
decrypt=(the decryption string for the account)
sCreditCardDesc_BusinessConfiguration=(the description of the credit card to create)
nCreditCardNumber_BusinessConfiguration=(the credit card number)
sCreditCardEmployee_BusinessConfiguration=(the ID of the employee that will be responsible for the credit card)
sCreditCardType_BusinessConfiguration={amex|dc|mc|visa}
nCreditCardMonth_BusinessConfiguration=(the expiration month for the credit card)
nCreditCardYear_BusinessConfiguration=(the expiration year for the credit card)
nCreditCardCVV2_BusinessConfiguration=(the CVV2 number of the credit card)
sCardList_BusinessConfiguration=(the ID of the credit card to update)

This will return all the information in the following XML layout:

   <s><msg>The credit card has been updated successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Load a location|vendor|provider

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:

action=load
target={Location|Vendor|Provider}
username=(the username for the account)
SID=(the security identifier for the account)
decrypt=(the decryption string for the account)
acctID=(the ID of the additional location, vendor, or service provider to load)

This will return all the information in the following XML layout:

   <{Location|Vendor|Provider}s>
      <{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" />
      <address type="main" addr1="STRING" addr2="STRING" city="STRING" state="STRING" zip="STRING" country="STRING" />
      <contact id="INTEGER" name="STRING" />

      ...repeated for each contact associated with the location, vendor, or provider...
      <freight id="INTEGER" name="STRING" />

      ...repeated for each freight account associated with the location, vendor, or provider...
      <bank id="INTEGER" name="STRING" />

      ...repeated for each bank account associated with the location, vendor, or provider...
   </{Location|Vendor|Provider}s>


Create a location|vendor|provider

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:

action=new
target={Location|Vendor|Provider}
username=(the username for the account)
SID=(the security identifier for the account)
decrypt=(the decryption string for the account)
s{Location|Vendor|Provider}Desc_BusinessConfiguration=(the description of the location, vendor, or provider to create)
s{Location|Vendor|Provider}OPoID_BusinessConfiguration=[for future use]
s{Location|Vendor|Provider}CommerceURI_BusinessConfiguration=[the commerce URI of the location, vendor, or provider]
s{Location|Vendor|Provider}CommerceSID_BusinessConfiguration=[the commerce SID of the location, vendor, or provider]
n{Location|Vendor|Provider}Phone_BusinessConfiguration=(the expiration month for the credit card)
n{Location|Vendor|Provider}Fax_BusinessConfiguration=(the expiration year for the credit card)
s{Location|Vendor|Provider}Website_BusinessConfiguration=(the CVV2 number of the credit card)
s{Location|Vendor|Provider}MainAddr1_BusinessConfiguration=(the main address line 1 of the location, vendor, or provider)
s{Location|Vendor|Provider}MainAddr2_BusinessConfiguration=(the main address line 2 of the location, vendor, or provider)
s{Location|Vendor|Provider}MainCity_BusinessConfiguration=(the city of the main address for the location, vendor, or provider)
s{Location|Vendor|Provider}MainState_BusinessConfiguration=(the state of the main address for the location, vendor, or provider)
s{Location|Vendor|Provider}MainZip_BusinessConfiguration=(the zip of the main address for the location, vendor, or provider)
s{Location|Vendor|Provider}MainCountry_BusinessConfiguration=(the country of the main address for the location, vendor, or provider)
s{Location|Vendor|Provider}Timezone_BusinessConfiguration=(the timezone of the location, vendor, or provider)
n{Location|Vendor|Provider}BeginHour_BusinessConfiguration=(the opening hour of the location, vendor, or provider)
n{Location|Vendor|Provider}BeginMin_BusinessConfiguration=(the opening minute of the location, vendor, or provider)
s{Location|Vendor|Provider}BeginHalf_BusinessConfiguration={am|pm}
n{Location|Vendor|Provider}EndHour_BusinessConfiguration=(the closing hour of the location, vendor, or provider)
n{Location|Vendor|Provider}EndMin_BusinessConfiguration=(the closing minute of the location, vendor, or provider)
s{Location|Vendor|Provider}EndHalf_BusinessConfiguration={am|pm}
e{Location|Vendor|Provider}Founded_BusinessConfiguration=(the date indicating when the location, vendor, or provider was founded)
s{Location|Vendor|Provider}Country_BusinessConfiguration=(the country where the location, vendor, or provider was founded)
sLocationStatus_BusinessConfiguration={opened|closed|re-opened}
sLocationSalesTax_BusinessConfiguration=[the sales tax number of the additional location]
nLocationSalesTaxRate_BusinessConfiguration=[the sales tax rate of the additional location]
s{Vendor|Provider}Merchant_BusinessConfiguration=[the merchant of the vendor or service provider]
s{Vendor|Provider}MerchantID_BusinessConfiguration=[the merchant ID of the vendor or service provider]

This will return all the information in the following XML layout:

   <s><msg>The {Location|Vendor|Provider} has been created successfully!</msg><data id="INTEGER"></data></s>

   OR

   <f><msg>...</msg></f>


Delete a location|vendor|provider

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:

action=delete
target={Location|Vendor|Provider}
username=(the username for the account)
SID=(the security identifier for the account)
acctID=(the ID of the additional location, vendor, and service provider to delete)

This will return all the information in the following XML layout:

   <s><msg>The {Location|Vendor|Provider} has been deleted successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Update a location|vendor|provider

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:

action=update
target=card
username=(the username for the account)
SID=(the security identifier for the account)
decrypt=(the decryption string for the account)
s{Location|Vendor|Provider}Desc_BusinessConfiguration=(the description of the location, vendor, or provider to create)
s{Location|Vendor|Provider}OPoID_BusinessConfiguration=[for future use]
s{Location|Vendor|Provider}CommerceURI_BusinessConfiguration=[the commerce URI of the location, vendor, or provider]
s{Location|Vendor|Provider}CommerceSID_BusinessConfiguration=[the commerce SID of the location, vendor, or provider]
n{Location|Vendor|Provider}Phone_BusinessConfiguration=(the expiration month for the credit card)
n{Location|Vendor|Provider}Fax_BusinessConfiguration=(the expiration year for the credit card)
s{Location|Vendor|Provider}Website_BusinessConfiguration=(the CVV2 number of the credit card)
s{Location|Vendor|Provider}MainAddr1_BusinessConfiguration=(the main address line 1 of the location, vendor, or provider)
s{Location|Vendor|Provider}MainAddr2_BusinessConfiguration=(the main address line 2 of the location, vendor, or provider)
s{Location|Vendor|Provider}MainCity_BusinessConfiguration=(the city of the main address for the location, vendor, or provider)
s{Location|Vendor|Provider}MainState_BusinessConfiguration=(the state of the main address for the location, vendor, or provider)
s{Location|Vendor|Provider}MainZip_BusinessConfiguration=(the zip of the main address for the location, vendor, or provider)
s{Location|Vendor|Provider}MainCountry_BusinessConfiguration=(the country of the main address for the location, vendor, or provider)
s{Location|Vendor|Provider}Timezone_BusinessConfiguration=(the timezone of the location, vendor, or provider)
n{Location|Vendor|Provider}BeginHour_BusinessConfiguration=(the opening hour of the location, vendor, or provider)
n{Location|Vendor|Provider}BeginMin_BusinessConfiguration=(the opening minute of the location, vendor, or provider)
s{Location|Vendor|Provider}BeginHalf_BusinessConfiguration={am|pm}
n{Location|Vendor|Provider}EndHour_BusinessConfiguration=(the closing hour of the location, vendor, or provider)
n{Location|Vendor|Provider}EndMin_BusinessConfiguration=(the closing minute of the location, vendor, or provider)
s{Location|Vendor|Provider}EndHalf_BusinessConfiguration={am|pm}
e{Location|Vendor|Provider}Founded_BusinessConfiguration=(the date indicating when the location, vendor, or provider was founded)
s{Location|Vendor|Provider}Country_BusinessConfiguration=(the country where the location, vendor, or provider was founded)
sLocationStatus_BusinessConfiguration={opened|closed|re-opened}
sLocationSalesTax_BusinessConfiguration=[the sales tax number of the additional location]
nLocationSalesTaxRate_BusinessConfiguration=[the sales tax rate of the additional location]
s{Vendor|Provider}Merchant_BusinessConfiguration=[the merchant of the vendor or service provider]
s{Vendor|Provider}MerchantID_BusinessConfiguration=[the merchant ID of the vendor or service provider]
s{Location|Vendor|Provider}List_BusinessConfiguration=(the ID of the location, vendor, or provider to update)

This will return all the information in the following XML layout:

   <s><msg>The {Location|Vendor|Provider} has been updated successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Send commerce info

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:

action=email
target=pairing
username=(the username for the account)
SID=(the security identifier for the account)
email=(the email address of the recipient at the additional location, vendor, and service provider)
sid=(the commerce SID to send to the additional location, vendor, or service provider)

This will return all the information in the following XML layout:

   <s><msg>The commerce pairing info has been emailed successfully!</msg></s>

   OR

   <f><msg>...</msg></f>


Pair a location|vendor|provider

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:

action=pair
target=software
username=(the username for the account)
SID=(the security identifier for the account)
decrypt=(the decryption string for the account)
id=(the ID of the additional location, vendor, and service provider to pair with)

This will return all the information in the following XML layout:

   <s><msg>The software has been paired successfully!</msg></s>

   OR

   <f><msg>...</msg></f>