Get Extracted Results For Invoices In a Set

Endpoint Name: URL/access/klearstack/getdocumentsforset

Request type : POST

Authorization : Bearer token as header

Endpoint Details : The getdocumentsforsetendpoint will be used to fetch all the documents belonging to a certain set based on the Set Reference Number.

Method	URL
POST	URL/access/klearstack/getdocumentsforset

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in
set_reference_number	string	Yes	set_reference_number for which documents are required
userid	string	No	User ID
role	string	No	user role, e.g:Approver

Request Code Samples

Shell

• Request body

curl --location "URL/access/klearstack/getdocumentsforset" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "userid=Replace_User_ID_Here" \
  --form "set_reference_number=Replace_Set_Reference_Number_Here" \
  --form "role=Replace_Role_Here"

Python

• Request body

import requests

url = "URL/access/klearstack/getdocumentsforset"

payload = {'company_name': 'Replace_Company_Name_Here',
'userid': 'Replace_User_ID_Here',
'set_reference_number': 'Replace_Set_Reference_Number_Here',
'role': 'Replace_Role_Here'}
files=[

]
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("userid", "Replace_User_ID_Here")
    .addFormDataPart("set_reference_number", "Replace_Set_Reference_Number_Here")
    .addFormDataPart("role", "Replace_Role_Here")
    .build();

Request request = new Request.Builder()
    .url("URL/access/klearstack/getdocumentsforset")
    .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');

let formData = new FormData();
formData.append('company_name', 'Replace_Company_Name_Here');
formData.append('userid', 'Replace_User_ID_Here');
formData.append('set_reference_number', 'Replace_Set_Reference_Number_Here');
formData.append('role', 'Replace_Role_Here');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/getdocumentsforset',
  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("userid", "Replace_User_ID_Here");
formData.append("set_reference_number", "Replace_Set_Reference_Number_Here");
formData.append("role", "Replace_Role_Here");

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/getdocumentsforset");
xhr.setRequestHeader("Authorization", "Bearer your_token_here");

xhr.send(formData);

API Response

Status code	Example Response
200	{ "all_result": [ { "batch_id": "f383919b-8efe-4014-a725", "status": "complete", "file_name": "test.pdf", "ondisk_encrypted_file_name": "", "result": [] } ] }