# 收款单列表

## 请求

```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     | 收款单 ID，UUID 格式                                          | 1c48b092-9878-48f5-b441-07a8a48e7b54 | 否       |        |
| `invoiceUid` | String   | 收款单 ID（面向买家）                                         | F7ncQviM1N92                         | 否       |        |
| `projectId`  | UUID     | 项目 ID，UUID 格式                                            | 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`                          | 收款单 ID，UUID 格式                                                                                                                                                       |
| `uid`                         | 收款单 ID（面向买家）                                                                                                                                                      |
| `projectId`                   | 项目 ID，UUID 格式                                                                                                                                                         |
| `createDatetime`              | 收款单创建日期和时间 (UTC)                                                                                                                                                 |
| `timeToPayDatetime`           | 收款单有效期截止的日期和时间 (UTC)。买家须在此时间之前支付收款单                                                                                                           |
| `commissionFiatUSD`           | 服务费金额，按 `amountFiatUSD` 金额计算                                                                                                                                    |
| `amountFiatUSD`               | 折算成 USD 的收款单金额。创建收款单时按当时汇率由 `amountFiat` 换算。付款时被实际收到的金额覆盖，按付款时刻的汇率折算成 USD。`commissionFiatUSD` 中的服务费也随之重算      |
| `amountFiat`                  | 收款单的法币原始金额，不会改变                                                                                                                                             |
| `currencyFiat`                | 法币币种                                                                                                                                                                   |
| `description`                 | 创建收款单时填写的描述，向买家展示                                                                                                                                         |
| `serviceData`                 | 创建收款单时填写的服务数据，不向买家展示。用于在商户店铺中识别收款单和付款                                                                                                 |
| `views`                       | 支付页面的浏览次数                                                                                                                                                         |
| `status`                      | 收款单状态                                                                                                                                                                 |
| `payment`                     | 付款参数块。收款单已支付时存在                                                                                                                                             |
| `payment.id`                  | 付款 ID，UUID 格式                                                                                                                                                         |
| `payment.amount`              | 以加密货币计的付款金额                                                                                                                                                     |
| `payment.hash`                | 链上交易哈希                                                                                                                                                               |
| `payment.transactionDatetime` | 链上交易的日期和时间 (UTC)                                                                                                                                                 |
| `wallet`                      | 收到付款的钱包参数块。收款单已支付时存在                                                                                                                                   |
| `wallet.id`                   | 钱包 ID，UUID 格式                                                                                                                                                         |
| `wallet.name`                 | 钱包名称                                                                                                                                                                   |
| `wallet.blockchain`           | 加密钱包所在的区块链                                                                                                                                                       |
| `wallet.cryptocurrency`       | 钱包的加密货币                                                                                                                                                             |
| `wallet.address`              | 加密钱包地址                                                                                                                                                               |