Retrieve Receipt

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" or system-generated "id" (UUID)

Example:

OUTLET-POSID-11321

Header Params

string

optional

Example:

application/json

Responses

🟢200OK

application/json

Body

status

string

required

message

string

required

data

object (Receipt)

required

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": "OK",
  "message": "",
  "data": {
    "items": [
      {
        "id": 1,
        "quantity": 0.76,
        "subtotal": 7.65,
        "unit_price": 10.2,
        "description": "CHICKEN THIGH",
        "measurement": "KG",
        "discount_rate": 0,
        "total_excl_tax": 7.65,
        "total_incl_tax": 7.65,
        "discount_amount": 0
      },
      {
        "id": 2,
        "quantity": 1,
        "subtotal": 10.99,
        "unit_price": 16.99,
        "description": "NESTLE CORNFLAKES 800G",
        "measurement": "UNIT",
        "discount_rate": 0.35,
        "total_excl_tax": 10.99,
        "total_incl_tax": 10.99,
        "discount_amount": 6
      }
    ],
    "total": 18.65,
    "pos_id": "05",
    "status": "valid",
    "quantity": 1.76,
    "rounding": 0.01,
    "sst_rate": 0,
    "issued_at": "2024-01-20",
    "sub_total": 18.64,
    "sst_amount": 0,
    "buyer_email": "",
    "buyer_phone": "",
    "outlet_code": "VGSP",
    "currency_code": "MYR",
    "currency_rate": 1,
    "membership_id": "",
    "invoice_number": "VGSP007362830",
    "discount_amount": 6,
    "reference_number": "VGSP007362830",
    "service_charge_rate": 0,
    "service_charge_amount": 0,
    "document": {
      "lhdn_uin": "ZK6EGF4D5SD9X62P5MHA9T9J10",
      "reference_number": "VGSP007362830",
      "invoice_number": "VGSP007362830",
      "lhdn_validated_at": null,
      "lhdn_validate_url": null,
      "long_id": null
    }
  }
}

🟠404Record not found

🟠400Invalid input

Request

Request samples

Responses