Difference between revisions of "API/Services/getInvoiceDetail"

From Emersion
Jump to: navigation, search
(Created page with "'''Purpose ''' Get invoice items for a given invoice. '''Inputs''' <soapenv:Header/> <soapenv:Body> <ser:getInvoiceDetail> <ser:invoice_id>1</ser:invoice...")
 
 
Line 1: Line 1:
 
'''Purpose '''
 
'''Purpose '''
  
−
Get invoice items for a given invoice.
+
Get the content from an individual invoice.
  
 
'''Inputs'''
 
'''Inputs'''
−
  <soapenv:Header/>
+
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
 +
  <soapenv:Header/>
 
   <soapenv:Body>
 
   <soapenv:Body>
−
       <ser:getInvoiceDetail>
+
       <urn:getInvoiceDetail>
−
         <ser:invoice_id>1</ser:invoice_id>
+
         <urn:invoice_id>2720016</urn:invoice_id>
−
       </ser:getInvoiceDetail>
+
       </urn:getInvoiceDetail>
 +
  </soapenv:Body>
 +
</soapenv:Envelope>ceDetail>
 
   </soapenv:Body>
 
   </soapenv:Body>
  
Line 14: Line 17:
  
 
'''Output'''
 
'''Output'''
−
   <SOAP-ENV:Body>
+
   <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:types" xmlns:ns2="urn:emersion:api">
−
      <ns1:getInvoiceDetailResponse>
+
  <SOAP-ENV:Body>
−
        <ns1:getInvoiceDetailItem>
+
      <ns2:getInvoiceDetailResponse>
−
            <ns1:ledger_code></ns1:ledger_code>
+
        <ns2:getInvoiceDetailItem>
−
            <ns1:ledger_code_name></ns1:ledger_code_name>
+
             <ns1:ledger_code_name>GENERAL_DISPUTE_RESOLVE</ns1:ledger_code_name>
−
            <ns1:ledger_code_description></ns1:ledger_code_description>
+
             <ns1:cardline_id>46429992</ns1:cardline_id>
−
            <ns1:package_plan_name></ns1:package_plan_name>
+
             <ns1:covers_from>2018-04-09 13:21:00</ns1:covers_from>
−
            <ns1:package_plan_id></ns1:package_plan_id>
+
             <ns1:covers_to>2018-04-09 13:21:00</ns1:covers_to>
−
            <ns1:package_plan_period_length></ns1:package_plan_period_length>
+
             <ns1:vanity_covers_from>2018-04-09 13:21:00</ns1:vanity_covers_from>
−
            <ns1:service_plan_id></ns1:service_plan_id>
+
             <ns1:vanity_covers_to>2018-04-09 13:21:00</ns1:vanity_covers_to>
−
            <ns1:service_plan_name></ns1:service_plan_name>
+
             <ns1:actual_amount_ex>-454.55</ns1:actual_amount_ex>
−
            <ns1:service_plan_period_length></ns1:service_plan_period_length>
+
             <ns1:actual_amount_tax>-45.45</ns1:actual_amount_tax>
−
             <ns1:bolt_on_plan_id></ns1:bolt_on_plan_id>
+
             <ns1:transaction_date>2018-04-09T13:21:00+10:00</ns1:transaction_date>
−
             <ns1:bolt_on_plan_name></ns1:bolt_on_plan_name>
+
         </ns2:getInvoiceDetailItem>
−
             <ns1:bolt_on_plan_period_length></ns1:bolt_on_plan_period_length>
+
       </ns2:getInvoiceDetailResponse>
−
            <ns1:covers_from></ns1:covers_from>
 
−
             <ns1:covers_to></ns1:covers_to>
 
−
             <ns1:vanity_covers_from></ns1:vanity_covers_from>
 
−
             <ns1:vanity_covers_to></ns1:vanity_covers_to>
 
−
             <ns1:actual_amount_ex></ns1:actual_amount_ex>
 
−
             <ns1:actual_amount_tax></ns1:actual_amount_tax>
 
−
             <ns1:transaction_date></ns1:transaction_date>
 
−
            <ns1:service_start_date></ns1:service_start_date>
 
−
            <ns1:service_created_by_id></ns1:service_created_by_id>
 
−
            <ns1:service_created_by_name></ns1:service_created_by_name>
 
−
         </ns1:getInvoiceDetailItem>
 
−
       </ns1:getInvoiceDetailResponse>
 
 
   </SOAP-ENV:Body>
 
   </SOAP-ENV:Body>
 +
</SOAP-ENV:Envelope>
  
 
'''Error String'''
 
'''Error String'''
  
 
144. Missing invoice_id
 
144. Missing invoice_id

Latest revision as of 10:15, 11 April 2018

Purpose

Get the content from an individual invoice.

Inputs <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api"> 

  <soapenv:Header/>
  <soapenv:Body>
     <urn:getInvoiceDetail>
        <urn:invoice_id>2720016</urn:invoice_id>
     </urn:getInvoiceDetail>
  </soapenv:Body>

</soapenv:Envelope>ceDetail> 

  </soapenv:Body>


Output 

 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:types" xmlns:ns2="urn:emersion:api">
  <SOAP-ENV:Body>
     <ns2:getInvoiceDetailResponse>
        <ns2:getInvoiceDetailItem>
           <ns1:ledger_code_name>GENERAL_DISPUTE_RESOLVE</ns1:ledger_code_name>
           <ns1:cardline_id>46429992</ns1:cardline_id>
           <ns1:covers_from>2018-04-09 13:21:00</ns1:covers_from>
           <ns1:covers_to>2018-04-09 13:21:00</ns1:covers_to>
           <ns1:vanity_covers_from>2018-04-09 13:21:00</ns1:vanity_covers_from>
           <ns1:vanity_covers_to>2018-04-09 13:21:00</ns1:vanity_covers_to>
           <ns1:actual_amount_ex>-454.55</ns1:actual_amount_ex>
           <ns1:actual_amount_tax>-45.45</ns1:actual_amount_tax>
           <ns1:transaction_date>2018-04-09T13:21:00+10:00</ns1:transaction_date>
        </ns2:getInvoiceDetailItem>
     </ns2:getInvoiceDetailResponse>
  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Error String

144. Missing invoice_id

Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/getInvoiceDetail&oldid=6204"