Check Status v2 - BeaconX e-Invoice API

This API endpoint returns status of a single document with validation details.

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

reference_number

array[string]

optional

Filter results by reference numbers. Supports multiple values (array).

outlet_code

array[string]

optional

Filter results by Outlet Codes / Branches. Supports multiple values (array).

direction

string

optional

Use "sent" for Outbound e-Invoices.
Use "received" for Inbound e-Invoices.

document_type

array[string]

optional

Type of e-Invoice Document. Supports multiple values (array).

01 Invoice
02 Credit Note
03 Debit Note
04 Refund Note
11 Self-billed Invoice
12 Self-billed Credit Note
13 Self-billed Debit Note
14 Self-billed Refund Note

tax_payer_code

array[string]

optional

Filter results by Tax Payer (Supplier / Buyer) code. Supports multiple values (array).

date_from

string

optional

Filter results by Date Range of Invoice / Document (Inclusive of the date provided)

date_to

string

optional

Filter results by Date Range of Invoice / Document (Inclusive of the date provided)

source

string

optional

Filter results by source system (use "iserve" for B2C eInvoices)

Example

{
  "reference_number": "INV1001"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

string

required

"OK" - Status of resopnse from middleware

message

string

required

Any relevant error messages

data

array [object {9}]

required

reference_number

string

optional

Reference Number of the document that was.

status

string

optional

"Valid" - A fully validated e-Invoice from LHDN
"Invalid" - Failed validation
"InProgress" - Submitted to LHDN and is still pending final status
"Submitted" - Submitted to LHDN and have not checked
"InQueue" - Currently in queue and not submitted to LHDN yet
"Cancelled" - eInvoice is cancelled

direction

string

optional

"Sent" or "Received".

lhdn_uin

string

optional

LHDN Unique Identifier

lhdn_long_id

string

optional

LHDN Long ID

lhdn_validated_at

string

optional

Date/Time of Validation of EInvoice

lhdn_validation_url

string

optional

The validated URL of eInvoice

email_notified_at

string

optional

message

array[string]

optional

Examples

Success (AR / Self-bill - Sent)Success (AP - Received)

{
  "status": "OK",
  "message": "",
  "data": [
    {
      "reference_number": "INV1234",
      "status": "valid",
      "direction": "Sent",
      "lhdn_uin": "42S512YACQBRSRHYKBXBTGQG22",
      "lhdn_long_id": "YQH73576FY9VR57B",
      "lhdn_validated_at": "2015-02-13T14:20:00Z",
      "lhdn_validation_url": "https://preprod.myinvois.hasil.gov.my/42S512YACQBRSRHYKBXBTGQG22/share/YQH73576FY9VR57B",
      "email_notified_at": "2015-02-13T14:20:00Z",
      "message": []
    }
  ]
}