Reports

Settlement List

get

Gets all Vendor-Settlement List

Query parameters

limitintegerOptional

offsetintegerOptional

keywordstringOptional

startDatestring · date-timeOptional

endDatestring · date-timeOptional

amountFromstringOptional

amountTostringOptional

countbooleanOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got settlement count."or"Successfully got settlement list.

get

/settlement

HTTPcURLJavaScriptPython

GET /settlement HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully got settlement count.\"or\"Successfully got settlement list."
}

Create Settlement

post

Adds a settlement for a vendor

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

titlestringOptional

vendorOrderIdinteger · int32[]Optional

Responses

200

success response

application/json

statusintegerOptional

messagestringOptionalDefault: Successfully created new Settlement.

400

error response

application/json

post

/settlement

HTTPcURLJavaScriptPython

POST /settlement HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 36

"title='text'&vendorOrderId=[1]"

{
  "status": 1,
  "message": "Successfully created new Settlement."
}

Settlement Export Excel Download

get

Downloads a Single Vendor-Settlement Excel File

Query parameters

settlementIdstringOptional

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: File Download has Started..!

get

/settlement/settlement-export-excel-download

HTTPcURLJavaScriptPython

GET /settlement/settlement-export-excel-download HTTP/1.1
Accept: */*

200

Success response

{
  "status": 1,
  "message": "File Download has Started..!"
}

Bulk Settlement Export Excel Download

get

Downloads all Vendor-Settlement Excel file

Query parameters

keywordstringOptional

startDatestringOptional

endDatestringOptional

amountFromstringOptional

amountTostringOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: File Download has Started..!

get

/settlement/bulk-export-settlement-list

HTTPcURLJavaScriptPython

GET /settlement/bulk-export-settlement-list HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "File Download has Started..!"
}

Vendor-Settlement Details

get

Gets detail of a Vendor-Settlement

Path parameters

idinteger · int32Required

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: successfully got Settlement details.

get

/settlement/settlement/{id}

HTTPcURLJavaScriptPython

GET /settlement/settlement/{id} HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "successfully got Settlement details."
}

Delete Multiple Settlement

post

Deletes multiple Vendor-Settlement records

Query parameters

settlementIdstringOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully deleted the settlement.

post

/settlement/delete-multiple-settlement

HTTPcURLJavaScriptPython

POST /settlement/delete-multiple-settlement HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully deleted the settlement."
}

Vendor Sales Report list

get

Gets list of Vendor Sales Report

Query parameters

offsetinteger · int32Optional

limitinteger · int32Optional

allVendorinteger · int32Optional

vendorsIdstringOptional

startDatestringOptional

endDatestringOptional

countbooleanOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got sales report count."or"Successfully got vendor sales list.

get

/settlement/vendor-sales-report-list

HTTPcURLJavaScriptPython

GET /settlement/vendor-sales-report-list HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully got sales report count.\"or\"Successfully got vendor sales list."
}

Total Sales Report list

get

Gets Total Sales Report from Vendor-Settlement

Query parameters

limitinteger · int32Optional

offsetinteger · int32Optional

amountFromstringOptional

amountTostringOptional

startDatestringOptional

endDatestringOptional

countbooleanOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got sales report count."or"Successfully got total vendor sales list.

get

/settlement/total-sales-report-list

HTTPcURLJavaScriptPython

GET /settlement/total-sales-report-list HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully got sales report count.\"or\"Successfully got total vendor sales list."
}

Settlement Report list

get

Gets all Vendor-Settlement Report list

Query parameters

vendorsIdstringOptional

limitinteger · int32Optional

offsetinteger · int32Optional

countbooleanOptional

startDatestringOptional

endDatestringOptional

settlementFlagstringOptional

orderStatusstringOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got sales report count."or"Successfully got settlement report list.

get

/settlement/settlement-report-list

HTTPcURLJavaScriptPython

GET /settlement/settlement-report-list HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully got sales report count.\"or\"Successfully got settlement report list."
}

Total sales report excel download

get

Downloads total Sales Report of Vendor-Settlement

Query parameters

amountFromstringOptional

amountTostringOptional

startDatestringOptional

endDatestringOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: File Download has Started..!

get

/settlement/total-sales-report-excel

HTTPcURLJavaScriptPython

GET /settlement/total-sales-report-excel HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "File Download has Started..!"
}

Total Vendor sales report excel download

get

Dowloads all Vendor-Settlement sales Report Excel

Query parameters

startDatestringOptional

endDatestringOptional

vendorsIdstringOptional

allVendornumber · int32Optional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: File Download has Started..!

get

/settlement/total-vendor-sales-report-excel

HTTPcURLJavaScriptPython

GET /settlement/total-vendor-sales-report-excel HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "File Download has Started..!"
}

Settlement Report excel download

get

Downloads all Vendor-Settlement Report in Excel

Query parameters

limitnumber · int32Optional

offsetnumber · int32Optional

vendorsIdstringOptional

orderStatusstringOptional

startDatestringOptional

endDatestringOptional

settlementFlagnumber · int32Optional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: File Download has Started..!

get

/settlement/settlement-report-excel

HTTPcURLJavaScriptPython

GET /settlement/settlement-report-excel HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "File Download has Started..!"
}