# Fatura Listesi

Bir düzenli ödemeye ait ödeme kayıtlarının listesini girilen parametrelere göre dönen servistir.

{% hint style="success" %}
<https://api.paynet.com.tr/v1/subscription/invoice_list>
{% endhint %}

{% tabs %}
{% tab title="İstek Parametreleri" %}

| Parametre İsmi       | Tip    | Zorunlu | Açıklama               |
| -------------------- | ------ | ------- | ---------------------- |
| **agent\_id**        | string | Hayır   | Bayi Kodu              |
| **limit**            | int    | Hayır   | Limit bilgisi          |
| **invoice\_status**  | string | Hayır   | Fatura Durumu          |
| **subscription\_id** | string | Evet\*  | Düzenli Ödeme ID       |
| **reference\_no**    | string | Evet\*  | Düzenli Ödeme numarası |
| {% endtab %}         |        |         |                        |

{% tab title="Dönüş Parametreleri" %}

| Parametre İsmi                       | Tip    | Açıklama                                                                                                                                                                           |
| ------------------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **total**                            | int    | Toplam satır sayısı                                                                                                                                                                |
| **total\_count**                     | int    | Toplam gösterilen satır sayısı                                                                                                                                                     |
| **limit**                            | int    | Döndürülecek veri sayısı. Default 10 kayıt döner.                                                                                                                                  |
| **ending\_before**                   | int    | Belirtilen index’den önceki limit sayısı kadar kayıt getirir. Eğer ending\_before 90 gönderildi, limit olarak 15 gönderildi. 75. İle 90. Kayıtları arasındaki kayıtları gönderir.  |
| **starting\_after**                  | int    | Belirtilen index’den sonraki limit sayısı kadar kayıt getirir. Eğer starting after 15 gönderildi, limit olarak 15 gönderildi. 15. İle 30. Kayıtları arasındaki kayıtları gönderir. |
| **has\_more**                        | bool   | True ise Belirtilen kriterlerde gönderilen satırlardan daha olduğu anlamına gelir.                                                                                                 |
| **Data\[]**                          |        |                                                                                                                                                                                    |
| <p>->  </p><p>subscription\_id</p>   | string | Düzenli ödeme no                                                                                                                                                                   |
| -> subscription\_attempt\_day\_count |        |                                                                                                                                                                                    |
| -> invoice\_id                       |        |                                                                                                                                                                                    |
| -> invoice\_no                       |        | Düzenli ödeme fatura numarası                                                                                                                                                      |
| -> invoice\_val\_date                |        |                                                                                                                                                                                    |
| -> invoice\_amount                   |        |                                                                                                                                                                                    |
| -> invoice\_agent\_amount            |        |                                                                                                                                                                                    |
| -> invoice\_company\_amount          |        |                                                                                                                                                                                    |
| -> invoice\_attempt\_count           |        |                                                                                                                                                                                    |
| -> invoice\_status                   |        |                                                                                                                                                                                    |
| -> invoice\_succeed\_xact\_id        |        |                                                                                                                                                                                    |
| -> invoice\_sms\_posted              |        |                                                                                                                                                                                    |
| -> invoice\_email\_posted            |        |                                                                                                                                                                                    |
| -> invoice\_status\_desc             |        |                                                                                                                                                                                    |
| **object\_name**                     | string | Dönüş yapılan API’nin nesne adı                                                                                                                                                    |
| **code**                             | string | Dönüş sonucunun kodu                                                                                                                                                               |
| **message**                          | string | Dönüş sonuç kodunun açıklaması                                                                                                                                                     |
| {% endtab %}                         |        |                                                                                                                                                                                    |

{% tab title="Request" %}

```
{  
   "agent_id":"48811",
   "limit":1000,
   "invoice_status":0,
   "reference_no":""
}
```

{% endtab %}

{% tab title="Response" %}

```
{
  "total": 3,
  "total_count": 0,
  "limit": 1000,
  "ending_before": 0,
  "starting_after": 0,
  "has_more": false,
  "Data": [
    {
      "subscription_id": "184d7591-51c1-45c8-bdd5-6e65c9b1f828",
      "subscription_attempt_day_count": 5,
      "invoice_id": 5617,
      "invoice_no": "11400551",
      "invoice_val_date": "2017-09-29T11:11:16",
      "invoice_amount": 55.08,
      "invoice_agent_amount": 4.49,
      "invoice_company_amount": 50.59,
      "invoice_attempt_count": 0,
      "invoice_status": 0,
      "invoice_succeed_xact_id": -1,
      "invoice_sms_posted": false,
      "invoice_email_posted": false,
      "invoice_status_desc": "Bekleniyor"
    },
    {
      "subscription_id": "184d7591-51c1-45c8-bdd5-6e65c9b1f828",
      "subscription_attempt_day_count": 5,
      "invoice_id": 5618,
      "invoice_no": "11400552",
      "invoice_val_date": "2017-09-29T11:14:11",
      "invoice_amount": 55.08,
      "invoice_agent_amount": 4.49,
      "invoice_company_amount": 50.59,
      "invoice_attempt_count": 0,
      "invoice_status": 0,
      "invoice_succeed_xact_id": -1,
      "invoice_sms_posted": false,
      "invoice_email_posted": false,
      "invoice_status_desc": "Bekleniyor"
    },
    {
      "subscription_id": "184d7591-51c1-45c8-bdd5-6e65c9b1f828",
      "subscription_attempt_day_count": 5,
      "invoice_id": 5622,
      "invoice_no": "11400555",
      "invoice_val_date": "2017-10-02T12:10:59",
      "invoice_amount": 21.67,
      "invoice_agent_amount": 2.58,
      "invoice_company_amount": 19.09,
      "invoice_attempt_count": 0,
      "invoice_status": 0,
      "invoice_succeed_xact_id": -1,
      "invoice_sms_posted": false,
      "invoice_email_posted": false,
      "invoice_status_desc": "Bekleniyor"
    }
  ],
  "object_name": "subscription_invoice_list",
  "code": 0,
  "message": null
}
```

{% endtab %}

{% tab title="Service Url" %}

| Sistem           | URL                                                                                                                                                                                                                                                    |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Canlı Sistem** | <https://api.paynet.com.tr/v1/subscription/invoice_list>                                                                                                                                                                                               |
| **Test Sistemi** | ​ [https://pts-api.paynet.com.tr​​\[/v1/subscription/invoice\\\_list](https://doc.paynet.com.tr/uornek/servisler/abonelik/https:/pts-api.paynet.com.tr​​\[/v1/subscription/invoice\\_list)]\(<https://api.paynet.com.tr/v1/subscription/invoice_list>) |
| {% endtab %}     |                                                                                                                                                                                                                                                        |
| {% endtabs %}    |                                                                                                                                                                                                                                                        |

{% hint style="info" %}
\*subcription\_id veya reference\_no'dan en az birini göndermeniz gerekmektedir.
{% endhint %}