Upload Multiple Documents In A Zip Folder And Get Batch Id

Endpoint Name: uploadbatch

Endpoint Details: This API is used to get a single batch id for all the invoices uploaded by the user in the form of a zip folder.

Authorization: Bearer token as header

Request Type

Method

URL

POST

URL/access/klearstack/uploadbatch

Request Body

Type

Params

Values

Description

POST

company_name

string

Name of the company

POST

username

string

Username for a particular user of a company

POST

password

string

Password for a particular user of a company

POST

file

Binary

Zip folder containing images/pdf

POST

POST

POST

processing_pref

document_type

invoice_type

string

string

string

Either “Speed” or “Accuracy” ” (It’s not case sensitive)

Type of document to be processed -

“Invoices”, “Receipts”, “PurchaseOrders”,“NACH”,“LoanAgreement” or “Insurances”.

“B2B” for invoices commissioned by a business to another business directly;

“B2C” for invoices commissioned by a business to a consumer.

“B2C” for Insurances.

POST

source_name

String

API

POST

priority_flag

String

true or false

POST

account_id

String

Account_id number

POST

set_reference_number

(Optional)

String

For adding document in Existing Set

POST

set_name

(Optional)

String

For assigning Name to document set, it cannot be updated after set is created

POST

create_new_set (Optional)

String

Flag needs to be True for creating new set, the param if set to True will create a new set with the given set_name and assign new set_reference_number to the document.

API Response

Status

Example Response

200

{

"Function successfully executed!": "169a4df0-52c4-4835-8bb4-10296c8e5e3a",

"release_version": "7.8.9",

"set_reference_number":"12345"

}

400

{"error": "Please provide username."}

400

{"error": "Please provide password."}

401

{"error": "Incorrect username or password."}

500

{"error": "Something went wrong. Please try again later."}

Last updated