Upload Multiple Documents In A Zip Folder And Get Batch Id

Endpoint Name: uploadbatch

Request type : POST

Authorization: Bearer token as header

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.

Request Type

Method	URL
POST	URL/access/klearstack/uploadbatch

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company.
username	string	Yes	Username for a particular user of a company.
password	string	Yes	Password for a particular user of a company.
file	Binary	Yes	Zip folder containing images/pdf.
processing_pref	string	Yes	Either “Speed” or “Accuracy” ” (It’s not case sensitive).
document_type	string	Yes	Type of document to be processed - “Invoices”, “Receipts”, “PurchaseOrders”,“NACH”,“LoanAgreement” or “Insurances”.
invoice_type	string	Yes	“B2B” for invoices commissioned by a business to another business directly; “B2C” for invoices commissioned by a business to a consumer. “B2C” for Insurances.
source_name	String	No	API
priority_flag	String	No	true or false
account_id	String	No	Account_id number
set_reference_number	String	No	For adding document in Existing Set
set_name	String	No	For assigning Name to document set, it cannot be updated after set is created.
create_new_set	String	No	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.

Shell

• Request Body

curl --location "URL/access/klearstack/uploadbatch" \
  -H "Authorization: Bearer your_token_here" \
  -F "company_name=Replace_Company_Name_Here" \
  -F "username=Replace_User_Name_Here" \
  -F "password=Replace_Password_Here" \
  -F "processing_pref=Speed" \
  -F "document_type=Invoices" \
  -F "invoice_type=B2B" \
  -F "source_name=API" \
  -F "priority_flag=true" \
  -F "account_id=123456" \
  -F "set_reference_number=Ref123" \
  -F "set_name=MySet" \
  -F "create_new_set=true" \
  -F "file=@C:\Users\user\Downloads\batch.zip"

Python (Requests)

• Request Body

import requests

url = "URL/access/klearstack/uploadbatch"

payload = {'company_name': 'Replace_Company_Name_Here',
'username': 'Replace_User_Name_Here',
'password': 'Replace_Password_Here',
'processing_pref': 'Speed',
'document_type': 'Invoices',
'invoice_type': 'B2B',
'source_name': 'API',
'priority_flag': 'true',
'account_id': '123456',
'set_reference_number': 'Ref123',
'set_name': 'MySet',
'create_new_set': 'true'}
files=[
  ('file',('C:\Users\user\Downloads\batch.zip',open('C:\\Users\\user\\Downloads\\batch.zip','rb'),'application/zip'))
]
headers = {
  'Authorization': 'Bearer your_token_here'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Java (OkHttp)

• Request Body

OkHttpClient client = new OkHttpClient();

RequestBody body = new MultipartBody.Builder()
    .setType(MultipartBody.FORM)
    .addFormDataPart("company_name", "Replace_Company_Name_Here")
    .addFormDataPart("username", "Replace_User_Name_Here")
    .addFormDataPart("password", "Replace_Password_Here")
    .addFormDataPart("processing_pref", "Speed")
    .addFormDataPart("document_type", "Invoices")
    .addFormDataPart("invoice_type", "B2B")
    .addFormDataPart("source_name", "API")
    .addFormDataPart("priority_flag", "true")
    .addFormDataPart("account_id", "123456")
    .addFormDataPart("set_reference_number", "Ref123")
    .addFormDataPart("set_name", "MySet")
    .addFormDataPart("create_new_set", "true")
    .addFormDataPart(
        "file",
        "batch.zip",
        RequestBody.create(
            MediaType.parse("application/octet-stream"),
            new File("C:\\Users\\user\\Downloads\\batch.zip")
        )
    )
    .build();

Request request = new Request.Builder()
    .url("URL/access/klearstack/uploadbatch")
    .post(body)
    .addHeader("Authorization", "Bearer your_token_here")
    .build();

Response response = client.newCall(request).execute();

Node.js (Axios)

• Request Body

const axios = require('axios');
const FormData = require('form-data');
const fs = require('fs');

let formData = new FormData();
formData.append('company_name', 'Replace_Company_Name_Here');
formData.append('username', 'Replace_User_Name_Here');
formData.append('password', 'Replace_Password_Here');
formData.append('processing_pref', 'Speed');
formData.append('document_type', 'Invoices');
formData.append('invoice_type', 'B2B');
formData.append('source_name', 'API');
formData.append('priority_flag', 'true');
formData.append('account_id', '123456');
formData.append('set_reference_number', 'Ref123');
formData.append('set_name', 'MySet');
formData.append('create_new_set', 'true');
formData.append('file', fs.createReadStream('C:\\Users\\user\\Downloads\\batch.zip'));

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/uploadbatch',
  headers: {
    'Authorization': 'Bearer your_token_here',
    ...formData.getHeaders()
  },
  data: formData
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

JavaScript (XHR)

• Request Body

// WARNING: For POST requests, body is set to null by browsers.

var formData = new FormData();
formData.append("company_name", "Replace_Company_Name_Here");
formData.append("username", "Replace_User_Name_Here");
formData.append("password", "Replace_Password_Here");
formData.append("processing_pref", "Speed");
formData.append("document_type", "Invoices");
formData.append("invoice_type", "B2B");
formData.append("source_name", "API");
formData.append("priority_flag", "true");
formData.append("account_id", "123456");
formData.append("set_reference_number", "Ref123");
formData.append("set_name", "MySet");
formData.append("create_new_set", "true");
formData.append("file", fileInput.files[0], "batch.zip");

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "URL/access/klearstack/uploadbatch");
xhr.setRequestHeader("Authorization", "Bearer your_token_here");

xhr.send(formData);

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."}