POSTMultiple Invoice Query Service

This service should be used if corporate invoices are to be inquired collectively. Invoice information that can be queried at once is a maximum of 15.

serviceAddress: /invoices/multipleinvoicequery

Request

Header
Parameter Name Parameter Type Explanation
ApiKey

required

 string It is provided by the service provider.

for example; 3f0126be-****-****-****-06025352594a

SecretKey

required

 string It is provided by the service provider.

for example; 3f0126be-****-****-****-06025352594a

Body Parameter
Parameter Name Parameter Type Explanation
invoiceQueryList

required

 ListArray Invoice query list

invoiceQueryList Details
Parameter Name Parameter Type Explanation
sootCode

required

 string The code of the institution to be queried.
subscriberNo

required

 string The subscriber (installation) number on the invoice.
additionalNo

optional

 string The additional number of the invoice.

Note: If there is no business code, it should be sent blank.

firmRefNo

required

 string The unique reference number created by the merchant.

It should be a maximum of 15 characters.


Request Sample
 {
        "invoiceQueryList": [
        {
            "sootCode": "1",
            "subscriberNo": "01345677000",
            "additionalNo": "",
            "firmRefNo": "589652454499"
        },
        {
            "sootCode": "1",
            "subscriberNo": "01345699000",
            "additionalNo": "",
            "firmRefNo": "589652454499"
        },
        {
            "sootCode": "1",
            "subscriberNo": "0134569000",
            "additionalNo": "",
            "firmRefNo": "589652454499"
        },
        {
            "sootCode": "1",
            "subscriberNo": "1345600",
            "additionalNo": "",
            "firmRefNo": "589652454499"
        }
 }

Response

Response Parameter
Parameter Name Parameter Type Explanation
invoiceQueryList[] ListArray Invoice query list
invoiceQueryList 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 The invoice debt list returns as an array.

invoiceList Parameter
Parameter Name Parameter Type Explanation
invoiceQueryId integer The Id value of the invoice being queried.
subscriberNo string The subscriber (installation) number on the invoice.
customerName string Subscriber's name and surname
invoiceNo string Invoice number
expDate string The last payment date of the invoice.
invoiceAmount decimal Amount of the invoice
merchantProfit decimal Service fee
totalAmount decimal Total amount
sootCode integer The code of the institution to be queried.

Response Sample
     {
            "invoices": [
        {
            "invoiceList": [
                {
                    "invoiceQueryId": 615202,
                    "subscriberNo": "01345677000",
                    "customerName": "DE*** ÖZ****",
                    "invoiceNo": "0000000",
                    "expDate": "10.05.2022",
                    "invoiceAmount": 560.0,
                    "merchantProfit": 2.00,
                    "totalAmount": 562.00,
                    "sootCode": 1
                }
            ],
            "result": true,
            "resultCode": 1,
            "resultMessage": "İşlem Başarılı"
        },
        {
            "invoiceList": [
                {
                    "invoiceQueryId": 615203,
                    "subscriberNo": "01345699000",
                    "customerName": "A** B***********",
                    "invoiceNo": "0000000",
                    "expDate": "10.05.2022",
                    "invoiceAmount": 2.0,
                    "merchantProfit": 2.00,
                    "totalAmount": 4.00,
                    "sootCode": 1
                }
            ],
            "result": true,
            "resultCode": 1,
            "resultMessage": "İşlem Başarılı"
        },
        {
            "invoiceList": [
                {
                    "invoiceQueryId": 615204,
                    "subscriberNo": "0134569000",
                    "customerName": "AB*** FA*******",
                    "invoiceNo": "0000000",
                    "expDate": "10.05.2022",
                    "invoiceAmount": 57.0,
                    "merchantProfit": 2.00,
                    "totalAmount": 59.00,
                    "sootCode": 1
                }
            ],
            "result": true,
            "resultCode": 1,
            "resultMessage": "İşlem Başarılı"
        },
        {
            "invoiceList": [],
            "result": false,
            "resultCode": -1,
            "resultMessage": "Abone Numarasına Ait Borç Kaydı Bulunmamaktadır"
        }
    ]
     }