Call GetRemittancesByCustomer API to retrieve list of remittances by customer number and between specified date range. Details of documents are retrieved in xml format. This API receives GetRemittancesByCustomer XML as input and renders Response XML as output.
public string GetRemittancesByCustomer (string GetRemittancesByCustomer XML, string ReferenceNo)
|
Argument Name |
Data Type |
Is Mandatory |
Description |
|
GetRemittancesByCustomerXML |
String |
Yes |
An XML string that contains customer number and date range. |
|
ReferenceNo |
String |
Yes |
An unique number provided to identify the request |
|
Element Name |
Data Type |
Length |
Is Mandatory |
Description |
|
CUSTOMERNO |
String |
16 |
Y |
Customer 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. |
|
LIMIT |
Number |
|
N |
Total number of records to be retrieved. Default value is 500 |
<REQUESTINFO>
<KEY_NAMEVALUE>
<KEY_NAME>CUSTOMERNO</KEY_NAME>
<KEY_VALUE>1234</KEY_VALUE>
</KEY_NAMEVALUE>
<ADDITIONALPARAM>
<FROMDATE>01-01-2010</FROMDATE>
<TODATE>30-04-2010</TODATE>
<LIMIT>10</LIMIT>
</ADDITIONALPARAM>
</REQUESTINFO>
|
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" |
|
REMITTANCEID |
Number |
Remittance Id |
|
CUSTOMERNO |
String |
Customer Number |
|
REMITTANCEDATE |
Date |
Remittance Date |
|
AMOUNT |
Decimal |
Amount |
|
BANKACCOUNT |
String |
Bank Account Number |
|
CURRENCYCODE |
String |
Currency code |
|
STATUS |
String |
Status- Values can be 'Pending' or ''Processed' |
<RESPONSEINFO>
<STATUS>
<TRANSACTIONNO>2551</TRANSACTIONNO>
<ERRORNO>0</ERRORNO>
<MESSAGE>SUCCESS</MESSAGE>
</STATUS>
<REMITTANCEID>100</REMITTANCEID>
<CUSTOMERNO>CUST100</CUSTOMERNO>
<REMITTANCEDATE>25-05-2010</REMITTANCEDATE>
<AMOUNT>200</AMOUNT>
<BANKACCOUNT>A12354345</BANKACCOUNT>
<CURRENCYCODE>USD</CURRENCYCODE>
<STATUS></STATUS>
</RESPONSEINFO>
Note: Refer to Error Codes and Description to view errors in detail.