Send a Receipt (Email / WhatsApp) - 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" or system-generated "id" (UUID)

Example:

VGSP007362829

Header Params

Accept

string

optional

Example:

application/json

Body Params application/json

object {0}

Example

{
  "channel": "whatsapp",
  "buyer": {
    "email": "abc@gmail.com",
    "contact": "",
    "contact_alt": ""
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://einvoice-api.beaconx.com.my/receipts/VGSP007362829/send' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel": "whatsapp",
    "buyer": {
        "email": "abc@gmail.com",
        "contact": "",
        "contact_alt": ""
    }
}'

Responses

🟢200OK

application/json

Body

status

string

required

message

string

required

data

object

required

items

array [object {10}]

required

total

number

required

pos_id

string

required

status

string

required

quantity

number

required

rounding

number

required

sst_rate

integer

required

issued_at

string

required

sub_total

number

required

sst_amount

integer

required

buyer_email

string

required

buyer_phone

string

required

outlet_code

string

required

currency_code

string

required

currency_rate

integer

required

membership_id

string

required

invoice_number

string

required

discount_amount

integer

required

reference_number

string

required

service_charge_rate

integer

required

service_charge_amount

integer

required

id

string

required

Example

{
  "status": "string",
  "message": "string",
  "data": {
    "items": [
      {
        "id": 0,
        "quantity": 0,
        "subtotal": 0,
        "unit_price": 0,
        "description": "string",
        "measurement": "string",
        "discount_rate": 0,
        "total_excl_tax": 0,
        "total_incl_tax": 0,
        "discount_amount": 0
      }
    ],
    "total": 0,
    "pos_id": "string",
    "status": "string",
    "quantity": 0,
    "rounding": 0,
    "sst_rate": 0,
    "issued_at": "string",
    "sub_total": 0,
    "sst_amount": 0,
    "buyer_email": "string",
    "buyer_phone": "string",
    "outlet_code": "string",
    "currency_code": "string",
    "currency_rate": 0,
    "membership_id": "string",
    "invoice_number": "string",
    "discount_amount": 0,
    "reference_number": "string",
    "service_charge_rate": 0,
    "service_charge_amount": 0,
    "id": "string"
  }
}