Get

[POST] .../v1/reportbuildertemplate/get

Returns current user's report builder templates. Use this method to read report builder templates saved by the current user. The response returns paged ReportBuilderUserTemplate records and supports filters by id, domain and last_update; search is passed next to filters and searches template name, description and domain. Only templates owned by the current user are returned. This method requires billing db version 406 or later and an account tariff with report builder enabled; older account databases return ErrorResult 1008 and disabled tariff returns ErrorResult 7501. The caller must have report-builder permission 759; missing body, denied access, unavailable tariff, invalid filters and persistent storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name	Type	Required	Description
filters	Array of Filter	Optional	Optional filters by fields available for this API method.
limit	Int32	Optional	Maximum number of rows to return. The server setting is used when omitted or invalid.
offset	Int32	Optional	Number of rows to skip.
search	String	Optional	Searches templates by name, description or domain.

Filterable Fields

Field	Type	Description
domain	string
id	int
last_update	int

Request Example

{
  "filters": [
    {
      "Field": "domain",
      "Operator": "Equal",
      "Value": "Nomenclature"
    }
  ],
  "search": "Stock",
  "limit": 20,
  "offset": 0
}

Response Parameters

Name	Type	Description
next_offset	Int32	Offset for the next data page.
ok	Boolean	Indicates whether the request completed successfully.
result	Array of ReportBuilderUserTemplate	Result array.
total	Int64	Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 10,
      "user_id": 5,
      "domain": "Nomenclature",
      "name": "Stock by warehouse",
      "description": "Current stock balance grouped by item and warehouse.",
      "structure": {
        "row_groups": [
          "item_group.name",
          "item.name"
        ],
        "row_columns": [
          "item.code",
          "unit.name"
        ],
        "column_groups": [
          "stock.name"
        ],
        "metrics": [
          "stock_balance.current_quantity"
        ]
      },
      "filters": {
        "firm_id": 1,
        "stock_ids": [
          1,
          2
        ]
      },
      "options": {
        "include_totals": true
      },
      "last_update": 1772527200
    }
  ],
  "next_offset": 0,
  "total": 1
}