RubyGems - etapper - Versions diffs - 0.0.0 - Mend

etapper 0.0.0

Files changed (650) hide show

data/doc/api/ct_Phone.html ADDED Viewed

@@ -0,0 +1,51 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<table width='100%'><tr>
+  <td><div class='complexTypeName'><img src='images/etap.gif'/> Phone Complex Type<br></div></td>
+  <td align='right' valign='bottom'><div class='smallText'>ROA = Required on Add, ROU = Required on Update, Click Column Header to Sort Column</div></td>
+</tr></table>
+<table class='reportTable' id='ct_Phone'>
+  <tr class='reportTableHeader' fixed='true'>
+    <td><a href="javascript:sortTable('ct_Phone',0)">Name</a></td>
+    <td><a href="javascript:sortTable('ct_Phone',1)">Type</a></td>
+    <td align='center'><a href="javascript:sortTable('ct_Phone',2)" title='Required on Add'>ROA</a></td>
+    <td align='center'><a href="javascript:sortTable('ct_Phone',3)" title='Required on Update'>ROU</a></td>
+    <td align='center'><a href="javascript:sortTable('ct_Phone',4)">Read Only</a></td>
+    <td><a href="javascript:sortTable('ct_Phone',5)">Basic Comments</a></td>
+    <td><a href="javascript:sortTable('ct_Phone',6)">Special Comments</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>type</td>
+    <td>string</td>
+    <td align='center'>Yes</td>
+    <td align='center'>Yes</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Phone.html#scPhone1'>SC1</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>number</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Special Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td><a name='scPhone1'></a>SC1)</td>
+    <td>The field type must match (case sensitive) an existing phone type name already in eTapestry. &nbsp;Existing phone type names can be found at Manage...System Defined Fields...Phone Type Code.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/ct_Pledge.html ADDED Viewed

@@ -0,0 +1,408 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<table width='100%'><tr>
+  <td><div class='complexTypeName'><img src='images/etap.gif'/> Pledge Complex Type<br></div></td>
+  <td align='right' valign='bottom'><div class='smallText'>ROA = Required on Add, ROU = Required on Update, Click Column Header to Sort Column</div></td>
+</tr></table>
+<table class='reportTable' id='ct_Pledge'>
+  <tr class='reportTableHeader' fixed='true'>
+    <td><a href="javascript:sortTable('ct_Pledge',0)">Name</a></td>
+    <td><a href="javascript:sortTable('ct_Pledge',1)">Type</a></td>
+    <td align='center'><a href="javascript:sortTable('ct_Pledge',2)" title='Required on Add'>ROA</a></td>
+    <td align='center'><a href="javascript:sortTable('ct_Pledge',3)" title='Required on Update'>ROU</a></td>
+    <td align='center'><a href="javascript:sortTable('ct_Pledge',4)">Read Only</a></td>
+    <td><a href="javascript:sortTable('ct_Pledge',5)">Basic Comments</a></td>
+    <td><a href="javascript:sortTable('ct_Pledge',6)">Special Comments</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>type</td>
+    <td>int</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>Set to 6 when journal entry is retrieved from eTapestry</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>accountRef</td>
+    <td>string</td>
+    <td align='center'>Yes</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>Must be a donor role account</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>accountName</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>ref</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>final</td>
+    <td>boolean</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge1'>SC1</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>date</td>
+    <td>date</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>amount</td>
+    <td>double</td>
+    <td align='center'>Yes</td>
+    <td align='center'>Yes</td>
+    <td align='center'>&nbsp;</td>
+    <td>Must be greater than zero</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>initialPaymentAmount</td>
+    <td>double</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>Must be greater than or equal to zero</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>nonDeductibleAmount</td>
+    <td>double</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>Must be greater than or equal to zero and less than or equal to the amount</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>fund</td>
+    <td>string</td>
+    <td align='center'>Yes</td>
+    <td align='center'>Yes</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge2'>SC2</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>campaign</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge3'>SC3</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>approach</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge4'>SC4</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>letter</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge5'>SC5</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>receipt</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>note</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>outstandingBalance</td>
+    <td>double</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>nextPaymentDate</td>
+    <td>date</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>nextPaymentAmount</td>
+    <td>double</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>standardSchedule</td>
+    <td><a href='ct_StandardPaymentSchedule.html'>StandardPaymentSchedule</a></td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge6'>SC6</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>customSchedule</td>
+    <td><a href='ct_CustomPaymentSchedule.html'>CustomPaymentSchedule</a></td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge6'>SC6</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>paymentValuable</td>
+    <td><a href='ct_Valuable.html'>Valuable</a></td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge7'>SC7</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>scheduledValuable</td>
+    <td><a href='ct_Valuable.html'>Valuable</a></td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge8'>SC8</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>definedValues</td>
+    <td><a href='ct_DefinedValue.html'>DefinedValue</a> array</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>softCredit</td>
+    <td><a href='ct_SoftCredit.html'>SoftCredit</a></td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge9'>SC9</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>tributeAccountRef</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge10'>SC10</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>tributeAccountName</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>recognitionName</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge11'>SC11</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>recognitionType</td>
+    <td>int</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>0 = User Donor Name<br>1 = Don't Recognize<br>2 = Anonymous<br>3 = Use Transaction Recognition Name</td>
+    <td>&nbsp;</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>writeOff</td>
+    <td>boolean</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge12'>SC12</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>offsettingRef</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge13'>SC13</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>segmentedTransactionRef</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge14'>SC14</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>originalAccountRef</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge15'>SC15</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>originalAccountName</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge15'>SC15</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>originalTransactionRef</td>
+    <td>string</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge15'>SC15</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>attachments</td>
+    <td><a href='ct_Attachment.html'>Attachment</a> array</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>&nbsp;</td>
+    <td align='center'>Yes</td>
+    <td>&nbsp;</td>
+    <td><a href='ct_Pledge.html#scPledge16'>SC16</a></td>
+  </tr>
+</table><br>
+<div class='specialComments'>Special Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td><a name='scPledge1'></a>SC1)</td>
+    <td>The field final indicates whether the transaction can be updated by non admin users. &nbsp;A true value means it cannot be updated by non admin users.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge2'></a>SC2)</td>
+    <td>The field fund must match (case sensitive) an existing fund name in eTapestry. &nbsp;Existing fund names can be found at Manage...Funds.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge3'></a>SC3)</td>
+    <td>The field campaign must match (case sensitive) an existing campaign name in eTapestry. &nbsp;Existing campaign names can be found at Manage...Campaigns.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge4'></a>SC4)</td>
+    <td>The field approach must match (case sensitive) an existing approach name in eTapestry. &nbsp;Existing approach names can be found at Manage...Approaches.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge5'></a>SC5)</td>
+    <td>The field letter must match (case sensitive) an existing letter name in eTapestry. &nbsp;Existing letter names can be found at Manage...Letters.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge6'></a>SC6)</td>
+    <td>Only one of these fields should be populated. &nbsp;If an add is being performed and no schedule is provided, a default schedule (the frequency will be annual, the first installment date will be the date of the pledge, and the installment amount will be the initialPaymentAmount or the pledge amount) will be created. &nbsp;If an update is being performed on a transaction that has a schedule, a schedule will be required. &nbsp;On an update, switching schedule types (standard versus custom) is allowed.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge7'></a>SC7)</td>
+    <td>The field paymentValuable should only be populated when initialPaymentAmount is above zero. &nbsp;If an update is being performed on a pledge that already has an initial payment amount, paymentValuable will be required.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge8'></a>SC8)</td>
+    <td>The field scheduledValuable is required when standardSchedule or customSchedule is marked with a process type of auto. &nbsp;Auto transactions must have CreditCard or ElectronicFundsTransfer populated.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge9'></a>SC9)</td>
+    <td>The field softCredit contains the soft credit transaction linked to this pledge. &nbsp;The linked soft credit can have a different fund, campaign, approach, letter, and amount. &nbsp;Please note, soft credit transactions can only belong to donor role accounts. &nbsp;If an update is processed, the soft credit account can be switched from one account to another.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge10'></a>SC10)</td>
+    <td>The field tributeAccountRef indicates the transaction is in honor/memorial of a particular account. &nbsp;This must be a tribute role account.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge11'></a>SC11)</td>
+    <td>The field recognitionName should only be populated when recognitionType is 3.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge12'></a>SC12)</td>
+    <td>The field writeOff indicates the remaining balance of the pledge has been written off (i.e. the donor has notified the organization they no longer plan to fulfill the pledge or the organization simpily doesn't expect the donor to make any more payments).</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge13'></a>SC13)</td>
+    <td>eTapestry allows transactions to be reversed. &nbsp;The field offsettingRef indicates this transaction is a transaction that has been reversed or the reversal transaction. &nbsp;Reversal transanctions or transactions that have been reveresed cannot be updated.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge14'></a>SC14)</td>
+    <td>eTapestry allows segmented pledge transactions which consist of multiple pledges. &nbsp;The field segmentedTransactionRef indicates this pledge is a single segment of a segmented pledge transaction. &nbsp;Individual segments of a segmented pledge transaction cannot be updated, but the entire segmented pledge transaction (which includes the individual segments) can be updated.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge15'></a>SC15)</td>
+    <td>eTapestry allows transactions to denote a tribute (tributes are separate accounts within the database). &nbsp;For reporting purposes, eTapestry stores a replica of the transaction within the tribute's journal. &nbsp;When the field originalAccountRef, originalAccountName, and originalTransactionRef are populated, this transaction is a tribute's replica. &nbsp;The field originalAccountRef will contain the account ref of the original transaction owner. &nbsp;The field originalAccountName will contain the account name of the original transaction owner. &nbsp;The field originalTransactionRef will contain the ref of the original transaction. &nbsp;<b>Please note</b>, replica tribute transactions cannot be updated. &nbsp;If attempted, soap fault 107 will occur.</td>
+  </tr>
+  <tr>
+    <td><a name='scPledge16'></a>SC16)</td>
+    <td>Journal entries retrieved from eTapestry will contain all attachment data except the fileContent. &nbsp;This is done for efficiency purposes.</td>
+  </tr>
+</table>
+</body>
+</html>