Skip to main content

Get Transaction Bulk by External Reference

Deskripsi​

API ini digunakan untuk mengambil beberapa data transaksi berdasarkan properti eksternal yang digunakan sebagai reference

MethodURL
GET{{ base_url }}/api/v2/bumn/transactions/reference-number/:reference_number

Request​

TypeParamsValuesDescriptionM/O
QUERY:reference_numberREF-PERTAMINA-XDD546, REF- PERTAMINA-XDD547, REF- PERTAMINA-XDD548Search transaction data using a reference parameter maximal 10Mandatory

Contoh Request​

GET {{base_url}}/api/v2/bumn/transactions/reference-number/:reference_number

Response​

Success​

StatusPayload
200
{
  "status": "success",
  "data": {
    "meta": {
      "first": "http://openapistage.padiumkm.id/api/v2/bumn/transactions?page=1&limit=1",
      "last": "http://openapi- stage.padiumkm.id/api/v2/bumn/transactions?page=152399&limit=1",
      "limit": 1,
      "next": "http://openapistage.padiumkm.id/api/v2/bumn/transactions?page=5&limit=1",
      "page": 4,
      "prev": "http://openapistage.padiumkm.id/api/v2/bumn/transactions?page=3&limit=1",
      "total_data": 152399,
      "total_page": 152399
    },
    "not_found": [
      "perta002",
      "refpertamina001"
    ],
    "transaction": [
      {
        "buyer_group": {
          "bumn_id": "62a7079031bfe7a364644273",
          "id": "668765b084ebcf498495e41e",
          "name": "Corcomm Telkom",
          "user_id": "668765b084ebcf498495e41a",
          "user_name": "Best Staf"
        },
        "general": {
          "buyer_name": "Best Staf",
          "entry_date": "2024-07-05T10:32:26+07:00",
          "invoice_number": "INV-2024-07-05-636380915",
          "purchase_order_number": "PO-2024-07-05-310027145",
          "purchase_request_number": "PR-2024-07-05-41173205",
          "status_change_date": "2024-07-05T10:32:26+07:00",
          "status_name": "Menunggu Pembayaran"
        },
        "payment": {
        "bank_holder": "PaDiUMKM Best Staf",
          "bank_name": "Mandiri Virtual Account",
          "bill_amount": 38710000,
          "due_at": null,
          "payment_method": "MANDIRI",
          "payment_term": "",
          "payment_type": "prepaid",
          "pph21": 0,
          "pph22": 0,
          "pph23": 790000,
          "ppn_by": "Pembeli",
          "price_sub_total": 39500000,
          "product_ppn": 4345000,
          "shipping_cost": 0,
          "shipping_cost_pph": 0,
          "shipping_cost_ppn": 0,
          "total_pph": 790000,
          "total_ppn": 4345000,
          "va_number": "889089999924847"
        },
        "vendor": {
          "id": "62a7079031bfe7a364644444",
          "address": "JL.KH.WAHID HASYIM NO.2",
          "city": "Jakarta Pusat",
          "district": "Gambir",
          "name": "KOPEGTEL MEDIATRON",
          "province": "Jakarta",
          "zipcode": "10140",
          "email": "xxxx@gmail.com",
          "nomor_telepon": "081xxxxxx",
          "npwp": "9291389128"
        }
      },
      {
        "buyer_group": {
          "bumn_id": "62a7079031bfe7a364644888",
          "id": "668765b084ebcf498495e41e",
          "name": "Corcomm Telkom",
          "user_id": "668765b084ebcf498495e41a",
          "user_name": "Best Staf"
        },
        "general": {
          "buyer_name": "Best Staf",
          "entry_date": "2024-07-05T10:32:26+07:00",
          "invoice_number": "INV-2024-07-05-636380915",
          "purchase_order_number": "PO-2024-07-05-310027145",
          "purchase_request_number": "PR-2024-07-05-41173205",
          "status_change_date": "2024-07-05T10:32:26+07:00",
          "status_name": "Menunggu Pembayaran"
        },
        "payment": {
          "bank_holder": "PaDiUMKM Best Staf",
          "bank_name": "Mandiri Virtual Account",
          "bill_amount": 38710000,
          "due_at": null,
          "payment_method": "MANDIRI",
          "payment_term": "",
          "payment_type": "prepaid",
          "pph21": 0,
          "pph22": 0,
          "pph23": 790000,
          "ppn_by": "Pembeli",
          "price_sub_total": 39500000,
          "product_ppn": 4345000,
          "shipping_cost": 0,
          "shipping_cost_pph": 0,
          "shipping_cost_ppn": 0,
          "total_pph": 790000,
          "total_ppn": 4345000,
          "va_number": "889089999924847"
        },
        "vendor": {
          "id": "62a7079031bfe7a364644444",
          "address": "JL.KH.WAHID HASYIM NO.2",
          "city": "Jakarta Pusat",
          "district": "Gambir",
          "name": "KOPEGTEL MEDIATRON",
          "province": "Jakarta",
          "zipcode": "10140",
          "email": "xxxx@gmail.com",
          "nomor_telepon": "081xxxxxx",
          "npwp": "9291389128"
        }
      }
    ]
  },
  "message": "ok"
}
ParamsDescription
is_open_api
  Data Type: Boolean
  Indicates whether the API is open or not.
meta.first
  Data Type: Object
  URL of the first page in the data list (empty in this example).
meta.last
  Data Type: String
  URL of the last page in the data list (empty in this example).
meta.next
  Data Type: String
  URL of the next page if available (empty in this example).
meta.prev
  Data Type: String
  URL of the previous page if available (empty in this example).
meta.limit
  Data Type: Integer
  Number of records displayed per page.
meta.page
  Data Type: Integer
  The page currently being accessed.
meta.total_data
  Data Type: Integer
  Total number of available records.
meta.total_page
  Data Type: Integer
  Total number of pages available.
not_found
  Data Type: Array
  List of reference numbers that were not found in the system.
status
  Data Type: String
  Status of the API response (e.g., "success").
transaction
  Data Type: Array Object
  List of transactions returned by the API.
general
  Data Type: Object
general.purchase_request_number
  Data Type: String
  Purchase request number.
general.purchase_order_number
  Data Type: String 
  Purchase order number.
general.invoice_number
  Data Type: String
  Invoice number related to the transaction.
general.status_name
  Data Type: String
  Transaction status (e.g., "Due").
general.entry_date
  Data Type: String
  Date the transaction was entered into the system.
general.status_change_date
  Data Type: String
  Date when the transaction status was last updated.
general.buyer_name
  Data Type: String
  Name of the buyer in this transaction.
general.invoice_date
  Data Type: String
  Date the invoice was issued.
payment
  Data Type: Object
payment.bill_amount
  Data Type: Integer
  Total bill amount to be paid.
payment.payment_type
  Data Type: String
  Payment type (postpaid & prepaid)
payment.payment_term
  Data Type: String
  Payment term in days.
payment.payment_method
  Data Type: String 
  Payment method used
payment.bank_holder
  Data Type: String
  Name of the account holder receiving the payment.
payment.bank_name
  Data Type: String
  Name of the bank receiving the payment.
payment.va_number
  Data Type: String
  Virtual Account number for payment.
payment.due_at
  Data Type: String
  Payment due date.
payment.price_sub_total
  Data Type: Integer
  Product subtotal price before taxes and additional fees.
payment.shipping_cost
  Data Type: Integer
  Shipping cost for the goods.
payment.product_ppn
  Data Type: Integer
  Value-Added Tax (VAT) for the product.
payment.shipping_cost_ppn
  Data Type: Integer
  The shipping cost.
payment.total_ppn
  Data Type: Integer
  Total VAT amount to be paid.
payment.ppn_by
  Data Type: String
  The party responsible for paying VAT (e.g., "Seller").
payment.shipping_cost_pph
  Data Type: Integer
  Withholding tax (PPh) on shipping costs.
payment.pph21
  Data Type: Integer
  Tax PPh 21 applied.
payment.pph22
  Data Type: Integer
  Tax PPh 22 applied.
payment.pph23
  Data Type: Integer
  Tax PPh 23 applied.
payment.total_pph
  Data Type: Integer
  Total withholding tax (PPh) amount to be paid.
vendor
  Data Type: object
vendor.id
  Data Type: String
  Seller ID
vendor.name
  Data Type: String
  Name of the vendor involved in the transaction.
vendor.address
  Data Type: String
  Full address of the vendor.
vendor.district
  Data Type: String
  District where the vendor is located.
vendor.city
  Data Type: String
  City where the vendor is located.
vendor.province
  Data Type: String
  Province where the vendor is located.
vendor.zipcode
  Data Type: String
  Vendor's postal code
vendor.email
  Data Type: String
  Vendor's email address.
vendor.nomor_telepon
  Data Type: String
  Vendor's phone number.
vendor.npwp
  Data Type: String
  Vendor’s (NPWP) for tax purposes.
buyer_group
  Data Type: object
buyer_group.id
  Data Type:  String
  Buyer group ID.
buyer_group.name
  Data Type: String
  Name of the buyer group.
buyer_group.bumn_id
  Data Type: String
  State-Owned Enterprise (BUMN) ID related to the buyer.
buyer_group.user_name
  Data Type: String
  Username of the buyer group member.
buyer_group.user_id
  Data Type: String
  User ID within the buyer group.

Error​

StatusPayload
400
{
    "status": "error",
    "message": "maximum input are 10 !"
}
404
{
    "status": "error",
    "message": "transactions not found"
}
500
{
    "message": "data is not a map",
    "status": "error"
}
ParamsDescription
status
  Data Type: STRING

  Status of the request delivered to server.
  Available value:
  * "success"
  * "error"
message
  Data Type: STRING

  Description message for the occurring error