Api Web Service

Api

Click here for a complete list of operations.

GetTransactions

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.bisglobal.net/GetTransactions"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTransactions xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <Transaction_Id>long</Transaction_Id>
        <Contact_Id>long</Contact_Id>
        <IsPaid>boolean</IsPaid>
        <Form_Id>long</Form_Id>
        <Category_Id>int</Category_Id>
        <Sustainer_Id>long</Sustainer_Id>
        <Pledge_Id>long</Pledge_Id>
        <Membership_Id>long</Membership_Id>
        <Amount_From>double</Amount_From>
        <Amount_To>double</Amount_To>
        <OrganizationName>string</OrganizationName>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <EmailAddress>string</EmailAddress>
        <AddressCity>string</AddressCity>
        <AddressStateProvince_Id>int</AddressStateProvince_Id>
        <AddressPostalCode>string</AddressPostalCode>
        <AddressCountry_Id>int</AddressCountry_Id>
        <PaymentMethod_Id>int</PaymentMethod_Id>
        <GeneralLedgerCode_Id>long</GeneralLedgerCode_Id>
        <Fund_Id>long</Fund_Id>
        <CampaignInitiative_Id>long</CampaignInitiative_Id>
        <ResponseChannel_Id>long</ResponseChannel_Id>
        <Tribute_Id>long</Tribute_Id>
        <Event_Id>long</Event_Id>
        <GrassrootsEvent_Id>long</GrassrootsEvent_Id>
        <P2PPage_Id>long</P2PPage_Id>
        <P2PTeam_Id>long</P2PTeam_Id>
        <P2PMicrosite_Id>long</P2PMicrosite_Id>
        <TransactionDate_From>dateTime</TransactionDate_From>
        <TransactionDate_To>dateTime</TransactionDate_To>
        <DateCreated_From>dateTime</DateCreated_From>
        <DateCreated_To>dateTime</DateCreated_To>
        <DateModified_From>dateTime</DateModified_From>
        <DateModified_To>dateTime</DateModified_To>
      </queryParameters>
    </GetTransactions>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTransactionsResponse xmlns="https://api.bisglobal.net/">
      <GetTransactionsResult>
        <AuthenticationContext_Id>long</AuthenticationContext_Id>
        <Transactions>
          <Transaction Transaction_Id="long" TransactionDate="dateTime" Form_Id="long" FormView_Id="long" Amount="double" TaxDeductibleAmount="double" TicketSaleAmount="double" Confirmed="boolean" CheckNumber="string" PaymentResultCode="string" PaymentResultMessage="string" CreditCardNumberLastFour="string" AchAccountNumberLastFour="string" IPAddress="string" Promo_Id="int" PromoCode_Id="int" MakeAnonymous="boolean" HideAmountOnline="boolean" IsRefunded="boolean" RefundedTransaction_Id="long" DateCreated="string" DateModified="string" TransactionBatch_Id="int">
            <Contact xsi:nil="true" />
            <Category xsi:nil="true" />
            <PaymentMethod xsi:nil="true" />
            <ContactInfo xsi:nil="true" />
            <BillingDetail xsi:nil="true" />
            <RelatedOrganization xsi:nil="true" />
            <ElectronicTransactionType xsi:nil="true" />
            <Sustainer_Id>long</Sustainer_Id>
            <Pledge_Id>long</Pledge_Id>
            <Membership_Id>long</Membership_Id>
            <Invoice_Id>long</Invoice_Id>
            <Attribution xsi:nil="true" />
            <DisplayNameOnlineAs>string</DisplayNameOnlineAs>
          </Transaction>
          <Transaction Transaction_Id="long" TransactionDate="dateTime" Form_Id="long" FormView_Id="long" Amount="double" TaxDeductibleAmount="double" TicketSaleAmount="double" Confirmed="boolean" CheckNumber="string" PaymentResultCode="string" PaymentResultMessage="string" CreditCardNumberLastFour="string" AchAccountNumberLastFour="string" IPAddress="string" Promo_Id="int" PromoCode_Id="int" MakeAnonymous="boolean" HideAmountOnline="boolean" IsRefunded="boolean" RefundedTransaction_Id="long" DateCreated="string" DateModified="string" TransactionBatch_Id="int">
            <Contact xsi:nil="true" />
            <Category xsi:nil="true" />
            <PaymentMethod xsi:nil="true" />
            <ContactInfo xsi:nil="true" />
            <BillingDetail xsi:nil="true" />
            <RelatedOrganization xsi:nil="true" />
            <ElectronicTransactionType xsi:nil="true" />
            <Sustainer_Id>long</Sustainer_Id>
            <Pledge_Id>long</Pledge_Id>
            <Membership_Id>long</Membership_Id>
            <Invoice_Id>long</Invoice_Id>
            <Attribution xsi:nil="true" />
            <DisplayNameOnlineAs>string</DisplayNameOnlineAs>
          </Transaction>
        </Transactions>
      </GetTransactionsResult>
    </GetTransactionsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetTransactions xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <Transaction_Id>long</Transaction_Id>
        <Contact_Id>long</Contact_Id>
        <IsPaid>boolean</IsPaid>
        <Form_Id>long</Form_Id>
        <Category_Id>int</Category_Id>
        <Sustainer_Id>long</Sustainer_Id>
        <Pledge_Id>long</Pledge_Id>
        <Membership_Id>long</Membership_Id>
        <Amount_From>double</Amount_From>
        <Amount_To>double</Amount_To>
        <OrganizationName>string</OrganizationName>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <EmailAddress>string</EmailAddress>
        <AddressCity>string</AddressCity>
        <AddressStateProvince_Id>int</AddressStateProvince_Id>
        <AddressPostalCode>string</AddressPostalCode>
        <AddressCountry_Id>int</AddressCountry_Id>
        <PaymentMethod_Id>int</PaymentMethod_Id>
        <GeneralLedgerCode_Id>long</GeneralLedgerCode_Id>
        <Fund_Id>long</Fund_Id>
        <CampaignInitiative_Id>long</CampaignInitiative_Id>
        <ResponseChannel_Id>long</ResponseChannel_Id>
        <Tribute_Id>long</Tribute_Id>
        <Event_Id>long</Event_Id>
        <GrassrootsEvent_Id>long</GrassrootsEvent_Id>
        <P2PPage_Id>long</P2PPage_Id>
        <P2PTeam_Id>long</P2PTeam_Id>
        <P2PMicrosite_Id>long</P2PMicrosite_Id>
        <TransactionDate_From>dateTime</TransactionDate_From>
        <TransactionDate_To>dateTime</TransactionDate_To>
        <DateCreated_From>dateTime</DateCreated_From>
        <DateCreated_To>dateTime</DateCreated_To>
        <DateModified_From>dateTime</DateModified_From>
        <DateModified_To>dateTime</DateModified_To>
      </queryParameters>
    </GetTransactions>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetTransactionsResponse xmlns="https://api.bisglobal.net/">
      <GetTransactionsResult>
        <AuthenticationContext_Id>long</AuthenticationContext_Id>
        <Transactions>
          <Transaction Transaction_Id="long" TransactionDate="dateTime" Form_Id="long" FormView_Id="long" Amount="double" TaxDeductibleAmount="double" TicketSaleAmount="double" Confirmed="boolean" CheckNumber="string" PaymentResultCode="string" PaymentResultMessage="string" CreditCardNumberLastFour="string" AchAccountNumberLastFour="string" IPAddress="string" Promo_Id="int" PromoCode_Id="int" MakeAnonymous="boolean" HideAmountOnline="boolean" IsRefunded="boolean" RefundedTransaction_Id="long" DateCreated="string" DateModified="string" TransactionBatch_Id="int">
            <Contact xsi:nil="true" />
            <Category xsi:nil="true" />
            <PaymentMethod xsi:nil="true" />
            <ContactInfo xsi:nil="true" />
            <BillingDetail xsi:nil="true" />
            <RelatedOrganization xsi:nil="true" />
            <ElectronicTransactionType xsi:nil="true" />
            <Sustainer_Id>long</Sustainer_Id>
            <Pledge_Id>long</Pledge_Id>
            <Membership_Id>long</Membership_Id>
            <Invoice_Id>long</Invoice_Id>
            <Attribution xsi:nil="true" />
            <DisplayNameOnlineAs>string</DisplayNameOnlineAs>
          </Transaction>
          <Transaction Transaction_Id="long" TransactionDate="dateTime" Form_Id="long" FormView_Id="long" Amount="double" TaxDeductibleAmount="double" TicketSaleAmount="double" Confirmed="boolean" CheckNumber="string" PaymentResultCode="string" PaymentResultMessage="string" CreditCardNumberLastFour="string" AchAccountNumberLastFour="string" IPAddress="string" Promo_Id="int" PromoCode_Id="int" MakeAnonymous="boolean" HideAmountOnline="boolean" IsRefunded="boolean" RefundedTransaction_Id="long" DateCreated="string" DateModified="string" TransactionBatch_Id="int">
            <Contact xsi:nil="true" />
            <Category xsi:nil="true" />
            <PaymentMethod xsi:nil="true" />
            <ContactInfo xsi:nil="true" />
            <BillingDetail xsi:nil="true" />
            <RelatedOrganization xsi:nil="true" />
            <ElectronicTransactionType xsi:nil="true" />
            <Sustainer_Id>long</Sustainer_Id>
            <Pledge_Id>long</Pledge_Id>
            <Membership_Id>long</Membership_Id>
            <Invoice_Id>long</Invoice_Id>
            <Attribution xsi:nil="true" />
            <DisplayNameOnlineAs>string</DisplayNameOnlineAs>
          </Transaction>
        </Transactions>
      </GetTransactionsResult>
    </GetTransactionsResponse>
  </soap12:Body>
</soap12:Envelope>