Create Document(s) - BeaconX e-Invoice API

This endpoint allows source systems to create eInvoice from provided invoice document data. Depending on the response, documents are inserted or rejected from system under the following scenarios:

"in_queue" - Document under this status means it is accepted and currently in queue to be submitted to IRBM.

"attention" - Document under this status means it is accepted but failed validation. Resubmitting will be replace with latest information based on reference_number.

"rejected" - Document under this status means it is rejected and not recorded in system. Data will need to be fixed and resubmitted again.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

{
  "supplier": {
    "code": "",
    "id_type": "BRN",
    "tin": "C0123456789",
    "id_number": "201900000000",
    "name": "BEACON SYSTEMS SDN BHD",
    "email": "info@beaconx.com.my",
    "address1": "1, Jalan Beacon",
    "address2": "",
    "address3": "",
    "city": "Kuala Lumpur",
    "postcode": "57000",
    "state": "14",
    "country": "MYS",
    "sst_number": "NA",
    "ttx_number": "",
    "phone": "",
    "msic1": "00000",
    "msic1_desc": "NOT APPLICABLE",
    "is_foreign": "true"
  },
  "buyer": {
    "code": "",
    "id_type": "BRN",
    "tin": "C61901366810",
    "id_number": "201903007118",
    "name": "MY COMPANY 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",
    "phone": "0125168978",
    "membership_id": "",
    "is_foreign": "false"
  },
  "shipping": {
    "code": "",
    "id_type": "",
    "tin": "",
    "id_number": "",
    "name": "",
    "email": "",
    "address1": "",
    "address2": "",
    "address3": "",
    "city": "",
    "postcode": "",
    "state": "",
    "country": "MYS"
  },
  "annex": {
    "custom_form_number": "",
    "incoterms": "",
    "fta": "",
    "certified_exporter_number": "",
    "custom_k2_number": "",
    "other_charges_description": "",
    "other_charges_amount": ""
  },
  "status": "valid",
  "source": "ERP",
  "type": "01",
  "reference_number": "INV/6990761",
  "invoice_number": "INV/6990761",
  "original_einvoice_ref_number": "",
  "original_einvoice_inv_number": "",
  "po_number": "PO/8555",
  "pos_id": "",
  "created_at": "",
  "issued_at": "2024-10-21",
  "posted_at": "2024-10-23",
  "system_company_name": "",
  "system_company_id": "",
  "outlet_id": "",
  "outlet_code": "HQ",
  "dept_id": "",
  "dept_code": "",
  "job_type": "",
  "created_by": "user@beaconx.com.my",
  "currency_code": "MYR",
  "currency_rate": 1,
  "frequency": "",
  "billing_period_start": "",
  "billing_period_end": "",
  "subtotal": 447.92,
  "discount_rate": 0,
  "discount_amount": 0,
  "total_excl_tax": 447.92,
  "sales_tax_amount": 0,
  "service_tax_amount": 0.00,
  "gst_amount": 0,
  "ttx_amount": 0,
  "hvgt_amount": 0,
  "lvst_amount": 0,
  "exempt_amount": 0,
  "total_tax_amount": 0.0,
  "total_incl_tax": 200.00,
  "service_fee_rate": 0,
  "service_fee_amount": 0,
  "rounding": 0,
  "total_payable_amount": 200.00,
  "payment_mode": "",
  "suppliers_bank_account_number": "",
  "payment_terms": "",
  "prepayment_amount": "",
  "prepayment_datetime": "",
  "prepayment_reference_number": "",
  "bill_reference_number": "",
  "footer_notes": "",
  "so_number": "",
  "do_number": "",
  "template": "",
  "items": [
    {
      "details_tax_exemption": "",
      "tax_exempt_amount": 0,
      "id": "1",
      "classification": "022",
      "product_tariff_code": "",
      "code": "",
      "description": "1-3000",
      "long_description": "",
      "quantity": 1,
      "measurement": "EA",
      "unit_price": 100,
      "subtotal": 100,
      "discount_rate": 0,
      "discount_amount": 0,
      "service_fee_rate": 0,
      "service_fee_amount": 0,
      "total_excl_tax": 100,
      "sales_tax_rate": 0,
      "sales_tax_amount": 0,
      "service_tax_rate": 0.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": 100,
      "country_of_origin": "",
      "total_sales": "",
      "commission_rate": ""
    },
    {
      "details_tax_exemption": "",
      "tax_exempt_amount": 0,
      "id": "2",
      "classification": "022",
      "product_tariff_code": "",
      "code": "",
      "description": "1-4000",
      "long_description": "",
      "quantity": 1,
      "measurement": "EA",
      "unit_price": 100,
      "subtotal": 100,
      "discount_rate": 0,
      "discount_amount": 0,
      "service_fee_rate": 0,
      "service_fee_amount": 0,
      "total_excl_tax": 100,
      "sales_tax_rate": 0,
      "sales_tax_amount": 0,
      "service_tax_rate": 0.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": 100,
      "country_of_origin": "",
      "total_sales": "",
      "commission_rate": ""
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://einvoice-api.beaconx.com.my/einvoices/create' \
--header 'Content-Type: application/json' \
--data-raw '{
  "supplier": {
    "code": "",
    "id_type": "BRN",
    "tin": "C0123456789",
    "id_number": "201900000000",
    "name": "BEACON SYSTEMS SDN BHD",
    "email": "info@beaconx.com.my",
    "address1": "1, Jalan Beacon",
    "address2": "",
    "address3": "",
    "city": "Kuala Lumpur",
    "postcode": "57000",
    "state": "14",
    "country": "MYS",
    "sst_number": "NA",
    "ttx_number": "",
    "phone": "",
    "msic1": "00000",
    "msic1_desc": "NOT APPLICABLE",
    "is_foreign": "true"
  },
  "buyer": {
    "code": "",
    "id_type": "BRN",
    "tin": "C61901366810",
    "id_number": "201903007118",
    "name": "MY COMPANY 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",
    "phone": "0125168978",
    "membership_id": "",
    "is_foreign": "false"
  },
  "shipping": {
    "code": "",
    "id_type": "",
    "tin": "",
    "id_number": "",
    "name": "",
    "email": "",
    "address1": "",
    "address2": "",
    "address3": "",
    "city": "",
    "postcode": "",
    "state": "",
    "country": "MYS"
  },
  "annex": {
    "custom_form_number": "",
    "incoterms": "",
    "fta": "",
    "certified_exporter_number": "",
    "custom_k2_number": "",
    "other_charges_description": "",
    "other_charges_amount": ""
  },
  "status": "valid",
  "source": "ERP",
  "type": "01",
  "reference_number": "INV/6990761",
  "invoice_number": "INV/6990761",
  "original_einvoice_ref_number": "",
  "original_einvoice_inv_number": "",
  "po_number": "PO/8555",
  "pos_id": "",
  "created_at": "",
  "issued_at": "2024-10-21",
  "posted_at": "2024-10-23",
  "system_company_name": "",
  "system_company_id": "",
  "outlet_id": "",
  "outlet_code": "HQ",
  "dept_id": "",
  "dept_code": "",
  "job_type": "",
  "created_by": "user@beaconx.com.my",
  "currency_code": "MYR",
  "currency_rate": 1,
  "frequency": "",
  "billing_period_start": "",
  "billing_period_end": "",
  "subtotal": 447.92,
  "discount_rate": 0,
  "discount_amount": 0,
  "total_excl_tax": 447.92,
  "sales_tax_amount": 0,
  "service_tax_amount": 0.00,
  "gst_amount": 0,
  "ttx_amount": 0,
  "hvgt_amount": 0,
  "lvst_amount": 0,
  "exempt_amount": 0,
  "total_tax_amount": 0.0,
  "total_incl_tax": 200.00,
  "service_fee_rate": 0,
  "service_fee_amount": 0,
  "rounding": 0,
  "total_payable_amount": 200.00,
  "payment_mode": "",
  "suppliers_bank_account_number": "",
  "payment_terms": "",
  "prepayment_amount": "",
  "prepayment_datetime": "",
  "prepayment_reference_number": "",
  "bill_reference_number": "",
  "footer_notes": "",
  "so_number": "",
  "do_number": "",
  "template": "",
  "items": [
    {
      "details_tax_exemption": "",
      "tax_exempt_amount": 0,
      "id": "1",
      "classification": "022",
      "product_tariff_code": "",
      "code": "",
      "description": "1-3000",
      "long_description": "",
      "quantity": 1,
      "measurement": "EA",
      "unit_price": 100,
      "subtotal": 100,
      "discount_rate": 0,
      "discount_amount": 0,
      "service_fee_rate": 0,
      "service_fee_amount": 0,
      "total_excl_tax": 100,
      "sales_tax_rate": 0,
      "sales_tax_amount": 0,
      "service_tax_rate": 0.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": 100,
      "country_of_origin": "",
      "total_sales": "",
      "commission_rate": ""
    },
    {
      "details_tax_exemption": "",
      "tax_exempt_amount": 0,
      "id": "2",
      "classification": "022",
      "product_tariff_code": "",
      "code": "",
      "description": "1-4000",
      "long_description": "",
      "quantity": 1,
      "measurement": "EA",
      "unit_price": 100,
      "subtotal": 100,
      "discount_rate": 0,
      "discount_amount": 0,
      "service_fee_rate": 0,
      "service_fee_amount": 0,
      "total_excl_tax": 100,
      "sales_tax_rate": 0,
      "sales_tax_amount": 0,
      "service_tax_rate": 0.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": 100,
      "country_of_origin": "",
      "total_sales": "",
      "commission_rate": ""
    }
  ]
}'

Responses

🟢200Success

application/json

Body

Examples

Needs AttentionSuccessRejected

{
    "status": "OK",
    "message": "",
    "data": {
        "attention": [
            {
                "reference_number": "10050",
                "payload": {
                    "buyer": {
                        "code": null,
                        "id_type": "BRN",
                        "tin": "C61901366810",
                        "id_number": "201903007118",
                        "name": "MEDHURST, GRIMES AND SIPES SDN. BHD.",
                        "email": "kendall.purdy@reilly.net",
                        "address1": "72684 Murl Light Apt. 668",
                        "address2": null,
                        "address3": null,
                        "city": "Lake Tedfort",
                        "postcode": "29311",
                        "state": "01",
                        "country": "MYS",
                        "sst_number": "W10-1060-26389071",
                        "phone": "0125168978",
                        "membership_id": null,
                        "is_foreign": "false"
                    },
                    "shipping": {
                        "code": null,
                        "id_type": null,
                        "tin": null,
                        "id_number": null,
                        "name": null,
                        "email": null,
                        "address1": null,
                        "address2": null,
                        "address3": null,
                        "city": null,
                        "postcode": null,
                        "state": null,
                        "country": "MYS"
                    },
                    "annex": {
                        "custom_form_number": null,
                        "incoterms": null,
                        "fta": null,
                        "certified_exporter_number": null,
                        "custom_k2_number": null,
                        "other_charges_description": null,
                        "other_charges_amount": null
                    },
                    "status": "valid",
                    "source": "ERP",
                    "type": "01",
                    "reference_number": "10050",
                    "invoice_number": "INV/6990761",
                    "original_einvoice_reference_number": null,
                    "po_number": "PO/8555",
                    "pos_id": null,
                    "issued_at": "2024-04-10",
                    "outlet_code": "HQ",
                    "currency_code": "MYR",
                    "currency_rate": null,
                    "frequency": null,
                    "billing_period_start": null,
                    "billing_period_end": null,
                    "subtotal": "447.92",
                    "discount_rate": "0",
                    "discount_amount": "0",
                    "total_excl_tax": "447.92",
                    "sales_tax_amount": "0",
                    "service_tax_amount": "35.83",
                    "gst_amount": "0",
                    "ttx_amount": "0",
                    "hvgt_amount": "0",
                    "lvst_amount": "0",
                    "total_tax_amount": "35.83",
                    "total_incl_tax": "483.75",
                    "service_fee_rate": "0",
                    "service_fee_amount": "0",
                    "rounding": "0",
                    "total_payable_amount": "483.75",
                    "payment_mode": null,
                    "suppliers_bank_account_number": null,
                    "payment_terms": null,
                    "prepayment_amount": null,
                    "prepayment_datetime": null,
                    "prepayment_reference_number": null,
                    "bill_reference_number": null,
                    "items": [
                        {
                            "id": "1",
                            "classification": "022",
                            "product_tariff_code": null,
                            "code": "123",
                            "description": "ullam et ex qui",
                            "long_description": "ullam et ex qui ullam et ex qui ullam et ex qui \n ullam et ex qui",
                            "quantity": "8",
                            "measurement": "UNIT",
                            "unit_price": "55.99",
                            "subtotal": "447.92",
                            "discount_rate": "0",
                            "discount_amount": "0",
                            "fee_rate": "0.00",
                            "fee_amount": "0",
                            "charge_rate": "0",
                            "charge_amount": "0.00",
                            "total_excl_tax": "447.92",
                            "sales_tax_rate": "0",
                            "sales_tax_amount": "0",
                            "service_tax_rate": "0.08",
                            "service_tax_amount": "35.83",
                            "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": "483.75",
                            "details_tax_exemption": null,
                            "exempt_tax_amount": null,
                            "country_of_origin": null
                        }
                    ]
                },
                "lhdn_uin": "",
                "lhdn_validated_at": "",
                "lhdn_long_id": "",
                "id": "9c0d00a3-3515-4857-8329-9925e58e2703",
                "internal_error_message": "[\"The supplier field is required.\",\"The supplier.id type field is required.\",\"The supplier.tin field is required.\",\"The supplier.id number field is required.\",\"The supplier.name field is required.\",\"The supplier.email field is required.\",\"The supplier.address1 field is required.\"]"
            }
        ],
        "in_queue": [],
        "rejected": []
    }
}