Create Multiple Receipts (Bulk) - BeaconX e-Invoice API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

string

optional

Example:

application/json

Body Params application/json

array of:

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

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

line_items

integer

required

Number of line items

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

fee_rate

number

required

Additional Fees rate % where applicable

fee_amount

number

required

Additional Fees where applicable

charge_rate

number

required

Additional Charges % where applicable

charge_amount

number

required

Additional Charges 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 {28}]

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 | integer

required

Unit Price

quantity

number

required

Quantity, minimum is 1

description

string

required

Product / Service description text

measurement

string

required

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

subtotal

number

required

= unit_price x quantity

discount_rate

string

required

Discount % where applicable

discount_amount

number

required

Discount amount where applicable

fee_rate

integer

required

Additional Fees % where applicable

fee_amount

integer

required

Additional Fee amount where applicable

charge_rate

integer

required

Additional Charge % where applicable

charge_amount

integer

required

Additional Charge amount where applicable

total_excl_tax

integer

required

= subtotal - discount_amount + fee_amount + charge_amount

sales_tax_rate

integer

required

Sales tax %

sales_tax_amount

integer

required

Sales tax amount

service_tax_rate

integer

required

Service tax %

service_tax_amount

integer

required

Service tax amount

gst_rate

integer

required

GST %

gst_amount

integer

required

GST amount

ttx_rate

integer

required

Tourism tax %

ttx_amount

integer

required

Tourism tax amount

hvgt_rate

integer

required

High Value Goods Tax %

hvgt_amount

integer

required

High Value Goods Tax amount

lvst_rate

integer

required

Low Value Sales Tax %

lvst_amount

integer

required

Low Value Sales Tax amount

total_tax_amount

string

required

Sum of all tax types amounts

total_incl_tax

number

required

= total_excl_tax + total_tax_amount

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 samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://einvoice-api.beaconx.com.my/receipts' \
--header 'Accept: application/json' \
--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

status

string

required

message

string

required

data

object

required

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
  }
}