UnVoid a Receipt - BeaconX e-Invoice API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

reference_number

string

required

The unique "reference_number"

Example:

VGSP0073628292

Header Params

Accept

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://einvoice-api.beaconx.com.my/receipts/VGSP0073628292/unvoid' \
--header 'Accept: application/json'

Responses

🟢200OK

application/json

Body

status

string

required

message

string

required

data

required

Any of

Receipt

null

issued_at

string <date-time>

required

Date of Receipt Issued by Point of Sale

outlet_code

string

required

Outlet / Location Identifier

pos_id

string

required

Point of Sale Terminal Identifier

reference_number

string

required

Global Unique Reference Identifier. Must not duplicate.

invoice_number

string | null

optional

If not provided, this will be the same as "reference_number" when sending to LHDN.

membership_id

string | null

optional

Loyalty Membership Identifier

buyer_email

string | null

optional

If provided, the e-Receipt will be sent via Email (as PDF attachment).

Example:

john.doe@gmail.com

buyer_phone

string | null

optional

If provided, the e-Receipt will be sent via WhatsApp (as PDF attachment).

sub_total

number

required

service_charge_rate

number | null

optional

Not applicable to retail goods

service_charge_amount

number | null

optional

Not applicable to retail goods

sst_rate

number | null

optional

Not applicable to retail goods

sst_amount

number | null

optional

Not applicable to retail goods

rounding

number

required

Rounding adjustments

total

number

required

quantity

number

read-onlyoptional

Sum of all itemized quantity. Auto-calculated.

discount_amount

number

optional

Sum of all itemized discounts. Auto-calculated.

status

string

read-onlyoptional

currency_code

string | null

optional

If not provided, defaults to "MYR"

>= 3 characters<= 3 characters

Example:

MYR

Match pattern:

^[A-Z]{3}

currency_rate

number | null

optional

If not provided, defaults to 1.0

items

array [object {10}]

required

List of itemized entries

payment_mode

string | null

optional

Refer to Documentation. Accepts ["01" to "08"].

>= 2 characters<= 2 characters

Match pattern:

^0[1-8]{1}

payment_amount

number | null

optional

payment_reference_number

string | null

optional

Payment transaction idenfier may be used here.

remarks

string | null

optional

Additional notes to be included if necessary.

Example

{
  "status": "string",
  "message": "string",
  "data": {
    "issued_at": "2019-08-24T14:15:22Z",
    "outlet_code": "string",
    "pos_id": "string",
    "reference_number": "string",
    "invoice_number": "string",
    "membership_id": "string",
    "buyer_email": "john.doe@gmail.com",
    "buyer_phone": "string",
    "sub_total": 0,
    "service_charge_rate": 0,
    "service_charge_amount": 0,
    "sst_rate": 0,
    "sst_amount": 0,
    "rounding": 0,
    "total": 0,
    "quantity": 0,
    "discount_amount": 0,
    "status": "string",
    "currency_code": "MYR",
    "currency_rate": 0,
    "items": [
      {
        "id": 0,
        "description": "string",
        "unit_price": 0,
        "quantity": 0,
        "measurement": "UNIT",
        "discount_rate": 0,
        "discount_amount": 0,
        "subtotal": 0,
        "total_excl_tax": 0,
        "total_incl_tax": 0
      }
    ],
    "payment_mode": "st",
    "payment_amount": 0,
    "payment_reference_number": "string",
    "remarks": "string"
  }
}