IDH API Manager

General notes

IDH API Manager adalah sebuah layanan integrasi untuk mendapatkan data pemesanan (order), pelanggan (store), dan produk melalui koneksi API (Application Programming Interface). Tujuan dari API ini adalah untuk integrasi aplikasi IDH dengan DMS (Distributor Management System).

Sebelum dapat menggunakan API ini, client diharuskan mendaftarkan diri ke pihak IDH untuk mendapatkan token atau API key yang digunakan untuk mengakses IDH API Manager. Umumnya, token berlaku seumur hidup (lifetime) kecuali jika ada kasus tertentu yang mengharuskan sistem membuat token baru untuk mengakses IDH API Manager.

Setiap harinya, kami selalu berusaha meningkatkan pelayanan IDH API Manager. Jika Anda memiliki pertanyaan, masukan dan saran silahkan hubungi kami di dev@idh.id.

image flow using api key

API IDH URL

These are URL API :

URL Production

https://api.manager.idh.id/

URL Sandbox

https://api.manager.demo.idh.id/

API Status Code

Status kode tidak disediakan oleh standard respon API IDH, namun bisa didapatkan dari http header. Berikut ini beberapa kode respon yang umum terjadi.

Code Note
200 request success
400 bad request
401 unauthorized/ invalid token
404 not found

API Response format

Untuk respon sukses dengan kode 200, terdapat dua format. Pertama, respon yang menghasilkan tipe data lebih dari 1 (array) seperti daftar pemesanan (order list) yang hasilnya dibungkus dalam tanda kurung siku [] dalam elemen bernama results. Contoh formatnya dapat dilihat sebagai berikut:

{
    "success":true, 
    "paginator": {
        "current_page": 1,
        "total_page": 2,
        "data_count": 14
    },
    "results": [
      {
        "po": "123456789",
        --- truncated
      },
      {
        "po": "987654321",
        --- truncated
      }
}

Berikutnya adalah respon yang menghasilkan data tunggal seperti detail pemesanan ( order detail). Perbedaannya pada respon ini tidak terdapat elemen paginator dan hasilnya dibungkus dalam tanda kurung kurawal {} dalam elemen bernama object. Contoh formatnya dapat sebagai berikut:

{
    "success":true, 
    "object": {
        "po": "123456789",
        --- truncated
     }
}

API detail

ping

Endpoint ini disediakan hanya untuk menguji koneksi dari domain asal ke server IDH.

curl -X GET "{{apiManagerUrl}}/v1/ping"
GET %7B%7BapiManagerUrl%7D%7D/v1/ping HTTP/1.1
Host:
Status200 OK
{
    "success": true
}

order

Dalam entitas order, terdapat dua rute API yang dapat digunakan, yakni:

  1. GET order list
  2. GET detail order

GET order list digunakan untuk mendapatkan daftar pesanan dalam rentang waktu maksimum 30 hari.

daftar order

End point untuk mengambil data transaksi.

curl -X GET -H "Content-Type: application/json" "{{apiManagerUrl}}/v1/order?date=01052024-31052024"
GET %7B%7BapiManagerUrl%7D%7D/v1/order?date=01052024-31052024 HTTP/1.1
Host: 
Content-Type: application/json
Status200 OK
Content-Length942
Content-Typeapplication/json; charset=utf-8
ServeridhServer
DateSat, 13 Jul 2024 06:32:35 GMT
{
    "paginator": {
        "current_page": 1,
        "data_count": 2,
        "total_page": 1
    },
    "results": [
        {
            "customer_code": "",
            "date": "2024-05-03T16:40:41+07:00",
            "distributor_id": "",
            "order_note": "",
            "pickup_point": "",
            "po": "358430351",
            "principal_name": [
                "PT. JOHNSON HOME HYGIENE PRODUCTS"
            ],
            "status": "confirmed",
            "store_code": "",
            "store_id": "4276355",
            "store_name": "Toko Pirtual",
            "total": 104500
        },
        {
            "customer_code": "tm-4567",
            "date": "2024-05-24T21:02:19+07:00",
            "distributor_id": "",
            "order_note": "",
            "pickup_point": "",
            "po": "358943531",
            "principal_name": [
                "PT. AMERTA INDAH OTSUKA"
            ],
            "status": "confirmed",
            "store_code": "tm-4567",
            "store_id": "2243322",
            "store_name": "Auto Toko A",
            "total": 855591.66
        }
    ],
    "success": true
}

order detail

Order list memiliki beberapa parameter yang dapat digunakan untuk memfilter hasil respon.

query format default
store min 3 letters empty
principal min 3 letters empty
date DDMMYYYY-DDMMYYYY last 30 days
status open, confirmed, noncanceled empty
page unsigned integer 1 
curl -X GET -H "Content-Type: application/json" "{{apiManagerUrl}}/v1/order/po/:po"
GET %7B%7BapiManagerUrl%7D%7D/v1/order/po/:po HTTP/1.1
Host: 
Content-Type: application/json
Status200 OK
Content-Length1707
Content-Typeapplication/json; charset=utf-8
ServeridhServer
DateSat, 20 Jul 2024 04:19:04 GMT
{
    "object": {
        "delivery_status": "Proses Kirim",
        "items": 3,
        "order_detail": [
            {
                "internal_code": "",
                "name": "Soyjoy STRAWBERRY 30Gr",
                "ordered_product_id": "358943551",
                "principal": "PT. AMERTA INDAH OTSUKA",
                "principal_code": "",
                "product_id": "350683568",
                "qty": 48,
                "salesman_code": "S-0123",
                "salesman_id": "320316821",
                "salesman_name": "Rico Sales 01",
                "store_code": "aio-0001",
                "store_name": "Auto Toko A",
                "sub": 381600,
                "unit": "pcs"
            },
            {
                "internal_code": "",
                "name": "Pocari Sweat PET 500mL",
                "ordered_product_id": "358943572",
                "principal": "PT. AMERTA INDAH OTSUKA",
                "principal_code": "",
                "product_id": "320241594",
                "qty": 1,
                "salesman_code": "",
                "salesman_id": "",
                "salesman_name": "",
                "store_code": "aio-0001",
                "store_name": "Auto Toko A",
                "sub": 133200,
                "unit": "lusin"
            },
            {
                "internal_code": "",
                "name": "Pocari Sweat SACHET 15Gr",
                "ordered_product_id": "358943593",
                "principal": "PT. AMERTA INDAH OTSUKA",
                "principal_code": "",
                "product_id": "338542773",
                "qty": 36,
                "salesman_code": "",
                "salesman_id": "",
                "salesman_name": "",
                "store_code": "aio-0001",
                "store_name": "Auto Toko A",
                "sub": 442800,
                "unit": "pak"
            }
        ],
        "order_id": "358943531",
        "po": "358943531",
        "status": "confirmed",
        "store_code": "tm-4567",
        "store_name": "Auto Toko A",
        "total": 957600
    },
    "success": true
}

detail order ext

API ini merupakan versi extend dari API detail order sebelumnya. Url API ini memiliki respon yang lebih lengkap dan format responnya bisa digunakan untuk API konfirmasi order sehingga disarankan untuk menggunakan API detail order ext. URL API ini memiliki tambahan query parameters berupa

query format default
withSender bool false
withRecipient bool false

parameter sender dan recipient digunakan untuk menampilkan alamat penagihan contoh request dengan menggunakan query parameter.

curl -X GET "{{apiManagerUrl}}/v1/order/po/:po/ext"
GET %7B%7BapiManagerUrl%7D%7D/v1/order/po/:po/ext HTTP/1.1
Host:
Status200 OK
{
    "object": {
        "cancel_reason": "",
        "created_on_date": "16-06-2022",
        "delivery_status": "",
        "items": [
            {
                "principal": {
                    "api_confirmedprincipal": "",
                    "discount_fixed": 0,
                    "discount_percent": 0,
                    "name": "PT. AMERTA INDAH OTSUKA",
                    "principal_id": "350631573",
                    "store_code": "AIO-AM-01",
                    "store_name": "Ade Mawan"
                },
                "products": [
                    {
                        "cancel_reason": "",
                        "discount_fixed": 0,
                        "discount_percent": 0,
                        "internal_code": "1100001",
                        "measure_unit": "Pcs",
                        "name": "POCARI SWEAT PET 2000mL",
                        "orderedproduct_id": "580260509",
                        "price": 18800,
                        "quantity": 5,
                        "salesman_code": "SLM_AMRTA002",
                        "salesman_id": "580254477",
                        "salesman_name": "salesmanNEw",
                        "status_confirmedproduct": "",
                        "sub_total": 94000
                    },
                    {
                        "cancel_reason": "",
                        "discount_fixed": 0,
                        "discount_percent": 0,
                        "internal_code": "1100083",
                        "measure_unit": "pcs",
                        "name": "SOYJOY BAR CRISPY VANILA 25Gr",
                        "orderedproduct_id": "580260527",
                        "price": 8278,
                        "quantity": 4,
                        "salesman_code": "SM0001",
                        "salesman_id": "574321338",
                        "salesman_name": "cobasalesman",
                        "status_confirmedproduct": "",
                        "sub_total": 33112
                    },
                    {
                        "cancel_reason": "",
                        "discount_fixed": 0,
                        "discount_percent": 0,
                        "internal_code": "1100085",
                        "measure_unit": "pcs",
                        "name": "SOYJOY BAR RAISIN ALMOND 30Gr",
                        "orderedproduct_id": "580260545",
                        "price": 8278,
                        "quantity": 4,
                        "salesman_code": "SM0001",
                        "salesman_id": "574321338",
                        "salesman_name": "cobasalesman",
                        "status_confirmedproduct": "",
                        "sub_total": 33112
                    }
                ]
            },
            {
                "principal": {
                    "api_confirmedprincipal": "",
                    "discount_fixed": 0,
                    "discount_percent": 0,
                    "name": "PT YHS INDONESIA",
                    "principal_id": "352883089",
                    "store_code": "YHS-AM-01",
                    "store_name": "Ade Mawan"
                },
                "products": [
                    {
                        "cancel_reason": "",
                        "discount_fixed": 0,
                        "discount_percent": 0,
                        "internal_code": "9",
                        "measure_unit": "Pcs",
                        "name": "Yeos Bird Nest CAN 300 mL",
                        "orderedproduct_id": "580260563",
                        "price": 107800,
                        "quantity": 3,
                        "salesman_code": "",
                        "salesman_id": "",
                        "salesman_name": "",
                        "status_confirmedproduct": "",
                        "sub_total": 323400
                    }
                ]
            }
        ],
        "order_id": "580260477",
        "order_note": "",
        "order_status": "Open PO",
        "status_confirmedorder": "",
        "store_code": "TM_001",
        "store_name": "Ade Mawan",
        "total": 483624
    },
    "success": true
}

konfirm order

API ini digunakan untuk konfirmasi order dengan menggunakan body request format json. Parameter request didapatkan dari respon [GET] detail order ext. Secara garis besar, konfirmasi order melalui IDH Manager dapat dilakukan tiga cara.

  • konfirmasi level order

  • konfirmasi level pricipal

  • konfirmasi level produk

Saat ini konfirmasi dapat dilakukan dua cara, level order dan produk. Beberapa parameter penting untuk request konfirmasi order dapat dilihat sebagai

parameter format note
status_confirmedorder string (“cancel”, “confirm”, “”)
status_confirmedproduct string (“cancel”, “confirm”, “”)
order_id string mandatory
orderedproduct_id string mandatory
quantity float mandatory
price float mandatory
sub_total float mandatory

Konfirmasi level produk dilakukan ketika status_confirmedorder bernilai kosong atau nil. Namun jika status_confirmedorder diisi dengan nilai “confirm” atau “cancel”, maka konfirmasi level produk akan diabaikan, dan seluruh produk akan dikonfirmasi atau dibatalkan sesuai status_confirmedorder.

Jika ingin melakukan perubahan data seperti harga atau diskon, maka gunakan konfirmasi level produk. Untuk melakukan konfirmasi level produk, request status_confirmedproduct pada semua produk harus diisi dan request status_confirmedorder dikosongkan (empty string “”).

tampilan dashboard manager

Konfirmasi produk pada dashboard manager dapat dilihat pada gambar diatas. Perubahan harga (price), kuantitas (quantity) dan diskon (discount) pada konfirmasi produk di dashboard manager bisa dilakukan juga di IDH API Manager. _Namun semua komponen angka, harga, quantity, diskon dan subtotal tersebut wajib diisi secara manual karena IDH API manager tidak melakukan kalkulasi.“

curl -X POST -d '{
    "object": {
        "created_on_date": "08-10-2023",
        "items": [
            {
                "principal": {
                    "name": "PT. AMERTA INDAH OTSUKA",
                    "principal_id": "92084"
                },
                "products": [
                    {
                        "discount_fixed": 0,
                        "discount_percent": 0,
                        "internal_code": "8997035563544",
                        "measure_unit": "lusin",
                        "name": "Pocari Sweat PET 350mL",
                        "orderedproduct_id": "574293198",
                        "price": 112800,
                        "quantity": 3,
                        "status_confirmedproduct": "confirm",
                        "sub_total": 338400
                    }
                ]
            }
        ],
        "order_id": "352995256",
        "order_note": "",
        "status_confirmedorder": "confirm",
        "total": 338400
    },
    "success": true
}' "{{apiManagerUrl}}/v1/order/confirm"
POST %7B%7BapiManagerUrl%7D%7D/v1/order/confirm HTTP/1.1
Host: 

{
    "object": {
        "created_on_date": "08-10-2023",
        "items": [
            {
                "principal": {
                    "name": "PT. AMERTA INDAH OTSUKA",
                    "principal_id": "92084"
                },
                "products": [
                    {
                        "discount_fixed": 0,
                        "discount_percent": 0,
                        "internal_code": "8997035563544",
                        "measure_unit": "lusin",
                        "name": "Pocari Sweat PET 350mL",
                        "orderedproduct_id": "574293198",
                        "price": 112800,
                        "quantity": 3,
                        "status_confirmedproduct": "confirm",
                        "sub_total": 338400
                    }
                ]
            }
        ],
        "order_id": "352995256",
        "order_note": "",
        "status_confirmedorder": "confirm",
        "total": 338400
    },
    "success": true
}
Status200 OK
{
    "message": "order selesai dikonfirmasi",
    "success": true
}
Status200 OK
{
    "message": "order gagal dikonfirmasi",
    "success": false
}

store

Bagian ini adalah kumpulan API yang memproses data pelanggan di IDH.

daftar pelanggan

Berikut ini adalah API untuk mendapatkan daftar toko atau pelanggan.

curl -X GET "{{apiManagerUrl}}/v1/store"
GET %7B%7BapiManagerUrl%7D%7D/v1/store HTTP/1.1
Host:
Status200 OK
{
    "paginator": {
        "current_page": 1,
        "data_count": 41,
        "total_page": 5
    },
    "results": [
        {
            "name": "Aldan DEV IDH",
            "store_id": "350598151"
        },
        {
            "name": "midistore88",
            "store_id": "358626752"
        },
        {
            "name": "toko test",
            "store_id": "418459705"
        },
        {
            "name": "Toko Admin Rico",
            "store_id": "350514939"
        },
        {
            "name": "Toko Aku",
            "store_id": "423307326"
        },
        {
            "name": "Toko Elsa IDH ",
            "store_id": "428937270"
        },
        {
            "name": "TOKO ARMANDO",
            "store_id": "350592643"
        },
        {
            "name": "toko test prab",
            "store_id": "434114553"
        },
        {
            "name": "toko test Trade",
            "store_id": "438274622"
        },
        {
            "name": "Aldan UAT 31 Mei 2021",
            "store_id": "451858951"
        }
    ],
    "success": true
}

detail pelanggan

Dengan menambahkan /id diikuti store_id pada URL API sebelumnya, respon detail toko atau pelanggan dapat dihasilkan.

curl -X GET "{{apiManagerUrl}}/v1/store/id/:id"
GET %7B%7BapiManagerUrl%7D%7D/v1/store/id/:id HTTP/1.1
Host:
Status200 OK
{
    "results": {
        "address": [
            {
                "address": "Dusun Kerepet",
                "country": "",
                "district": "LABU API",
                "district_id": "5201030",
                "is_default": true,
                "name": "toko sederhana",
                "phone": "08563512474",
                "province": "NUSA TENGGARA BARAT",
                "province_id": "52",
                "regency": "KABUPATEN LOMBOK BARAT",
                "regency_id": "5201",
                "village": "PERAMPUAN",
                "village_id": "5201030002",
                "zip": "83361"
            },
            {
                "address": "KH Ahmad Dahlan 3",
                "country": "",
                "district": "BATU LAYAR",
                "district_id": "5201061",
                "is_default": false,
                "name": "gudang sederhana",
                "phone": "08123033321",
                "province": "NUSA TENGGARA BARAT",
                "province_id": "52",
                "regency": "KABUPATEN LOMBOK BARAT",
                "regency_id": "5201",
                "village": "LEMBAH SARI",
                "village_id": "5201061004",
                "zip": "16161"
            },
            {
                "address": "jl. bedahan no 33",
                "country": "",
                "district": "BOJONG GEDE",
                "district_id": "3201220",
                "is_default": false,
                "name": "rumah pabuaran",
                "phone": "08123404322",
                "province": "JAWA BARAT",
                "province_id": "32",
                "regency": "KABUPATEN BOGOR",
                "regency_id": "3201",
                "village": "KEDUNG WARINGIN",
                "village_id": "3201220004",
                "zip": "16716"
            }
        ],
        "dmsinfo": [
            {
                "dms": "505276194",
                "principal": "477824416"
            },
            {
                "dms": "505276238",
                "principal": "464335820"
            },
            {
                "dms": "505431549",
                "principal": "465534026"
            },
            {
                "dms": "505431653",
                "principal": "477824416"
            },
            {
                "dms": "505431725",
                "principal": "350526520"
            }
        ],
        "emails": null,
        "name": "toko sederhana",
        "phones": null,
        "storetype": [
            {
                "principal": "PT. AMERTA INDAH OTSUKA",
                "type": "Semi Grosir"
            }
        ]
    },
    "success": true
}

product

Bagian ini adalah API untuk memproses data produk.

daftar product

Berikut ini adalah API untuk menampilkan daftar produk. Maksimal data yang ditampilkan pada daftar produk adalah 20 item. Jumlah item yang ditampilkan tiap halaman (page) adalah 10. Untuk mendapatkan data produk yang diinginkan, user dapat menggunakan filter parameter name dan/atau internal_code

query format default
name min 3 letters empty
internal_code min 3 letters empty
page unsigned integer 1 
curl -X GET "{{apiManagerUrl}}/v1/product"
GET %7B%7BapiManagerUrl%7D%7D/v1/product HTTP/1.1
Host:
Status200 OK
{
    "paginator": {
        "current_page": 1,
        "data_count": 1,
        "total_page": 1
    },
    "results": [
        {
            "internal_code": "baygon_1",
            "measure_unit": "pcs",
            "name": "Baygon Aerosol Silky Lavender 750mL",
            "price": 38447,
            "product_id": "352295982"
        }
    ],
    "success": true
}

detail product

Berikut ini adalah API untuk menampilkan detail produk.

curl -X GET "{{apiManagerUrl}}/v1/product/id/:id"
GET %7B%7BapiManagerUrl%7D%7D/v1/product/id/:id HTTP/1.1
Host:
Status200 OK
{
    "object": {
        "description": "1 karton isi 12pcs",
        "internal_code": "",
        "measure_unit": "pcs",
        "name": "Kiwi Express Shine Neutral 7mL",
        "price": 23200,
        "principal": "PT. JOHNSON HOME HYGIENE PRODUCTS",
        "product_id": "352253328"
    },
    "success": true
}

edit product

Endpoint ini untuk mengubah harga produk dari DMS.

curl -X PATCH -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "price=22500" "{{apiManagerUrl}}/v1/product/:id/price"
PATCH %7B%7BapiManagerUrl%7D%7D/v1/product/:id/price HTTP/1.1
Host: 
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="price"

22500
----WebKitFormBoundary7MA4YWxkTrZu0gW
Status200 OK
Content-Length118
Content-Typeapplication/json; charset=utf-8
ServeridhServer
DateSat, 06 Jul 2024 04:39:21 GMT
{
    "object": {
        "price_new": 22500,
        "price_old": 22500,
        "product_id": "357767245"
    },
    "success": true
}

scylla

Bagian API ini disediakan khusus untuk DMS Scylla.

daftar order 

curl -X GET "{{apiManagerUrl}}/v1/scylla/order?date=2022-06-01/2022-06-30&principal=amerta"
GET %7B%7BapiManagerUrl%7D%7D/v1/scylla/order?date=2022-06-01/2022-06-30&principal=amerta HTTP/1.1
Host:

returnexchange

Bagian ini adalah API untuk memproses data retur atau tukar barang (return/exchange).

daftar retur

API Request Description

Endpoint ini membuat HTTP GET request untuk mengambil data return/exchange berdasarkan durasi tanggal, informasi pelanggan, dan principal.

curl -X GET "{{apiManagerUrl}}/v1/returnexchange?date=01012024-31012024&store_id&store_code&principal_id&include_items=true&is_open_only=true&page=0&limit=2"
GET %7B%7BapiManagerUrl%7D%7D/v1/returnexchange?date=01012024-31012024&store_id&store_code&principal_id&include_items=true&is_open_only=true&page=0&limit=2 HTTP/1.1
Host:
Status200 OK
{
    "paginator": {
        "current_page": 1,
        "data_count": 5,
        "total_page": 3
    },
    "results": [
        {
            "admin_note": "",
            "canceled_by": "",
            "canceled_on_milli": 0,
            "confirmed_by": "1968367",
            "confirmed_on_milli": 1715260221954,
            "created_by": "4276351",
            "created_on_milli": 1704227022001,
            "customer_code": "",
            "distributor_id": "319827836",
            "distributor_name": "PT Tulus Maju",
            "id": 45,
            "is_canceled": false,
            "is_confirmed": true,
            "is_processed": false,
            "items": [
                {
                    "buying_price": 0,
                    "completed_by": "",
                    "completed_on_milli": 0,
                    "created_by": "4276351",
                    "created_on_milli": 1704226990229,
                    "discount": 0,
                    "distributor_id": "319827836",
                    "id": 86,
                    "is_completed": false,
                    "measure_unit": "kotak",
                    "note": "",
                    "principal_id": "7020203",
                    "principal_name": "PT. MANDOM INDONESIA, Tbk",
                    "product_condition": "good",
                    "product_id": "334381732",
                    "product_name": "MIRATONE Conditioning Cream Color BLUE BLACK (2BB)",
                    "quantity": 1,
                    "return_type": "exchange",
                    "statuses": [
                        {
                            "admin_note": "",
                            "confirmed_by": "1968367",
                            "confirmed_by_name": "Admin Tulus Maju",
                            "confirmed_measure_unit": "kotak",
                            "confirmed_on_milli": 1715260201993,
                            "confirmed_quantity": 1,
                            "created_by": "1968367",
                            "created_on_milli": 1715260192400,
                            "distributor_id": "319827836",
                            "id": 34,
                            "pickup_status": "picked_up",
                            "product_id": "334381732",
                            "request_status": "approved",
                            "store_id": "4276355",
                            "storeretur_id": 45,
                            "storereturitem_id": 86
                        }
                    ],
                    "store_id": "4276355",
                    "storeretur_id": 45
                }
            ],
            "principal_id": "7020203",
            "principal_name": "PT. MANDOM INDONESIA, Tbk",
            "processed_by": "1968367",
            "processed_by_name": "Admin Tulus Maju",
            "processed_on_milli": 1715260221954,
            "salesman_code": "TM-003",
            "salesman_id": "340802426",
            "salesman_name": "Sales-03x",
            "store_email": "toko@example.net",
            "store_id": "4276355",
            "store_name": "Toko Pirtual",
            "store_phone": "081231233"
        },
        {
            "admin_note": "",
            "canceled_by": "1968367",
            "canceled_on_milli": 1720168554647,
            "confirmed_by": "",
            "confirmed_on_milli": 0,
            "created_by": "4276351",
            "created_on_milli": 1704227022467,
            "customer_code": "",
            "distributor_id": "319827836",
            "distributor_name": "PT Tulus Maju",
            "id": 47,
            "is_canceled": true,
            "is_confirmed": false,
            "is_processed": false,
            "items": [
                {
                    "buying_price": 0,
                    "completed_by": "",
                    "completed_on_milli": 0,
                    "created_by": "4276351",
                    "created_on_milli": 1704226935007,
                    "discount": 0,
                    "distributor_id": "319827836",
                    "id": 84,
                    "is_completed": false,
                    "measure_unit": "pcs",
                    "note": "",
                    "principal_id": "92084",
                    "principal_name": "PT. AMERTA INDAH OTSUKA",
                    "product_condition": "bad",
                    "product_id": "320233787",
                    "product_name": "Soyjoy RAISIN ALMOND 30Gr",
                    "quantity": 1,
                    "return_type": "exchange",
                    "statuses": [
                        {
                            "admin_note": "",
                            "confirmed_by": "1968367",
                            "confirmed_by_name": "Admin Tulus Maju",
                            "confirmed_measure_unit": "",
                            "confirmed_on_milli": 1720168554744,
                            "confirmed_quantity": 0,
                            "created_by": "1968367",
                            "created_on_milli": 1720168554744,
                            "distributor_id": "319827836",
                            "id": 36,
                            "pickup_status": "",
                            "product_id": "320233787",
                            "request_status": "rejected",
                            "store_id": "4276355",
                            "storeretur_id": 47,
                            "storereturitem_id": 84
                        }
                    ],
                    "store_id": "4276355",
                    "storeretur_id": 47
                }
            ],
            "principal_id": "92084",
            "principal_name": "PT. AMERTA INDAH OTSUKA",
            "processed_by": "1968367",
            "processed_by_name": "Admin Tulus Maju",
            "processed_on_milli": 1720168554647,
            "salesman_code": "",
            "salesman_id": "",
            "salesman_name": "",
            "store_email": "toko@example.net",
            "store_id": "4276355",
            "store_name": "Toko Pirtual",
            "store_phone": "081231233"
        }
    ],
    "success": true
}

update retur

Update Return/Exchange Data

Endpoint ini membuat HTTP PATCH request untuk mengubah data return/exchange yang masih belum diproses.

Status setiap produk yang diminta adalah berupa array, artinya bisa terdapat beberapa status yang berbeda untuk 1 (satu) SKU, misalnya jumlah pengajuan ada 10 pcs, tapi 5 diterima dan 5 lainnya ditolak.

Request Body

  • Request memerlukan JSON body yang berisikan data-data ini:

    • status (string): status pengajuan secara keseluruhan (“cancel/confirm”).

    • admin_note (string): catatan tambahan dari admin.

    • storeretur_id (integer): ID dari retur.

    • salesman_id (string): ID salesman di IDH, atau gunakan salesman_code.

    • salesman_code (string): Kode salesman di IDH.

    • items (array): array dari produk menggunakan sub-parameters:

      • product_id (string): ID produk di IDH.

      • statuses (array): array dari beberapa status pengajuan perproduk, dengan sub-parameters:

        • request_status (string): status dari pengajuan (“approved/rejected”.)

        • pickup_status (string): status pengambilan (“picked_up/delivered”).

        • confirmed_quantity (string): jumlah yang dikonfirmasi.

        • confirmed_measure_unit (string): unit satuan yang dikonfirmasi (menggunakan satuan yang telah ditentukan dalam sistem IDH per produk ini).

        • admin_note (string): catatan tambahan dari admin.

curl -X PATCH -d '{
    "status": "confirm",
    "admin_note": "testing confirm API",
    "storeretur_id": 46,
    "salesman_id": "320316821",
    "items": [
        {
            "product_id": "349225387",
            "note": "catatan produk",
            "statuses": [
                {
                    "request_status": "",
                    "pickup_status": "",
                    "confirmed_quantity": "",
                    "confirmed_measure_unit": "",
                    "admin_note": "catatan status"
                }
            ]
        }
    ]
}' "{{apiManagerUrl}}/v1/returnexchange/:id"
PATCH %7B%7BapiManagerUrl%7D%7D/v1/returnexchange/:id HTTP/1.1
Host: 

{
    "status": "confirm",
    "admin_note": "testing confirm API",
    "storeretur_id": 46,
    "salesman_id": "320316821",
    "items": [
        {
            "product_id": "349225387",
            "note": "catatan produk",
            "statuses": [
                {
                    "request_status": "",
                    "pickup_status": "",
                    "confirmed_quantity": "",
                    "confirmed_measure_unit": "",
                    "admin_note": "catatan status"
                }
            ]
        }
    ]
}
Status200 OK
{
    "message": "retur selesai dikonfirmasi",
    "object": {
        "admin_note": "testing confirm API",
        "canceled_by": "",
        "canceled_on_milli": 0,
        "confirmed_by": "1968367",
        "confirmed_on_milli": 1720193476400,
        "created_by": "4276351",
        "created_on_milli": 1704227022358,
        "distributor_id": "319827836",
        "id": 46,
        "is_canceled": false,
        "is_confirmed": true,
        "is_processed": true,
        "items": [
            {
                "buying_price": 0,
                "completed_by": "",
                "completed_on_milli": 0,
                "created_by": "4276351",
                "created_on_milli": 1704226965754,
                "discount": 0,
                "distributor_id": "319827836",
                "id": 85,
                "is_completed": false,
                "measure_unit": "botol",
                "note": "",
                "principal_id": "349061196",
                "product_condition": "bad",
                "product_id": "349225387",
                "quantity": 1,
                "return_type": "return",
                "statuses": [
                    {
                        "admin_note": "catatan status",
                        "confirmed_by": "1968367",
                        "confirmed_measure_unit": "botol",
                        "confirmed_on_milli": 1720193476551,
                        "confirmed_quantity": 1,
                        "created_by": "1968367",
                        "created_on_milli": 1720193476551,
                        "distributor_id": "319827836",
                        "id": 48,
                        "pickup_status": "",
                        "product_id": "349225387",
                        "request_status": "approve",
                        "store_id": "4276355",
                        "storeretur_id": 46,
                        "storereturitem_id": 85
                    }
                ],
                "store_id": "4276355",
                "storeretur_id": 46
            }
        ],
        "principal_id": "349061196",
        "processed_by": "1968367",
        "processed_on_milli": 1720193476400,
        "salesman_id": "320316821",
        "store_id": "4276355"
    },
    "success": true
}

Invoice

Get Invoice List

Endpoint ini digunakan untuk mengambil list tagihan toko yang sudah dibuat oleh admin distributor.

Ada beberapa parameter query yang dapat digunakan di endpoint ini, yaitu:

Properties Type Description
limit number Untuk memberikan limit data yang akan ditampilkan (default 24)
page number Untuk menentukan pagination ke berapa
unixtime_range string Untuk menyaring data dari tanggal berapa sampai tanggal berapa
search string Untuk mencari data berdasarkan keyword (id, nama toko, nomer invoice)
store_id string Untuk menyaring list tagihan berdasarkan ID Toko di IDH
salesman_id string Untuk menyaring list tagihan berdasarkan ID Salesman di IDH 
curl -X GET "{{apiManagerUrl}}/v1/invoice"
GET %7B%7BapiManagerUrl%7D%7D/v1/invoice HTTP/1.1
Host:
Status200 OK
Content-Length10286
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 27 Aug 2024 03:44:13 GMT
{
    "data_count": 13,
    "paginator": {
        "HasNext": true,
        "HasPrev": false,
        "MaxPages": 0,
        "Page": 1,
        "PageLinkFirst": "/v1/invoice?limit=10&page=1&search=&unixtime_range=1719792060-1722470399",
        "PageLinkLast": "/v1/invoice?limit=10&p=2&page=1&search=&unixtime_range=1719792060-1722470399",
        "PageLinkNext": "/v1/invoice?limit=10&p=2&page=1&search=&unixtime_range=1719792060-1722470399",
        "PageLinkPrev": "",
        "PageNums": 2,
        "Pages": [
            1,
            2
        ],
        "PerPageNums": 10
    },
    "results": [
        {
            "created_by": "tulusmaju",
            "created_on": "24-07-2024",
            "due_date": "31-07-2024",
            "file": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/486192996/769515494/INVTMDEARGOD_009",
            "file_retur": "",
            "id": "769515494",
            "invoice_number": "INV/TM/DEARGOD/009",
            "is_import": false,
            "is_paid": false,
            "is_pay_manually": false,
            "is_select_payment": false,
            "order_ids": [
                "696046140",
                "694194387"
            ],
            "order_ids_formatted": "696046140, 694194387",
            "pickup_id": "354681623",
            "pickup_name": "TM_PUSAT",
            "retur_dms_id": "RTRTM009,RTRTM0010,RTRTM0011",
            "salesman_id": "732742203",
            "salesman_name": "Armand",
            "status": "Belum Dibayar",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "subtotal": 705000,
            "total_retur": 100000
        },
        {
            "created_by": "tulusmaju",
            "created_on": "24-07-2024",
            "due_date": "31-07-2024",
            "file": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/486192996//769515419/Bukti Pembayaran Tagihan IDH-INV_TM_DEARGOD_001 (1)",
            "file_retur": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/486192996//769515419/fileretur/Bukti Pembayaran Tagihan IDH-INV_TM_DEARGOD_001 (1)",
            "id": "769515419",
            "invoice_number": "INV/TM/DEARGOD/008",
            "is_import": true,
            "is_paid": false,
            "is_pay_manually": false,
            "is_select_payment": false,
            "order_ids": [
                "696145130"
            ],
            "order_ids_formatted": "696145130",
            "pickup_id": "354681623",
            "pickup_name": "TM_PUSAT",
            "retur_dms_id": "RTR/TM/008",
            "salesman_id": "732742203",
            "salesman_name": "Armand",
            "status": "Belum Dibayar",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "subtotal": 603000,
            "total_retur": 100000
        },
        {
            "created_by": "tulusmaju",
            "created_on": "23-07-2024",
            "due_date": "10-08-2024",
            "file": "",
            "file_retur": "",
            "id": "769094191",
            "invoice_number": "INV/TM/DEARGOD/007",
            "is_import": false,
            "is_paid": false,
            "is_pay_manually": true,
            "is_select_payment": true,
            "list_payment": "Cash On Delivery (COD), Cash On Delivery (COD), Retur",
            "order_ids": [
                "752045688"
            ],
            "order_ids_formatted": "752045688",
            "pickup_id": "",
            "pickup_name": "",
            "retur_dms_id": "",
            "salesman_id": "",
            "salesman_name": "",
            "status": "Cicil",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "subtotal": 482400,
            "total_retur": 0
        },
        {
            "created_by": "tulusmaju",
            "created_on": "23-07-2024",
            "due_date": "10-08-2024",
            "file": "",
            "file_retur": "",
            "id": "769091266",
            "invoice_number": "INV/TM/DEARGOD/006",
            "is_import": false,
            "is_paid": false,
            "is_pay_manually": true,
            "is_select_payment": true,
            "list_payment": "Cash On Delivery (COD), Retur",
            "order_ids": [
                "724880033"
            ],
            "order_ids_formatted": "724880033",
            "pickup_id": "",
            "pickup_name": "",
            "retur_dms_id": "",
            "salesman_id": "",
            "salesman_name": "",
            "status": "Cicil",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "subtotal": 129320,
            "total_retur": 0
        },
        {
            "created_by": "tulusmaju",
            "created_on": "23-07-2024",
            "due_date": "10-08-2024",
            "file": "",
            "file_retur": "",
            "id": "769088464",
            "invoice_number": "INV/TM/DEARGOD/005",
            "is_import": false,
            "is_paid": true,
            "is_pay_manually": true,
            "is_select_payment": true,
            "list_payment": "Cash On Delivery (COD), Transfer Manual",
            "order_ids": [
                "752045688"
            ],
            "order_ids_formatted": "752045688",
            "pickup_id": "354681623",
            "pickup_name": "TM_PUSAT",
            "retur_dms_id": "RTR/TM/005",
            "salesman_id": "732742203",
            "salesman_name": "Armand",
            "status": "Dilunasi Secara Manual",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "subtotal": 482400,
            "total_retur": 82400
        },
        {
            "created_by": "tulusmaju",
            "created_on": "23-07-2024",
            "due_date": "10-08-2024",
            "file": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/486192996/744287285/769065928/WhatsApp Image 2024-06-26 at 15.04.53.jpeg",
            "file_retur": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/486192996/744287285/769065928/fileretur/WhatsApp Image 2024-06-26 at 15.05.22.jpeg",
            "id": "769065928",
            "invoice_number": "INV/TM/DEARGOD/004",
            "is_import": false,
            "is_paid": false,
            "is_pay_manually": true,
            "is_select_payment": true,
            "list_payment": "Cash On Delivery (COD), Cash On Delivery (COD), Transfer Manual",
            "order_ids": [
                "744287285"
            ],
            "order_ids_formatted": "744287285",
            "pickup_id": "354681623",
            "pickup_name": "TM_PUSAT",
            "retur_dms_id": "RTR/TM/004",
            "salesman_id": "732742203",
            "salesman_name": "Armand",
            "status": "Belum Dibayar",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "subtotal": 1173600,
            "total_retur": 173600
        },
        {
            "created_by": "tulusmaju",
            "created_on": "23-07-2024",
            "due_date": "30-07-2024",
            "file": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/717930505/768842194/769044161/Slide 16_9 - 3.pdf",
            "file_retur": "",
            "id": "769044161",
            "invoice_number": "INV/TM/MANUAL/01",
            "is_import": false,
            "is_paid": true,
            "is_pay_manually": true,
            "is_select_payment": true,
            "list_payment": "Cash On Delivery (COD)",
            "order_ids": [
                "768842194"
            ],
            "order_ids_formatted": "768842194",
            "pickup_id": "",
            "pickup_name": "",
            "retur_dms_id": "",
            "salesman_id": "",
            "salesman_name": "",
            "status": "Dilunasi Secara Manual",
            "store_id": "717930505",
            "store_name": "Toko Faisal Demo",
            "subtotal": 406000,
            "total_retur": 0
        },
        {
            "created_by": "tulusmaju",
            "created_on": "22-07-2024",
            "due_date": "10-08-2024",
            "file": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/603409482/695060905_695057914/768973644/address-block-template-website-creative-260nw-1753443164.webp",
            "file_retur": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/603409482/695060905_695057914/768973644/fileretur/address-block-template-website-creative-260nw-1753443164.webp",
            "id": "768973644",
            "invoice_number": "INV/TM/DEARGOD/003",
            "is_import": false,
            "is_paid": false,
            "is_pay_manually": false,
            "is_select_payment": false,
            "order_ids": [
                "695060905",
                "695057914"
            ],
            "order_ids_formatted": "695060905, 695057914",
            "pickup_id": "354681623",
            "pickup_name": "TM_PUSAT",
            "retur_dms_id": "RTR/TM/002",
            "salesman_id": "732742203",
            "salesman_name": "Armand",
            "status": "Belum Dibayar",
            "store_id": "603409482",
            "store_name": "faisal 170922 011",
            "subtotal": 403190,
            "total_retur": 100000
        },
        {
            "created_by": "tulusmaju",
            "created_on": "22-07-2024",
            "due_date": "29-07-2024",
            "file": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/717930505/768838342_768842194/768935784/Slide 16_9 - 1.pdf",
            "file_retur": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/717930505/768838342_768842194/768935784/fileretur/Slide 16_9 - 4.pdf",
            "id": "768935784",
            "invoice_number": "manualdemo3",
            "is_import": false,
            "is_paid": true,
            "is_pay_manually": true,
            "is_select_payment": true,
            "list_payment": "Cash On Delivery (COD), Cash On Delivery (COD)",
            "order_ids": [
                "768838342",
                "768842194"
            ],
            "order_ids_formatted": "768838342, 768842194",
            "pickup_id": "417661769",
            "pickup_name": "ODI",
            "retur_dms_id": "rdms12345",
            "salesman_id": "607621781",
            "salesman_name": "Faisal ",
            "status": "Dilunasi Secara Manual",
            "store_id": "717930505",
            "store_name": "Toko Faisal Demo",
            "subtotal": 1052800,
            "total_retur": 52800
        },
        {
            "created_by": "tulusmaju",
            "created_on": "22-07-2024",
            "due_date": "24-07-2024",
            "file": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/717930505/768833460/768853961/Slide 16_9 - 3.pdf",
            "file_retur": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/717930505/768833460/768853961/fileretur/Slide 16_9 - 4.pdf",
            "id": "768853961",
            "invoice_number": "manualdemo2",
            "is_import": false,
            "is_paid": true,
            "is_pay_manually": true,
            "is_select_payment": true,
            "list_payment": "Cash On Delivery (COD), Cash On Delivery (COD), Retur",
            "order_ids": [
                "768833460"
            ],
            "order_ids_formatted": "768833460",
            "pickup_id": "354681623",
            "pickup_name": "TM_PUSAT",
            "retur_dms_id": "rtr12345",
            "salesman_id": "607621781",
            "salesman_name": "Faisal ",
            "status": "Dilunasi Secara Manual",
            "store_id": "717930505",
            "store_name": "Toko Faisal Demo",
            "subtotal": 5500950,
            "total_retur": 500950
        }
    ],
    "success": true
}
Status401 Unauthorized
Content-Length70
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 27 Aug 2024 16:19:23 GMT
{
    "error": "invalid token - error parse token",
    "success": false
}

Get Invoice Detail

Endpoint ini digunakan untuk mengambil detail data tagihan berdasarkan ID tagihan.

Gunakan path variable id pada url untuk mengambil data tagihan. path id bersifat wajib.

curl -X GET "{{apiManagerUrl}}/v1/invoice/detail/:id"
GET %7B%7BapiManagerUrl%7D%7D/v1/invoice/detail/:id HTTP/1.1
Host:
Status200 OK
Content-Length89
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 27 Aug 2024 07:06:44 GMT
{
    "error": "Data dengan nomer tagihan 7690941911 tidak ditemukan",
    "success": false
}
Status200 OK
Content-Length1379
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateWed, 04 Sep 2024 03:11:40 GMT
{
    "object": {
        "created_by": "tulusmaju",
        "created_on": "02-07-2024",
        "due_date": "31-07-2024",
        "file": "",
        "file_retur": "",
        "id": "765845419",
        "invoice_number": "INV/DLJ/002",
        "is_paid": false,
        "is_pay_manually": true,
        "is_select_payment": false,
        "list_payment": "Cash On Delivery (COD), Transfer Manual",
        "list_payments": [
            {
                "created_on": "23-07-2024",
                "note": "cicil 2",
                "outstanding_balance": 0,
                "payment_date": "23-07-2024",
                "payment_name": "Cash On Delivery (COD)",
                "status": "Lunas",
                "title": "Pembayaran ke-2",
                "total": 101000
            },
            {
                "created_on": "23-07-2024",
                "note": "Cicil-1",
                "outstanding_balance": 101000,
                "payment_date": "23-07-2024",
                "payment_name": "Transfer Manual",
                "status": "Cicil",
                "title": "Pembayaran ke-1",
                "total": 100000
            }
        ],
        "order_ids": [
            "752358370",
            "751858679"
        ],
        "order_ids_formatted": "752358370, 751858679",
        "pickup_id": "417661769",
        "pickup_name": "ODI",
        "retur_dms_id": "",
        "salesman_id": "608186207",
        "salesman_name": "Sales Dan",
        "status": "Lunas",
        "store_id": "636550146",
        "store_name": "faisal test 060323",
        "subtotal": 201000,
        "total_retur": 0
    },
    "success": true
}

Create Invoice

Endpoint ini digunakan untuk membuat tagihan pada toko yang jikalau di halaman manager website IDH bisa di akses di menu Tagihan ➡️ Daftar Tagihan.

Perlu diperhatikan, di dalam body raw json terdapat beberapa field yang perlu di isi, yaitu :

Properties Type Description
store_id string ID toko pada sistem IDH, (wajib)
salesman_id string ID salesman pada sistem IDH (optional)
order_ids string order ID pada sistem IDH (API /v1/order), jika ingin menambahkan order ID lebih dari 1, maka bisa gunakan tanda koma (,) sebagai contoh 121335,141398 (wajib)
invoice_number string Nomor cetak faktur, atau uniq number dimana value ini tidak boleh sama dengan value yang sudah pernah di inputkan (wajib)
subtotal number subtotal dari tagihan (wajib) (total tagihan akan dikurangi nilai retur jika terdapat total retur)
due_date number Tanggal jatuh tempo, gunakan format Unixtime (Wajib)
pickup_id string Titik kirim distributor (optional, disarankan di isi jika distributor memiliki cabang/ titik kirim lain guna untuk mempermudah rekonsiliasi antara IDH dan distributor
retur_dms_id string Nomor retur pada dms distributor, jika lebih dari 1 bisa gunakan tanda koma (,) (optional)
total_retur number Nilai total retur, jika ada lebih dari 1 retur bisa ditotalkan jumlahnya (optional) 
curl -X POST -d '{
    "store_id": "350514876",
    "salesman_id": "732742203",
    "order_ids": "775910153,775924913",
    "invoice_number": "INV/API/02",
    "subtotal": 310500,
    "due_date": 1726815965,
    "pickup_id": "354681623",
    "retur_dms_id": "RT28082024-1",
    "total_retur": 500
}' "{{apiManagerUrl}}/v1/invoice/send"
POST %7B%7BapiManagerUrl%7D%7D/v1/invoice/send HTTP/1.1
Host: 

{
    "store_id": "350514876",
    "salesman_id": "732742203",
    "order_ids": "775910153,775924913",
    "invoice_number": "INV/API/02",
    "subtotal": 310500,
    "due_date": 1726815965,
    "pickup_id": "354681623",
    "retur_dms_id": "RT28082024-1",
    "total_retur": 500
}
Status200 OK
Content-Length81
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateThu, 29 Aug 2024 08:42:27 GMT
{
    "error": "Nomor tagihan DMS (Faktur)  sudah di gunakan",
    "success": false
}
Status200 OK
Content-Length726
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateSat, 31 Aug 2024 08:21:10 GMT
{
    "object": {
        "created_by": "",
        "created_on": "31-08-2024",
        "due_date": "28-09-2024",
        "file": "",
        "file_retur": "",
        "id": "774190707",
        "invoice_number": "INV/API/01",
        "is_paid": false,
        "is_pay_manually": false,
        "is_select_payment": false,
        "order_ids": [
            "768842194",
            "768838342"
        ],
        "order_ids_formatted": "768842194, 768838342",
        "pickup_id": "354681623",
        "pickup_name": "TM_PUSAT",
        "retur_dms_id": "RT28082024-1",
        "salesman_id": "732742203",
        "salesman_name": "Armand",
        "status": "Belum Dibayar",
        "store_id": "717930505",
        "store_name": "Toko Faisal Demo",
        "subtotal": 250000,
        "total_retur": 50000
    },
    "success": true
}

Update Invoice

Endpoint ini digunakan untuk mengubah data tagihan pada IDH sesuai dengan ID tagihan.

Ada beberapa field yang dapat di ubah yaitu:

Properties Type Description
salesman_id string ID salesman pada sistem IDH (optional)
invoice_number string Nomor cetak faktur, atau uniq number dimana value ini tidak boleh sama dengan value yang sudah pernah di inputkan (wajib)
subtotal number subtotal dari tagihan (wajib) (total tagihan akan dikurangi nilai retur jika terdapat total retur)
due_date number Tanggal jatuh tempo, gunakan format Unixtime (Wajib)
pickup_id string Titik kirim distributor (optional, disarankan di isi jika distributor memiliki cabang/ titik kirim lain guna untuk mempermudah rekonsiliasi antara IDH dan distributor
retur_dms_id string Nomor retur pada dms distributor, jika lebih dari 1 bisa gunakan tanda koma (,) (optional)
total_retur number Nilai total retur, jika ada lebih dari 1 retur bisa ditotalkan jumlahnya (optional)

Notes :

Tagihan tidak dapat diubah jika status is_select_payment = TRUE, karena pada saat bernilai true berarti toko sudah memilih metode pembayaran dan akan melakukan pembayaran pada tagihan tersebut.

curl -X PATCH -d '{
    "salesman_id": "732742203",
    "invoice_number": "INV/API/01",
    "subtotal": 370000,
    "due_date": 1727506498,
    "pickup_id": "354681623",
    "retur_dms_id": "RT28082024-1",
    "total_retur": 50000
}' "{{apiManagerUrl}}/v1/invoice/updated/:id"
PATCH %7B%7BapiManagerUrl%7D%7D/v1/invoice/updated/:id HTTP/1.1
Host: 

{
    "salesman_id": "732742203",
    "invoice_number": "INV/API/01",
    "subtotal": 370000,
    "due_date": 1727506498,
    "pickup_id": "354681623",
    "retur_dms_id": "RT28082024-1",
    "total_retur": 50000
}
Status200 OK
Content-Length975
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 03 Sep 2024 12:36:41 GMT
{
    "object": {
        "created_by": "",
        "created_on": "31-08-2024",
        "due_date": "28-09-2024",
        "file": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/717930505/768842194_768838342/774190707/anilo.png",
        "file_retur": "http://manager.staging.idh.id/uploads/distributor/354680330/invoice/717930505/768842194_768838342/774190707/fileretur/golang-img.png",
        "id": "774190707",
        "invoice_number": "INV/API/01",
        "is_paid": false,
        "is_pay_manually": false,
        "is_select_payment": false,
        "order_ids": [
            "768842194",
            "768838342"
        ],
        "order_ids_formatted": "768842194, 768838342",
        "pickup_id": "354681623",
        "pickup_name": "TM_PUSAT",
        "retur_dms_id": "RT28082024-1",
        "salesman_id": "732742203",
        "salesman_name": "Armand",
        "status": "Belum Dibayar",
        "store_id": "717930505",
        "store_name": "Toko Faisal Demo",
        "subtotal": 370000,
        "total_retur": 50000
    },
    "success": true
}

Upload File Faktur

Endpoint ini digunakan untuk mengunggah file faktur dari distributor ke dalam server IDH sesuai dengan ID tagihan.

Sebelum melakukan request API ini, Anda perlu melakukan request pada API /v1/invoice/send untuk mendapatkan ID tagihan dari IDH. Jika di urutkan sebagai berikut :

  1. Request API pembuatan tagihan (/v1/invoice/send)
  2. Request API unggah berkas faktur (/v1/invoice/upload/faktur/:id)

Adapun request body form-data dengan key file dan bertipekan File dimana file tersebut di unggah dari local komputer Anda. Notes Max-File Size (5MB)

curl -X POST -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "file=/home/idh-dev/Pictures/Contoh/anilo.png" "{{apiManagerUrl}}/v1/invoice/upload/faktur/:id"
POST %7B%7BapiManagerUrl%7D%7D/v1/invoice/upload/faktur/:id HTTP/1.1
Host: 
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"

/home/idh-dev/Pictures/Contoh/anilo.png
----WebKitFormBoundary7MA4YWxkTrZu0gW
Status200 OK
Content-Length64
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateMon, 02 Sep 2024 03:51:47 GMT
{
    "message": "Berhasil mengunggah berkas",
    "success": true
}
Status200 OK
Content-Length64
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateMon, 02 Sep 2024 09:09:22 GMT
{
    "error": "Ukuran file lebih dari 2 MB",
    "success": false
}
Status200 OK
Content-Length92
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 03 Sep 2024 01:58:55 GMT
{
    "error": "File yang dapat di unggah adalah PDF, JPG, JPEG dan PNG",
    "success": false
}

Upload File Retur

Endpoint ini digunakan untuk mengunggah file retur dari distributor ke dalam server IDH sesuai dengan ID tagihan.

Sebelum melakukan request API ini, Anda perlu melakukan request pada API /v1/invoice/send untuk mendapatkan ID tagihan dari IDH. Jika di urutkan sebagai berikut :

  1. Request API pembuatan tagihan (/v1/invoice/send)
  2. Request API unggah berkas retur (/v1/invoice/upload/retur/:id)

Adapun request body form-data dengan key file dan bertipekan File dimana file tersebut di unggah dari local komputer Anda. Notes Max-File Size (5MB)

curl -X POST -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "file=/home/idh-dev/Downloads/golang-img.png" "{{apiManagerUrl}}/v1/invoice/upload/retur/:id"
POST %7B%7BapiManagerUrl%7D%7D/v1/invoice/upload/retur/:id HTTP/1.1
Host: 
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"

/home/idh-dev/Downloads/golang-img.png
----WebKitFormBoundary7MA4YWxkTrZu0gW
Status200 OK
Content-Length64
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateMon, 02 Sep 2024 03:51:47 GMT
{
    "message": "Berhasil mengunggah berkas",
    "success": true
}
Status200 OK
Content-Length64
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateMon, 02 Sep 2024 09:09:22 GMT
{
    "error": "Ukuran file lebih dari 2 MB",
    "success": false
}
Status200 OK
Content-Length92
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 03 Sep 2024 01:58:55 GMT
{
    "error": "File yang dapat di unggah adalah PDF, JPG, JPEG dan PNG",
    "success": false
}

Delete Invoice

Endpoint ini digunakan untuk menghapus data tagihan di IDH berdasarkan id tagihan dengan menggunakan method Delete.

Notes :

Tagian tidak dapat dihapus dengan beberapa kondisi, yaitu :

  1. Toko sudah memilih metode pembayaran dan akan melakukan pembayaran
  2. Status sudah lunas
curl -X DELETE "{{apiManagerUrl}}/v1/invoice/deleted/:id"
DELETE %7B%7BapiManagerUrl%7D%7D/v1/invoice/deleted/:id HTTP/1.1
Host:
Status200 OK
Content-Length86
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateWed, 04 Sep 2024 04:33:29 GMT
{
    "message": "Berhasil menghapus data tagihan dengan 774190707",
    "success": true
}
Status200 OK
Content-Length85
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 10 Sep 2024 08:16:52 GMT
{
    "error": "Data tagihan dengan ID 775965205 tidak ditemukan",
    "success": false
}

Send Payment

Endpoint ini digunakan untuk melakukan pembayaran tagihan melalui belakang, seperti halnya di dalam manager IDH, pada menu tagihan klik edit tagihan, lalu klik tab pembayaran, maka akan tampil seperti berikut :

Detail%20Tagihan

Adapun untuk body raw json, sebagai berikut :

Properties Type Description
payment_date number tanggal melakukan pembayaran (tidka di seting by time-now karena bisa saja toko bayar kemarin sedangkan admin baru input hari ini)
payment_type string Untuk bagian ini terdapet 2 pilihan yaitu cod atau manual_transfer dan bersifat wajib.
total number Total yang dibayarkan oleh toko
notes string Pesan atau catatan yang diberikan oleh toko atau admin atau lainnya sebagai informasi tambahan (Optional)

Notes:

  • Untuk status pembayaran akan otomatis berubah mengikuti keadaan (Cicil atau Lunas)
curl -X POST -d '{
    "payment_date": 1725951965,
    "payment_type": "manual_transfer",
    "total": 50000,
    "notes": "Dititip ke salesman Faisal Rizki struk bukti Transfer-nya"
}' "{{apiManagerUrl}}/v1/invoice/payment/send/:id"
POST %7B%7BapiManagerUrl%7D%7D/v1/invoice/payment/send/:id HTTP/1.1
Host: 

{
    "payment_date": 1725951965,
    "payment_type": "manual_transfer",
    "total": 50000,
    "notes": "Dititip ke salesman Faisal Rizki struk bukti Transfer-nya"
}
Status200 OK
Content-Length388
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateMon, 09 Sep 2024 09:23:10 GMT
{
    "object": {
        "id": "775673104",
        "invoice_id": "775672783",
        "note": "Dititip ke salesman Faisal Rizki struk bukti TF-nya",
        "outstanding_balance": 50000,
        "payment_date": "09-09-2024",
        "paymentchannel_name": "",
        "status_translate": "Cicil",
        "store_id": "717930505",
        "store_name": "Toko Faisal Demo",
        "total_payment": 150000
    },
    "success": true
}
Status200 OK
Content-Length60
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateMon, 09 Sep 2024 09:36:50 GMT
{
    "error": "Tagihan tidak ditemukan",
    "success": false
}
Status200 OK
Content-Length90
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateMon, 09 Sep 2024 09:37:20 GMT
{
    "error": "Jumlah yang dibayarkan melebihi sisa tagihan yang ada",
    "success": false
}

History Payment

Endpoint ini digunakan untuk mengambil list history payment digital (tidak termasuk pilihan bayar Tunai via aplikasi).

Ada beberapa parameter query yang dapat digunakan di endpoint ini, yaitu:

Properties Type Description
limit number Untuk memberikan limit data yang akan ditampilkan (default 24)
page number Untuk menentukan pagination ke berapa
payment_type string Opsi: digital or manually

digital : untuk history pembayaran digital (tidak termasuk pilih bayar tunai via aplikasi)

manually : untuk pembayaran secara manual yang di input lewat manager atau api payment
unixtime_range string Untuk menyaring data dari tanggal berapa sampai tanggal berapa
search string Untuk mencari data berdasarkan keyword (id invoice, nama toko)
store_id string Untuk menyaring list tagihan berdasarkan ID Toko di IDH

Notes:

  1. Jika is_disbursed sama dengan true, berarti dana/ uang dari IDH sudah di transferkan kepada rekening distributor.
  2. Untuk parameter is_correct_manually adalah parameter yang menyatakan bahwa pembayaran dilakukan secara manual lewat aplikasi bukan manager IDH dan dapat diubah dari API Confirm Payment Manually.
curl -X GET "{{apiManagerUrl}}/v1/invoice/payment/history?payment_type=manually"
GET %7B%7BapiManagerUrl%7D%7D/v1/invoice/payment/history?payment_type=manually HTTP/1.1
Host:
Status200 OK
Content-Length12153
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 10 Sep 2024 03:17:15 GMT
{
    "data_count": 139,
    "paginator": {
        "HasNext": true,
        "HasPrev": false,
        "MaxPages": 0,
        "Page": 1,
        "PageLinkFirst": "/v1/invoice/payment/history?payment_type=digital",
        "PageLinkLast": "/v1/invoice/payment/history?p=6&payment_type=digital",
        "PageLinkNext": "/v1/invoice/payment/history?p=2&payment_type=digital",
        "PageLinkPrev": "",
        "PageNums": 6,
        "Pages": [
            1,
            2,
            3,
            4,
            5,
            6
        ],
        "PerPageNums": 24
    },
    "results": [
        {
            "id": "748915789",
            "invoice_id": "748914789",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan KoinWorks",
            "outstanding_balance": 0,
            "payment_date": "25-03-2024",
            "paymentchannel_name": "KoinWorks",
            "status_translate": "Lunas",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 125625
        },
        {
            "id": "748753033",
            "invoice_id": "748752513",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan KoinWorks",
            "outstanding_balance": 0,
            "payment_date": "22-03-2024",
            "paymentchannel_name": "KoinWorks",
            "status_translate": "Lunas",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 100800
        },
        {
            "id": "748602639",
            "invoice_id": "732913260",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 1078000,
            "payment_date": "21-03-2024",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 0
        },
        {
            "id": "748599883",
            "invoice_id": "748290532",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan KoinWorks",
            "outstanding_balance": 0,
            "payment_date": "21-03-2024",
            "paymentchannel_name": "KoinWorks",
            "status_translate": "Lunas",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 100000
        },
        {
            "id": "748467056",
            "invoice_id": "748465329",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan KoinWorks",
            "outstanding_balance": 0,
            "payment_date": "20-03-2024",
            "paymentchannel_name": "KoinWorks",
            "status_translate": "Lunas",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 100800
        },
        {
            "id": "748442227",
            "invoice_id": "748433946",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan KoinWorks",
            "outstanding_balance": 0,
            "payment_date": "20-03-2024",
            "paymentchannel_name": "KoinWorks",
            "status_translate": "Lunas",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 114000
        },
        {
            "id": "748301284",
            "invoice_id": "748300684",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan KoinWorks",
            "outstanding_balance": 0,
            "payment_date": "19-03-2024",
            "paymentchannel_name": "KoinWorks",
            "status_translate": "Lunas",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 110000
        },
        {
            "id": "748292034",
            "invoice_id": "748279894",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan KoinWorks",
            "outstanding_balance": 0,
            "payment_date": "19-03-2024",
            "paymentchannel_name": "KoinWorks",
            "status_translate": "Lunas",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 100000
        },
        {
            "id": "687457916",
            "invoice_id": "687454220",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 322000,
            "payment_date": "09-09-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "603409482",
            "store_name": "faisal 170922 011",
            "total_payment": 0
        },
        {
            "id": "686858465",
            "invoice_id": "686852908",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 142800,
            "payment_date": "07-09-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "total_payment": 0
        },
        {
            "id": "686846905",
            "invoice_id": "685819678",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 142800,
            "payment_date": "07-09-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "total_payment": 0
        },
        {
            "id": "686841853",
            "invoice_id": "685819678",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 142800,
            "payment_date": "07-09-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "total_payment": 0
        },
        {
            "id": "686118088",
            "invoice_id": "686115237",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 15075,
            "payment_date": "05-09-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "603409482",
            "store_name": "faisal 170922 011",
            "total_payment": 0
        },
        {
            "id": "686112262",
            "invoice_id": "678376553",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 1064000,
            "payment_date": "05-09-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "603409482",
            "store_name": "faisal 170922 011",
            "total_payment": 0
        },
        {
            "id": "685936262",
            "invoice_id": "681605570",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 785400,
            "payment_date": "04-09-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "641843327",
            "store_name": "GabrielIDHdemotest",
            "total_payment": 0
        },
        {
            "id": "685907136",
            "invoice_id": "685819678",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 142800,
            "payment_date": "04-09-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "486192996",
            "store_name": "QA TEST QA 999",
            "total_payment": 0
        },
        {
            "id": "684444479",
            "invoice_id": "681082793",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 406,
            "payment_date": "29-08-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 0
        },
        {
            "id": "684085867",
            "invoice_id": "681082793",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 406,
            "payment_date": "28-08-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 0
        },
        {
            "id": "683834486",
            "invoice_id": "681082793",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 406,
            "payment_date": "25-08-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "636550146",
            "store_name": "faisal test 060323",
            "total_payment": 0
        },
        {
            "id": "681408795",
            "invoice_id": "681407995",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan QRIS",
            "outstanding_balance": 0,
            "payment_date": "13-08-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Lunas",
            "store_id": "350514876",
            "store_name": "Muklis Demo Store",
            "total_payment": 406
        },
        {
            "id": "681402664",
            "invoice_id": "678079018",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 60163,
            "payment_date": "13-08-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "350514876",
            "store_name": "Muklis Demo Store",
            "total_payment": 0
        },
        {
            "id": "681270729",
            "invoice_id": "681265564",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan QRIS",
            "outstanding_balance": 0,
            "payment_date": "11-08-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Lunas",
            "store_id": "350593007",
            "store_name": "Aldan DEMO IDH",
            "total_payment": 1000
        },
        {
            "id": "681267304",
            "invoice_id": "681265564",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Waktu pembayaran menggunakan QRIS telah habis, silahkan di informasikan kembali kepada toko tersebut.",
            "outstanding_balance": 1000,
            "payment_date": "11-08-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Waktu pembayaran habis",
            "store_id": "350593007",
            "store_name": "Aldan DEMO IDH",
            "total_payment": 0
        },
        {
            "id": "681260190",
            "invoice_id": "681259744",
            "is_correct_manually": false,
            "is_disbursed": false,
            "note": "Pembayaran telah dilunasi menggunakan QRIS",
            "outstanding_balance": 0,
            "payment_date": "11-08-2023",
            "paymentchannel_name": "QRIS",
            "status_translate": "Lunas",
            "store_id": "350593007",
            "store_name": "Aldan DEMO IDH",
            "total_payment": 406
        }
    ],
    "success": true
}

Confirm Payment Manually

Endpoint ini digunakan untuk melakukan konfirmasi khusus pembayaran Tunai lewat aplikasi, dimana jika sudah dikonfirmasi tandanya admin menyetujui bahwa toko tersebut melakukan pembayaran tunai pada tagihan dengan nomor ID tersebut dan tagihan akan berubah statusnya :

  • Cicil jika pembayaran belum lunas
  • Dilunasi Secara Manual jika tagihan sudah dilunasi dengan pembayaran tunai
curl -X POST "{{apiManagerUrl}}/v1/invoice/paymentmanually/confirm/:id"
POST %7B%7BapiManagerUrl%7D%7D/v1/invoice/paymentmanually/confirm/:id HTTP/1.1
Host:
Status200 OK
Content-Length90
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 10 Sep 2024 07:52:40 GMT
{
    "error": "Pembayaran ini adalah pembayaran digital, bukan Tunai",
    "success": false
}
Status200 OK
Content-Length410
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 10 Sep 2024 07:56:46 GMT
{
    "object": {
        "id": "775961934",
        "invoice_id": "775928134",
        "is_disbursed": false,
        "note": "Titip ke salesman dimas",
        "outstanding_balance": 300000,
        "payment_date": "10-09-2024",
        "paymentchannel_name": "Cash On Delivery (COD)",
        "status_translate": "Cicil",
        "store_id": "350514876",
        "store_name": "Muklis Demo Store",
        "total_payment": 10000
    },
    "success": true
}
Status200 OK
Content-Length74
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 10 Sep 2024 07:56:56 GMT
{
    "error": "Pembayaran manual sudah di konfirmasi",
    "success": false
}
Status200 OK
Content-Length88
Content-Typeapplication/json; charset=utf-8
ServerbeegoServer:2.0.0
DateTue, 10 Sep 2024 08:00:42 GMT
{
    "error": "Data pembayaran dengan ID 775961997 tidak ditemukan",
    "success": false
}