API reference / Reports

Reports API

36 endpoints. Scopes: Scalar360.reports.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

Get statement

/api/v1/reports/cash-bank

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default month)	No
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/cash-bank" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export

/api/v1/reports/cash-bank/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default month)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/cash-bank/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Excel

/api/v1/reports/documents/excel

Scope: Scalar360.reports.CREATE

Body field	Type	Required	Notes
`title`	string
`periodLabel`	string
`columns`	array of string	Yes	required, not empty
`rows`	array of array of any
`summary`	array of array of any

Example request

curl -X POST "https://api.scalar360.com/api/v1/reports/documents/excel" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"columns":["string"]}'

POST

Pdf

/api/v1/reports/documents/pdf

Scope: Scalar360.reports.CREATE

Body field	Type	Required	Notes
`title`	string
`periodLabel`	string
`columns`	array of string	Yes	required, not empty
`rows`	array of array of any
`summary`	array of array of any

Example request

curl -X POST "https://api.scalar360.com/api/v1/reports/documents/pdf" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"columns":["string"]}'

GET

Export

/api/v1/reports/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`reportId`	query	string	Yes
`format`	query	string (default csv)	No
`period`	query	string (default month)	No
`from`	query	string (date)	No
`to`	query	string (date)	No
`asOf`	query	string (date)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get gstr1 report

/api/v1/reports/gstr1

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`from`	query	string (date)	Yes
`to`	query	string (date)	Yes
`q`	query	string	No
`page`	query	integer	No
`pageSize`	query	integer	No
`sortBy`	query	string	No
`sortDir`	query	string	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr1" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get gstr1 summary

/api/v1/reports/gstr1-summary

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default month)	No
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr1-summary" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export gstr1 summary

/api/v1/reports/gstr1-summary/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default month)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr1-summary/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export csv

/api/v1/reports/gstr1/csv

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`from`	query	string (date)	Yes
`to`	query	string (date)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr1/csv" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export excel

/api/v1/reports/gstr1/excel

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`from`	query	string (date)	Yes
`to`	query	string (date)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr1/excel" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export json

/api/v1/reports/gstr1/json

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`from`	query	string (date)	Yes
`to`	query	string (date)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr1/json" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export pdf

/api/v1/reports/gstr1/pdf

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`from`	query	string (date)	Yes
`to`	query	string (date)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr1/pdf" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get gstr3b summary

/api/v1/reports/gstr3b

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`from`	query	string (date)	Yes
`to`	query	string (date)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr3b" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get gstr3b report

/api/v1/reports/gstr3b-summary

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default month)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr3b-summary" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export gstr3b report

/api/v1/reports/gstr3b-summary/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default month)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr3b-summary/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export gstr3b csv

/api/v1/reports/gstr3b/csv

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`from`	query	string (date)	Yes
`to`	query	string (date)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr3b/csv" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export gstr3b pdf

/api/v1/reports/gstr3b/pdf

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`from`	query	string (date)	Yes
`to`	query	string (date)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/gstr3b/pdf" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get invoice ageing

/api/v1/reports/invoice-ageing

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default MONTH)	No
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/invoice-ageing" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export invoice ageing

/api/v1/reports/invoice-ageing/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default MONTH)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/invoice-ageing/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get low stock report

/api/v1/reports/low-stock

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/low-stock" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export low stock report

/api/v1/reports/low-stock/export

Scope: Scalar360.reports.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/low-stock/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get payables report

/api/v1/reports/payables-report

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default month)	No
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/payables-report" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export payables report

/api/v1/reports/payables-report/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default month)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/payables-report/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Run

/api/v1/reports/run/{reportId}

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`reportId`	path	string	Yes
`period`	query	string (default month)	No
`from`	query	string (date)	No
`to`	query	string (date)	No
`asOf`	query	string (date)	No
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 25)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/run/{reportId}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get sales summary

/api/v1/reports/sales-summary

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default MONTH)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/sales-summary" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export sales summary

/api/v1/reports/sales-summary/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default MONTH)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/sales-summary/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get stock ledger

/api/v1/reports/stock-ledger

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`itemId`	query	string (uuid)	Yes
`from`	query	string (date)	No
`to`	query	string (date)	No
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 25)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/stock-ledger" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export stock ledger

/api/v1/reports/stock-ledger/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`itemId`	query	string (uuid)	Yes
`from`	query	string (date)	No
`to`	query	string (date)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/stock-ledger/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get stock report

/api/v1/reports/stock-report

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/stock-report" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export stock report

/api/v1/reports/stock-report/export

Scope: Scalar360.reports.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/stock-report/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get top customers

/api/v1/reports/top-customers

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default MONTH)	No
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/top-customers" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export top customers

/api/v1/reports/top-customers/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default MONTH)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/top-customers/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get top items

/api/v1/reports/top-items

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default MONTH)	No
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/top-items" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Export top items

/api/v1/reports/top-items/export

Scope: Scalar360.reports.READ

Parameter	In	Type	Required
`period`	query	string (default MONTH)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/top-items/export" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get views

/api/v1/reports/views

Scope: Scalar360.reports.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/reports/views" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Save view

/api/v1/reports/views

Scope: Scalar360.reports.CREATE

Body field	Type	Required	Notes
`reportType`	string	Yes	required, not blank
`viewName`	string	Yes	required, not blank
`period`	string
`filters`	map of any

Example request

curl -X POST "https://api.scalar360.com/api/v1/reports/views" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reportType":"string","viewName":"string"}'