Batch Profiles

The Batch Profiles service allows you to pass in a given date and have all batches created or modified since that date returned to you. If a date is not provided, all batches in the system will be returned.

Service Name

batch_profiles

Required Parameters

None

Optional Parameters

NameType
modified_sincedatetime

Example Curl

curl -u user:pass "https://yourchurch.ccbchurch.com/api.php?srv=batch_profiles&modified_since=2010-05-18"

Example Response XML

<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="batch_profiles" name="srv"/>
      <argument value="2010-05-18" name="modified_since"/>
    </parameters>
  </request>
  <response>
    <service>batch_profiles</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <batches count="10">
      <batch id="3">
        <campus id="1">Church of Cucumbers</campus>
        <post_date>2011-07-10</post_date>
        <begin_date>2011-07-12</begin_date>
        <end_date>0000-00-00</end_date>
        <in_accounting_package>false</in_accounting_package>
        <status>Open</status>
        <source>Manual Entry</source>
        <transactions>
            <transaction id="11" merchant_transaction_id="">
              <campus id="1">Church of Cucumbers</campus>
              <individual id="2">Mr. Larry</individual>
              <date>2011-07-10</date>
              <grouping id="1">None</grouping>
              <payment_type>Check</payment_type>
              <check_number>20</check_number>
              <transaction_details>
                <transaction_detail id="12">
                  <coa id="1">General Fund - TD</coa>
                  <amount>123</amount>
                  <tax_deductible>true</tax_deductible>
                  <note></note>
                  <creator id="5">Full Financial</creator>
                  <modifier id="5">Full Financial</modifier>
                  <created>2011-07-12 15:13:59</created>
                  <modified>2011-07-12 15:13:59</modified>
                </transaction_detail>
              </transaction_details>
              <creator id="5">Full Financial</creator>
              <modifier id="5">Full Financial</modifier>
              <created>2011-07-12 15:12:12</created>
              <modified>2011-07-12 15:13:59</modified>
              <merchant_name></merchant_name>
              <merchant_individual_id></merchant_individual_id>
            </transaction>
        </transactions>
        <creator id="5">Full Financial</creator>
        <modifier id="5">Full Financial</modifier>
        <created>2011-07-12 15:11:42</created>
        <modified>2011-07-12 15:12:00</modified>
      </batch>
       …
      <batch id="13">
        <campus id="6">ProfitStars</campus>
        <post_date>2012-10-31</post_date>
        <begin_date>2012-10-31</begin_date>
        <end_date>0000-00-00</end_date>
        <in_accounting_package>false</in_accounting_package>
        <status>Closed</status>
        <source>Online</source>
        <transactions>
          <transaction id="21" merchant_transaction_id="">
            <campus id="6">ProfitStars</campus>
            <individual id="7">Bob Tomato</individual>
            <date>2012-10-31</date>
            <grouping id="1">None</grouping>
            <payment_type>Check</payment_type>
            <check_number>004440</check_number>
            <transaction_details>
              <transaction_detail id="22">
                <coa id="5">Online Giving</coa>
                <amount>960</amount>
                <tax_deductible>true</tax_deductible>
                <note></note>
                <creator id="1">Larry Cucumber</creator>
                <modifier id="1">Larry Cucumber</modifier>
                <created>2012-10-31 07:57:40</created>
                <modified>2012-10-31 07:57:40</modified>
              </transaction_detail>
            </transaction_details>
            <creator id="1">Larry Cucumber</creator>
            <modifier id="1">Larry Cucumber</modifier>
            <created>2012-10-31 07:57:40</created>
            <modified>2012-10-31 07:57:40</modified>
            <merchant_name></merchant_name>
            <merchant_individual_id></merchant_individual_id>
          </transaction>
          …
          <transaction id="22" merchant_transaction_id="">
            <campus id="6">ProfitStars</campus>
            <individual id="2">Mr. Lunt</individual>
            <date>2012-10-31</date>
            <grouping id="1">None</grouping>
            <payment_type>Check</payment_type>
            <check_number>000626</check_number>
            <transaction_details>
              <transaction_detail id="23">
                <coa id="5">Online Giving</coa>
                <amount>4797</amount>
                <tax_deductible>true</tax_deductible>
                <note></note>
                <creator id="1">Larry Cucumber</creator>
                <modifier id="1">Larry Cucumber</modifier>
                <created>2012-10-31 07:57:40</created>
                <modified>2012-10-31 07:57:40</modified>
              </transaction_detail>
            </transaction_details>
            <creator id="1">Larry Cucumber</creator>
            <modifier id="1">Larry Cucumber</modifier>
            <created>2012-10-31 07:57:40</created>
            <modified>2012-10-31 07:57:40</modified>
            <merchant_name></merchant_name>
            <merchant_individual_id></merchant_individual_id>
          </transaction>
        </transactions>
        <creator id="1">Larry Cucumber</creator>
        <modifier id="1">Larry Cucumber</modifier>
        <created>2012-10-31 07:57:40</created>
        <modified>2012-10-31 07:57:40</modified>
      </batch>
    </batches>
  </response>
</ccb_api>