Sync Tax Payer Master List - BeaconX e-Invoice API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

array of:

type

string

optional

Accepts "supplier" or "buyer". Denotes if this tax payer entry is your Supplier or Buyer/Customer.

action

string

optional

Accepts "sync" or "remove". Sync will perform either an Insert / Update if record already exists. If "remove" is used, the tax payer will be removed using Soft Delete.

code

string

optional

Unique code for each Supplier / Buyer to be used as a common data point to map data between Source Systems and BeaconX

id_type

string

optional

Use either "BRN", "NRIC", "PASSPORT" or "ARMY"

tin

string

optional

Tax Identifier Number (TIN) of Tax Payer. Not required for Foreign Tax Payer.

id_number

string

optional

NRIC/Passport/BRN of the Tax Payer

name

string

optional

Full Name / Company Name as per IC / Registrar

email

string

optional

Email

address1

string

optional

Address Line 1

address2

string

optional

Address Line 2

address3

string

optional

Address Line 3

city

string

optional

City

postcode

string

optional

Postcode

state

string

optional

State

00 All States
01 Johor
02 Kedah
03 Kelantan
04 Melaka
05 Negeri Sembilan
06 Pahang
07 Pulau Pinang
08 Perak
09 Perlis
10 Selangor
11 Terengganu
12 Sabah
13 Sarawak
14 Wilayah Persekutuan Kuala Lumpur
15 Wilayah Persekutuan Labuan
16 Wilayah Persekutuan Putrajaya
17 Not Applicable

country

string

optional

Country. Default to "MYS"

Refer to https://sdk.myinvois.hasil.gov.my/codes/countries/ for full list

sst_number

string

optional

SST Registration No

phone

string

optional

Phone Number

membership_id

string

optional

Membership No. If applicable for internal use.

is_foreign

string

optional

Indicate if Tax Payer is Foreign. (1 for true, 0 for false)

Example

[
    {
        "code": "",
        "type": "supplier",
        "action": "sync",
        "id_type": "BRN",
        "tin": "C61901366810",
        "id_number1": "201903007118",
        "id_number2": "",
        "name": "MEDHURST, GRIMES AND SIPES SDN. BHD.",
        "email": "kendall.purdy@reilly.net",
        "address1": "72684 Murl Light Apt. 668",
        "address2": "",
        "address3": "",
        "city": "Lake Tedfort",
        "postcode": "29311",
        "state": "01",
        "country": "MYS",
        "sst_number": "W10-1060-26389071",
        "tourism_tax_number", "",
        "phone": "0125168978",
        "membership_id": "",
        "is_foreign": "false",
        "is_supplier": "1",
        "is_buyer": "",
        "is_shipping": ""
    }
]

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/taxpayers/sync' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "code": "",
        "type": "supplier",
        "action": "sync",
        "id_type": "BRN",
        "tin": "C61901366810",
        "id_number1": "201903007118",
        "id_number2": "",
        "name": "MEDHURST, GRIMES AND SIPES SDN. BHD.",
        "email": "kendall.purdy@reilly.net",
        "address1": "72684 Murl Light Apt. 668",
        "address2": "",
        "address3": "",
        "city": "Lake Tedfort",
        "postcode": "29311",
        "state": "01",
        "country": "MYS",
        "sst_number": "W10-1060-26389071",
        "tourism_tax_number", "",
        "phone": "0125168978",
        "membership_id": "",
        "is_foreign": "false",
        "is_supplier": "1",
        "is_buyer": "",
        "is_shipping": ""
    }
]'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}