Daftar invoice

GET/v1/invoicesJalankan

Membutuhkan izin invoices:read.

Parameter query

project_idstringopsional

Hanya invoice proyek ini.

Contoh: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali prj_.

statusstringopsional

Hanya invoice dengan status ini.

Contoh: draft

Nilai yang mungkin: draft, open, paying, paid, expired, void

qstringopsional

Nomor invoice, atau sebagian nama atau email pelanggan.

Contoh: Budi

Panjang minimum: 1

Panjang maksimum: 100

starting_afterstringopsional

Id item terakhir di halaman yang sudah kamu punya. Halaman berikutnya dimulai setelah item itu.

Contoh: inv_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali inv_.

limitintegeropsional

Jumlah item per halaman, dari 1 sampai 100. Bawaannya 20.

Contoh: 20

Minimum: 1

Maksimum: 100

Respons (200)

Mengembalikan satu halaman daftar: data berisi item, dan meta.pagination menunjukkan kelanjutannya. Halaman berikutnya dengan limit dan starting_after (id item terakhir yang sudah kamu punya), atau ambil meta.pagination.next.

dataarray dari objectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

idstringwajib

Id invoice (inv_…).

Contoh: inv_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali inv_.

livemodebooleanwajib

true berarti objek ini ada di live dan bisa melibatkan pembayaran sungguhan; false berarti objek ini ada di sandbox.

project_idstringwajib

Proyek tempat objek ini berada. Pengaturannya menentukan metode pembayaran dan batas yang berlaku.

Contoh: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali prj_.

numberstringwajib

Nomor urut invoice-mu per bulan: INV/2026/10/0001. Nomor tidak pernah dipakai dua kali.

Contoh: INV/2026/10/0001

statusstringwajib

draft (bisa diubah), open (menunggu pembayaran), paying (pembayaran sedang berjalan), paid, expired (lewat jatuh tempo), atau void.

Contoh: open

Nilai yang mungkin: draft, open, paying, paid, expired, void

customer_namestringwajib

Nama pelanggan yang kamu tagih.

Contoh: Budi Santoso

customer_emailstringwajib

Ke mana tautan bayar dikirim saat invoice diterbitkan di live.

Contoh: budi@example.com

customer_phonestring | nullwajib

Nomor telepon pelanggan; opsional.

Contoh: +628123456789

notestring | nullwajib

Catatan pada invoice, sampai 500 karakter.

Contoh: Terima kasih atas kepercayaannya.

itemsarray dari objectwajib

Baris-baris tagihan, dari 1 sampai 50.

descriptionstringwajib

Nama produk atau jasa yang ditagihkan pada baris invoice ini.

Contoh: Desain logo

quantityintegerwajib

Jumlah unit pada baris ini; dikalikan dengan unit_amount untuk menghitung amount.

Contoh: 2

unit_amountintegerwajib

Harga satu unit, rupiah bulat, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 30000000

amountintegerwajib

Total baris: jumlah dikali harga satuan, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 60000000

currencystringwajib

Mata uang, kode ISO 4217. Saat ini hanya IDR.

Contoh: IDR

Nilai: IDR

subtotalintegerwajib

Jumlah semua baris, sebelum pajak, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 60000000

tax_rate_bpintegerwajib

Satu tarif pajak untuk seluruh invoice dalam basis poin: 1100 berarti 11%. Tanpa pajak bila dikosongkan.

Contoh: 1100

tax_amountintegerwajib

Pajaknya, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 6600000

totalintegerwajib

Yang dibayar pelanggan: subtotal ditambah pajak, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 66600000

fee_bearerstringwajib

Siapa yang menanggung biaya Baiyar: merchant memotongnya dari yang kamu terima, customer menambahkannya ke yang dibayar pembayar.

Contoh: merchant

Nilai yang mungkin: merchant, customer

due_atstringwajib

Kapan invoice jatuh tempo (RFC 3339). Setelah itu tautan bayar tidak lagi menerima pembayaran.

Contoh: 2026-11-15T16:59:59Z

Format: date-time

urlstring | nullwajib

Alamat yang dikirim ke pelanggan untuk membayar. Null sampai invoice diterbitkan.

Contoh: https://pay.baiyar.com/p/lt_live_…

payment_link_idstring | nullwajib

Payment link sekali pakai yang dibuat saat invoice diterbitkan; null untuk draf.

Contoh: lnk_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali lnk_.

issued_atstring | nullwajib

Kapan diterbitkan; null untuk draf.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

paid_atstring | nullwajib

Waktu pembayaran dikonfirmasi lunas (RFC 3339, UTC); null sebelum itu.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

voided_atstring | nullwajib

Kapan dibatalkan; null bila tidak.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

versionintegerwajib

Kirim kembali saat menulis ulang draf, supaya penyimpanan orang lain di antaranya ketahuan.

Contoh: 1

created_atstringwajib

Waktu objek ini dibuat (RFC 3339, UTC). Gunakan untuk mengurutkan objek berdasarkan waktu pembuatan.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

metaobjectwajib

Detail request seperti id dan kursor paginasi.

request_idstringwajib

Id request ini. Sebutkan saat bertanya ke dukungan.

Contoh: req_Hy3k9QzT2LmN8vXa

paginationobjectwajib

Detail paginasi untuk respons daftar. Gunakan next untuk mengambil halaman berikutnya, atau starting_after untuk menyusun URL sendiri.

per_pageintegerwajib

Jumlah item yang dikembalikan di halaman ini.

Contoh: 20

has_morebooleanwajib

true berarti masih ada item di halaman berikutnya.

nextstring | nullwajib

Alamat halaman berikutnya, dengan filtermu tetap; null di halaman terakhir.

Contoh: string

Request yang gagal dijawab dengan bentuk error yang sama; lihat Error.

Request

curl "https://api.baiyar.com/v1/invoices" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Respons

{
  "data": [
    {
      "id": "inv_01k7q3m8x2v5t9n4b6c1d0e7fa",
      "livemode": false,
      "project_id": "prj_01k7q3m8x2v5t9n4b6c1d0e7fa",
      "number": "INV/2026/10/0001",
      "status": "open",
      "customer_name": "Budi Santoso",
      "customer_email": "budi@example.com",
      "customer_phone": "+628123456789",
      "note": "Terima kasih atas kepercayaannya.",
      "items": [
        {
          "description": "Desain logo",
          "quantity": 2,
          "unit_amount": 30000000,
          "amount": 60000000
        }
      ],
      "currency": "IDR",
      "subtotal": 60000000,
      "tax_rate_bp": 1100,
      "tax_amount": 6600000,
      "total": 66600000,
      "fee_bearer": "merchant",
      "due_at": "2026-11-15T16:59:59Z",
      "url": "https://pay.baiyar.com/p/lt_live_…",
      "payment_link_id": "lnk_01k7q3m8x2v5t9n4b6c1d0e7fa",
      "issued_at": "2026-10-26T03:04:05.000Z",
      "paid_at": "2026-10-26T03:04:05.000Z",
      "voided_at": "2026-10-26T03:04:05.000Z",
      "version": 1,
      "created_at": "2026-10-26T03:04:05.000Z"
    }
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa",
    "pagination": {
      "per_page": 20,
      "has_more": true,
      "next": "https://api.baiyar.com/v1/invoices?starting_after=inv_01k7q3m8x2v5t9n4b6c1d0e7fa"
    }
  }
}