Get Results of Modified Invoices since the last pull

Endpoint Name : getmodifiedinvoices

Request type : POST

Authorization : Bearer token as header

Endpoint Details : This API is used to get the results of modified invoices which are modified by any user of a company since the last pull.

Request Type

Method	URL
POST	URL/access/klearstack/getmodifiedinvoices

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
document_type	string	No	Type of document to be processed - “Invoices”, “Receipts”, “PurchaseOrders”,“NACH”,“LoanAgreement” or “Insurances”. By default “Invoices” will be set if this parameter is not passed Note: Optional Parameter

Shall

• Request Body

curl --location "URL/access/klearstack/getmodifiedinvoices" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "username=Replace_User_Name_Here" \
  --form "password=Replace_Password_Here" \
  --form "document_type=Invoices"

Python

• Request Body

import requests

url = "URL/access/klearstack/getmodifiedinvoices"

payload = {'company_name': 'Replace_Company_Name_Here',
'username': 'Replace_User_Name_Here',
'password': 'Replace_Password_Here',
'document_type': 'Invoices'}
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("username", "Replace_User_Name_Here")
    .addFormDataPart("password", "Replace_Password_Here")
    .addFormDataPart("document_type", "Invoices")
    .build();

Request request = new Request.Builder()
    .url("URL/access/klearstack/getmodifiedinvoices")
    .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('username', 'Replace_User_Name_Here');
formData.append('password', 'Replace_Password_Here');
formData.append('document_type', 'Invoices');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/getmodifiedinvoices',
  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("document_type", "Invoices");

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

xhr.send(formData);

API Response

Status Code	Response
200	{ "result": [ { "file_name": "24101020953_Invoice Copy_Invoice Copy_1.pdf", "status": "in_progress" } ], "status": "in_progress" }
403	Forbidden: Client Error
501	Server Error