Transactions by Family

The Transactions by Family service allows you to return all transactions for a specific family. You can optionally filter the results by transaction date range and by the date the records were modified.

Service Name

transactions_by_family

Required Parameters

NameType
family_idinteger

Optional Parameters

NameType
date_startdatetime
date_enddatetime
modified_sincedatetime

Example Curl

curl -u user:pass "https://yourchurch.ccbchurch.com/api.php?srv=transactions_by_family&family_id=2809&modified_since=2012-12-17&date_end=2013-01-01"

Example Response XML

<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
     <request>
          <parameters>
               <argument value="transactions_by_family" name="srv"/>
               <argument value="2809" name="family_id"/>
               <argument value="2012-12-17" name="modified_since"/>
               <argument value="2013-01-01" name="date_end"/>
          </parameters>
     </request>
     <response>
          <service>transactions_by_family</service>
          <service_action>execute</service_action>
          <availability>public</availability>
          <transactions count="3">
               <transaction id="3067" merchant_transaction_id="">
                    <campus id="1">Our Church</campus>
                    <individual id="1">Billy A</individual>
                    <date>2012-12-06</date>
                    <grouping id="2">1st Saturday Service</grouping>
                    <payment_type>Online</payment_type>
                    <check_number></check_number>
                    <transaction_details>
                         <transaction_detail id="3516">
                              <coa id="46">General</coa>
                              <amount>1</amount>
                              <tax_deductible>true</tax_deductible>
                              <note></note>
                              <creator id="1">Billy A</creator>
                              <modifier id="1">Billy A</modifier>
                              <created>2012-12-17 08:43:59</created>
                              <modified>2012-12-17 08:43:59</modified>
                         </transaction_detail>
                    </transaction_details>
                    <creator id="1">Billy A</creator>
                    <modifier id="1">Billy A</modifier>
                    <created>2012-12-17 08:43:59</created>
                    <modified>2012-12-17 08:43:59</modified>
                    <merchant_name></merchant_name>
                    <merchant_individual_id></merchant_individual_id>
               </transaction>
               ...
               <transaction id="3069" merchant_transaction_id="">
                    <campus id="1">Our Church</campus>
                    <individual id="2">Bobby A</individual>
                    <date>2012-12-07</date>
                    <grouping id="2">1st Saturday Service</grouping>
                    <payment_type>Online</payment_type>
                    <check_number></check_number>
                    <transaction_details>
                         <transaction_detail id="3518">
                              <coa id="5">012345678901234567890123456789</coa>
                              <amount>1</amount>
                              <tax_deductible>true</tax_deductible>
                              <note></note>
                              <creator id="1">Bobby A</creator>
                              <modifier id="1">Bobby A</modifier>
                              <created>2012-12-17 08:44:24</created>
                              <modified>2012-12-17 08:44:24</modified>
                         </transaction_detail>
                    </transaction_details>
                    <creator id="1">Bobby A</creator>
                    <modifier id="1">Bobby A</modifier>
                    <created>2012-12-17 08:44:24</created>
                    <modified>2012-12-17 08:44:24</modified>
                    <merchant_name></merchant_name>
                    <merchant_individual_id></merchant_individual_id>
               </transaction>
          </transactions>
     </response>
</ccb_api>