INVOICE

Overview
Invoices can be created for accounts or user groups in BillingPlatform. It is not necessary to create an invoice if you plan on collecting data using the usage collector, as invoices will be created automatically once usage comes through the system. This section will describe the invoice object, and the different fields available.

System Entity Name
INVOICE

Allowed Functions

Create Update Retrieve Delete Upsert
YES YES YES YES YES



Fields

Field Data Type Properties Description
ActivityEndDate dateTime    
ActivityStartDate dateTime  

 

AgingInterval string    
BillingCycleEndDate dateTime    
BillingCycleStartDate dateTime    
BillingProfileObj BILLING_PROFILE    
BillingProfileId decimal    
BuyRateAmount decimal    
ClosedDate dateTime    
CreditAmount decimal    
DueAmount decimal    
DueDate dateTime    
GrandTotalAmount decimal    
ManualCloseApprovedFlag decimal    
PaymentAmount decimal    
PaymentStatus string    
Status string    
TaxTotalAmount decimal    
TotalAmount decimal    
VoidedByInvoiceId 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>NZEQUFGBWfBvhzNJKTeHFzsaLcHkWnNXpSGBBNyV</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="PRODUCT">
            <!--Zero or more repetitions:-->
            <NAME>TEST_PRODUCT6</NAME>
            <Status>ACTIVE</Status>
         </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>15523515</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>NZEQUFGBWfBvhzNJKTeHFzsaLcHkWnNXpSGBBNyV</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="PRODUCT">
            <urn:Id>15523515</urn:Id>
            <urn:Name>TEST_PRODUCT7</urn:Name>
         </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>15523515</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>NZEQUFGBWfBvhzNJKTeHFzsaLcHkWnNXpSGBBNyV</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:queryAnsiSql>Name='TEST_PRODUCT7'</urn:queryAnsiSql>
         <urn:brmObjectType>PRODUCT</urn:brmObjectType>
         <!--Zero or more repetitions:-->
         <urn:id>10155</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:PRODUCT">
            <urn:Id>15523515</urn:Id>
            <urn:Created>2014-03-04T20:50:29.000Z</urn:Created>
            <urn:CreatedUserId xsi:nil="true"/>
            <urn:DefaultBillingComponent xsi:nil="true"/>
            <urn:Name>TEST_PRODUCT7</urn:Name>
            <urn:Status>ACTIVE</urn:Status>
            <urn:Updated xsi:nil="true"/>
            <urn:UpdatedUserId xsi:nil="true"/>
         </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>NZEQUFGBWfBvhzNJKTeHFzsaLcHkWnNXpSGBBNyV</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="PRODUCT">
            <urn:Id>15523515</urn:Id>
            <urn:Name>TEST_PRODUCT7</urn:Name>
         </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>15523515</urn:Id>
         </urn:result>
      </urn:updateResponse>
   </soapenv:Body>
</soapenv:Envelope>

Upsert

Request

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>NZEQUFGBWfBvhzNJKTeHFzsaLcHkWnNXpSGBBNyV</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="PRODUCT">
            <urn:Id>15523515</urn:Id>
            <urn:Name>TEST_PRODUCT7</urn:Name>
         </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>15523515</urn:Id>
         </urn:result>
      </urn:updateResponse>
   </soapenv:Body>
</soapenv:Envelope>
Have more questions? Submit a request

Comments

Powered by Zendesk