Last Updated: 20th September 2024
- 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
Search Receipts
GET
/receipts
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
Header Params
Request 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 GET 'https://einvoice-api.beaconx.com.my/receipts?pos_id&reference_number&issued_at=&status&outlet_code&payment_reference_number' \
--header 'Accept: application/json'Responses
🟢200OK
application/json
Body
Example
{
"status": "OK",
"message": "",
"data": [
{
"items": [
{
"id": 1,
"total": 1,
"discount": 0,
"quantity": 1.5,
"unit_price": 1,
"description": "Chicken",
"discount_rate": 0
}
],
"total": 10,
"pos_id": "ASDD",
"status": "valid",
"discount": 0,
"quantity": 1,
"rounding": 0,
"sub_total": 10,
"outlet_code": "JGDM",
"reference_number": "JGBY1232312213"
},
{
"items": [
{
"id": 1,
"total": 7.65,
"discount": 0,
"quantity": 0.765,
"unit_price": 10,
"description": "CHICKEN THIGH",
"measurement": "KG",
"discount_rate": 0
},
{
"id": 1,
"total": 10.99,
"discount": 6,
"quantity": 1,
"unit_price": 16.99,
"description": "NESTLE CORNFLAKES 800G",
"measurement": "UNIT",
"discount_rate": 0.3531
}
],
"total": 18.65,
"pos_id": "05",
"status": "valid",
"discount": 6,
"quantity": 2,
"rounding": 0.01,
"sub_total": 18.64,
"outlet_code": "VGSP",
"reference_number": "VGSP007362826"
},
{
"items": [
{
"id": 1,
"total": 7.65,
"discount": 0,
"quantity": 0.765,
"unit_price": 10,
"description": "CHICKEN THIGH",
"measurement": "KG",
"discount_rate": 0
},
{
"id": 1,
"total": 10.99,
"discount": 6,
"quantity": 1,
"unit_price": 16.99,
"description": "NESTLE CORNFLAKES 800G",
"measurement": "UNIT",
"discount_rate": 0.3531
}
],
"total": 18.65,
"pos_id": "05",
"status": "valid",
"discount": 6,
"quantity": 2,
"rounding": 0.01,
"issued_at": "2024-01-09",
"sub_total": 18.64,
"outlet_code": "VGSP",
"reference_number": "VGSP007362826"
},
{
"items": [
{
"id": 1,
"total": 7.65,
"discount": 0,
"quantity": 0.765,
"unit_price": 10,
"description": "CHICKEN THIGH",
"measurement": "KG",
"discount_rate": 0
},
{
"id": 1,
"total": 10.99,
"discount": 6,
"quantity": 1,
"unit_price": 16.99,
"description": "NESTLE CORNFLAKES 800G",
"measurement": "UNIT",
"discount_rate": 0.3531
}
],
"total": 18.65,
"pos_id": "05",
"status": "valid",
"discount": 6,
"quantity": 2,
"rounding": 0.01,
"issued_at": "2024-01-09",
"sub_total": 18.64,
"outlet_code": "VGSP",
"reference_number": "VGSP007362826"
},
{
"items": [
{
"id": 1,
"total": 7.65,
"discount": 0,
"quantity": 0.765,
"unit_price": 10,
"description": "CHICKEN THIGH",
"measurement": "KG",
"discount_rate": 0
},
{
"id": 1,
"total": 10.99,
"discount": 6,
"quantity": 1,
"unit_price": 16.99,
"description": "NESTLE CORNFLAKES 800G",
"measurement": "UNIT",
"discount_rate": 0.3531
}
],
"total": 18.65,
"pos_id": "05",
"status": "valid",
"discount": 6,
"quantity": 2,
"rounding": 0.01,
"issued_at": "2024-01-09",
"sub_total": 18.64,
"outlet_code": "VGSP",
"reference_number": "VGSP007362826"
}
]
}🟠400Invalid status value
Modified at 2024-11-18 09:55:27