Get Most Recent Invoice

Call GetMostRecentInvoice API to retrieve the latest invoice for a customer. This API receives GetMostRecentInvoiceXML as input and renders Response XML as output.

Syntax and Arguments

public string GetMostRecentInvoice (string  GetMostRecentInvoiceXML, string ReferenceNo)

Input Arguments

Argument Name

Data Type

Is Mandatory

Description

GetMostRecentInvoiceXML

String

Yes

An XML string that contains customer number.

ReferenceNo

String

Yes

An unique number provided to identify the request

GetMostRecentInvoiceXML

Request XML Elements

Element Name

Data Type

Length
(Bytes)

Is Mandatory

Description

CUSTOMERNO

String

16

Y

Customer number

Request XML Format

<REQUESTINFO>

<KEY_NAMEVALUE>

<KEY_NAME>CUSTOMERNO</KEY_NAME>

<KEY_VALUE>CUST100</KEY_VALUE>

                        </KEY_NAMEVALUE>

</REQUESTINFO>

Response XML

Output Parameters

Parameter Name

Data Type

Description

TRANSACTIONNO

String

An unique number generated for each request

ERRORNO

Integer

Returns Error Number

1076  “Details are not provided properly"

1059

MESSAGE

String

Returns "Success" or "Failed"

CUSTOMERNO

String

Customer number

DATE

Date

Invoice date

AMOUNT

Decimal

Invoice amount

CURRENCYCODE

String

Currency code

CHARGEID

Long

Charge Id

AMOUNT

Decimal

Amount. Either invoice amount, charge amount, discount amount, adjustment amount, tax amount.

DESCR

String

Description for charges or discounts or adjustments or taxes.

CHARGEPERIOD

String

Charge period

Response XML Format

<RESPONSEINFO>

<STATUS>

<TRANSACTIONNO>2551</TRANSACTIONNO>

<ERRORNO>0</ERRORNO>

<MESSAGE>SUCCESS</MESSAGE>

</STATUS> 

<DOCUMENT>

             <DOCHDR>

                          <DOCTYPE>INVOICE</DOCTYPE>

                           <DOCNO>INV456</DOCNO>

                             <CUSTOMERNO>CUST100</CUSTOMERNO>

                            <DATE>01-04-2010</DATE>

                           <AMOUNT>200</AMOUNT>

                            <CURRENCYCODE>USD</CURRENCYCODE>

                            <REMARKS>Invoice generated for this customer</REMARKS>

                </DOCHDR>

               <DOCBODY>

                            <INVOICE>

                                      <CHARGES>

                                                <CHARGE>

                                                     <CHARGEID>CHG100</CHARGEID>

                                                     <AMOUNT>100</AMOUNT>

                                       <DESCR>Installation Charges</DESCR>

                                        <CHARGEPERIOD>01-03-2010 to 31-03-2010</CHARGEPERIOD>

                                             </CHARGE>

                                             <CHARGE>

                                                   <CHARGEID>CHG200</CHARGEID>

                                                   <AMOUNT>50</AMOUNT>

                                      <DESCR>Subscription Charges</DESCR>

                                     <CHARGEPERIOD>01-03-2010 to 31-03-2010</CHARGEPERIOD>

                                             </CHARGE>

                                      </CHARGES>

                                      <TAXES>

                                                 <TAX>

                                                           <DESCR>VAT</DESCR>

                                                            <AMOUNT>10</AMOUNT>

                                                  </TAX>

                                      </TAXES>

                                      <DISCOUNTS>

                                                   <DISCOUNT>

                                                              <DESCR>DIS1</DESCR>

                                                        <AMOUNT>5</AMOUNT>

                                                        <CHARGEID>10</CHARGEID>

                                                </DISCOUNT>

                                     </DISCOUNTS>

                                    <ADJUSTMENTS>

                                            <ADJUSTMENT>

                                                       <DESCR>ADJ1</DESCR>      

                                                       <AMOUNT>20</AMOUNT>

                                                            <CHARGEID>10</CHARGEID>

                                            </ADJUSTMENT>     

                                    </ADJUSTMENTS>

                          </INVOICE>

               </DOCBODY>

</DOCUMENT>

   </RESPONSEINFO>

Note: Refer to Error Codes and Description to view errors in detail.