Last Updated: 20th September 2024

Update existing Receipt

PUT

/receipts/{reference_number}

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:

O1-20240202-VGSP217362830

Header Params

string

optional

Example:

application/json

Body Params application/json

buyer

object

required

Buyer Object

tin

string

required

Tax Identification Number (TIN)

name

string

required

Full Name as per IC

string

required

Email Address

address1

string

required

Address Line 1

address2

string

required

Address Line 2

address3

string

required

Address Line 3

city

string

required

City

postcode

string

required

Postcode

state

string

required

State

country

string

required

Country

contact

string

required

Phone Number

id_number

string

required

NRIC, Passport or BRN value

id_type

string

required

Accepts only "NRIC", "PASSPORT", "ARMY" or "BRN"

sst_number

string

required

SST Number if applicable

membership_id

string

required

Membership No for record purposes

reference_number

string

required

System Unique ID

invoice_number

string

required

For POS, use running receipt number

outlet_code

string

required

Outlet / Branch code

pos_id

string

required

POS Terminal No / ID

source

string

required

Source system label for internal reference. Leave as empty string if not applicable.

issued_at

string

required

Date/Time of transaction

status

string

required

"valid" to allow Buyer to claim the e-Invoice. "pending" or "voided" values will prevent Buyer from claiming the e-Invoice

subtotal

number

required

Sum of all amount before discount

discount_rate

number

required

Discount rate % where applicable

discount_amount

number

required

Discount amount where applicable

service_fee_rate

number

required

Additional Fees rate % where applicable

service_fee_amount

number

required

Additional Fees where applicable

total_excl_tax

number

required

= subtotal - discount_amount + fee_amount + charge+amount

sales_tax_amount

number

required

Sum of line items Sales Tax type

service_tax_amount

number

required

Sum of line items Service Tax type

gst_amount

number

required

Sum of line items GST type

ttx_amount

number

required

Sum of line items Tourism Tax type

hvgt_amount

number

required

Sum of line items High Value Goods Tax type

lvst_amount

number

required

Sum of line items Low Value Sales Tax type

total_tax_amount

number

required

Sum of all tax types amounts

total_incl_tax

number

required

total_excl_tax + total_tax_amount

rounding

number

required

Rounding of total_incl_tax to nearest RM0.05

total

number

required

= total_incl_tax + rounding

currency_code

string

required

Defaults to "MYR"

currency_rate

number

required

Defaults to "1.0"

items

array [object {27}]

required

Minimum of 1 item

string

required

Line item ID, may be a sequence of running number if not available

classification

string

required

Classification code of item

unit_price

number

required

Unit Price

quantity

number

required

Quantity, minimum is 1

description

string

required

Product / Service description text (limited to 300 characters)

long_description

string

required

Product / Service description text (no limit on characters, to be used for full detailed invoice print out). Optional.

measurement

string

required

Unit of measure. e.g. "KGM" or "PC"

subtotal

number

required

= unit_price x quantity

discount_rate

number

required

Discount % where applicable

discount_amount

number

required

Discount amount where applicable

service_fee_rate

number

required

Additional Fees % where applicable

service_fee_amount

number

required

Additional Fee amount where applicable

total_excl_tax

number

required

= subtotal - discount_amount + fee_amount + charge_amount

sales_tax_rate

number

required

Sales tax %

sales_tax_amount

number

required

Sales tax amount

service_tax_rate

number

required

Service tax %

service_tax_amount

number

required

Service tax amount

gst_rate

number

required

GST %

gst_amount

number

required

GST amount

ttx_rate

number

required

Tourism tax %

ttx_amount

number

required

Tourism tax amount

hvgt_rate

number

required

High Value Goods Tax %

hvgt_amount

number

required

High Value Goods Tax amount

lvst_rate

number

required

Low Value Sales Tax %

lvst_amount

number

required

Low Value Sales Tax amount

total_tax_amount

number

required

Sum of all tax types amounts

total_incl_tax

number

required

= total_excl_tax + total_tax_amount

Example

{
  "reference_number": "OUTLET-POSID-1130",
  "invoice_number": "1000",
  "pos_id": "",
  "source": "",
  "issued_at": "2024-04-30",
  "outlet_code": "KL",
  "status": "valid",
  "quantity": 0,
  "subtotal": 117.3,
  "discount_rate": 0,
  "discount_amount": 14.49,
  "service_fee_rate": 0,
  "service_fee_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_tax_amount": 0,
  "total_incl_tax": 102.81,
  "rounding": -0.01,
  "currency_code": "MYR",
  "currency_rate": 1,
  "total_payable_amount": 102.8,
  "items": [
    {
      "id": "50000",
      "classification": "",
      "unit_price": 6.9,
      "quantity": 6,
      "description": "DESCRIPTION",
      "long_description": "",
      "measurement": "",
      "subtotal": 41.4,
      "discount_rate": 0,
      "discount_amount": 6.21,
      "total_excl_tax": 0,
      "service_fee_rate": 0,
      "service_fee_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
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://einvoice-api.beaconx.com.my/receipts/O1-20240202-VGSP217362830' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference_number": "OUTLET-POSID-1130",
    "invoice_number": "1000",
    "pos_id": "",
    "source": "",
    "issued_at": "2024-04-30",
    "outlet_code": "KL",
    "status": "valid",
    "quantity": 0,
    "subtotal": 117.3,
    "discount_rate": 0,
    "discount_amount": 14.49,
    "service_fee_rate": 0,
    "service_fee_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_tax_amount": 0,
    "total_incl_tax": 102.81,
    "rounding": -0.01,
    "currency_code": "MYR",
    "currency_rate": 1,
    "total_payable_amount": 102.80,
    "items": [
        {
            "id": "50000",
            "classification": "",
            "unit_price": 6.9,
            "quantity": 6,
            "description": "DESCRIPTION",
            "long_description": "",
            "measurement": "",
            "subtotal": 41.4,
            "discount_rate": 0,
            "discount_amount": 6.21,
            "total_excl_tax": 0,
            "service_fee_rate": 0,
            "service_fee_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
        }
    ]
}'

Responses

🟠405Validation error

application/json

Body

object {0}

Example

{}

🟢200OK

🟠404Record not found

Modified at 2024-07-09 02:33:33

Create a Receipt

Void a Receipt