# Listar cobranças

## Requisição

```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"
```

## Parâmetros da requisição

| Parâmetro    | Tipo de dado | Descrição                                                       | Exemplo                              | Obrigatório? | Padrão  |
| ------------ | --------- | --------------------------------------------------------------- | ------------------------------------ | --------- | ------- |
| `invoiceId`  | UUID      | ID da cobrança no formato UUID                                  | 1c48b092-9878-48f5-b441-07a8a48e7b54 | não        |         |
| `invoiceUid` | String    | ID da cobrança (para o cliente)                                 | F7ncQviM1N92                         | não        |         |
| `projectId`  | UUID      | ID do projeto no formato UUID                                   | 1c48b092-9878-48f5-b441-07a8a48e7b54 | não        |         |
| `startDate`  | String    | Data inicial de criação das cobranças, no formato Y-m-d         | 2000-01-01                           | não        |         |
| `endDate`    | String    | Data final de criação das cobranças, no formato Y-m-d           | 2030-01-01                           | não        |         |
| `status`     | String    | Status da cobrança. Valores permitidos: unpaid, canceled, paid, expired | paid                                 | não        |         |
| `offset`     | Integer   | Índice do primeiro registro a retornar                          | 0                                    | não        | 0       |
| `limit`      | Integer   | Número de registros que você quer receber                       | 50                                   | não        | 10      |

## Exemplo de resposta

```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"
            }
        }
    ]
}
```

## Parâmetros da resposta

| Parâmetro                     | Descrição                                                                                                                                                                                                                                                                                |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                          | ID da cobrança no formato UUID                                                                                                                                                                                                                                                           |
| `uid`                         | ID da cobrança (para o cliente)                                                                                                                                                                                                                                                          |
| `projectId`                   | ID do projeto no formato UUID                                                                                                                                                                                                                                                            |
| `createDatetime`              | Data e hora de criação da cobrança (UTC)                                                                                                                                                                                                                                                 |
| `timeToPayDatetime`           | Data e hora até as quais a cobrança é válida (UTC). O cliente deve pagar a cobrança antes desse horário                                                                                                                                                                                  |
| `commissionFiatUSD`           | Valor da taxa do serviço. Calculado a partir do valor `amountFiatUSD`                                                                                                                                                                                                                    |
| `amountFiatUSD`               | O valor da cobrança convertido para USD. Na criação da cobrança, é calculado a partir de `amountFiat` pela cotação atual. No momento do pagamento, é sobrescrito com o valor efetivamente recebido, convertido para USD pela cotação daquele momento. A taxa em `commissionFiatUSD` também é recalculada a partir dele |
| `amountFiat`                  | O valor original da cobrança em moeda fiat. Não muda                                                                                                                                                                                                                                     |
| `currencyFiat`                | Moeda fiat                                                                                                                                                                                                                                                                               |
| `description`                 | A descrição definida na criação da cobrança. Exibida ao cliente                                                                                                                                                                                                                          |
| `serviceData`                 | Os dados de serviço definidos na criação da cobrança. Não são exibidos ao cliente. Usados para identificar a cobrança e o pagamento na loja do lojista                                                                                                                                   |
| `views`                       | Número de visualizações da página de pagamento                                                                                                                                                                                                                                           |
| `status`                      | Status da cobrança                                                                                                                                                                                                                                                                       |
| `payment`                     | Bloco com os parâmetros do pagamento. Presente se a cobrança foi paga                                                                                                                                                                                                                    |
| `payment.id`                  | ID do pagamento no formato UUID                                                                                                                                                                                                                                                          |
| `payment.amount`              | Valor do pagamento em criptomoeda                                                                                                                                                                                                                                                        |
| `payment.hash`                | O hash da transação on-chain                                                                                                                                                                                                                                                             |
| `payment.transactionDatetime` | Data e hora da transação on-chain (UTC)                                                                                                                                                                                                                                                  |
| `wallet`                      | Bloco com os parâmetros da carteira que recebeu o pagamento. Presente se a cobrança foi paga                                                                                                                                                                                             |
| `wallet.id`                   | ID da carteira no formato UUID                                                                                                                                                                                                                                                           |
| `wallet.name`                 | Nome da carteira                                                                                                                                                                                                                                                                         |
| `wallet.blockchain`           | O blockchain da carteira cripto                                                                                                                                                                                                                                                          |
| `wallet.cryptocurrency`       | A criptomoeda da carteira                                                                                                                                                                                                                                                                |
| `wallet.address`              | O endereço da carteira cripto                                                                                                                                                                                                                                                            |