POSTViewing Invoice List
Merchant merchants can display their invoices within a certain date range by POSTing the following parameters to the "InvoiceList" method. The submitted date range is limited to 15 days.
Service Address: /invoices/invoicelist
Request
Header
Parameter Name | Parameter Type | Explanation |
---|---|---|
ApiKey
|
string | It is provided by the service provider .
|
SecretKey
|
string | It is provided by the service provider .
|
Body Parameter
Parameter Name | Parameter Type | Explanation |
---|---|---|
firstDate
|
string | Report start date (yyyy-mm-dd) |
lastDate
|
string | Report due date (yyyy-mm-dd) |
Request Sample
{ "firstDate": "2022-05-09", "lastDate": "2022-05-10" }
Response
Response Parameter
Parameter Name | Parameter Type | Explanation |
---|---|---|
Result | boolean | The result of a successful or unsuccessful query. |
ResultCode | integer | The code that returns the query result. |
ResultMessage | string | The description that returns as a result of the query. |
InvoiceList[] | array | Invoices within the specified date range are returned. |
InvoiceList Parameter
Parameter Name | Parameter Type | Explanation |
---|---|---|
invoicePaymentId | integer | It is the "InvoicePaymentId" value returned as a result of the collection process. |
invoiceType | string | Bill type (Ex: Electricity Bill, Water Bill etc.) |
sootName | string | Company Name |
subscriberNo | string | It is the subscriber (installation) number on the invoice. |
customerName | string | Subscriber's name and surname |
invoiceNo | string | Invoice number |
expDate | string | It is the last payment date of the invoice. |
invoiceAmount | decimal | Amount of the invoice |
profit | decimal | It is the service fee charged for the collection process. |
paymentDate | string | It is the transaction date on which the collection is made. |
status | string | Status of the invoice Status = Paid “Invoice Paid” Status = Cancelled “Invoice Canceled” |
Response Sample
{ "invoiceList": [ { "invoicePaymentId": 1786, "invoiceType": "Su Faturası", "sootName": "İSKİ", "subscriberNo": "01345677000", "customerName": "DE*** ÖZ****", "invoiceNo": "0000000", "expDate": "10.05.2022", "invoiceAmount": 1.00, "profit": 0.50, "paymentDate": "10.05.2022", "status": "Paid" } ], "result": true, "resultCode": 1, "resultMessage": "İşlem Başarılı" }