- BeaconX e-Invoice API Documentation
- API Endpoints
- B2B e-Invoicing
- B2C Receipt
- Retrieve ReceiptGET
- Search ReceiptsGET
- Create a ReceiptPOST
- Update existing ReceiptPUT
- Void a ReceiptGET
- Void Multiple ReceiptsPOST
- UnVoid a ReceiptGET
- Send a Receipt (Email / WhatsApp)POST
- Download Receipts ReportGET
- Create Multiple Receipts (Bulk)POST
- Receipt ReversalPOST
- Update Reference NumberPOST
- Check StatusPOST
- TaxPayer
- Lists
Create Multiple Receipts (Bulk)
POST
/receipts
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Header Params
Body Params application/json
Example
[
{
"buyer": {
"tin": "",
"name": "",
"email": "",
"address1": "",
"address2": "",
"address3": "",
"city": "",
"postcode": "",
"state": "",
"country": "MYS",
"contact": "",
"id_number": "",
"sst_number": "",
"membership_id": ""
},
"invoice_number": "3020176927",
"pos_id": "P0302",
"issued_at": "2024-04-30",
"status": "valid",
"quantity": 0,
"subtotal": 117.3,
"discount_rate": 0,
"discount_amount": 14.49,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"total_excl_tax": 0,
"sales_tax_amount": 0,
"service_tax_amount": 0,
"gst_amount": 0,
"ttx_amount": 0,
"hvgt_amount": 0,
"lvst_amount": 0,
"total_incl_tax": 102.81,
"rounding": 0.01,
"total": 102.81,
"outlet_code": "S2003",
"currency_code": "MYR",
"currency_rate": 1,
"reference_number": "211976",
"items": [
{
"id": "50000",
"classification": "",
"unit_price": 6.9,
"quantity": 6,
"description": "MATEMATIK - S - MMP",
"measurement": "PC",
"subtotal": 41.4,
"discount_rate": "",
"discount_amount": 6.21,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 35.19
},
{
"id": "60000",
"classification": "",
"unit_price": 7.5,
"quantity": 6,
"description": "BAHASA INGGERIS - S - MMP",
"measurement": "PC",
"subtotal": 45,
"discount_rate": "",
"discount_amount": 4.5,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 40.5
},
{
"id": "70000",
"classification": "",
"unit_price": 0,
"quantity": 1,
"description": "MISC",
"measurement": "PC",
"subtotal": 0,
"discount_rate": "",
"discount_amount": 0,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 0
},
{
"id": "10000",
"classification": "",
"unit_price": 3.2,
"quantity": 1,
"description": "ACTIVITY - M - PS",
"measurement": "PC",
"subtotal": 3.2,
"discount_rate": "",
"discount_amount": 0.32,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 2.88
},
{
"id": "20000",
"classification": "",
"unit_price": 6,
"quantity": 1,
"description": "BAHASA INGGERIS - S - MMP",
"measurement": "PC",
"subtotal": 6,
"discount_rate": "",
"discount_amount": 0.6,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 5.4
},
{
"id": "30000",
"classification": "",
"unit_price": 7.9,
"quantity": 1,
"description": "BAHASA MELAYU - S - MMP",
"measurement": "PC",
"subtotal": 7.9,
"discount_rate": "",
"discount_amount": 0.79,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 7.11
},
{
"id": "40000",
"classification": "",
"unit_price": 6.9,
"quantity": 2,
"description": "MATEMATIK - S - MMP",
"measurement": "PC",
"subtotal": 13.8,
"discount_rate": "",
"discount_amount": 2.07,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 11.73
}
]
}
]Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://einvoice-api.beaconx.com.my/receipts' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"buyer": {
"tin": "",
"name": "",
"email": "",
"address1": "",
"address2": "",
"address3": "",
"city": "",
"postcode": "",
"state": "",
"country": "MYS",
"contact": "",
"id_number": "",
"sst_number": "",
"membership_id": ""
},
"invoice_number": "3020176927",
"pos_id": "P0302",
"issued_at": "2024-04-30",
"status": "valid",
"quantity": 0,
"subtotal": 117.3,
"discount_rate": 0,
"discount_amount": 14.49,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"total_excl_tax": 0,
"sales_tax_amount": 0,
"service_tax_amount": 0,
"gst_amount": 0,
"ttx_amount": 0,
"hvgt_amount": 0,
"lvst_amount": 0,
"total_incl_tax": 102.81,
"rounding": 0.01,
"total": 102.81,
"outlet_code": "S2003",
"currency_code": "MYR",
"currency_rate": 1,
"reference_number": "211976",
"items": [
{
"id": "50000",
"classification": "",
"unit_price": 6.9,
"quantity": 6,
"description": "MATEMATIK - S - MMP",
"measurement": "PC",
"subtotal": 41.4,
"discount_rate": "",
"discount_amount": 6.21,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 35.19
},
{
"id": "60000",
"classification": "",
"unit_price": 7.5,
"quantity": 6,
"description": "BAHASA INGGERIS - S - MMP",
"measurement": "PC",
"subtotal": 45,
"discount_rate": "",
"discount_amount": 4.5,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 40.5
},
{
"id": "70000",
"classification": "",
"unit_price": 0,
"quantity": 1,
"description": "MISC",
"measurement": "PC",
"subtotal": 0,
"discount_rate": "",
"discount_amount": 0,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 0
},
{
"id": "10000",
"classification": "",
"unit_price": 3.2,
"quantity": 1,
"description": "ACTIVITY - M - PS",
"measurement": "PC",
"subtotal": 3.2,
"discount_rate": "",
"discount_amount": 0.32,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 2.88
},
{
"id": "20000",
"classification": "",
"unit_price": 6,
"quantity": 1,
"description": "BAHASA INGGERIS - S - MMP",
"measurement": "PC",
"subtotal": 6,
"discount_rate": "",
"discount_amount": 0.6,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 5.4
},
{
"id": "30000",
"classification": "",
"unit_price": 7.9,
"quantity": 1,
"description": "BAHASA MELAYU - S - MMP",
"measurement": "PC",
"subtotal": 7.9,
"discount_rate": "",
"discount_amount": 0.79,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 7.11
},
{
"id": "40000",
"classification": "",
"unit_price": 6.9,
"quantity": 2,
"description": "MATEMATIK - S - MMP",
"measurement": "PC",
"subtotal": 13.8,
"discount_rate": "",
"discount_amount": 2.07,
"total_excl_tax": 0,
"fee_rate": 0,
"fee_amount": 0,
"charge_rate": 0,
"charge_amount": 0,
"sales_tax_rate": 0,
"sales_tax_amount": 0,
"service_tax_rate": 0,
"service_tax_amount": 0,
"gst_rate": 0,
"gst_amount": 0,
"ttx_rate": 0,
"ttx_amount": 0,
"hvgt_rate": 0,
"hvgt_amount": 0,
"lvst_rate": 0,
"lvst_amount": 0,
"total_incl_tax": 11.73
}
]
}
]'Responses
🟢200OK
application/json
Body
Example
{"status":"OK","message":"","data":{"items":[{"id":1,"subtotal":7.65,"quantity":0.76,"unit_price":10.2,"description":"CHICKEN THIGH","measurement":"KG","discount_rate":0,"discount_amount":0,"total_excl_tax":7.65,"total_incl_tax":7.65},{"id":2,"subtotal":10.99,"quantity":1,"unit_price":16.99,"description":"NESTLE CORNFLAKES 800G","measurement":"UNIT","discount_rate":0.35,"discount_amount":6,"total_excl_tax":10.99,"total_incl_tax":10.99}],"total":18.65,"pos_id":"05","rounding":0.01,"issued_at":"2024-01-20","sub_total":18.64,"outlet_code":"VGSP","reference_number":"VGSP007362830","currency_code":"MYR","currency_rate":1,"invoice_number":"VGSP007362830","buyer_email":"","buyer_phone":"","membership_id":"","service_charge_rate":0,"service_charge_amount":0,"sst_rate":0,"sst_amount":0,"status":"valid","quantity":1.76,"discount_amount":6}}Modified at 2024-06-20 01:40:32