Faturaları listele

İstek

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"

İstek parametreleri

Parametre	Veri türü	Açıklama	Örnek	Zorunlu mu?	Varsayılan
invoiceId	UUID	UUID biçiminde fatura ID'si	1c48b092-9878-48f5-b441-07a8a48e7b54	hayır
invoiceUid	String	Fatura ID'si (alıcı için)	F7ncQviM1N92	hayır
projectId	UUID	UUID biçiminde proje ID'si	1c48b092-9878-48f5-b441-07a8a48e7b54	hayır
startDate	String	Fatura oluşturmanın başlangıç tarihi, Y-m-d biçiminde	2000-01-01	hayır
endDate	String	Fatura oluşturmanın bitiş tarihi, Y-m-d biçiminde	2030-01-01	hayır
status	String	Fatura durumu. İzin verilen değerler: unpaid, canceled, paid, expired	paid	hayır
offset	Integer	Döndürülecek ilk kaydın dizini	0	hayır	0
limit	Integer	Almak istediğiniz kayıt sayısı	50	hayır	10

Yanıt örneği

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

Yanıt parametreleri

Parametre	Açıklama
id	UUID biçiminde fatura ID'si
uid	Fatura ID'si (alıcı için)
projectId	UUID biçiminde proje ID'si
createDatetime	Faturanın oluşturulma tarihi ve saati (UTC)
timeToPayDatetime	Faturanın geçerli olduğu son tarih ve saat (UTC). Alıcı, faturayı bu zamandan önce ödemelidir
commissionFiatUSD	Hizmet ücreti tutarı. amountFiatUSD tutarından hesaplanır
amountFiatUSD	USD'ye dönüştürülmüş fatura tutarı. Fatura oluşturulurken amountFiat değerinden güncel kura göre hesaplanır. Ödeme anında üzerine, o andaki kurla USD'ye dönüştürülerek fiilen alınan tutar yazılır. commissionFiatUSD içindeki ücret de bundan yeniden hesaplanır
amountFiat	Faturanın itibari para cinsinden orijinal tutarı. Değişmez
currencyFiat	İtibari para birimi
description	Fatura oluşturulurken ayarlanan açıklama. Alıcıya gösterilir
serviceData	Fatura oluşturulurken ayarlanan hizmet verisi. Alıcıya gösterilmez. Satıcının mağazasında faturayı ve ödemeyi tanımlamak için kullanılır
views	Ödeme sayfası görüntülenme sayısı
status	Fatura durumu
payment	Ödeme parametrelerini içeren blok. Fatura ödendiyse bulunur
payment.id	UUID biçiminde ödeme ID'si
payment.amount	Kripto para cinsinden ödeme tutarı
payment.hash	On-chain işlemin hash'i
payment.transactionDatetime	On-chain işlemin tarihi ve saati (UTC)
wallet	Ödemeyi alan cüzdanın parametrelerini içeren blok. Fatura ödendiyse bulunur
wallet.id	UUID biçiminde cüzdan ID'si
wallet.name	Cüzdan adı
wallet.blockchain	Kripto cüzdanının blockchain'i
wallet.cryptocurrency	Cüzdanın kripto parası
wallet.address	Kripto cüzdanının adresi