FileStorage
This service provides functionality to manage assets and generate pdf. You can upload the assets, get the cdn link for the assets, proxy the assets and many more things.
Browse files by fetching all files in a directory based on the provided namespace, query, and request body parameters. It determines the directory path, retrieves paginated files accordingly, and serializes the response for further processing. This method optimizes directory browsing functionality within the system.
Operations
GET
# Application browse files.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page
integer
page no
limit
integer
Limit
search
string
Search
Response
200
400
Success
Properties
items
array of object
Array of Properties
_id
string
file_name
string
file_path
string
success
boolean
namespace
string
content_type
string
size
number
operation
string
tags
array of string
cdn
object
Properties
url
string
upload
object
Properties
url
string
expiry
number
created_by
object
Properties
username
string
company_id
number
bucket_key
string
created_at
string
updated_at
string
__v
number
page
object
Properties
item_total
integer
| int32
next_id
string
has_previous
boolean
has_next
boolean
current
integer
| int32
type
string
size
integer
| int32
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
page:
1
limit:
1
search:
"test"
Was this section helpful?
GET
Response
Enable seamless file management within application and across external sources. It copy files, ensuring data replication and backup for various purposes. Additionally, browse, navigate, and utilize proxy functionality for interacting with files and performing operations on them within the platform
Operations
POST
# Application copy files.
POST
# Browse Files
Parameters
sync
boolean
sync
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
urls
array of string
destination
object (DestinationNamespace)
Required
DestinationNamespace
namespace
string
Response
200
400
Success
Properties
tracking_url
string
The URL to track the status of the copy-files task.
task
object
Details about the task being performed.
Properties
id
string
A string representing the unique identifier of the task.
name
string
A string representing the name of the task.
data
object
An object that includes urls, destination.
Properties
urls
array of string
An array of strings, each representing a URL of a file.
destination
object
The destination details for the copied files.
Properties
namespace
string
This is defining namespace.
basepath
string
The base path in the destination where files will be stored.
opts
object
Options for task execution.
Properties
attempts
number
The number of attempts to try the task.
backoff
object
The backoff strategy for retrying the task.
Properties
type
string
The type of backoff strategy.
delay
number
The delay between retries in milliseconds.
delay
number
The delay before starting the task, in milliseconds.
timestamp
number
The timestamp when the task was created.
progress
number
The current progress of the task, as a percentage.
delay
number
The delay before starting the task, in milliseconds.
timestamp
number
The timestamp when the task was created.
attemptsMade
number
The number of attempts that have been made to complete the task.
returnvalue
string
Nullable
The return value of the task upon completion.
finishedOn
string
Nullable
The timestamp when the task was finished.
processedOn
string
Nullable
The timestamp when the task started processing.
stacktrace
array of object
This is defining the The stack trace.
Examples
Parameters
company_id:
2
body:
body
Was this section helpful?
POST
Response
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page
integer
page no
limit
integer
Limit
search
string
Search
Request body
extension_slug
string
Response
200
400
Success
Properties
items
array of object
Array of Properties
_id
string
file_name
string
file_path
string
success
boolean
namespace
string
content_type
string
size
number
operation
string
tags
array of string
cdn
object
Properties
url
string
upload
object
Properties
url
string
expiry
number
created_by
object
Properties
username
string
company_id
number
bucket_key
string
created_at
string
updated_at
string
__v
number
page
object
Properties
item_total
integer
| int32
next_id
string
has_previous
boolean
has_next
boolean
current
integer
| int32
type
string
size
integer
| int32
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
page:
1
limit:
1
search:
"test"
body:
body
Was this section helpful?
POST
Response
File upload is a feature that enables users to upload files from their device to a designated storage location in the system. The process of uploading begins by validating user parameters and organizing files into different groups based on their type using something called a "namespace". This helps in storing the files into Public and Private buckets Private - The files stored in private bucket is accessible via getSignedUrl method for a temporary duration. Public - The files stored in public bucket is accessible via cdn url Seller initiate the upload process by selecting files through drag-and-drop, pre-existing images, choosing from your device, uploading via URL, or entering an image URL. 1. Start Upload - Once seller calls start upload will receive a signed URL to initiate the upload process. 2. Utilize a Google Cloud Platform (GCP) method to upload the file through the obtained signed URL. 3. Complete File upload - Important file details such as name, size, content type, and namespace are collected and linked to maintain data integrity within the system's database. Once you upload a file, you receive a message with all the details about where your file is stored, including a secure URL for uploading files to the designated storage and a CDN (Content Delivery Network) URL for future accessibility. Furthermore, the system sets an expiration time for access links(signed Url) enhancing security measures.
Operations
POST
# Application start upload.
POST
# Application complete upload.
Start uploading a file from an application and returns a storage link in response.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
file_name
string
Required
content_type
string
Required
size
integer
Required
tags
array of string
params
object
Response
200
400
Success. Returns a response containing relaving and absolute_url of storage service
FileUpload
file_name
string
file_path
string
content_type
string
method
string
namespace
string
operation
string
size
integer
upload
object (Upload)
Upload
expiry
integer
url
string
tags
array of string
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
file_name
string
Required
file_path
string
Required
content_type
string
Required
method
string
namespace
string
Required
operation
string
Required
size
integer
Required
upload
object (Upload)
Required
Upload
expiry
integer
Required
url
string
Required
tags
array of string
Response
200
400
Success
FileUploadComplete
_id
string
file_name
string
file_path
string
content_type
string
namespace
string
operation
string
company_id
number
size
integer
upload
object (Upload)
Upload
expiry
integer
url
string
cdn
object (CDN)
CDN
url
string
absolute_url
string
relative_url
string
success
boolean
tags
array of string
created_on
string
| date-time
modified_on
string
| date-time
created_by
object (CreatedBy)
CreatedBy
username
string
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
Manage and customize PDF and HTML templates. Access various PDF types, retrieve default PDF data, obtain default HTML templates, save custom HTML templates, preview templates, and access the default PDF template.
Operations
GET
# Get all the supported invoice pdf types
GET
# Get the pdf types of by id
GET
# Get default PDF data.
GET
# Get default PDF data.
GET
# Update html template for invoice or label
PUT
# Update HTML Template
DEL
# Delete a PDF generator configuration
GET
# Get html template for sales channel
POST
# Save HTML template.
GET
# Get default PDF template.
POST
# Generate payment receipt.
GET
# get default html template for invoice or label
Get all the supported invoice pdf types such as Invoice, Label, Delivery challan
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
country_code
string
This is country_code for which data needs to be displayed on UI
store_os
boolean
Required
This is store_os field to identify the pdf generator flow displayed on UI
Response
200
Get all the invoice types and its format
InvoiceTypes
data
array of object (InvoiceTypesData)
Array of InvoiceTypesData
status
boolean
_id
string
pdf_type_id
integer
| int32
name
string
format
array of string
__v
integer
visibility
boolean
store_os
boolean
country_code
string
success
boolean
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
country_code:
"IN"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
id
string
Required
This is mongo id
Response
200
Get Pdf types successfully for given id.
PdfTypeByIdDetails
store_os
boolean
country_code
string
pdf_type_id
integer
__v
integer
_id
string
format
array of string
name
string
visibility
boolean
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ca228e6b701f6e108ba690"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
pdf_type_id
integer
Required
This is invoice unique id
country_code
string
This is country_code for which data needs to be displayed on UI
Response
200
Get dummy json data for invoice
PdfDataItemsDetails
data
array of object (DummyTemplateData)
Array of DummyTemplateData
_id
string
This field contains the unique identifier for the PDF payload.
pdf_type_id
number
This is invoice unique id
payload
object (PdfPayloadDetails)
PdfPayloadDetails
is_export
boolean
is_export_shipment
boolean
app_domain_name
string
txn_id
string
utr
string
po_number
string
credit_note_id
string
Nullable
current_date
string
| date-time
total_value_of_goods
number
b2b_buyer_details
object
is_qwik
object
order_type
string
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
timestamp
number
currency_code
string
shipment_id
string
delivery_partner_detail
object (DeliveryPartnerDetail)
DeliveryPartnerDetail
name
string
awb_number_barcode
string
awb_number
string
origin
string
destination
string
eway_bill_number
string
Nullable
image
object (Image)
Image
sales_channel_logo
string
payments
array of object (PaymentData)
Array of PaymentData
payment_type
string
amount
number
date
string
transaction_id
string
time
string
mode
string
name
string
meta
object
invoice_detail
object (InvoiceDetail)
InvoiceDetail
invoice_id
string
invoice_date
string
| date-time
irn
string
external_order_id
string
shipment_id
string
signed_qrcode
string
upi_qrcode
string
device_id
string
marketplace_invoice_id
string
marketplace_shipment_id
string
channel_order_id
string
company_detail
object (CompanyDetail)
CompanyDetail
name
string
The official name of the company.
address
string
The physical street address of the company.
city
string
The city where the company is located.
state
string
The state or province where the company is located.
country
string
The country where the company is based.
zip_code
number
The postal code for the company's location.
state_code
string
A code representing the state, often used in official documents and forms.
country_code
string
The code of the country.
gstin
string
Nullable
The Goods and Services Tax Identification Number, unique to each business in India.
pan
string
Nullable
The Permanent Account Number, unique to each taxpayer in India.
phone_no
string
Nullable
The primary contact phone number for the company.
cin
string
The Corporate Identification Number, unique to each company registered in India.
website_url
string
The URL to the company's official website.
email
string
The company's official email address.
display_address
string
The display address of the company.
sector
string
The sector in which company is located.
phone
object
The provided phone no of country.
trn
string
The trn no of the company.
vat
string
The vat no of the company.
business_country_timezone
string
The bussiness country timezone.
business_country_currency
object
This object represents the bussiness country currency.
meta
object
This object represents the meta fields for company.
store_detail
object (StoreDetail)
StoreDetail
store_name
string
address
string
city
string
state
string
country
string
country_code
string
zip_code
string
state_code
string
gstin
string
Nullable
display_address
string
sector
string
store_id
string
customer_billing_detail
object (CustomerBillingDetail)
CustomerBillingDetail
name
string
phone_no
string
address
string
city
string
state
string
country
string
country_code
string
zip_code
string
state_code
string
gstin
string
Nullable
display_address
string
sector
string
email
string
customer_shipping_detail
object (CustomerShippingDetail)
CustomerShippingDetail
name
string
phone_no
string
address
string
city
string
state
string
country
string
country_code
string
zip_code
string
state_code
string
gstin
string
Nullable
display_address
string
sector
string
return_detail
object (ReturnDetail)
ReturnDetail
address
string
city
string
state
string
country
string
country_code
string
Nullable
zip_code
string
state_code
string
gstin
string
Nullable
display_address
string
sector
string
product_table
object (ProductTable)
ProductTable
total_items
number
products
array of object (ItemsProductTable)
Array of ItemsProductTable
name
string
seller_identifier
string
total
number
brand
object (Brand)
Brand
logo
string
name
string
hsn_code
string
item_code
string
total_units
number
size
string
mrp
number
discount
number
taxable_amount
number
total_taxable_amount
number
tax
object (Tax)
Tax
cgst
object (Cgst)
Cgst
value
number
percent
number
sgst
object (Sgst)
Sgst
value
number
percent
number
igst
object (Igst)
Igst
value
number
percent
number
meta
object
country_of_origin
string
grand_total
number
delivery_charges
number
delivery_charge_text
string
cod_charges
number
fynd_discounts
number
total_in_words
string
gift_price
number
total_quantity
number
sub_total
number
discount
number
promotion
number
coupon
number
reward
number
round_off
number
total_value_of_goods
number
tax_table
object (TaxTable)
TaxTable
taxes
array of object (Taxes)
Array of Taxes
hsn_code
string
tax
object (Tax)
Tax
cgst
object (Cgst)
Cgst
value
number
percent
number
sgst
object (Sgst)
Sgst
value
number
percent
number
igst
object (Igst)
Igst
value
number
percent
number
total_tax_value
number
total_tax
number
tax_in_words
string
declaration_texts
array of string
registered_company_detail
object (RegisteredCompanyDetail)
RegisteredCompanyDetail
address
string
city
string
state
string
country
string
country_code
string
zip_code
number
state_code
string
display_address
string
sector
string
disclaimer
string
meta
object (Meta)
Meta
generator
object (MetaProperty)
MetaProperty
shipment_id_barcode_generator
object (ShipmentIdBarcodeGenerator)
ShipmentIdBarcodeGenerator
method
string
kwargs
object (Kwargs)
Kwargs
value
string
signed_qrcode_generator
object (SignedQrcodeGenerator)
SignedQrcodeGenerator
method
string
kwargs
object (Kwargs)
Kwargs
value
string
upi_qrcode_generator
object (UpiQrcodeGenerator)
UpiQrcodeGenerator
method
string
kwargs
object (KwargsUpiQrcode)
KwargsUpiQrcode
qr_data
string
qr_url
string
digitalsignature_generator
object (DigitalsignatureGenerator)
DigitalsignatureGenerator
method
string
kwargs
object (Kwargs)
Kwargs
value
string
awb_number_label_barcode_generator
object (AwbNumberLabelBarcodeGenerator)
AwbNumberLabelBarcodeGenerator
method
string
kwargs
object (KwargsAwbNumber)
KwargsAwbNumber
value
array of object
awb_number_barcode_generator
object (AwbNumberBarcodeGenerator)
AwbNumberBarcodeGenerator
method
string
kwargs
object (Kwargs)
Kwargs
value
string
is_self_ship
boolean
mode
string
is_self_pickup
boolean
platform_name
string
amount_to_be_collected
number
amount_paid
number
waybills
array of object
total_items
number
brand_logo
string
shipment_id_barcode
string
signed_qrcode
string
upi_qrcode
string
digitalsignature
string
awb_number_barcode
string
uid
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
country_code
string
This field represents the country code.
__v
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
success
boolean
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
pdf_type_id:
1
country_code:
"IN"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
id
string
Required
This is mongo id
Response
200
Get dummy json data for invoice
MapperDetails
_id
string
pdf_type_id
number
payload
object (PdfPayloadDetails)
PdfPayloadDetails
is_export
boolean
is_export_shipment
boolean
app_domain_name
string
txn_id
string
utr
string
po_number
string
credit_note_id
string
Nullable
current_date
string
| date-time
total_value_of_goods
number
b2b_buyer_details
object
is_qwik
object
order_type
string
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
timestamp
number
currency_code
string
shipment_id
string
delivery_partner_detail
object (DeliveryPartnerDetail)
DeliveryPartnerDetail
name
string
awb_number_barcode
string
awb_number
string
origin
string
destination
string
eway_bill_number
string
Nullable
image
object (Image)
Image
sales_channel_logo
string
payments
array of object (PaymentData)
Array of PaymentData
payment_type
string
amount
number
date
string
transaction_id
string
time
string
mode
string
name
string
meta
object
invoice_detail
object (InvoiceDetail)
InvoiceDetail
invoice_id
string
invoice_date
string
| date-time
irn
string
external_order_id
string
shipment_id
string
signed_qrcode
string
upi_qrcode
string
device_id
string
marketplace_invoice_id
string
marketplace_shipment_id
string
channel_order_id
string
company_detail
object (CompanyDetail)
CompanyDetail
name
string
The official name of the company.
address
string
The physical street address of the company.
city
string
The city where the company is located.
state
string
The state or province where the company is located.
country
string
The country where the company is based.
zip_code
number
The postal code for the company's location.
state_code
string
A code representing the state, often used in official documents and forms.
country_code
string
The code of the country.
gstin
string
Nullable
The Goods and Services Tax Identification Number, unique to each business in India.
pan
string
Nullable
The Permanent Account Number, unique to each taxpayer in India.
phone_no
string
Nullable
The primary contact phone number for the company.
cin
string
The Corporate Identification Number, unique to each company registered in India.
website_url
string
The URL to the company's official website.
email
string
The company's official email address.
display_address
string
The display address of the company.
sector
string
The sector in which company is located.
phone
object
The provided phone no of country.
trn
string
The trn no of the company.
vat
string
The vat no of the company.
business_country_timezone
string
The bussiness country timezone.
business_country_currency
object
This object represents the bussiness country currency.
meta
object
This object represents the meta fields for company.
store_detail
object (StoreDetail)
StoreDetail
store_name
string
address
string
city
string
state
string
country
string
country_code
string
zip_code
string
state_code
string
gstin
string
Nullable
display_address
string
sector
string
store_id
string
customer_billing_detail
object (CustomerBillingDetail)
CustomerBillingDetail
name
string
phone_no
string
address
string
city
string
state
string
country
string
country_code
string
zip_code
string
state_code
string
gstin
string
Nullable
display_address
string
sector
string
email
string
customer_shipping_detail
object (CustomerShippingDetail)
CustomerShippingDetail
name
string
phone_no
string
address
string
city
string
state
string
country
string
country_code
string
zip_code
string
state_code
string
gstin
string
Nullable
display_address
string
sector
string
return_detail
object (ReturnDetail)
ReturnDetail
address
string
city
string
state
string
country
string
country_code
string
Nullable
zip_code
string
state_code
string
gstin
string
Nullable
display_address
string
sector
string
product_table
object (ProductTable)
ProductTable
total_items
number
products
array of object (ItemsProductTable)
Array of ItemsProductTable
name
string
seller_identifier
string
total
number
brand
object (Brand)
Brand
logo
string
name
string
hsn_code
string
item_code
string
total_units
number
size
string
mrp
number
discount
number
taxable_amount
number
total_taxable_amount
number
tax
object (Tax)
Tax
cgst
object (Cgst)
Cgst
value
number
percent
number
sgst
object (Sgst)
Sgst
value
number
percent
number
igst
object (Igst)
Igst
value
number
percent
number
meta
object
country_of_origin
string
grand_total
number
delivery_charges
number
delivery_charge_text
string
cod_charges
number
fynd_discounts
number
total_in_words
string
gift_price
number
total_quantity
number
sub_total
number
discount
number
promotion
number
coupon
number
reward
number
round_off
number
total_value_of_goods
number
tax_table
object (TaxTable)
TaxTable
taxes
array of object (Taxes)
Array of Taxes
hsn_code
string
tax
object (Tax)
Tax
cgst
object (Cgst)
Cgst
value
number
percent
number
sgst
object (Sgst)
Sgst
value
number
percent
number
igst
object (Igst)
Igst
value
number
percent
number
total_tax_value
number
total_tax
number
tax_in_words
string
declaration_texts
array of string
registered_company_detail
object (RegisteredCompanyDetail)
RegisteredCompanyDetail
address
string
city
string
state
string
country
string
country_code
string
zip_code
number
state_code
string
display_address
string
sector
string
disclaimer
string
meta
object (Meta)
Meta
generator
object (MetaProperty)
MetaProperty
shipment_id_barcode_generator
object (ShipmentIdBarcodeGenerator)
ShipmentIdBarcodeGenerator
method
string
kwargs
object (Kwargs)
Kwargs
value
string
signed_qrcode_generator
object (SignedQrcodeGenerator)
SignedQrcodeGenerator
method
string
kwargs
object (Kwargs)
Kwargs
value
string
upi_qrcode_generator
object (UpiQrcodeGenerator)
UpiQrcodeGenerator
method
string
kwargs
object (KwargsUpiQrcode)
KwargsUpiQrcode
qr_data
string
qr_url
string
digitalsignature_generator
object (DigitalsignatureGenerator)
DigitalsignatureGenerator
method
string
kwargs
object (Kwargs)
Kwargs
value
string
awb_number_label_barcode_generator
object (AwbNumberLabelBarcodeGenerator)
AwbNumberLabelBarcodeGenerator
method
string
kwargs
object (KwargsAwbNumber)
KwargsAwbNumber
value
array of object
awb_number_barcode_generator
object (AwbNumberBarcodeGenerator)
AwbNumberBarcodeGenerator
method
string
kwargs
object (Kwargs)
Kwargs
value
string
is_self_ship
boolean
mode
string
is_self_pickup
boolean
platform_name
string
amount_to_be_collected
number
amount_paid
number
waybills
array of object
total_items
number
brand_logo
string
shipment_id_barcode
string
signed_qrcode
string
upi_qrcode
string
digitalsignature
string
awb_number_barcode
string
uid
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
country_code
string
__v
integer
This field holds the version number.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65e07e1c26e7477701e961ea"
Was this section helpful?
GET
Response
Update html template for invoice such as Invoice, Label, Deliver challan
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
id
string
Required
This is mongo id
Response
200
Update html template for invoice
Properties
_id
string
application_id
string
company_id
integer
format
string
pdf_type_id
integer
__v
integer
created_at
string
| date-time
template
string
updated_at
string
| date-time
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ccd7250ffb27e1f347e22a"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
id
string
Required
This is mongo id
Request body
format
string
This is invoice document format such as A4, A6, POS
Enum
template
string
This is html template string.
pdf_type_id
integer
This field holds an identifier for the type of PDF.
country_code
string
This field contains the country code.
default_template
boolean
This field indicates whether the fetched HTML template is the default template.
Response
200
Update html template for invoice
PdfConfigSaveSuccess
data
object (PdfConfigSaveSuccessData)
PdfConfigSaveSuccessData
_id
string
company_id
integer
application_id
string
pdf_type_id
integer
format
string
Enum
template
string
__v
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
success
boolean
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ccd7250ffb27e1f347e22c"
body:
body
Was this section helpful?
PUT
Response
Deletes a specific PDF generator configuration based on the provided id.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
id
string
Required
This is mongo id
Response
200
Successful deletion of the PDF generator configuration.
Properties
success
boolean
Indicates if the deletion was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ccd7250ffb27e1f347e22c"
Was this section helpful?
DEL
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
pdf_type_id
integer
Required
This is invoice unique id
format
string
Required
This is invoice document format such as A4, A6, POS
Enum
country_code
string
This is country_code for which data needs to be displayed on UI
Response
200
Get last saved html template for invoice
PdfConfigSuccess
data
array of object (PdfConfigSuccessData)
Array of PdfConfigSuccessData
_id
string
This field contains the unique identifier for the PDF configuration.
company_id
integer
This field holds the identifier for the company associated with the PDF configuration.
application_id
string
This field contains the identifier for the application that uses this PDF configuration.
pdf_type_id
integer
This field holds an identifier for the type of PDF.
format
string
This field specifies the format of the invoice document.
Enum
template
string
This field contains the HTML template string for the PDF document.
__v
integer
This field holds the version number of the PDF configuration document.
country_code
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
success
boolean
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
pdf_type_id:
1
format:
"A4"
country_code:
"IN"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
format
string
This is invoice document format such as A4, A6, POS
Enum
template
string
This is html template string.
pdf_type_id
integer
This field holds an identifier for the type of PDF.
country_code
string
This field contains the country code.
default_template
boolean
This field indicates whether the fetched HTML template is the default template.
Response
201
Saved html template for invoice
PdfConfigSaveSuccess
data
object (PdfConfigSaveSuccessData)
PdfConfigSaveSuccessData
_id
string
company_id
integer
application_id
string
pdf_type_id
integer
format
string
Enum
template
string
__v
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
success
boolean
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
pdf_type_id
integer
Required
This is invoice unique id
format
string
Required
This is invoice document format such as A4, A6, POS
Enum
country_code
string
This is country_code for which data needs to be displayed on UI
Response
200
Get rendered html with dummy json payload
PdfDefaultTemplateSuccess
data
array of object (Document)
Array of Document
_id
string
pdf_type_id
integer
format
string
template
string
country_code
string
__v
integer
success
boolean
Indicates if the request was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
pdf_type_id:
1
format:
"A4"
country_code:
"IN"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
payload
object (PaymentReceiptPayload)
PaymentReceiptPayload
uid
string
order_detail
object (PaymentReceiptOrderDetails)
PaymentReceiptOrderDetails
jiomart_order_id
string
total_items
number
final_amount
number
final_amount_in_words
string
order_created_date
string
order_created_time
string
prm_id
string
receipt_no
string
taxes
object (PaymentReceiptTaxes)
PaymentReceiptTaxes
gstin
string
pancard
string
customer_detail
object (PaymentReceiptCustomerDetails)
PaymentReceiptCustomerDetails
id
string
email_id
string
last_name
string
first_name
string
mobile_number
string
payments
array of object (PaymentReceiptPayments)
Array of PaymentReceiptPayments
payment_desc
string
txn_date
string
| date-time
meta
object (PaymentReceiptMeta)
PaymentReceiptMeta
job_type
string
action
string
event
object
organizaton_id
string
company_id
number
application_id
array of string
format
object (PaymentReceiptFormat)
PaymentReceiptFormat
payment_receipt
array of string
trace_id
array of string
created_timestamp
number
service
object (PaymentReceiptService)
PaymentReceiptService
name
string
event_trace_info
object
trace
string
Response
200
400
Kafka response published to generate payment receipt
Properties
success
boolean
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
get default html template for invoice such as Invoice, Label, Deliver challan
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
id
string
Required
This is mongo id
Response
200
Update html template for invoice
PdfDefaultTemplateById
_id
string
The ID of the PDF default template
country_code
string
The country code associated with the template
format
string
The format of the template (e.g., "A4")
pdf_type_id
integer
The ID of the PDF type
__v
integer
Version number
template
string
The HTML template content
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ccd7250ffb27e1f347e1d8"
Was this section helpful?
GET
Response