wsFundRaising


Click here for a complete list of operations.

processFundraising

Processes a donation. If isPledge is set to true, the PaymentAmount is optional if you don't want to apply a payment. However, if you do apply a payment it must be equal to the first installment which is determined by the PaymentTermsName. For a pledge PaymentTermsName is a predefined payment terms value from iMIS. The FirstInstallmentBillDate is the date of the first installment.

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 /WebServices/wsFundraising.asmx HTTP/1.1
Host: demo.atsol.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.atsol.org/wsFundRaising/processFundraising"

<?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>
    <processFundraising xmlns="http://www.atsol.org/wsFundRaising/">
      <striMISID>string</striMISID>
      <strFundCode>string</strFundCode>
      <strDistributionCode>string</strDistributionCode>
      <strCampaign>string</strCampaign>
      <strAppeal>string</strAppeal>
      <GiftAmount>decimal</GiftAmount>
      <PaymentAmount>decimal</PaymentAmount>
      <IsPledge>boolean</IsPledge>
      <strBatch>string</strBatch>
      <strGiftNote>string</strGiftNote>
      <strListAs>string</strListAs>
      <strMemorialTributeID>string</strMemorialTributeID>
      <strMemorialTributeName>string</strMemorialTributeName>
      <strPaymentTermsName>string</strPaymentTermsName>
      <dtFirstInstallmentBillDate>dateTime</dtFirstInstallmentBillDate>
      <strSoftCreditContactID>string</strSoftCreditContactID>
      <strSolicitorContactID>string</strSolicitorContactID>
      <strGiftSourceCode>string</strGiftSourceCode>
      <payment>
        <Amount>decimal</Amount>
        <CashAccountCode>string</CashAccountCode>
        <CheckPOPaymentNumber>string</CheckPOPaymentNumber>
        <ClassicPayType>string</ClassicPayType>
        <CreditCardExpiration>string</CreditCardExpiration>
        <CreditCardExpirationEncrypted>string</CreditCardExpirationEncrypted>
        <CreditCardExpirationMasked>string</CreditCardExpirationMasked>
        <CreditCardNumber>string</CreditCardNumber>
        <CreditCardSecurityCode>string</CreditCardSecurityCode>
        <CreditCardSecurityCodeEncrypted>string</CreditCardSecurityCodeEncrypted>
        <CreditDebitCardAuthorizationCode>string</CreditDebitCardAuthorizationCode>
        <CreditDebitCardHoldersName>string</CreditDebitCardHoldersName>
        <CreditDebitCardNumberEncrypted>string</CreditDebitCardNumberEncrypted>
        <CreditDebitCardNumberMasked>string</CreditDebitCardNumberMasked>
        <CreditDebitCardStatus>string</CreditDebitCardStatus>
        <CurrencyCode>string</CurrencyCode>
        <DebitCardIssueDate>string</DebitCardIssueDate>
        <DebitCardIssueNumber>string</DebitCardIssueNumber>
        <DebitCardNumber>string</DebitCardNumber>
        <IsAmountLocked>boolean</IsAmountLocked>
        <OriginalTransactionId>string</OriginalTransactionId>
        <OrderNumber>double</OrderNumber>
        <PaymentToken>string</PaymentToken>
        <PaymentTokenSummary>string</PaymentTokenSummary>
        <PaymentType>Cash or CreditCard or Check or PurchaseOrder or InKind or Other or DebitCard or Unknown</PaymentType>
        <ReferenceNumber>string</ReferenceNumber>
        <TransactionComment1>string</TransactionComment1>
        <TransactionComment2>string</TransactionComment2>
        <TransactionId>string</TransactionId>
        <Address>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <AddressFormatCode>int</AddressFormatCode>
          <AddressNumber>int</AddressNumber>
          <AddressPurpose>string</AddressPurpose>
          <BadAddressReasonCode>string</BadAddressReasonCode>
          <BadAddressReasonDescription>string</BadAddressReasonDescription>
          <Barcode>string</Barcode>
          <CarrierRoute>string</CarrierRoute>
          <City>string</City>
          <ContactId>string</ContactId>
          <Country>string</Country>
          <County>string</County>
          <DeliveryPointBarcode>string</DeliveryPointBarcode>
          <Directions>string</Directions>
          <EmailAddress>string</EmailAddress>
          <Fax>string</Fax>
          <FormattedAddress>string</FormattedAddress>
          <InstituteName>string</InstituteName>
          <IsPreferredBill>boolean</IsPreferredBill>
          <IsPreferredMail>boolean</IsPreferredMail>
          <IsPreferredShip>boolean</IsPreferredShip>
          <LastQASBatchDateTime>dateTime</LastQASBatchDateTime>
          <LastVerifiedOn>dateTime</LastVerifiedOn>
          <LocalGovernmentDistrict1>string</LocalGovernmentDistrict1>
          <LocalGovernmentDistrict2>string</LocalGovernmentDistrict2>
          <MailCode>string</MailCode>
          <NationalGovernmentDistrict>string</NationalGovernmentDistrict>
          <Note>string</Note>
          <Phone>string</Phone>
          <PostalCode>string</PostalCode>
          <SkipAutoVerifyFlag>boolean</SkipAutoVerifyFlag>
          <StateProvince>string</StateProvince>
          <TollFree>string</TollFree>
          <UpdatedOn>dateTime</UpdatedOn>
        </Address>
      </payment>
    </processFundraising>
  </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>
    <processFundraisingResponse xmlns="http://www.atsol.org/wsFundRaising/">
      <processFundraisingResult>
        <Distributions>
          <Distribution>
            <AppealCode>string</AppealCode>
            <ApplyImageFlag>boolean</ApplyImageFlag>
            <ApplyInfoFlag>boolean</ApplyInfoFlag>
            <CampaignCode>string</CampaignCode>
            <CatalogDescription>string</CatalogDescription>
            <DeferredIncomeAccount>string</DeferredIncomeAccount>
            <Description>string</Description>
            <FairMarketValue>decimal</FairMarketValue>
            <FinancialEntityCode>string</FinancialEntityCode>
            <FundCode>string</FundCode>
            <FundRaisingType>string</FundRaisingType>
            <GiftAmount>decimal</GiftAmount>
            <ImageUrl>string</ImageUrl>
            <IncomeAccount>string</IncomeAccount>
            <InfoUrl>string</InfoUrl>
            <IsKit>boolean</IsKit>
            <IsPSTTaxable>boolean</IsPSTTaxable>
            <IsStockItem>boolean</IsStockItem>
            <IsTaxable>boolean</IsTaxable>
            <LetterTitle>string</LetterTitle>
            <Note>string</Note>
            <OtherDescription>string</OtherDescription>
            <ProductCode>string</ProductCode>
            <ProductMajor>string</ProductMajor>
            <ProductMinor>string</ProductMinor>
            <ProductTypeCode>string</ProductTypeCode>
            <PromoteProductFlag>boolean</PromoteProductFlag>
            <SellOnWeb>boolean</SellOnWeb>
            <StatusCode>string</StatusCode>
            <TaxableValue>decimal</TaxableValue>
            <TaxAuthorityCode>string</TaxAuthorityCode>
            <ThumbnailFlag>boolean</ThumbnailFlag>
            <ThumbnailUrl>string</ThumbnailUrl>
            <Title>string</Title>
            <ViewOnWeb>boolean</ViewOnWeb>
            <WebDescription>string</WebDescription>
            <WebOption>DoNotShow or ViewOnWeb or SellOnWeb</WebOption>
          </Distribution>
          <Distribution>
            <AppealCode>string</AppealCode>
            <ApplyImageFlag>boolean</ApplyImageFlag>
            <ApplyInfoFlag>boolean</ApplyInfoFlag>
            <CampaignCode>string</CampaignCode>
            <CatalogDescription>string</CatalogDescription>
            <DeferredIncomeAccount>string</DeferredIncomeAccount>
            <Description>string</Description>
            <FairMarketValue>decimal</FairMarketValue>
            <FinancialEntityCode>string</FinancialEntityCode>
            <FundCode>string</FundCode>
            <FundRaisingType>string</FundRaisingType>
            <GiftAmount>decimal</GiftAmount>
            <ImageUrl>string</ImageUrl>
            <IncomeAccount>string</IncomeAccount>
            <InfoUrl>string</InfoUrl>
            <IsKit>boolean</IsKit>
            <IsPSTTaxable>boolean</IsPSTTaxable>
            <IsStockItem>boolean</IsStockItem>
            <IsTaxable>boolean</IsTaxable>
            <LetterTitle>string</LetterTitle>
            <Note>string</Note>
            <OtherDescription>string</OtherDescription>
            <ProductCode>string</ProductCode>
            <ProductMajor>string</ProductMajor>
            <ProductMinor>string</ProductMinor>
            <ProductTypeCode>string</ProductTypeCode>
            <PromoteProductFlag>boolean</PromoteProductFlag>
            <SellOnWeb>boolean</SellOnWeb>
            <StatusCode>string</StatusCode>
            <TaxableValue>decimal</TaxableValue>
            <TaxAuthorityCode>string</TaxAuthorityCode>
            <ThumbnailFlag>boolean</ThumbnailFlag>
            <ThumbnailUrl>string</ThumbnailUrl>
            <Title>string</Title>
            <ViewOnWeb>boolean</ViewOnWeb>
            <WebDescription>string</WebDescription>
            <WebOption>DoNotShow or ViewOnWeb or SellOnWeb</WebOption>
          </Distribution>
        </Distributions>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
        <TransactionID>string</TransactionID>
      </processFundraisingResult>
    </processFundraisingResponse>
  </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 /WebServices/wsFundraising.asmx HTTP/1.1
Host: demo.atsol.org
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>
    <processFundraising xmlns="http://www.atsol.org/wsFundRaising/">
      <striMISID>string</striMISID>
      <strFundCode>string</strFundCode>
      <strDistributionCode>string</strDistributionCode>
      <strCampaign>string</strCampaign>
      <strAppeal>string</strAppeal>
      <GiftAmount>decimal</GiftAmount>
      <PaymentAmount>decimal</PaymentAmount>
      <IsPledge>boolean</IsPledge>
      <strBatch>string</strBatch>
      <strGiftNote>string</strGiftNote>
      <strListAs>string</strListAs>
      <strMemorialTributeID>string</strMemorialTributeID>
      <strMemorialTributeName>string</strMemorialTributeName>
      <strPaymentTermsName>string</strPaymentTermsName>
      <dtFirstInstallmentBillDate>dateTime</dtFirstInstallmentBillDate>
      <strSoftCreditContactID>string</strSoftCreditContactID>
      <strSolicitorContactID>string</strSolicitorContactID>
      <strGiftSourceCode>string</strGiftSourceCode>
      <payment>
        <Amount>decimal</Amount>
        <CashAccountCode>string</CashAccountCode>
        <CheckPOPaymentNumber>string</CheckPOPaymentNumber>
        <ClassicPayType>string</ClassicPayType>
        <CreditCardExpiration>string</CreditCardExpiration>
        <CreditCardExpirationEncrypted>string</CreditCardExpirationEncrypted>
        <CreditCardExpirationMasked>string</CreditCardExpirationMasked>
        <CreditCardNumber>string</CreditCardNumber>
        <CreditCardSecurityCode>string</CreditCardSecurityCode>
        <CreditCardSecurityCodeEncrypted>string</CreditCardSecurityCodeEncrypted>
        <CreditDebitCardAuthorizationCode>string</CreditDebitCardAuthorizationCode>
        <CreditDebitCardHoldersName>string</CreditDebitCardHoldersName>
        <CreditDebitCardNumberEncrypted>string</CreditDebitCardNumberEncrypted>
        <CreditDebitCardNumberMasked>string</CreditDebitCardNumberMasked>
        <CreditDebitCardStatus>string</CreditDebitCardStatus>
        <CurrencyCode>string</CurrencyCode>
        <DebitCardIssueDate>string</DebitCardIssueDate>
        <DebitCardIssueNumber>string</DebitCardIssueNumber>
        <DebitCardNumber>string</DebitCardNumber>
        <IsAmountLocked>boolean</IsAmountLocked>
        <OriginalTransactionId>string</OriginalTransactionId>
        <OrderNumber>double</OrderNumber>
        <PaymentToken>string</PaymentToken>
        <PaymentTokenSummary>string</PaymentTokenSummary>
        <PaymentType>Cash or CreditCard or Check or PurchaseOrder or InKind or Other or DebitCard or Unknown</PaymentType>
        <ReferenceNumber>string</ReferenceNumber>
        <TransactionComment1>string</TransactionComment1>
        <TransactionComment2>string</TransactionComment2>
        <TransactionId>string</TransactionId>
        <Address>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <AddressFormatCode>int</AddressFormatCode>
          <AddressNumber>int</AddressNumber>
          <AddressPurpose>string</AddressPurpose>
          <BadAddressReasonCode>string</BadAddressReasonCode>
          <BadAddressReasonDescription>string</BadAddressReasonDescription>
          <Barcode>string</Barcode>
          <CarrierRoute>string</CarrierRoute>
          <City>string</City>
          <ContactId>string</ContactId>
          <Country>string</Country>
          <County>string</County>
          <DeliveryPointBarcode>string</DeliveryPointBarcode>
          <Directions>string</Directions>
          <EmailAddress>string</EmailAddress>
          <Fax>string</Fax>
          <FormattedAddress>string</FormattedAddress>
          <InstituteName>string</InstituteName>
          <IsPreferredBill>boolean</IsPreferredBill>
          <IsPreferredMail>boolean</IsPreferredMail>
          <IsPreferredShip>boolean</IsPreferredShip>
          <LastQASBatchDateTime>dateTime</LastQASBatchDateTime>
          <LastVerifiedOn>dateTime</LastVerifiedOn>
          <LocalGovernmentDistrict1>string</LocalGovernmentDistrict1>
          <LocalGovernmentDistrict2>string</LocalGovernmentDistrict2>
          <MailCode>string</MailCode>
          <NationalGovernmentDistrict>string</NationalGovernmentDistrict>
          <Note>string</Note>
          <Phone>string</Phone>
          <PostalCode>string</PostalCode>
          <SkipAutoVerifyFlag>boolean</SkipAutoVerifyFlag>
          <StateProvince>string</StateProvince>
          <TollFree>string</TollFree>
          <UpdatedOn>dateTime</UpdatedOn>
        </Address>
      </payment>
    </processFundraising>
  </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>
    <processFundraisingResponse xmlns="http://www.atsol.org/wsFundRaising/">
      <processFundraisingResult>
        <Distributions>
          <Distribution>
            <AppealCode>string</AppealCode>
            <ApplyImageFlag>boolean</ApplyImageFlag>
            <ApplyInfoFlag>boolean</ApplyInfoFlag>
            <CampaignCode>string</CampaignCode>
            <CatalogDescription>string</CatalogDescription>
            <DeferredIncomeAccount>string</DeferredIncomeAccount>
            <Description>string</Description>
            <FairMarketValue>decimal</FairMarketValue>
            <FinancialEntityCode>string</FinancialEntityCode>
            <FundCode>string</FundCode>
            <FundRaisingType>string</FundRaisingType>
            <GiftAmount>decimal</GiftAmount>
            <ImageUrl>string</ImageUrl>
            <IncomeAccount>string</IncomeAccount>
            <InfoUrl>string</InfoUrl>
            <IsKit>boolean</IsKit>
            <IsPSTTaxable>boolean</IsPSTTaxable>
            <IsStockItem>boolean</IsStockItem>
            <IsTaxable>boolean</IsTaxable>
            <LetterTitle>string</LetterTitle>
            <Note>string</Note>
            <OtherDescription>string</OtherDescription>
            <ProductCode>string</ProductCode>
            <ProductMajor>string</ProductMajor>
            <ProductMinor>string</ProductMinor>
            <ProductTypeCode>string</ProductTypeCode>
            <PromoteProductFlag>boolean</PromoteProductFlag>
            <SellOnWeb>boolean</SellOnWeb>
            <StatusCode>string</StatusCode>
            <TaxableValue>decimal</TaxableValue>
            <TaxAuthorityCode>string</TaxAuthorityCode>
            <ThumbnailFlag>boolean</ThumbnailFlag>
            <ThumbnailUrl>string</ThumbnailUrl>
            <Title>string</Title>
            <ViewOnWeb>boolean</ViewOnWeb>
            <WebDescription>string</WebDescription>
            <WebOption>DoNotShow or ViewOnWeb or SellOnWeb</WebOption>
          </Distribution>
          <Distribution>
            <AppealCode>string</AppealCode>
            <ApplyImageFlag>boolean</ApplyImageFlag>
            <ApplyInfoFlag>boolean</ApplyInfoFlag>
            <CampaignCode>string</CampaignCode>
            <CatalogDescription>string</CatalogDescription>
            <DeferredIncomeAccount>string</DeferredIncomeAccount>
            <Description>string</Description>
            <FairMarketValue>decimal</FairMarketValue>
            <FinancialEntityCode>string</FinancialEntityCode>
            <FundCode>string</FundCode>
            <FundRaisingType>string</FundRaisingType>
            <GiftAmount>decimal</GiftAmount>
            <ImageUrl>string</ImageUrl>
            <IncomeAccount>string</IncomeAccount>
            <InfoUrl>string</InfoUrl>
            <IsKit>boolean</IsKit>
            <IsPSTTaxable>boolean</IsPSTTaxable>
            <IsStockItem>boolean</IsStockItem>
            <IsTaxable>boolean</IsTaxable>
            <LetterTitle>string</LetterTitle>
            <Note>string</Note>
            <OtherDescription>string</OtherDescription>
            <ProductCode>string</ProductCode>
            <ProductMajor>string</ProductMajor>
            <ProductMinor>string</ProductMinor>
            <ProductTypeCode>string</ProductTypeCode>
            <PromoteProductFlag>boolean</PromoteProductFlag>
            <SellOnWeb>boolean</SellOnWeb>
            <StatusCode>string</StatusCode>
            <TaxableValue>decimal</TaxableValue>
            <TaxAuthorityCode>string</TaxAuthorityCode>
            <ThumbnailFlag>boolean</ThumbnailFlag>
            <ThumbnailUrl>string</ThumbnailUrl>
            <Title>string</Title>
            <ViewOnWeb>boolean</ViewOnWeb>
            <WebDescription>string</WebDescription>
            <WebOption>DoNotShow or ViewOnWeb or SellOnWeb</WebOption>
          </Distribution>
        </Distributions>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
        <TransactionID>string</TransactionID>
      </processFundraisingResult>
    </processFundraisingResponse>
  </soap12:Body>
</soap12:Envelope>