API

API Key

Untuk mendapatkan API Key, Anda dapat mengikuti langkah di bawah ini

INFO

Silahkan pastikan Anda sudah memiliki Akun dan Perusahaan yang terdaftar pada Klearance One Portal

Klik Username Anda pada bagian pojok kanan atas
Klik Profil
Klik Profil pada bagian kiri
Klik tombol Buat API Key

WARNING

jika tombol Buat API Key diklik untuk kedua kalinya, maka API Key sebelumnya tidak akan bisa dipakai kembali

Header Paramater

Kunjungi Klearance API Technical Documentation
Pada bagian Authorizations klik tombol panah
Copy nama parameter pada Header Paramater Name

Account

Url

Method	Url
POST	https://dev-api.klearance.online/{tenantcode}/Account/upload

Metode yang digunakan adalah POST, untuk {tenantcode} sendiri diisikan dengan nama perusahaan, untuk mendapatkan nama perusahan, user dapat melakukan:

Klik Username anda
Pilih Profile
Pilih Perusahaan
Ambil nama perusahaan

Paramaters	Description
`{tenantcode}`	Diisikan dengan nama perusahaan, Ex: https://app.klearance.online/Sentosa maka Sentosa adalah nama perusahaan yang akan diisikan pada {tenantcode} HTTP Method tersebut

Body

json

{
    "data": [
      {
        "code": "B001",
        "name": "PT. SENTOSA RAYA",
        "address": "JL. Pertamburan Raya Cakung Barat no 12",
        "zipcode": "12731",
        "phone": "0219720412",
        "fax": " ",
        "bondedtype": "BZ",
        "countrycode": "ID",
        "npwp": "012454930431000",
        "niper": " ",
        "tpbno": " ",
        "tpbdate": "2019-08-24T14:15:22Z",
        "kpbccode": "040300",
        "currencycode": "USD",
        "importerstatus": "1",
        "apitype": " ",
        "apinumber": " ",
        "nik": " ",
        "accountstatus": "90",
        "parentaccount": " ",
        "deletion": false
      }
    ]
  }

Paramaters	Condition	Description
`code`	Required	Kode perusahaan (Ex: B001)
`name`	Required	Nama perusahaan
`address`		Alamat perusahaan
`zipcode`		Zipcode perusahaan
`phone`		Nomor telepon perusahaan
`fax`		Nomor fax perusahaan
`bondedtype`	Required	Jenis fasilitas perusahaan diisikan dengan kode ( Ex: BZ) BW – Gudang Berikat BZ – Kawasan Berikat FTZ – Kawasan Perdagangan Bebas LOC – Lokal OVR – Luar Negeri PLB – Logistik Berikat
`countrycode`		Diisikan dengan kode negara ( Ex :ID untuk Indonesia)
`npwp`	Required	Nomor npwp perusahaan
`niper`		Nomor niper perusahaan
`tpbno`		Nomor tpb perusahaan
`tpbdate`		Tanggal tpb perusahaan
`kpbccode`		Kode kantor kpbc pengawas ( Ex: 040300 untuk KPU Tanjung Priok)
`currencycode`		Kode mata uang ( Ex: USD untuk United State Dollar)
`importerstatus`		Diisikan dengan kode importer status ( Ex: 1) 1 – Importer Umum 2 – Importer Produsen 12 – Importer Umum & Importir Produsen A – AEO M – Mitra Utama L – Lainnya AM – AEO & Mitra Utama AL – AEO & Lainnya ML – Mitra Utama & Lainnya
`apitype`		Diisikan dengan tipe api ( Ex: 1) 1 – APIU 2 – APIP
`apinumber`		nomor api
`nik`		Nik perusahaan
`accountstatus`		Diisikan dengan kode status akun ( Ex: 90 untuk Lainnya) 10 – Koperasi 20 – PMDN(Migas) 21 – PMDN(Non-Migas) 30 – PMA(Migas) 31 – PMA(Non-Migas) 40 – BUMN 41 – BUMD 60 – Perorangan 70 – Usaha Mikro, Kecil dan Menengah ( UMKM ) 90 – Lainnya
`parentaccount`		Diisikan dengan kode akun induk jika ada
`deletion`		Indikator yang berguna untuk mengetahui apakah akun tersebut sudah dihapus pada ERP. Jika `true`, maka akun tersebut tidak akan dapat digunakan, dan status akun tersebut akan menjadi Tidak Aktif Jika `false`, maka akun tersebut dapat digunakan, dan status akun tersebut akan menjadi Aktif

Product

Method	Url
POST	https://dev-api.klearance.online/{tenantcode}/Product/upload

Metode yang digunakan adalah POST, untuk {tenantcode} sendiri diisikan dengan nama perusahaan, untuk mendapatkan nama perusahan, user dapat melakukan:

Klik Username anda
Pilih Profile
Pilih Perusahaan
Ambil nama perusahaan

Paramaters	Description
`{tenantcode}`	Diisikan dengan nama perusahaan, Ex: https://app.klearance.online/Sentosa maka Sentosa adalah nama perusahaan yang akan diisikan pada {tenantcode} HTTP Method tersebut

Body

json

{
    "data": [
      {
        "code": "BS-001",
        "description": "Tiang Besi",
        "uomcode": "PCE",
        "hscode": "01012100",
        "countryorigin": "ID",
        "district": " ",
        "netweight": 0,
        "grossweight": 0,
        "volume": 0,
        "type": " ",
        "spf": " ",
        "model": " ",
        "extra1": " ",
        "extra2": " ",
        "extra3": " ",
        "extra4": " ",
        "mapping": [
          {
            "accountcode": "B001",
            "accountname": "PT. SENTOSA RAYA",
            "description": "Tiang Besi",
            "code": "BS-001"
          }
        ]
      }
    ]
  }

Apabila ingin menambahkan mapping menjadi dua atau lebih, user dapat menyalin isi table didalam { } dan ditambahkan koma setelah tutup kurung sebelum memulai buka kurung yang baru Contoh:

json

"mapping": [
          {
            "accountcode": "B001",
            "accountname": "PT. SENTOSA RAYA",
            "description": "Tiang Besi",
            "code": "BS-001"
          },
          {
            "accountcode": "B002",
            "accountname": "PT. INDONESIA RAYA",
            "description": "Tiang Besi",
            "code": "BS-001"
          }
]

Paramaters	Condition	Description
`code`	Required	Kode barang ( Ex: BS-001)
`description`	Required	Deskirpsi barang
`uomcode`	Required	Satuan barang, diisikan dengan kode satuan ( Ex: PCE untuk Piece)
`hscode`		Nomor hscode
`countryorigin`		Negara asal ( Ex : ID untuk Indonesia)
`district`		Daerah asal
`netweight`		Nilai berat bersih
`grossweight`		Nilai berat kotor
`volume`		Nilai volume
`type`		Tipe barang
`spf`		spesifikasi
`model`		model
`extra1`		Informasi tambahan
`extra2`		Informasi tambahan
`extra3`		Informasi tambahan
`extra4`		Informasi tambahan
`accountcode`	Required	Kode perusahaan ( Ex: B001)
`accountname`	Required	Nama perusahaan ( Ex: PT. SENTOSA RAYA)
`description`	Required	Deskirpsi barang
`code`	Required	Kode barang ( Ex: BS-001)

Purchase Order

Method	Url
POST	https://dev-api.klearance.online/{tenantcode}/PurchaseOrder/upload

Metode yang digunakan adalah POST, untuk {tenantcode} sendiri diisikan dengan nama perusahaan, untuk mendapatkan nama perusahan, user dapat melakukan:

Klik Username anda
Pilih Profile
Pilih Perusahaan
Ambil nama perusahaan

Paramaters	Description
`{tenantcode}`	Diisikan dengan nama perusahaan, Ex: https://dev.klearance.online/Sentosa maka Sentosa adalah nama perusahaan yang akan diisikan pada {tenantcode} HTTP Method tersebut

json

{
    "data": [
      {
        "organizationcode": " ",
        "pono": "PO-001",
        "podate": "2022-06-16T14:15:22Z",
        "suppliercode": "B001",
        "suppliername": "PT. SENTOSA RAYA",
        "currencycode": "USD",
        "transporttype": "1",
        "referenceno": " ",
        "loadingportcode": "IDTPP",
        "unloadingportcode": "IDTPP",
        "details": [
          {
            "lineno": "1",
            "productcode": "KO01",
            "productname": "KO001",
            "uomcode": "PCE",
            "quantity": 200,
            "price": 5,
            "totalprice": 1000,
            "quantityreceipt": 100,
            "deletion": false,
            "externalmodifiedon": "2022-08-17",
            "completed": false
          }
        ]
      }
    ]
  }

Apabila ingin menambahkan detail menjadi dua atau lebih, user dapat menyalin isi table didalam { } dan ditambahkan koma setelah tutup kurung sebelum memulai buka kurung yang baru Contoh:

json

"details": [
          {
            "lineno": "1",
            "productcode": "KO01",
            "productname": "KO001",
            "uomcode": "PCE",
            "quantity": 100,
            "price": 1,
            "totalprice": 100,
            "quantityreceipt": 10,
            "deletion": false,
            "externalmodifiedon": "2022-08-17",
            "completed": false
          },
          {
            "lineno": "2",
            "productcode": "LIP001",
            "productname": "LIP",
            "uomcode": "PCE",
            "quantity": 100,
            "price": 2,
            "totalprice": 200,
            "quantityreceipt": 20,
            "deletion": false,
            "externalmodifiedon": "2022-08-17",
            "completed": false
          }
        ]

Paramaters	Condition	Description
`organizationcode`		Kode organisasi
`pono`	Required	Nomor po ( Ex: PO-001)
`podate`	Required	Tanggal po, format tanggal: yyyy-mm-dd
`suppliercode`	Required	Kode supplier ( Ex: B001)
`suppliername`	Required	Nama supplier
`currencycode`		Kode mata uang ( Ex: USD untuk United State Dollar)
`transporttype`		Diisikan dengan nomor jenis transport ( Ex: 1) 1 - Lainnya 2 - Instalasi/Pipa 3 - Perairan 4 - Multimoda 5 - Pos 6 - Udara 7 - Darat 8 - Kerata Api 9 - Laut
`referenceno`		Nomor referensi supplier
`loadingportcode`		Kode pelabuhan muat ( Ex: IDTPP untuk Tanjung Priok)
`unloadingportcode`		Kode pelabuhan bongkar ( Ex: JPTYO untuk Tokyo)
`lineno`		seri barang
`productcode`	Required	Kode barang PO ( Ex: KO01)
`productname`	Required	Nama barang PO
`uomcode`	Required	Kode satuan barang ( Ex: PCE untuk Piece)
`quantity`	Required	Jumlah barang
`price`		Harga satuan barang
`totalprice`	Required	Harga total barang
`quantityreceipt`		Jumlah barang yang sudah diterima
`deletion`		Indikator yang berguna untuk mengetahui apakah detail barang tersebut sudah dihapus pada ERP. Jika `true`, maka detail barang tersebut akan diabaikan Jika `false`, maka detail barang tersebut akan tetap dapat digunakan
`externalmodifiedon`		Tanggal terakhir data di-modifikiasi
`completed`		Indikator yang berguna untuk mengetahui apakah detail barang tersebut sudah diterima secara utuh pada ERP. Jika `true`, maka PO tersebut sudah tidak lagi dapat digunakan saat pembuatan dokumen PIB Jika `false`, maka PO tersebut dapat digunakan saat pembuatan dokumen PIB
`iscutoff`		Indikator yang berguna untuk menjelaskan apakah data yang diberikan merupakan data migrasi. Jika diisi `true`, maka quantityreceipt akan disamakan dengan quantityused. JIka diisi `false`, makan quantityreceipt akan bersifat sebagai info saja, dan nilai dari quantity receipt tidak akan dimasukan ke dalam quantityused

API ​

API Key ​

Header Paramater ​

Account ​

Url ​

Body ​

Product ​

Body ​

Purchase Order ​

API

API Key

Header Paramater

Account

Url

Body

Product

Body

Purchase Order