ACTIVITY

Overview
The ACTIVITY entity allows you to directly input charges into the application. If you choose this method to enter charges, keep in mind you will need to know the mapping behing the billing component idenitifers, as well as the vendor billing identifiers. This is necessary as inputting data here will bypass the mediation layer of the application. If you would like data to be passed through mediation, please use the COLLECTOR_STAGE entity as this will allow you to enter data as it would be input using the existing mapping setup within the application. For more information on uploading to COLLECTOR_STAGE please see here.

Allocating the charges to the correct level of the hierarchy requires knowing the IDs for each level you plan on using. See the following examples to see how fields need to be supplied.

Charge applied directly to account:

  1. Supply account ID

Charge applied to service point provisioned to account:

  1. Supply account ID (that service point is provisioned to)
  2. Supply service point ID

Charge applied directly to user group:

  1. Supply account ID (that user group belongs to)
  2. Supply user group ID

Charge applied to service point that belongs to user group:

  1. Supply account ID (that user group belongs to)
  2. Supply user group ID (that service point belongs to)
  3. Supply service point ID


System Entity Name
ACTIVITY

Allowed Functions

Create Update Retrieve Delete Upsert
YES YES YES YES YES


Fields

Field Data Type Properties Description
AccountObj ACCOUNT   An alternative to passing the ID of the account, the brmObject of the account that the activity will be billed against. 
AccountId decimal  

ID of the account that the activity will be billed against. 

ActivityDate dateTime  

Date and time in the yyyymmddThh24:mi:ss format.

For example, 12:30 PM on 10 February 2015 will be 20150210T12:30:00.

BillingComponentObj BILLING_COMPONENT   An alternative to passing the ID of the  product, the brmObject of the product that will be billed to the account.
BillingComponentId decimal   ID of the billing component/product that will be billed to the account. 
BuyCostOverride decimal   Allows for overriding the buy cost of the product. Use this to use a different value for this rated activity. 
Cost decimal   System field and should not be updated. 
CostOverride decimal   Allows for overriding the cost associated to the activity. Use this to use a different value other than the system-rated cost. 
CountryCodeMapObj COUNTRY_CODE_MAP   An alternative to passing the ID of the country code, the brmObject of the international rate that will be used to add country surcharges. 
CountryCodeMapId decimal   ID of the international rate that will be used to add country surcharges. This is normally used for telecommunication or cross-country charges/products.
InvoiceObj INVOICE   An alternative to passing the ID of the invoice, the brmObject of the invoice that the activity is associated with.
InvoiceId decimal   ID of the invoice that the activity is associated with. This serves as the invoice line item that is displayed on the UI or the invoice print-out. 
PricingObj PRICING   An alternative to passing the ID of the pricing record, the brmObject of the pricing record that will override the rate that is determined by the system.
PricingId decimal   ID of the pricing record if it is known and the system-driven rate needs to be overridden.
Quantity decimal   Quantity of the invoice line item that will be rated.
Rate decimal   System field and does not need to accept any values.  
RateOverride decimal   Rate that will be used against the rated amount/quantity. This is used to override the rate of the activity instead of accepting the system-determined rate or by indicating a pricing object. 
RatedAmount decimal   System field and does not need to accept any values. 
SubscriptionFromDate dateTime   Applicable only for products that are using the Subscription rating method. This indicates the start date of the subscription product that is being billed to the customer. 
SubscriptionToDate dateTime   Applicable only for products that are using the Subscription rating method. This indicates the end date of the subscription product that is being billed to the customer. 
TaxCost decimal   System field and does not need to accept any values.



Sample Requests
Create

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <s:Header>
       <SessionHeader xmlns="urn:stronglytyped.soap.brmsystems.com">
           <SessionID>tvfuncmlqjpELyfSBXAJCHwKfaWPNAtsfUHeSPuy</SessionID>
       </SessionHeader>
   </s:Header>
   <s:Body>
       <create xmlns:tns="http://schemas.xmlsoap.org/soap/encoding/" 
	       xmlns="urn:stronglytyped.soap.brmsystems.com" 
	       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <brmObjects xsi:type="ACTIVITY">
             <AccountObj>
                    <Name>DMP</Name>
             </AccountObj>   
             <BillingIdentifierObj>
                    <BillingIdentifier>DMP-PARKING-SVCPT</BillingIdentifier>
             </BillingIdentifierObj>                           
	     <Started>2014-10-06</Started>
	     <Ended>2016-10-06</Ended>
             <ActivityDate>2014-10-06T16:33:58</ActivityDate>
             <ExtUserId>cust1000</ExtUserId>
             <ProductObj>
	            <Name>ParkingSP-Tiered Parking</Name>
             </ProductObj>
             <Quantity>18</Quantity>
             <ServiceProviderId>111</ServiceProviderId>
             <ServiceId>1</ServiceId>
             <TransactionId>123456789</TransactionId>
             <UserId>mohit.mutha@simobility.com</UserId>
         </brmObjects>
      </create>
   </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="urn:stronglytyped.soap.brmsystems.com">
    <soapenv:Body>
        <createResponse xmlns="urn:stronglytyped.soap.brmsystems.com">
            <result>
                <ErrorCode>0</ErrorCode>
                <ErrorText>
                </ErrorText>
                <ErrorElementField>
                </ErrorElementField>
                <Id>11996187</Id>
            </result>
        </createResponse>
    </soapenv:Body>
</soapenv:Envelope>

 

Have more questions? Submit a request

Comments

Powered by Zendesk