Bab 13 · Developer API
Glosarium & Daftar Enum
Padanan istilah Indonesia ke nama field API, plus daftar lengkap nilai enum yang bisa muncul di respons.
Kenapa API-nya berbahasa Inggris
Aplikasi Lensiro berbahasa Indonesia, tapi seluruh path dan nama field API memakai bahasa Inggris — konvensi lazim untuk API, dan membuatnya bisa dipakai pustaka pihak ketiga tanpa penyesuaian. Tabel di bawah adalah jembatannya.
Padanan istilah
| Istilah di aplikasi | Di API | Keterangan |
|---|---|---|
| Penjualan / Transaksi | sale, /sales | Satu transaksi penjualan |
| Nomor SO | sales_order_number | SO-{cabang}-{urutan}, atau POS-... untuk kasir langsung |
| Faktur / Invoice | invoice_number, invoice_date | Terisi setelah difakturkan |
| Pelanggan / Member | member, /members | Di objek sale muncul sebagai customer |
| Kasir | cashier | Penerima pembayaran |
| Sales / Penjual | salesperson | Pembuat transaksi |
| Cabang | branch, branch_id | |
| Gudang | warehouse, /warehouse | |
| Barang | item, /warehouse/items | |
| Stok | stock, on_hand | |
| Perubahan Stok | stock-movements | Barang masuk dan keluar |
| Mutasi antar cabang | TRANSFER_OUT / TRANSFER_IN | |
| Opname | ADJUSTMENT dengan adjustment_type: "OPNAME" | |
| Faset / Fasset | facet, /sales/facets | Pekerjaan pemasangan lensa |
| Asuransi / BPJS | ASSURANCE, insurance_total | Dicatat sebagai jenis pembayaran |
| Poin | point_balance, point-logs | |
| Diskon | discount, sale_discount, item_discount_total | |
| Sisa tagihan / Piutang | outstanding | |
| Harga jual | sell_price | |
| Kode barang | code, custom_code, display_code | |
| Memo / Catatan | memo |
Daftar enum
status pada sale
| Nilai | Arti |
|---|---|
OPEN | Sudah dibuat, belum difakturkan |
COMPLETED | Sudah difakturkan |
CANCELED | Dibatalkan |
type pada pembayaran
| Nilai | Arti |
|---|---|
CASH | Tunai |
DEBIT | Kartu debit |
CREDIT | Kartu kredit |
QRIS | QRIS |
ASSURANCE | Tanggungan asuransi atau BPJS — bukan uang tunai masuk |
POINT | Ditukar dengan poin — bukan uang |
REFUND | Pengembalian dana; nilainya negatif |
status pada faset
| Nilai | Arti |
|---|---|
WORKING | Sedang dikerjakan |
SUCCESS | Selesai |
FAILED | Gagal, misalnya lensa pecah; penyebabnya biasanya ada di memo |
type pada pergerakan stok
| Nilai | Tanda | Arti |
|---|---|---|
PURCHASE_RECEIVE | + | Penerimaan pembelian |
TRANSFER_IN | + | Mutasi masuk, setelah diterima |
ADJUSTMENT | +/− | Opname atau penghapusan persediaan |
SALE | − | Terjual |
COMP_ITEM | − | Barang bonus atau komplimen |
PURCHASE_RETURN | − | Retur ke supplier |
PURCHASE_SENT | − | Barang dikirim untuk pesanan pembelian |
TRANSFER_OUT | − | Mutasi keluar |
FIT_BUFFER | − | Dipesan lewat Lensiro Fit |
adjustment_type
| Nilai | Arti |
|---|---|
OPNAME | Penyesuaian hasil stok opname |
WRITE_OFF | Penghapusan persediaan, misalnya rusak atau hilang |
gender pada pelanggan
MALE, FEMALE, atau null.
Objek kecil yang berulang
Bentuk-bentuk ini muncul di banyak tempat dengan struktur yang selalu sama:
"branch": { "id": 2, "code": "PST", "name": "Cabang Pusat" }
"customer": { "id": 511, "name": "Budi Santoso" }
"bank": { "id": 1, "name": "BCA" }
"insurance": { "id": 3, "name": "BPJS Kesehatan", "card_number": "00012345" }
"item": { "id": 3321, "code": "FR3321", "name": "Frame CONTOH X-01 Black" }
Semuanya bisa bernilai null kalau relasinya memang kosong.
