wsFundRaising


Click here for a complete list of operations.

payInvoices

Pay Invoices. referenceNumbers is a list of InvoiceReferenceNumbers and must be valid. paymentAmounts is a list of decimals amounts. They must match in number and order to the reference numbers. You can pay less than the amount due but not more than the amount due. batchNumber is a valid open batch number. payment is a payment object, billToID is the bill to id of the person paying. transDateEntered is the date of the transaction. This feature is not available in all versions of iMIS.

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/payInvoices"

<?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>
    <payInvoices xmlns="http://www.atsol.org/wsFundRaising/">
      <referenceNumbers>
        <int>int</int>
        <int>int</int>
      </referenceNumbers>
      <paymentAmounts>
        <decimal>decimal</decimal>
        <decimal>decimal</decimal>
      </paymentAmounts>
      <batchNumber>string</batchNumber>
      <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>
      <billToId>string</billToId>
      <transDateEntered>dateTime</transDateEntered>
    </payInvoices>
  </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>
    <payInvoicesResponse xmlns="http://www.atsol.org/wsFundRaising/">
      <payInvoicesResult>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <Invoices>
          <Invoice>
            <Adjustments>decimal</Adjustments>
            <ARGLAccount>string</ARGLAccount>
            <AvailableDiscount>decimal</AvailableDiscount>
            <Balance>decimal</Balance>
            <BatchNumber>string</BatchNumber>
            <BillToCC>boolean</BillToCC>
            <BillToContactID>string</BillToContactID>
            <Charges>decimal</Charges>
            <Credits>decimal</Credits>
            <CreditStatus>string</CreditStatus>
            <CustomerName>string</CustomerName>
            <CustomerReference>string</CustomerReference>
            <Description>string</Description>
            <DiscountDate>dateTime</DiscountDate>
            <DueDate>dateTime</DueDate>
            <EffectiveDate>dateTime</EffectiveDate>
            <FinancialEntityCode>string</FinancialEntityCode>
            <HasBeenBilled>boolean</HasBeenBilled>
            <InstallmentBillDate>dateTime</InstallmentBillDate>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceNumber>int</InvoiceNumber>
            <InvoiceTypeCode>string</InvoiceTypeCode>
            <IsMultiOrg>boolean</IsMultiOrg>
            <Note>string</Note>
            <NumLines>int</NumLines>
            <OriginatingTransNumber>int</OriginatingTransNumber>
            <ReferenceNumber>int</ReferenceNumber>
            <ShipToContactID>string</ShipToContactID>
            <SourceCode>string</SourceCode>
            <SourceSystem>string</SourceSystem>
            <TermsCode>string</TermsCode>
            <TransactionLines xsi:nil="true" />
          </Invoice>
          <Invoice>
            <Adjustments>decimal</Adjustments>
            <ARGLAccount>string</ARGLAccount>
            <AvailableDiscount>decimal</AvailableDiscount>
            <Balance>decimal</Balance>
            <BatchNumber>string</BatchNumber>
            <BillToCC>boolean</BillToCC>
            <BillToContactID>string</BillToContactID>
            <Charges>decimal</Charges>
            <Credits>decimal</Credits>
            <CreditStatus>string</CreditStatus>
            <CustomerName>string</CustomerName>
            <CustomerReference>string</CustomerReference>
            <Description>string</Description>
            <DiscountDate>dateTime</DiscountDate>
            <DueDate>dateTime</DueDate>
            <EffectiveDate>dateTime</EffectiveDate>
            <FinancialEntityCode>string</FinancialEntityCode>
            <HasBeenBilled>boolean</HasBeenBilled>
            <InstallmentBillDate>dateTime</InstallmentBillDate>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceNumber>int</InvoiceNumber>
            <InvoiceTypeCode>string</InvoiceTypeCode>
            <IsMultiOrg>boolean</IsMultiOrg>
            <Note>string</Note>
            <NumLines>int</NumLines>
            <OriginatingTransNumber>int</OriginatingTransNumber>
            <ReferenceNumber>int</ReferenceNumber>
            <ShipToContactID>string</ShipToContactID>
            <SourceCode>string</SourceCode>
            <SourceSystem>string</SourceSystem>
            <TermsCode>string</TermsCode>
            <TransactionLines xsi:nil="true" />
          </Invoice>
        </Invoices>
      </payInvoicesResult>
    </payInvoicesResponse>
  </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>
    <payInvoices xmlns="http://www.atsol.org/wsFundRaising/">
      <referenceNumbers>
        <int>int</int>
        <int>int</int>
      </referenceNumbers>
      <paymentAmounts>
        <decimal>decimal</decimal>
        <decimal>decimal</decimal>
      </paymentAmounts>
      <batchNumber>string</batchNumber>
      <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>
      <billToId>string</billToId>
      <transDateEntered>dateTime</transDateEntered>
    </payInvoices>
  </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>
    <payInvoicesResponse xmlns="http://www.atsol.org/wsFundRaising/">
      <payInvoicesResult>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <Invoices>
          <Invoice>
            <Adjustments>decimal</Adjustments>
            <ARGLAccount>string</ARGLAccount>
            <AvailableDiscount>decimal</AvailableDiscount>
            <Balance>decimal</Balance>
            <BatchNumber>string</BatchNumber>
            <BillToCC>boolean</BillToCC>
            <BillToContactID>string</BillToContactID>
            <Charges>decimal</Charges>
            <Credits>decimal</Credits>
            <CreditStatus>string</CreditStatus>
            <CustomerName>string</CustomerName>
            <CustomerReference>string</CustomerReference>
            <Description>string</Description>
            <DiscountDate>dateTime</DiscountDate>
            <DueDate>dateTime</DueDate>
            <EffectiveDate>dateTime</EffectiveDate>
            <FinancialEntityCode>string</FinancialEntityCode>
            <HasBeenBilled>boolean</HasBeenBilled>
            <InstallmentBillDate>dateTime</InstallmentBillDate>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceNumber>int</InvoiceNumber>
            <InvoiceTypeCode>string</InvoiceTypeCode>
            <IsMultiOrg>boolean</IsMultiOrg>
            <Note>string</Note>
            <NumLines>int</NumLines>
            <OriginatingTransNumber>int</OriginatingTransNumber>
            <ReferenceNumber>int</ReferenceNumber>
            <ShipToContactID>string</ShipToContactID>
            <SourceCode>string</SourceCode>
            <SourceSystem>string</SourceSystem>
            <TermsCode>string</TermsCode>
            <TransactionLines xsi:nil="true" />
          </Invoice>
          <Invoice>
            <Adjustments>decimal</Adjustments>
            <ARGLAccount>string</ARGLAccount>
            <AvailableDiscount>decimal</AvailableDiscount>
            <Balance>decimal</Balance>
            <BatchNumber>string</BatchNumber>
            <BillToCC>boolean</BillToCC>
            <BillToContactID>string</BillToContactID>
            <Charges>decimal</Charges>
            <Credits>decimal</Credits>
            <CreditStatus>string</CreditStatus>
            <CustomerName>string</CustomerName>
            <CustomerReference>string</CustomerReference>
            <Description>string</Description>
            <DiscountDate>dateTime</DiscountDate>
            <DueDate>dateTime</DueDate>
            <EffectiveDate>dateTime</EffectiveDate>
            <FinancialEntityCode>string</FinancialEntityCode>
            <HasBeenBilled>boolean</HasBeenBilled>
            <InstallmentBillDate>dateTime</InstallmentBillDate>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceNumber>int</InvoiceNumber>
            <InvoiceTypeCode>string</InvoiceTypeCode>
            <IsMultiOrg>boolean</IsMultiOrg>
            <Note>string</Note>
            <NumLines>int</NumLines>
            <OriginatingTransNumber>int</OriginatingTransNumber>
            <ReferenceNumber>int</ReferenceNumber>
            <ShipToContactID>string</ShipToContactID>
            <SourceCode>string</SourceCode>
            <SourceSystem>string</SourceSystem>
            <TermsCode>string</TermsCode>
            <TransactionLines xsi:nil="true" />
          </Invoice>
        </Invoices>
      </payInvoicesResult>
    </payInvoicesResponse>
  </soap12:Body>
</soap12:Envelope>