Last Updated: 20th September 2024

Embed QR Code

POST

/einvoices/{reference_number}/qr_embed

This endpoint allows source systems that does not have support for QR Code generation to embed QR code into the PDF invoice provided and returned to the source system via 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

Example:

BeaconX-83428

Header Params

string

optional

Example:

application/json

Body Params application/json

pdf_file

string

required

Base64 Encoded representation of the PDF file to be used.

position_x

integer

required

In millimeters horizontal position from left side of page.

position_y

integer

required

In millimeters vertical position from top side of page.

Example

{
  "pdf_file": "",
  "position_x": 10,
  "position_y": 10,
  "width": 35
}

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/BeaconX-83428/qr_embed' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pdf_file": "",
    "position_x": 10,
    "position_y": 10,
    "width": 35
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
  "status": "OK",
  "message": "",
  "data": {
    "object": "YWR3d2R3YQ=="
  }
}

Modified at 2024-07-15 04:51:40

Check Status v2

Invoice Reversal