# انوائسز کی فہرست حاصل کریں

## درخواست

```bash
curl -X POST https://api.bitsby.app/invoices/list \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
	-F "startDate=2000-01-01" \
	-F "endDate=2030-01-01" \
	-F "offset=0" \
	-F "limit=10"
```

## درخواست کے پیرامیٹرز

| پیرامیٹر    | ڈیٹا کی قسم | تفصیل                                                     | مثال                              | لازمی؟ | ڈیفالٹ |
| ------------ | --------- | --------------------------------------------------------------- | ------------------------------------ | --------- | ------- |
| `invoiceId`  | UUID      | UUID فارمیٹ میں انوائس ID                                       | 1c48b092-9878-48f5-b441-07a8a48e7b54 | نہیں        |         |
| `invoiceUid` | String    | انوائس ID (گاہک کے لیے)                                   | F7ncQviM1N92                         | نہیں        |         |
| `projectId`  | UUID      | UUID فارمیٹ میں پروجیکٹ ID                                       | 1c48b092-9878-48f5-b441-07a8a48e7b54 | نہیں        |         |
| `startDate`  | String    | انوائس بننے کی ابتدائی تاریخ، Y-m-d فارمیٹ میں                 | 2000-01-01                           | نہیں        |         |
| `endDate`    | String    | انوائس بننے کی آخری تاریخ، Y-m-d فارمیٹ میں                   | 2030-01-01                           | نہیں        |         |
| `status`     | String    | انوائس کا اسٹیٹس۔ اجازت شدہ قدریں: unpaid، canceled، paid، expired | paid                                 | نہیں        |         |
| `offset`     | Integer   | واپس کیے جانے والے پہلے ریکارڈ کا انڈیکس                             | 0                                    | نہیں        | 0       |
| `limit`      | Integer   | ریکارڈز کی تعداد جو آپ حاصل کرنا چاہتے ہیں                           | 50                                   | نہیں        | 10      |

## جواب کی مثال

```json
{
    "result": "success",
    "data": [
        {
            "id": "59302b02-d1be-4e10-960f-d6ec24bfcaaf",
            "uid": "F7nYgvxM1N92",
            "projectId": "9deea1e2-0c08-41a3-bdc2-a34eada3892d",
            "createDatetime": "2024-02-29 10:49:56",
            "timeToPayDatetime": "2024-02-29 22:49:56",
            "commissionFiatUSD": 1,
            "amountFiatUSD": 100,
            "amountFiat": 100,
            "currencyFiat": "USD",
            "description": null,
            "serviceData": null,
            "views": 0,
            "status": "canceled"
        },
        {
            "id": "f31c61f6-407f-4999-95cf-56477eff06d4",
            "uid": "riUZBnNvd2rX",
            "projectId": "9deea1e2-0c08-41a3-bdc2-a34eada3892d",
            "createDatetime": "2024-02-27 20:57:23",
            "timeToPayDatetime": "2024-02-28 08:57:23",
            "commissionFiatUSD": 0.12,
            "amountFiatUSD": 12,
            "amountFiat": 12,
            "currencyFiat": "USD",
            "description": null,
            "serviceData": "orderId:2444",
            "views": 3,
            "status": "paid",
            "payment": {
                "id": "f986ad8d-2298-473d-982a-efbc817b975d",
                "amount": 12,
                "hash": "f09352627039c088688806821b864895ff237558612d834861621fc026de5f68",
                "transactionDatetime": "2024-02-27 21:05:36"
            },
            "wallet": {
                "id": "47aa71e2-07a0-482e-9172-7114d7376ba0",
                "name": "usdt-tron",
                "blockchain": "tron",
                "cryptocurrency": "usdt",
                "address": "TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
            }
        }
    ]
}
```

## جواب کے پیرامیٹرز

| پیرامیٹر                     | تفصیل                                                                                                                                                                                                                                                                              |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                          | UUID فارمیٹ میں انوائس ID |
| `uid`                         | انوائس ID (گاہک کے لیے) |
| `projectId`                   | UUID فارمیٹ میں پروجیکٹ ID |
| `createDatetime`              | انوائس بننے کی تاریخ اور وقت (UTC) |
| `timeToPayDatetime`           | وہ تاریخ اور وقت جب تک انوائس درست رہتی ہے (UTC)۔ گاہک کو یہ انوائس اس وقت سے پہلے ادا کرنی ہے |
| `commissionFiatUSD`           | سروس فیس کی رقم۔ اس کا حساب `amountFiatUSD` کی رقم سے ہوتا ہے |
| `amountFiatUSD`               | USD میں تبدیل شدہ انوائس کی رقم۔ انوائس بنتے وقت اس کا حساب `amountFiat` سے موجودہ شرح تبادلہ پر ہوتا ہے۔ ادائیگی کے لمحے سروس اسے اصل میں موصول ہونے والی رقم سے بدل دیتی ہے، جو اس لمحے کی شرح تبادلہ پر USD میں تبدیل ہوتی ہے۔ `commissionFiatUSD` میں فیس بھی اسی سے دوبارہ شمار ہوتی ہے |
| `amountFiat`                  | فیاٹ کرنسی میں انوائس کی اصل رقم۔ نہیں بدلتی |
| `currencyFiat`                | فیاٹ کرنسی |
| `description`                 | انوائس بناتے وقت دی گئی تفصیل۔ گاہک کو نظر آتی ہے |
| `serviceData`                 | انوائس بناتے وقت دیا گیا سروس ڈیٹا۔ گاہک کو نظر نہیں آتا۔ تاجر کے اسٹور میں انوائس اور ادائیگی کی شناخت کے لیے استعمال ہوتا ہے |
| `views`                       | ادائیگی کے صفحے کے ویوز کی تعداد |
| `status`                      | انوائس کا اسٹیٹس |
| `payment`                     | ادائیگی کے پیرامیٹرز والا آبجیکٹ۔ انوائس ادا ہونے پر موجود ہوتا ہے |
| `payment.id`                  | UUID فارمیٹ میں ادائیگی کی ID |
| `payment.amount`              | کرپٹو کرنسی میں ادائیگی کی رقم |
| `payment.hash`                | آن چین ٹرانزیکشن کا ہیش |
| `payment.transactionDatetime` | آن چین ٹرانزیکشن کی تاریخ اور وقت (UTC) |
| `wallet`                      | اس والٹ کے پیرامیٹرز والا آبجیکٹ جس پر ادائیگی آئی۔ انوائس ادا ہونے پر موجود ہوتا ہے |
| `wallet.id`                   | UUID فارمیٹ میں والٹ ID |
| `wallet.name`                 | والٹ کا نام |
| `wallet.blockchain`            | کرپٹو والٹ کا بلاک چین |
| `wallet.cryptocurrency`       | والٹ کی کرپٹو کرنسی |
| `wallet.address`              | کرپٹو والٹ کا ایڈریس |
