Reports

The Reports endpoint executes system reports and returns paginated results — the same reports available in the desktop application.

The Report Object

{
  "reportID": 15,
  "reportName": "Stock Valuation",
  "reportType": 1
}

Fields

List Reports

GET /Report

Returns reports your API credentials have access to. Only reports permitted by your user group’s report rights are returned.

Parameters

Response

{
  "value": [
    {
      "reportID": 15,
      "reportName": "Stock Valuation",
      "reportType": 1
    },
    {
      "reportID": 22,
      "reportName": "Inventory Activity",
      "reportType": 1
    },
    {
      "reportID": 47,
      "reportName": "Open Purchase Orders",
      "reportType": 2
    }
  ],
  "totalCount": 45,
  "page": 1,
  "pageSize": 25,
  "pageCount": 2,
  "hasMore": true
}

Execute a Report

GET /Report/{id}

Runs the report and returns paginated results. Maximum page size is 1000.

Parameters

Response

Each report returns its own column structure. The value array contains one object per result row.

{
  "value": [
    {
      "partNo": 42,
      "shortID": "BOLT-M8-30",
      "warehouse": "Main",
      "units": 1500.0,
      "unitCost": 0.45,
      "totalValue": 675.00
    },
    {
      "partNo": 87,
      "shortID": "NUT-M8",
      "warehouse": "Main",
      "units": 3200.0,
      "unitCost": 0.22,
      "totalValue": 704.00
    }
  ],
  "totalCount": 2340,
  "page": 1,
  "pageSize": 100,
  "pageCount": 24,
  "hasMore": true
}

Column names and types vary per report. Run GET /Report to discover available reports, then query a specific report to inspect its result shape.

Error Cases

Permissions

Report access uses a per-report rights string separate from endpoint security. The list endpoint only returns reports your group can access. Executing a restricted report returns 403.