Check Status - BeaconX e-Invoice API

Retrieves status of multiple receipts. Either a list of reference_number or invoice_number array to be provided to search.

Possible values for status:
Valid - This receipt is valid for claim / to be consolidated
Refunded - This is a Refund Receipt / CN
Claimed - This receipt has been claimed for eInvoice
Consolidated - This receipt has consolidated
Reversed - This receipt has been reversed by a Refund Receipt that references this receipt as the original
Void - This receipt is voided

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

{
    "invoice_number": [
        "RCPT001",
        "RCPT002",
        "RCPT003",
        "RCPT004",
        "RCPT005"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "status": "OK",
    "message": "",
    "meta": {
        "count": 1,
        "limit": 1000
    },
    "data": [
        {
            "reference_number": "RCPT001",
            "invoice_number": "RCPT001",
            "status": "Valid"
        },
        {
            "reference_number": "RCPT002",
            "invoice_number": "RCPT002",
            "status": "Refunded"
        },
        {
            "reference_number": "RCPT003",
            "invoice_number": "RCPT003",
            "status": "Claimed"
        },
        {
            "reference_number": "RCPT004",
            "invoice_number": "RCPT004",
            "status": "Consolidated"
        },
        {
            "reference_number": "RCPT005",
            "invoice_number": "RCPT005",
            "status": "Reversed"
        }
    ]
}