Get Documents by Customer

Call GetDocumentsByCustomer API to retrieve list of documents by customer number and between specified date range. Documents may be either payment or refund or credit note. This API receives GetDocumentsByCustomer XML as input and renders Response XML as output.

Syntax and Arguments

public string GetDocumentsByCustomer (string  GetDocumentsByCustomerXML, string ReferenceNo)

Input Arguments

Argument Name

Data Type

Is Mandatory

Description

GetDocumentsByCustomerXML

String

Yes

An XML string that contains customer number, document type and date range.

ReferenceNo

String

Yes

An unique number provided to identify the request

GetDocumentsByCustomerXML

Request XML Elements

Element Name

Data Type

Length
(Bytes)

Is Mandatory

Description

CUSTOMERNO

String

16

Y

Customer number

PAYMENT

String

16

Y

Payment number.

REFUND

String

16

Y

Refund number.

CREDITNOTE

String

16

Y

Credit note number.

FROMDATE

Date

 

N

Date from which the documents should be retrieved. Date format should be in user preferred date format. Default value will be application date.

TODATE

Date

 

N

Date until when the documents should be retrieved. Date format should be in user preferred date format. Default value will be application date.

Request XML Format: PAYMENT document type

<REQUESTINFO>

<KEY_NAMEVALUE>

<KEY_NAME>CUSTOMERNO</KEY_NAME>

<KEY_VALUE>CUST100</KEY_VALUE>

</KEY_NAMEVALUE>

<ADDITIONALPARAM>

<DOCTYPE>PAYMENT</DOCTYPE>

<FROMDATE>01-01-2010</FROMDATE>

<TODATE>30-04-2010</TODATE>

<LIMIT>10</LIMIT>

</ADDITIONALPARAM>

</REQUESTINFO>

 Request XML Format: REFUND document type

<REQUESTINFO>

<KEY_NAMEVALUE>

<KEY_NAME>CUSTOMERNO</KEY_NAME>

<KEY_VALUE>CUST100</KEY_VALUE>

</KEY_NAMEVALUE>

<ADDITIONALPARAM>

<DOCTYPE>REFUND</DOCTYPE>

<FROMDATE>01-01-2010</FROMDATE>

<TODATE>30-04-2010</TODATE>

<LIMIT>10</LIMIT>

</ADDITIONALPARAM>

</REQUESTINFO>

 Request XML Format: CREDITNOTE document type

<REQUESTINFO>

<KEY_NAMEVALUE>

<KEY_NAME>CUSTOMERNO</KEY_NAME>

<KEY_VALUE>CUST100</KEY_VALUE>

</KEY_NAMEVALUE>

<ADDITIONALPARAM>

<DOCTYPE>CREDITNOTE</DOCTYPE>

<FROMDATE>01-01-2010</FROMDATE>

<TODATE>30-04-2010</TODATE>

<LIMIT>10</LIMIT>

</ADDITIONALPARAM>

</REQUESTINFO>

Response XML

Output Parameters: PAYMENT document type and CASH pay mode

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 - Invalid Date and Time Format

1100– Invalid limit

MESSAGE

String

Returns "Success" or "Failed"

DATE

Date

Payment date

AMOUNT

Decimal

Payment amount

CUSTOMERNO

String

Customer number

CURRENCYCODE

String

Currency code

RECEIPTNO

String

Payment receipt number

REMARKS

String

Notes

Response XML Format: PAYMENT document type and CASH or OP pay mode

<RESPONSEINFO>

<STATUS>

      <TRANSACTIONNO>2551</TRANSACTIONNO>

      <ERRORNO>0</ERRORNO>

      <MESSAGE>SUCCESS</MESSAGE>

</STATUS> 

<DOCUMENT>

               <DOCHDR>

                          <DOCTYPE>PAYMENT</DOCTYPE>

                              <DOCNO>PAY123</DOCNO>

                           <CUSTOMERNO>CUST100</CUSTOMERNO>

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

                           <AMOUNT>200 </AMOUNT>

                            <CURRENCYCODE>USD</CURRENCYCODE>

                            <REMARKS>Testing</REMARKS>

                </DOCHDR>

               <DOCBODY>

                      <PAYMENT>

                                     <PAYMODE  MODE=”CASH” />

                                   <RECEIPTNO>19782545</RECEIPTNO>

                      </PAYMENT>

               </DOCBODY>

</DOCUMENT>

</RESPONSEINFO>

Output Parameters: PAYMENT document type and CHECK pay mode

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 - Invalid Date and Time Format.

1100– Invalid limit

MESSAGE

String

Returns "Success" or "Failed"

DATE

Date

Payment date

AMOUNT

Decimal

Payment amount

CUSTOMERNO

String

Customer number

CURRENCYCODE

String

Currency code

CHEQUENO

String

Check number

CHEQUEDATE

Date

Check date

RECEIPTNO

String

Payment receipt number

REMARKS

String

Notes

Response XML Format: PAYMENT document type and CHECK pay mode

<RESPONSEINFO>

<STATUS>

    <TRANSACTIONNO>2551</TRANSACTIONNO>

    <ERRORNO>0</ERRORNO>

    <MESSAGE>SUCCESS</MESSAGE>

</STATUS>

<DOCUMENT>

               <DOCHDR>

                          <DOCTYPE>PAYMENT</DOCTYPE>

                              <DOCNO>PAY123</DOCNO>

                           <CUSTOMERNO>CUST100</CUSTOMERNO>

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

                           <AMOUNT>200 </AMOUNT>

                            <CURRENCYCODE>USD</CURRENCYCODE>

                            <REMARKS>Testing</REMARKS>

                </DOCHDR>

               <DOCBODY>

                              <PAYMENT>

                                               <PAYMODE   MODE=”CHECK”>

                                                     <CHECKNO>53441534</CHECKNO>

                                                      <CHECKDATE>20/07/2009</CHECKDATE>

                                             </PAYMODE>

                                             <RECEIPTNO>19782545</RECEIPTNO>

                              </PAYMENT>

              </DOCBODY>

</DOCUMENT>

            </RESPONSEINFO>

Output Parameters: PAYMENT document type and CC/DC pay mode

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 - Invalid Date and Time Format
1100– Invalid limit
MESSAGE String Returns "Success" or "Failed"
DOCUMENTNO String Document number which may be either INVOICE, PAYMENT, REFUND, CREDITNOTE
DATE Date Payment date
AMOUNT Decimal Payment amount
CUSTOMERNO String Customer number

CURRENCYCODE

String

Currency code

REMARKS

String

Document notes

AUTHCODE

String

Authorization code

EXTERNALTRANSID

String

External transaction id from gateway

Response XML Format: PAYMENT document type and CC/DC pay mode

<RESPONSEINFO>

<STATUS>

      <TRANSACTIONNO>2551</TRANSACTIONNO>

      <ERRORNO>0</ERRORNO>

      <MESSAGE>SUCCESS</MESSAGE>

</STATUS> 

<DOCUMENT>

               <DOCHDR>

                          <DOCTYPE>PAYMENT</DOCTYPE>

                              <DOCNO>PAY123</DOCNO>

                           <CUSTOMERNO>CUST100</CUSTOMERNO>

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

                           <AMOUNT>200 </AMOUNT>

                            <CURRENCYCODE>USD</CURRENCYCODE>

                            <REMARKS>Testing</REMARKS>

                </DOCHDR>

               <DOCBODY>

                           <PAYMENT>

                                         <PAYMODE   MODE=”CREDIT CARDC”>

                                                  <AUTHCODE>53441534</AUTHCODE>

                                                  <EXTTRANSID>1425239</EXTTRANSID>

                                          </PAYMODE>                              

                                          <RECEIPTNO>19782545</RECEIPTNO>

                             </PAYMENT>

              </DOCBODY>

</DOCUMENT>

</RESPONSEINFO>

Output Parameters: CREDITNOTE document type

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 - Invalid Date and Time Format

1100 – Invalid limit

MESSAGE

String

Returns "Success" or "Failed"

DATE

Date

Credit note date

AMOUNT

Decimal

Credit note amount

CUSTOMERNO

String

Customer number

CURRENCYCODE

String

Currency code

REMARKS

String

Notes

CREDITTYPE

String

Credit type

Response XML Format: CREDITNOTE document type

<RESPONSEINFO>

<STATUS>

   <TRANSACTIONNO>2551</TRANSACTIONNO>

   <ERRORNO>0</ERRORNO>

   <MESSAGE>SUCCESS</MESSAGE>

</STATUS> 

<DOCUMENT>

               <DOCHDR>

                          <DOCTYPE>CREDITNOTE</DOCTYPE>

                            <DOCNO>CR123</DOCNO>

                           <CUSTOMERNO>CUST100</CUSTOMERNO>

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

                           <AMOUNT>200 </AMOUNT>

                            <CURRENCYCODE>USD</CURRENCYCODE>

                           <REMARKS>Testing</REMARKS>

                </DOCHDR>

               <DOCBODY>

                             <CREDITNOTE>

                                       <CREDITTYPE></CREDITTYPE>

                             </CREDITNOTE>

               </DOCBODY>

</DOCUMENT>

</RESPONSEINFO>

Output Parameters: REFUND document type

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 - Invalid Date and Time Format
1100 – Invalid limit
MESSAGE String Returns "Success" or "Failed"
DATE Date Refund date
AMOUNT Decimal Refund amount
CUSTOMERNO String Customer number
CURRENCYCODE String Currency code
REMARKS String Notes
REFUNDTYPE String Refund type

Response XML Format: REFUND document type

<RESPONSEINFO>

<STATUS>

   <TRANSACTIONNO>2551</TRANSACTIONNO>

   <ERRORNO>0</ERRORNO>

   <MESSAGE>SUCCESS</MESSAGE>

</STATUS> 

<DOCUMENT>

               <DOCHDR>

                          <DOCTYPE>REFUND</DOCTYPE>

                           <DOCNO>REF123</DOCNO>

                           <CUSTOMERNO>CUST100</CUSTOMERNO>

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

                           <AMOUNT>200 </AMOUNT>

                            <CURRENCYCODE>USD</CURRENCYCODE>

                            <REMARKS>Testing</REMARKS>

                </DOCHDR>

               <DOCBODY>

                            <REFUND>

                                       <REFUNDTYPE>Balance</REFUNDTYPE>

                            </REFUND>

               </DOCBODY>

</DOCUMENT>

</RESPONSEINFO>

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