PAYMENT

Overview
The BillingPlatform webservice API allows you to create payments in your application. Please note additional steps may be needed after payment creation in order to apply the payment (or portions of the payment) to actual invoices.

For more information on payments please see here.

Payment entries contain the option to auto-allocate the payment. If this option is enabled then the payment funds will be distributed from the oldest to newest closed invoices (in the order) until funds run out. If all invoices are paid and funds still remain in the payment then they will sit in "unallocated" status. If amounts remain in unallocated status they will be applied to the next invoice that is closed.

If you choose not to auto-allocate funds then you may manually allocate amounts to closed invoices using the payment allocation entity. This option allows you to manually decide where the payment funds will be applied. Follow the link for more information on manually allocating payments.

If your application is configured to process credit card payments through a merchant (paypal, authorize.net, etc.) then the system will attempt to charge the credit card on the billing profile after the payment is created. If the card is declined, the payment will return 0 for the payment amount.

System Entity Name

PAYMENT
Allowed Functions

Create Update Retrieve Delete Upsert
YES YES YES NO YES



Fields

Field Data Type Properties Description
Amount decimal required Enter the amount for the new payment.  This should be enough to cover all allocations needed.
Autoallocate string   This flag allows you to set the system to handle the allocation automatically.  If set to 1, funds will be distributed to the oldest to newest closed invoices (in that order) until funds run out.
BillingProfileObj BILLING_PROFILE   Object in which to contain the billing profile object this payment will belong to.
BillingProfileId decimal   Enter the billing profile id for the billing profile this payment will belong to.
InvoiceIdDisplay decimal    
PaymentDate dateTime required Enter the date this payment was made.
PaymentNote string required Enter a descriptive note for the payment.  This can include check numbers, transfer information, etc.
PaymentType string   Enter the type for the payment.  These types are configured in the application.
UnallocatedAmount decimal    
VoidedAmount decimal    



Sample Requests
Create

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>cZZRIteVgWBZmWPzEXpYYZZujRhbTBuSZOGIJzKj</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <urn:create xmlns:tns="http://schemas.xmlsoap.org/soap/encoding/" xmlns="urn:stronglytyped.soap.brmsystems.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <!--Optional:-->
         <urn:brmObjects xsi:type="PAYMENT">
            <!--Zero or more repetitions:-->
            <Amount>100</Amount>
            <BillingProfileObj>
        <Id>7471</Id>
        </BillingProfileObj>
        <Autoallocate>1</Autoallocate>
        <PaymentDate>2014-04-01T00:00:00.000Z</PaymentDate>
        <PaymentNote>Test Webservice</PaymentNote>
        <PaymentType>CHECK</PaymentType>
         </urn:brmObjects>
      </urn:create>
   </soapenv:Body>
</soapenv:Envelope>



Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:createResponse>
         <urn:result>
            <urn:ErrorCode>0</urn:ErrorCode>
            <urn:ErrorText></urn:ErrorText>
            <urn:ErrorElementField></urn:ErrorElementField>
            <urn:Id>413954</urn:Id>
         </urn:result>
      </urn:createResponse>
   </soapenv:Body>
</soapenv:Envelope>




Update

Request

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>cZZRIteVgWBZmWPzEXpYYZZujRhbTBuSZOGIJzKj</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn:update xmlns="urn:stronglytyped.soap.brmsystems.com">
         <!--Optional:-->
         <urn:brmObjects xsi:type="PAYMENT">
            <Id>413954</Id>
            <PaymentDate>2014-03-30T00:00:00</PaymentDate>
            <PaymentNote>Updated payment date</PaymentNote>
         </urn:brmObjects>
      </urn:update>
   </soapenv:Body>
</soapenv:Envelope>

Response

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:updateResponse>
         <urn:result>
            <urn:ErrorCode>0</urn:ErrorCode>
            <urn:ErrorText></urn:ErrorText>
            <urn:ErrorElementField></urn:ErrorElementField>
            <urn:Id>413954</urn:Id>
         </urn:result>
      </urn:updateResponse>
   </soapenv:Body>
</soapenv:Envelope>

Retrieve

Request

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>cZZRIteVgWBZmWPzEXpYYZZujRhbTBuSZOGIJzKj</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn:retrieve xmlns="urn:stronglytyped.soap.brmsystems.com">
         <urn:brmObjectType>PAYMENT</urn:brmObjectType>
         <!--Zero or more repetitions:-->
         <urn:id>413954</urn:id>
      </urn:retrieve>
   </soapenv:Body>
</soapenv:Envelope>


Response

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:retrieveResponse>
         <urn:result xsi:type="urn:PAYMENT">
            <urn:Id>413954</urn:Id>
            <urn:Amount>100</urn:Amount>
            <urn:Autoallocate>1</urn:Autoallocate>
            <urn:BillingProfileId>7471</urn:BillingProfileId>
            <urn:Created>2014-04-25T17:21:12.000Z</urn:Created>
            <urn:CreatedUserId xsi:nil="true"/>
            <urn:CreditCardCCV xsi:nil="true"/>
            <urn:CreditCardExpDate xsi:nil="true"/>
            <urn:CreditCardName xsi:nil="true"/>
            <urn:CreditCardNumber xsi:nil="true"/>
            <urn:InvoiceIdDisplay xsi:nil="true"/>
            <urn:PaymentDate>2014-04-01T00:00:00.000Z</urn:PaymentDate>
            <urn:PaymentNote>[04/25/2014 11:21 AM: btest]
Test Webservice</urn:PaymentNote>
            <urn:PaymentType>CHECK</urn:PaymentType>
            <urn:UnallocatedAmount>0</urn:UnallocatedAmount>
            <urn:Updated xsi:nil="true"/>
            <urn:UpdatedUserId xsi:nil="true"/>
            <urn:VoidedAmount xsi:nil="true"/>
         </urn:result>
      </urn:retrieveResponse>
   </soapenv:Body>
</soapenv:Envelope>


Upsert

Request

 

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Header>
        <h:SessionHeader xmlns:h="urn:stronglytyped.soap.brmsystems.com" xmlns="urn:stronglytyped.soap.brmsystems.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <SessionID>cZZRIteVgWBZmWPzEXpYYZZujRhbTBuSZOGIJzKj</SessionID>
        </h:SessionHeader>
    </s:Header>
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <upsert xmlns="urn:stronglytyped.soap.brmsystems.com">
            <externalIDFieldName>Id</externalIDFieldName>
            <brmObjects xsi:type="PAYMENT">                
                <Id>413954</Id>
                <Autoallocate>0</Autoallocate>    
            </brmObjects>
        </upsert>
    </s:Body>
</s:Envelope>


Response

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:h="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <h:upsertResponse xmlns="urn:stronglytyped.soap.brmsystems.com">
         <h:result>
            <h:created>false</h:created>
            <h:ErrorCode>0</h:ErrorCode>
            <h:ErrorText></h:ErrorText>
            <h:ErrorElementField/>
            <h:Id>413954</h:Id>
         </h:result>
      </h:upsertResponse>
   </soapenv:Body>
</soapenv:Envelope>
Have more questions? Submit a request

Comments

Powered by Zendesk