BILLING_PROFILE

Overview
Identifies the billing and invoicing attributes for a given element of the hierarchy. BillingPlatform supports custom assignment of billing cycles and invoice templates at the customer or billing profile level for ultimate flexibility and customer serviceability.

System Entity Name
BILLING_PROFILE

Allowed Functions

Create Update Retrieve Delete Upsert
YES YES YES YES YES

 

Field Data Type Properties Description
AccountObj ACCOUNT nillable

If this billing profile will belong to an account then use this field, this should contain AccountId if used.

AccountId string nillable Specify the account this billing profie will belong to (to be used when AccountObj is used).
UserGroupObj USER_GROUP nillable If this billing profile will belong to a user group then use this field, this should contain UserGroupId if used.
UserGroupId string  nillable

Specify the user group this billing profie will belong to (to be used when UserGroupObj is used).

Address1 string required, nillable Enter line 1 of customer address
Address2 string nillable Enter line 2 of customer address
Attention string nillable Enter the Attn portion of customer address
BillTo string required, nillable Enter the name you would like to display on customer invoices
BillingCycle string

required,

nillable

Enter the customer billing cycle.  Valid inputs are:

  • DAILY
  • MONTHLY
  • PER TRANSACTION
  • QUARTERLY
  • YEARLY
  • WEEKLY
  • MANUAL
  • BIWEEKLY

Note: This can be different depending on your individual application and which cycles have been activated or deactivated.

BillingMethod string

required,

nillable

Enter the delivery method for customer invoices.  Valid input are:

  • CREDIT CARD
  • MAIL
  • ACH

Note: This can be different depending on your individual application and which methods have been activated or deactivated.

City string nillable Enter the city from your customer's billing address.
Country string nillable Enter the country from you customer's billing address.
CreditCardType string nillable Enter the credit card type. (Only applicable if you will be using credit card as the payment method)
CreditCardName string nillable Enter the name on the credit card.
CreditCardNumber string nillable Enter the credit card number.
CreditCardExpDate string nillable Enter the credit card's expiration date in format (MM/YYYY).
CreditCardCCV string nillable Enter the credit card's CCV number, the digits on the signature panel.
CurrencyCodeObj CURRENCY nillable Object to place the currency code under.
CurrencyCode string required, nillable Enter the currency code for the customer.  Valid fields will depend on what you have configured in your individual application.
DunningInterval string nillable Enter the dunning interval ID (if applicable).
DunningIntervalObj DUNNING_INTERVAL nillable An alternative to the dunning interval ID, the brmObject of the dunning interval record (if applicable).
Email string

required,

nillable

Enter the customers main contact email address.
Fax string nillable Enter the customers fax number
InvGraceDaysBeforeClosing string

required,

nillable

Indicates the number of days when the closing process of an invoice takes place. If it is set to a non-zero value, the rating and collecting processes for the invoice is completed X days after. This is useful for scenarios where the usage data for the billing cycle is not yet complete and the system needs to capture last-minute usage data from the vendors.

Setting this value to 0 will immediately rate and collect whatever is in the system and cloes the invoice.

InvoiceDeliveryMethod string nillable

Select the method in which you would like to deliver invoices.  Valid entries are:

  • EMAIL
  • MAIL

Remember using the automation for mail option will only work if you have integrated your application with a mail service provider.  Otherwise this is a manual process.

InvoiceTemplateObj INVOICE_TEMPLATE nillable Object containing the invoice template id in which you will assign to your customer.
InvoiceTemplateId string

required,

nillable

Enter the ID of the invoice template on which you would like the customers invoices to be rendered from.  The invoice template IDs can be found by pulling records from the INVOICE_TEMPLATE entity.
ManualCloseFlag string

required,

nillable

Set this flag to 0 if you would like invoices to be automatically closed at the end of the billing cycle, or 1 if you would like to manually close invoices.
MonthlyBillingDate string

required,

nillable

Enter the day of the month in which to end the billing cycle.
PaymentTermsDate string

required,

nillable

Enter the length of time for the due date to be set.  This is based off of the closing date of the invoice.  Say you set this field to 30, then the invoice due date will be 30 days from the invoice close date.
Phone string nillable Enter the customer's phone number.
State string nillable Enter the customer's state from the billing address.
StatementCycle string nillable

If your customer will be using statements in the application enter the cycle in which to create statements.  Valid entries are:

  • DAILY
  • WEEKLY
  • BI-WEEKLY
  • MONTHLY
StatementDeliveryMethod string nillable

If your customer will be using statements in the application, enter the method in which to deliver statements.  Valid entires are:

  • EMAIL
  • MAIL
StatementTemplate string nillable If your customer will be using statements in the application, enter the template ID in which to render statements from.  You will find these IDs by pulling records from the INVOICE_TEMPLATE entity.
Status string

required,

nillable

Enter the status for the customer.  Valid entries are:

  • ACTIVE
  • DEACTIVATED
TimeZoneObj TIME_ZONE nillable Object in which to specify the time zone ID.
TimeZoneId string

required,

nillable

Enter the ID of the time zone in which the customer resides.  IDs can be found by pulling records from the TIME_ZONE entity.
Zip string nillable Enter the ZIP code from the customers billing address.



Sample Requests
Create

Note: This request was made with the minimum required fields. Your request can include many more entries using the fields from above.
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>HvXndkGPeLhomkLQtNSbPbURyxwVrldQwwujbjwY</SessionID>
        </h:SessionHeader>
    </s:Header>
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <create xmlns="urn:stronglytyped.soap.brmsystems.com">
        <brmObjects xsi:type="BILLING_PROFILE">
            <AccountObj>
                 <Id>10154</Id>
            </AccountObj>
            <Address1>123 Mainstreet Dr.</Address1>
            <BillTo>Test Company 10</BillTo>
            <BillingCycle>MONTHLY</BillingCycle>
            <BillingMethod>MAIL</BillingMethod>
            <CurencyCode>USD</CurencyCode>
            <Email>email@testcompany10.com</Email>
            <Status>ACTIVE</Status>
            <InvGraceDaysBeforeClosing>0</InvGraceDaysBeforeClosing>
            <InvoiceTemplateId>63</InvoiceTemplateId>
            <ManualCloseFlag>1</ManualCloseFlag>
            <MonthlyBillingDate>30</MonthlyBillingDate>
            <PaymentTermDays>14</PaymentTermDays>
            <TimeZoneId>346</TimeZoneId>
        </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:h="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <h:createResponse>
         <h:result>
            <h:ErrorCode>0</h:ErrorCode>
            <h:ErrorText></h:ErrorText>
            <h:ErrorElementField></h:ErrorElementField>
            <h:Id>15523489</h:Id>
         </h:result>
      </h: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>HvXndkGPeLhomkLQtNSbPbURyxwVrldQwwujbjwY</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="BILLING_PROFILE">
            <urn:Id>15523489</urn:Id>
            <urn:Address1>456 Broadway Ave.</urn:Address1>
            <urn:Address2>Unit 401</urn:Address2>
            <urn:State>CO</urn:State>
            <urn:Country>USA</urn:Country>
            <urn:Zip>12345</urn:Zip>
         </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>15523489</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>HvXndkGPeLhomkLQtNSbPbURyxwVrldQwwujbjwY</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <urn:retrieve>
         <urn:queryAnsiSql>Id=15523489</urn:queryAnsiSql>
         <urn:brmObjectType>BILLING_PROFILE</urn:brmObjectType>
         <!--Zero or more repetitions:-->
         <urn:id>15523489</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:BILLING_PROFILE">
            <urn:Id>15523489</urn:Id>
            <urn:AccountId>10154</urn:AccountId>
            <urn:Address1>456 Broadway Ave.</urn:Address1>
            <urn:Address2>Unit 401</urn:Address2>
            <urn:Attention xsi:nil="true"/>
            <urn:BillTo>Test Company 10</urn:BillTo>
            <urn:BillingCycle>MONTHLY</urn:BillingCycle>
            <urn:BillingMethod>MAIL</urn:BillingMethod>
            <urn:City xsi:nil="true"/>
            <urn:Country>USA</urn:Country>
            <urn:Created>2014-02-24T22:13:11.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:CreditCardStatus xsi:nil="true"/>
            <urn:CreditCardType xsi:nil="true"/>
            <urn:CurencyCode>USD</urn:CurencyCode>
            <urn:DunningInterval xsi:nil="true"/>
            <urn:Email>email@testcompany10.com</urn:Email>
            <urn:Fax xsi:nil="true"/>
            <urn:InvGraceDaysBeforeClosing>0</urn:InvGraceDaysBeforeClosing>
            <urn:InvoiceDeliveryMethod xsi:nil="true"/>
            <urn:InvoiceTemplateId>63</urn:InvoiceTemplateId>
            <urn:ManualCloseFlag>1</urn:ManualCloseFlag>
            <urn:MonthlyBillingDate>30</urn:MonthlyBillingDate>
            <urn:PaymentTermDays>14</urn:PaymentTermDays>
            <urn:Phone xsi:nil="true"/>
            <urn:State>CO</urn:State>
            <urn:StatementCycle xsi:nil="true"/>
            <urn:StatementDeliveryMethod xsi:nil="true"/>
            <urn:StatementTemplate xsi:nil="true"/>
            <urn:Status>ACTIVE</urn:Status>
            <urn:TimeZoneId>346</urn:TimeZoneId>
            <urn:Updated>2014-02-25T02:08:03.000Z</urn:Updated>
            <urn:UpdatedUserId xsi:nil="true"/>
            <urn:UserGroupId xsi:nil="true"/>
            <urn:Zip>12345</urn:Zip>
         </urn:result>
      </urn:retrieveResponse>
   </soapenv:Body>
</soapenv:Envelope>


Delete

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>ticEQPIPGTzsIMqbGBGiDXeoGoxmSpnkNZqfIkqW</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:delete>
      <brmObjects xsi:type="BILLING_PROFILE">
         <Id>15523489</Id>
      </brmObjects>
      </urn:delete>
   </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:deleteResponse>
         <urn:result>
            <urn:ErrorCode>0</urn:ErrorCode>
            <urn:ErrorText></urn:ErrorText>
            <urn:Id>15523489</urn:Id>
            <urn:Success>true</urn:Success>
         </urn:result>
      </urn:deleteResponse>
   </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>bnyaHxooYijvHwbgWwbtOaXTMMatDKvBVHCxjRFE</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>Name</externalIDFieldName>
            <brmObjects xsi:type="ACCOUNT">                	
                <Name>Test Web Service 1</Name>
                <Status>ACTIVE</Status>					
            </brmObjects>
	    <brmObjects xsi:type="ACCOUNT">                	
                <Name>Test Web Service 2</Name>
                <Status>ACTIVE</Status>					
            </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>true</h:created>
                <h:ErrorCode>0</h:ErrorCode>
                <h:ErrorText>
                </h:ErrorText>
                <h:ErrorElementField>
                </h:ErrorElementField>
                <h:Id>12027</h:Id>
            </h:result>
        </h:upsertResponse>
        <h:upsertResponse xmlns="urn:stronglytyped.soap.brmsystems.com">
            <h:result>
                <h:created>true</h:created>
                <h:ErrorCode>0</h:ErrorCode>
                <h:ErrorText>
                </h:ErrorText>
                <h:ErrorElementField>
                </h:ErrorElementField>
                <h:Id>12028</h:Id>
            </h:result>
        </h:upsertResponse>
    </soapenv:Body>
</soapenv:Envelope>



Have more questions? Submit a request

Comments

Powered by Zendesk