Create PDF Invoice Link

POST

/home/createPDFInvoiceLink

Utility Operations

Generates a PDF invoice link based on the provided invoice details.

Request

Header Params

apikey

string

required

API key for authentication

Body Params application/json

Invoice details for generating the PDF

currency

string

required

Currency used for the invoice (e.g., USD, EUR)

clientName

string

required

Client's first name

clientCompanyName

string

required

Client's company name

clientBillingAddress

string

required

Client's billing address

clientPhone

string

required

Client's phone number

clientEmail

string

required

Client's email address

invoiceNumber

string

required

Unique invoice number

invoiceDate

string

required

Date the invoice was issued

dueDate

string

required

Due date for payment

paymentMethod

string

required

Payment method used for the invoice

bankName

string

optional

Name of the bank used for payment

bankAccountNo

string

optional

Bank account number for payments

onlineGatewayLink

string

optional

Online payment gateway link for invoice

services

array[object (PDFInvoiceItem) {5}]

required

List of services included in the invoice

description

string

optional

remarks

string

optional

quantity

number <double>

optional

unitRate

string

optional

total

string

optional

taxRate

string

required

Tax rate applicable to the invoice

taxValue

number <double>

required

Total tax value calculated for the invoice

subtotal

string

required

Subtotal amount before tax

total

string

required

Total amount including tax

logoPath

string

optional

Path to the logo image for the invoice

alignLogo

boolean

optional

Flag to determine if the logo should be aligned

addPaymentQr

boolean

optional

Flag to determine if a payment QR code should be added

addLogoImage

boolean

optional

Flag to determine if a logo image should be added

businessName

string

required

Business name of the issuer of the invoice

businessEmail

string

required

Business email of the issuer of the invoice

businessMobile

string

required

Business mobile number of the issuer of the invoice

businessWebsite

string

optional

Business website of the issuer of the invoice

businessAddress

string

optional

Business address of the issuer of the invoice

termsAndConditions

string

optional

Terms and conditions related to the invoice

invoiceType

string

optional

Type of the invoice (e.g., standard, recurring)

totalValue

number <double>

optional

totalValueLong

integer <int64>

optional

Example

{
  "currency": "string",
  "clientName": "string",
  "clientCompanyName": "string",
  "clientBillingAddress": "string",
  "clientPhone": "string",
  "clientEmail": "string",
  "invoiceNumber": "string",
  "invoiceDate": "string",
  "dueDate": "string",
  "paymentMethod": "string",
  "bankName": "string",
  "bankAccountNo": "string",
  "onlineGatewayLink": "string",
  "services": [
    {
      "description": "string",
      "remarks": "string",
      "quantity": 0,
      "unitRate": "string",
      "total": "string"
    }
  ],
  "taxRate": "string",
  "taxValue": 0,
  "subtotal": "string",
  "total": "string",
  "logoPath": "string",
  "alignLogo": true,
  "addPaymentQr": true,
  "addLogoImage": true,
  "businessName": "string",
  "businessEmail": "string",
  "businessMobile": "string",
  "businessWebsite": "string",
  "businessAddress": "string",
  "termsAndConditions": "string",
  "invoiceType": "string",
  "totalValue": 0,
  "totalValueLong": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://gateway.storeharmony.com/cloudapi/home/createPDFInvoiceLink' \
--header 'apikey;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "currency": "string",
    "clientName": "string",
    "clientCompanyName": "string",
    "clientBillingAddress": "string",
    "clientPhone": "string",
    "clientEmail": "string",
    "invoiceNumber": "string",
    "invoiceDate": "string",
    "dueDate": "string",
    "paymentMethod": "string",
    "bankName": "string",
    "bankAccountNo": "string",
    "onlineGatewayLink": "string",
    "services": [
        {
            "description": "string",
            "remarks": "string",
            "quantity": 0,
            "unitRate": "string",
            "total": "string"
        }
    ],
    "taxRate": "string",
    "taxValue": 0,
    "subtotal": "string",
    "total": "string",
    "logoPath": "string",
    "alignLogo": true,
    "addPaymentQr": true,
    "addLogoImage": true,
    "businessName": "string",
    "businessEmail": "string",
    "businessMobile": "string",
    "businessWebsite": "string",
    "businessAddress": "string",
    "termsAndConditions": "string",
    "invoiceType": "string",
    "totalValue": 0,
    "totalValueLong": 0
}'

Responses

🟢200OK

*/*

PDF invoice link created successfully.

Body

string

optional

Example

"string"

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Modified at 2025-03-27 14:31:04

getCustomerDataSet

Load Store Credentials By ID